Interface EditSessionEvents

interface EditSessionEvents {
    beforeEndOperation: (() => void);
    change: ((delta) => void);
    changeAnnotation: ((e) => void);
    changeBackMarker: (() => void);
    changeBreakpoint: ((e?) => void);
    changeEditor: ((e) => void);
    changeFold: ((e, session?) => void);
    changeFrontMarker: (() => void);
    changeMode: ((e) => void);
    changeOverwrite: ((overwrite) => void);
    changeScrollLeft: ((scrollLeft) => void);
    changeScrollTop: ((scrollTop) => void);
    changeSelection: (() => void);
    changeTabSize: (() => void);
    changeWrapLimit: ((e) => void);
    changeWrapMode: ((e) => void);
    endOperation: ((op?) => void);
    startOperation: ((op?) => void);
    tokenizerUpdate: ((e) => void);
}

Properties

beforeEndOperation change changeAnnotation changeBackMarker changeBreakpoint changeEditor changeFold changeFrontMarker changeMode changeOverwrite changeScrollLeft changeScrollTop changeSelection changeTabSize changeWrapLimit changeWrapMode endOperation startOperation tokenizerUpdate

Properties

beforeEndOperation

beforeEndOperation: (() => void)

Type declaration

    • (): void

    • Returns void

change

change: ((delta) => void)

Emitted when the document changes.

Type declaration

    • (delta): void

    • Emitted when the document changes.

      Parameters

      Returns void

changeAnnotation

changeAnnotation: ((e) => void)

Emitted when an annotation changes, like through [[EditSession.setAnnotations]].

Type declaration

    • (e): void

    • Emitted when an annotation changes, like through [[EditSession.setAnnotations]].

      Parameters

      • e: {}

        Returns void

    changeBackMarker

    changeBackMarker: (() => void)

    Emitted when a back marker changes.

    Type declaration

      • (): void

      • Emitted when a back marker changes.

        Returns void

    changeBreakpoint

    changeBreakpoint: ((e?) => void)

    Emitted when the gutter changes, either by setting or removing breakpoints, or when the gutter decorations change.

    Type declaration

      • (e?): void

      • Emitted when the gutter changes, either by setting or removing breakpoints, or when the gutter decorations change.

        Parameters

        • Optional e: {
              breakpoint?: boolean;
              row?: number;
          }
          • Optional breakpoint?: boolean
          • Optional row?: number

        Returns void

    changeEditor

    changeEditor: ((e) => void)

    Type declaration

      • (e): void

      • Parameters

        Returns void

    changeFold

    changeFold: ((e, session?) => void)

    Emitted when a code fold is added or removed.

    Type declaration

      • (e, session?): void

      • Emitted when a code fold is added or removed.

        Parameters

        Returns void

    changeFrontMarker

    changeFrontMarker: (() => void)

    Emitted when a front marker changes.

    Type declaration

      • (): void

      • Emitted when a front marker changes.

        Returns void

    changeMode

    changeMode: ((e) => void)

    Emitted when the current mode changes.

    Type declaration

      • (e): void

      • Emitted when the current mode changes.

        Parameters

        • e: any

        Returns void

    changeOverwrite

    changeOverwrite: ((overwrite) => void)

    Emitted when the ability to overwrite text changes, via [[EditSession.setOverwrite]].

    Type declaration

      • (overwrite): void

      • Emitted when the ability to overwrite text changes, via [[EditSession.setOverwrite]].

        Parameters

        • overwrite: boolean

        Returns void

    changeScrollLeft

    changeScrollLeft: ((scrollLeft) => void)

    Emitted when the scroll left changes.

    Type declaration

      • (scrollLeft): void

      • Emitted when the scroll left changes.

        Parameters

        • scrollLeft: number

          The new scroll left value

        Returns void

    Param: scrollLeft

    The new scroll left value

    changeScrollTop

    changeScrollTop: ((scrollTop) => void)

    Emitted when the scroll top changes.

    Type declaration

      • (scrollTop): void

      • Emitted when the scroll top changes.

        Parameters

        • scrollTop: number

          The new scroll top value

        Returns void

    Param: scrollTop

    The new scroll top value

    changeSelection

    changeSelection: (() => void)

    Type declaration

      • (): void

      • Returns void

    changeTabSize

    changeTabSize: (() => void)

    Emitted when the tab size changes, via [[EditSession.setTabSize]].

    Type declaration

      • (): void

      • Emitted when the tab size changes, via [[EditSession.setTabSize]].

        Returns void

    changeWrapLimit

    changeWrapLimit: ((e) => void)

    Emitted when the wrapping limit changes.

    Type declaration

      • (e): void

      • Emitted when the wrapping limit changes.

        Parameters

        • e: any

        Returns void

    changeWrapMode

    changeWrapMode: ((e) => void)

    Emitted when the wrap mode changes.

    Type declaration

      • (e): void

      • Emitted when the wrap mode changes.

        Parameters

        • e: any

        Returns void

    endOperation

    endOperation: ((op?) => void)

    Type declaration

      • (op?): void

      • Parameters

        • Optional op: any

        Returns void

    startOperation

    startOperation: ((op?) => void)

    Type declaration

      • (op?): void

      • Parameters

        • Optional op: {
              args?: any;
              command?: {
                  name?: string;
              };
          }
          • Optional args?: any
          • Optional command?: {
                name?: string;
            }
            • Optional name?: string

        Returns void

    tokenizerUpdate

    tokenizerUpdate: ((e) => void)

    Emitted when a background tokenizer asynchronously processes new rows.

    Type declaration

      • (e): void

      • Emitted when a background tokenizer asynchronously processes new rows.

        Parameters

        • e: {
              data: {
                  first: number;
                  last: number;
              };
          }
          • data: {
                first: number;
                last: number;
            }
            • first: number
            • last: number

        Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc