Interface EditorEvents

interface EditorEvents {
    beforeEndOperation: ((e) => void);
    blur: ((e) => void);
    change: ((delta) => void);
    changeMode: ((e) => void);
    changeSelection: (() => void);
    changeSelectionStyle: ((data) => void);
    changeSession: ((e) => void);
    changeStatus: ((e) => void);
    codeLensClick: ((e) => void);
    compositionStart: (() => void);
    copy: ((e) => void);
    destroy: ((e) => void);
    findSearchBox: ((e) => void);
    focus: ((e?) => void);
    gutterclick: ((e) => void);
    gutterkeydown: ((e) => void);
    hideGutterTooltip: ((e) => void);
    input: (() => void);
    keyboardActivity: ((e) => void);
    mousedown: ((e) => void);
    mousemove: ((e, editor?) => void);
    mouseup: ((e) => void);
    mousewheel: ((e) => void);
    nativecontextmenu: ((e) => void);
    paste: ((e) => void);
    select: (() => void);
    showGutterTooltip: ((e) => void);
}

Properties

beforeEndOperation blur change changeMode changeSelection changeSelectionStyle changeSession changeStatus codeLensClick compositionStart copy destroy findSearchBox focus gutterclick gutterkeydown hideGutterTooltip input keyboardActivity mousedown mousemove mouseup mousewheel nativecontextmenu paste select showGutterTooltip

Properties

beforeEndOperation

beforeEndOperation: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: any

      Returns void

blur

blur: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: any

      Returns void

change

change: ((delta) => void)

Type declaration

    • (delta): void

    • Parameters

      Returns void

changeMode

changeMode: ((e) => void)

Type declaration

changeSelection

changeSelection: (() => void)

Type declaration

    • (): void

    • Returns void

changeSelectionStyle

changeSelectionStyle: ((data) => void)

Emitted when the selection style changes, via [[Editor.setSelectionStyle]].

Type declaration

    • (data): void

    • Emitted when the selection style changes, via [[Editor.setSelectionStyle]].

      Parameters

      • data: "line" | "text" | "fullLine" | "screenLine"

        Contains one property, data, which indicates the new selection style

      Returns void

Param: data

Contains one property, data, which indicates the new selection style

changeSession

changeSession: ((e) => void)

Emitted whenever the [[EditSession]] changes.

Type declaration

    • (e): void

    • Emitted whenever the [[EditSession]] changes.

      Parameters

      Returns void

Param: e

An object with two properties, oldSession and session, that represent the old and new [[EditSession]]s.

changeStatus

changeStatus: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: any

      Returns void

codeLensClick

codeLensClick: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: any

      Returns void

compositionStart

compositionStart: (() => void)

Type declaration

    • (): void

    • Returns void

copy

copy: ((e) => void)

Emitted when text is copied.

Type declaration

    • (e): void

    • Emitted when text is copied.

      Parameters

      • e: {
            text: string;
        }
        • text: string

      Returns void

Param: text

The copied text

destroy

destroy: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: any

      Returns void

findSearchBox

findSearchBox: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: {
            match: boolean;
        }
        • match: boolean

      Returns void

focus

focus: ((e?) => void)

Type declaration

    • (e?): void

    • Parameters

      • Optional e: any

      Returns void

gutterclick

gutterclick: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: MouseEvent

      Returns void

gutterkeydown

gutterkeydown: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: GutterKeyboardEvent

      Returns void

hideGutterTooltip

hideGutterTooltip: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: GutterTooltip

      Returns void

input

input: (() => void)

Type declaration

    • (): void

    • Returns void

keyboardActivity

keyboardActivity: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: any

      Returns void

mousedown

mousedown: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: MouseEvent

      Returns void

mousemove

mousemove: ((e, editor?) => void)

Type declaration

    • (e, editor?): void

    • Parameters

      • e: MouseEvent & {
            scrollTop?: any;
        }
      • Optional editor: Editor

      Returns void

mouseup

mouseup: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: MouseEvent

      Returns void

mousewheel

mousewheel: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: MouseEvent

      Returns void

nativecontextmenu

nativecontextmenu: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: any

      Returns void

paste

paste: ((e) => void)

Emitted when text is pasted.

Type declaration

    • (e): void

    • Emitted when text is pasted.

      Parameters

      • e: {
            event?: ClipboardEvent;
            text: string;
        }
        • Optional event?: ClipboardEvent
        • text: string

      Returns void

select

select: (() => void)

Type declaration

    • (): void

    • Returns void

showGutterTooltip

showGutterTooltip: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: GutterTooltip

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc