Ace API Reference
    Preparing search index...

    Interface EditSessionEvents

    interface EditSessionEvents {
        beforeEndOperation: (e: undefined, emitter: EditSession) => void;
        change: (delta: Ace.Delta, emitter: EditSession) => void;
        changeAnnotation: (e: {}, emitter: EditSession) => void;
        changeBackMarker: (e: undefined, emitter: EditSession) => void;
        changeBreakpoint: (
            e: { breakpoint?: boolean; row?: number },
            emitter: EditSession,
        ) => void;
        changeEditor: (
            e: { editor?: Editor; oldEditor?: Editor },
            emitter: EditSession,
        ) => void;
        changeFold: (e: any, emitter: EditSession) => void;
        changeFrontMarker: (e: undefined, emitter: EditSession) => void;
        changeMode: (e: any, emitter: EditSession) => void;
        changeOverwrite: (overwrite: boolean, emitter: EditSession) => void;
        changeScrollLeft: (scrollLeft: number, emitter: EditSession) => void;
        changeScrollTop: (scrollTop: number, emitter: EditSession) => void;
        changeSelection: (e: undefined, emitter: EditSession) => void;
        changeTabSize: (e: undefined, emitter: EditSession) => void;
        changeWrapLimit: (e: any, emitter: EditSession) => void;
        changeWrapMode: (e: any, emitter: EditSession) => void;
        endOperation: (op: any, emitter: EditSession) => void;
        startOperation: (
            op: { args?: any; command?: { name?: string } },
            emitter: EditSession,
        ) => void;
        tokenizerUpdate: (
            e: { data: { first: number; last: number } },
            emitter: EditSession,
        ) => void;
    }
    Index

    Properties

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

    Properties

    beforeEndOperation: (e: undefined, emitter: EditSession) => void
    change: (delta: Ace.Delta, emitter: EditSession) => void

    Emitted when the document changes.

    changeAnnotation: (e: {}, emitter: EditSession) => void

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

    changeBackMarker: (e: undefined, emitter: EditSession) => void

    Emitted when a back marker changes.

    changeBreakpoint: (
        e: { breakpoint?: boolean; row?: number },
        emitter: EditSession,
    ) => void

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

    changeEditor: (
        e: { editor?: Editor; oldEditor?: Editor },
        emitter: EditSession,
    ) => void
    changeFold: (e: any, emitter: EditSession) => void

    Emitted when a code fold is added or removed.

    changeFrontMarker: (e: undefined, emitter: EditSession) => void

    Emitted when a front marker changes.

    changeMode: (e: any, emitter: EditSession) => void

    Emitted when the current mode changes.

    changeOverwrite: (overwrite: boolean, emitter: EditSession) => void

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

    changeScrollLeft: (scrollLeft: number, emitter: EditSession) => void

    Emitted when the scroll left changes.

    Type declaration

      • (scrollLeft: number, emitter: EditSession): void

      • Parameters

        • scrollLeft: number

          The new scroll left value

        • emitter: EditSession

        Returns void

    changeScrollTop: (scrollTop: number, emitter: EditSession) => void

    Emitted when the scroll top changes.

    Type declaration

      • (scrollTop: number, emitter: EditSession): void

      • Parameters

        • scrollTop: number

          The new scroll top value

        • emitter: EditSession

        Returns void

    changeSelection: (e: undefined, emitter: EditSession) => void
    changeTabSize: (e: undefined, emitter: EditSession) => void

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

    changeWrapLimit: (e: any, emitter: EditSession) => void

    Emitted when the wrapping limit changes.

    changeWrapMode: (e: any, emitter: EditSession) => void

    Emitted when the wrap mode changes.

    endOperation: (op: any, emitter: EditSession) => void
    startOperation: (
        op: { args?: any; command?: { name?: string } },
        emitter: EditSession,
    ) => void
    tokenizerUpdate: (
        e: { data: { first: number; last: number } },
        emitter: EditSession,
    ) => void

    Emitted when a background tokenizer asynchronously processes new rows.

    Settings

    Member Visibility

    On This Page

    Properties