Interface EditSession

interface EditSession {
    doc: Document;
    selection: Selection;
    addDynamicMarker(marker: MarkerLike, inFront: boolean): MarkerLike;
    addEventListener(
        name: string,
        callback: Function,
        capturing?: boolean,
    ): void;
    addFold(placeholder: string | Fold, range?: Range): Fold;
    addFolds(folds: Fold[]): void;
    addGutterDecoration(row: number, className: string): void;
    addMarker(
        range: Range,
        className: string,
        type: "text" | "fullLine" | "screenLine" | MarkerRenderer,
        inFront?: boolean,
    ): number;
    adjustWrapLimit(desiredLimit: number): boolean;
    clearAnnotations(): void;
    clearBreakpoint(row: number): void;
    clearBreakpoints(): void;
    destroy(): void;
    documentToScreenColumn(row: number, docColumn: number): number;
    documentToScreenPosition(docRow: number, docColumn: number): Position;
    documentToScreenPosition(position: Position): Position;
    documentToScreenRow(docRow: number, docColumn: number): number;
    duplicateLines(firstRow: number, lastRow: number): void;
    expandFold(fold: Fold): void;
    expandFolds(folds: Fold[]): void;
    foldAll(startRow?: number, endRow?: number, depth?: number): void;
    getAllFolds(): Fold[];
    getAnnotations(): Annotation[];
    getAWordRange(row: number, column: number): Range;
    getBreakpoints(): string[];
    getCommentFoldRange(
        row: number,
        column: number,
        dir: number,
    ): Range | undefined;
    getDisplayLine(
        row: number,
        endColumn: number | null,
        startRow: number | null,
        startColumn: number | null,
    ): string;
    getDocument(): Document;
    getDocumentLastRowColumn(docRow: number, docColumn: number): number;
    getdocumentLastRowColumnPosition(
        docRow: number,
        docColumn: number,
    ): Position;
    getFoldAt(row: number, column: number, side: number): Fold;
    getFoldDisplayLine(
        foldLine: FoldLine,
        endRow: number | null,
        endColumn: number | null,
        startRow: number | null,
        startColumn: number | null,
    ): string;
    getFoldedRowCount(first: number, last: number): number;
    getFoldLine(docRow: number, startFoldLine?: FoldLine): FoldLine | null;
    getFoldRowEnd(docRow: number, startFoldRow?: FoldLine): number;
    getFoldRowStart(docRow: number, startFoldRow?: FoldLine): number;
    getFoldsInRange(range: Range): Fold[];
    getFoldsInRangeList(ranges: Range[]): Fold[];
    getFoldStringAt(
        row: number,
        column: number,
        trim?: number,
        foldLine?: FoldLine,
    ): string | null;
    getLength(): number;
    getLine(row: number): string;
    getLines(firstRow: number, lastRow: number): string[];
    getLineWidgetMaxWidth(): number;
    getMarkers(inFront?: boolean): { [id: number]: MarkerLike };
    getMode(): SyntaxMode;
    getNavigateWithinSoftTabs(): boolean;
    getNewLineMode(): NewLineMode;
    getNextFoldLine(docRow: number, startFoldLine?: FoldLine): FoldLine | null;
    getOption<T extends keyof EditSessionOptions>(
        name: T,
    ): EditSessionOptions[T];
    getOptions(
        optionNames?: string[] | { [key: string]: any },
    ): { [key: string]: any };
    getOverwrite(): boolean;
    getParentFoldRangeData(
        row: number,
        ignoreCurrent?: boolean,
    ): { firstRange: Range; range?: Range };
    getRowLineCount(row: number): number;
    getRowSplitData(row: number): string | undefined;
    getRowWrapIndent(screenRow: number): number;
    getScreenLastRowColumn(screenRow: number): number;
    getScreenLength(): number;
    getScreenTabSize(screenColumn: number): number;
    getScreenWidth(): number;
    getScrollLeft(): number;
    getScrollTop(): number;
    getSelection(): Selection;
    getState(row: number): string;
    getTabSize(): number;
    getTabString(): string;
    getTextRange(range: Range): string;
    getTokenAt(row: number, column: number): Token | null;
    getTokens(row: number): Token[];
    getUndoManager(): UndoManager;
    getUseSoftTabs(): boolean;
    getUseWorker(): boolean;
    getUseWrapMode(): boolean;
    getValue(): string;
    getWordRange(row: number, column: number): Range;
    getWrapLimit(): number;
    getWrapLimitRange(): { max: number; min: number };
    highlight(re: RegExp): void;
    highlightLines(
        startRow: number,
        endRow: number,
        className: string,
        inFront?: boolean,
    ): Range;
    indentRows(startRow: number, endRow: number, indentString: string): void;
    insert(position: Position, text: string): void;
    isRowFolded(docRow: number, startFoldRow?: FoldLine): boolean;
    isTabStop(position: Position): boolean;
    markUndoGroup(): void;
    moveLinesDown(firstRow: number, lastRow: number): void;
    moveLinesUp(firstRow: number, lastRow: number): void;
    moveText(fromRange: Range, toPosition: Position, copy?: boolean): void;
    off(name: string, callback: Function): void;
    on(
        name: "changeFold",
        callback: (obj: { action: string; data: Fold }) => void,
    ): Function;
    on(
        name: "changeScrollLeft",
        callback: (scrollLeft: number) => void,
    ): Function;
    on(
        name: "changeScrollTop",
        callback: (scrollTop: number) => void,
    ): Function;
    on(
        name: "tokenizerUpdate",
        callback: (obj: { data: { first: number; last: number } }) => void,
    ): Function;
    on(name: "change", callback: () => void): Function;
    on(name: "changeTabSize", callback: () => void): Function;
    once(name: string, callback: Function): void;
    outdentRows(range: Range): void;
    redoChanges(deltas: Delta[], dontSelect?: boolean): void;
    remove(range: Range): void;
    removeAllListeners(name?: string): void;
    removeDefaultHandler(name: string, callback: Function): void;
    removeEventListener(name: string, callback: Function): void;
    removeFold(fold: Fold): void;
    removeFolds(folds: Fold[]): void;
    removeFullLines(firstRow: number, lastRow: number): void;
    removeGutterDecoration(row: number, className: string): void;
    removeListener(name: string, callback: Function): void;
    removeMarker(markerId: number): void;
    replace(range: Range, text: string): void;
    resetCaches(): void;
    screenToDocumentColumn(screenRow: number, screenColumn: number): number;
    screenToDocumentPosition(
        screenRow: number,
        screenColumn: number,
        offsetX?: number,
    ): Position;
    screenToDocumentRow(screenRow: number, screenColumn: number): number;
    setAnnotations(annotations: Annotation[]): void;
    setBreakpoint(row: number, className: string): void;
    setBreakpoints(rows: number[]): void;
    setDefaultHandler(name: string, callback: Function): void;
    setDocument(doc: Document): void;
    setFoldStyle(style: string): void;
    setMode(mode: string | SyntaxMode, callback?: () => void): void;
    setNavigateWithinSoftTabs(navigateWithinSoftTabs: boolean): void;
    setNewLineMode(newLineMode: NewLineMode): void;
    setOption<T extends keyof EditSessionOptions>(
        name: T,
        value: EditSessionOptions[T],
    ): void;
    setOptions(optList: { [key: string]: any }): void;
    setOverwrite(overwrite: boolean): void;
    setScrollLeft(scrollLeft: number): void;
    setScrollTop(scrollTop: number): void;
    setTabSize(tabSize: number): void;
    setUndoManager(undoManager: UndoManager): void;
    setUndoSelect(enable: boolean): void;
    setUseSoftTabs(val: boolean): void;
    setUseWorker(useWorker: boolean): void;
    setUseWrapMode(useWrapMode: boolean): void;
    setValue(text: string): void;
    setWrapLimit(limit: number): void;
    setWrapLimitRange(min: number, max: number): void;
    toggleFold(tryToUnfold?: boolean): void;
    toggleFoldWidget(toggleParent?: boolean): void;
    toggleOverwrite(): void;
    undoChanges(deltas: Delta[], dontSelect?: boolean): void;
    unfold(
        location: number | Point | Range | null,
        expandInner?: boolean,
    ): Fold[] | undefined;
    updateFoldWidgets(delta: Delta): void;
}

Hierarchy (View Summary)

Index

Properties

doc selection

Methods

addDynamicMarker addEventListener addFold addFolds addGutterDecoration addMarker adjustWrapLimit clearAnnotations clearBreakpoint clearBreakpoints destroy documentToScreenColumn documentToScreenPosition documentToScreenRow duplicateLines expandFold expandFolds foldAll getAllFolds getAnnotations getAWordRange getBreakpoints getCommentFoldRange getDisplayLine getDocument getDocumentLastRowColumn getdocumentLastRowColumnPosition getFoldAt getFoldDisplayLine getFoldedRowCount getFoldLine getFoldRowEnd getFoldRowStart getFoldsInRange getFoldsInRangeList getFoldStringAt getLength getLine getLines getLineWidgetMaxWidth getMarkers getMode getNavigateWithinSoftTabs getNewLineMode getNextFoldLine getOption getOptions getOverwrite getParentFoldRangeData getRowLineCount getRowSplitData getRowWrapIndent getScreenLastRowColumn getScreenLength getScreenTabSize getScreenWidth getScrollLeft getScrollTop getSelection getState getTabSize getTabString getTextRange getTokenAt getTokens getUndoManager getUseSoftTabs getUseWorker getUseWrapMode getValue getWordRange getWrapLimit getWrapLimitRange highlight highlightLines indentRows insert isRowFolded isTabStop markUndoGroup moveLinesDown moveLinesUp moveText off on once outdentRows redoChanges remove removeAllListeners removeDefaultHandler removeEventListener removeFold removeFolds removeFullLines removeGutterDecoration removeListener removeMarker replace resetCaches screenToDocumentColumn screenToDocumentPosition screenToDocumentRow setAnnotations setBreakpoint setBreakpoints setDefaultHandler setDocument setFoldStyle setMode setNavigateWithinSoftTabs setNewLineMode setOption setOptions setOverwrite setScrollLeft setScrollTop setTabSize setUndoManager setUndoSelect setUseSoftTabs setUseWorker setUseWrapMode setValue setWrapLimit setWrapLimitRange toggleFold toggleFoldWidget toggleOverwrite undoChanges unfold updateFoldWidgets

Properties

`Readonly`doc

doc: Document

selection

selection: Selection

Methods

addDynamicMarker

addDynamicMarker(marker: MarkerLike, inFront: boolean): MarkerLike
Parameters
- marker: MarkerLike
- inFront: boolean
Returns MarkerLike
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:555

addEventListener

addEventListener(name: string, callback: Function, capturing?: boolean): void
Parameters
- name: string
- callback: Function
- Optionalcapturing: boolean
Returns void
Inherited from EventEmitter.addEventListener
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:257

addFold

addFold(placeholder: string | Fold, range?: Range): Fold
Parameters
- placeholder: string | Fold
- Optionalrange: Range
Returns Fold
Inherited from Folding.addFold
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:94

addFolds

addFolds(folds: Fold[]): void
Parameters
- folds: Fold[]
Returns void
Inherited from Folding.addFolds
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:95

addGutterDecoration

addGutterDecoration(row: number, className: string): void
Parameters
- row: number
- className: string
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:544

addMarker

addMarker(
    range: Range,
    className: string,
    type: "text" | "fullLine" | "screenLine" | MarkerRenderer,
    inFront?: boolean,
): number
Parameters
- range: Range
- className: string
- type: "text" | "fullLine" | "screenLine" | MarkerRenderer
- OptionalinFront: boolean
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:551

adjustWrapLimit

adjustWrapLimit(desiredLimit: number): boolean
Parameters
- desiredLimit: number
Returns boolean
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:600

clearAnnotations

clearAnnotations(): void
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:565

clearBreakpoint

clearBreakpoint(row: number): void
Parameters
- row: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:550

clearBreakpoints

clearBreakpoints(): void
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:548

destroy

destroy(): void
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:621

documentToScreenColumn

documentToScreenColumn(row: number, docColumn: number): number
Parameters
- row: number
- docColumn: number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:618

documentToScreenPosition

documentToScreenPosition(docRow: number, docColumn: number): Position
Parameters
- docRow: number
- docColumn: number
Returns Position
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:616
documentToScreenPosition(position: Position): Position
Parameters
- position: Position
Returns Position
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:617

documentToScreenRow

documentToScreenRow(docRow: number, docColumn: number): number
Parameters
- docRow: number
- docColumn: number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:619

duplicateLines

duplicateLines(firstRow: number, lastRow: number): void
Parameters
- firstRow: number
- lastRow: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:596

expandFold

expandFold(fold: Fold): void
Parameters
- fold: Fold
Returns void
Inherited from Folding.expandFold
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:98

expandFolds

expandFolds(folds: Fold[]): void
Parameters
- folds: Fold[]
Returns void
Inherited from Folding.expandFolds
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:99

foldAll

foldAll(startRow?: number, endRow?: number, depth?: number): void
Parameters
- OptionalstartRow: number
- OptionalendRow: number
- Optionaldepth: number
Returns void
Inherited from Folding.foldAll
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:118

getAllFolds

getAllFolds(): Fold[]
Returns Fold[]
Inherited from Folding.getAllFolds
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:86

getAnnotations

getAnnotations(): Annotation[]
Returns Annotation[]
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:564

getAWordRange

getAWordRange(row: number, column: number): Range
Parameters
- row: number
- column: number
Returns Range
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:567

getBreakpoints

getBreakpoints(): string[]
Returns string[]
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:546

getCommentFoldRange

getCommentFoldRange(row: number, column: number, dir: number): Range | undefined
Parameters
- row: number
- column: number
- dir: number
Returns Range | undefined
Inherited from Folding.getCommentFoldRange
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:115

getDisplayLine

getDisplayLine(
    row: number,
    endColumn: number | null,
    startRow: number | null,
    startColumn: number | null,
): string
Parameters
- row: number
- endColumn: number | null
- startRow: number | null
- startColumn: number | null
Returns string
Inherited from Folding.getDisplayLine
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:110

getDocument

getDocument(): Document
Returns Document
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:522

getDocumentLastRowColumn

getDocumentLastRowColumn(docRow: number, docColumn: number): number
Parameters
- docRow: number
- docColumn: number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:607

getdocumentLastRowColumnPosition

getdocumentLastRowColumnPosition(docRow: number, docColumn: number): Position
Parameters
- docRow: number
- docColumn: number
Returns Position
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:608

getFoldAt

getFoldAt(row: number, column: number, side: number): Fold
Parameters
- row: number
- column: number
- side: number
Returns Fold
Inherited from Folding.getFoldAt
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:83

getFoldDisplayLine

getFoldDisplayLine(
    foldLine: FoldLine,
    endRow: number | null,
    endColumn: number | null,
    startRow: number | null,
    startColumn: number | null,
): string
Parameters
- foldLine: FoldLine
- endRow: number | null
- endColumn: number | null
- startRow: number | null
- startColumn: number | null
Returns string
Inherited from Folding.getFoldDisplayLine
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:105

getFoldedRowCount

getFoldedRowCount(first: number, last: number): number
Parameters
- first: number
- last: number
Returns number
Inherited from Folding.getFoldedRowCount
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:93

getFoldLine

getFoldLine(docRow: number, startFoldLine?: FoldLine): FoldLine | null
Parameters
- docRow: number
- OptionalstartFoldLine: FoldLine
Returns FoldLine | null
Inherited from Folding.getFoldLine
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:91

getFoldRowEnd

getFoldRowEnd(docRow: number, startFoldRow?: FoldLine): number
Parameters
- docRow: number
- OptionalstartFoldRow: FoldLine
Returns number
Inherited from Folding.getFoldRowEnd
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:103

getFoldRowStart

getFoldRowStart(docRow: number, startFoldRow?: FoldLine): number
Parameters
- docRow: number
- OptionalstartFoldRow: FoldLine
Returns number
Inherited from Folding.getFoldRowStart
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:104

getFoldsInRange

getFoldsInRange(range: Range): Fold[]
Parameters
- range: Range
Returns Fold[]
Inherited from Folding.getFoldsInRange
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:84

getFoldsInRangeList

getFoldsInRangeList(ranges: Range[]): Fold[]
Parameters
- ranges: Range[]
Returns Fold[]
Inherited from Folding.getFoldsInRangeList
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:85

getFoldStringAt

getFoldStringAt(
    row: number,
    column: number,
    trim?: number,
    foldLine?: FoldLine,
): string | null
Parameters
- row: number
- column: number
- Optionaltrim: number
- OptionalfoldLine: FoldLine
Returns string | null
Inherited from Folding.getFoldStringAt
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:87

getLength

getLength(): number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:582

getLine

getLine(row: number): string
Parameters
- row: number
Returns string
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:580

getLines

getLines(firstRow: number, lastRow: number): string[]
Parameters
- firstRow: number
- lastRow: number
Returns string[]
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:581

getLineWidgetMaxWidth

getLineWidgetMaxWidth(): number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:579

getMarkers

getMarkers(inFront?: boolean): { [id: number]: MarkerLike }
Parameters
- OptionalinFront: boolean
Returns { [id: number]: MarkerLike }
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:557

getMode

getMode(): SyntaxMode
Returns SyntaxMode
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:573

getNavigateWithinSoftTabs

getNavigateWithinSoftTabs(): boolean
Returns boolean
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:540

getNewLineMode

getNewLineMode(): NewLineMode
Returns NewLineMode
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:569

getNextFoldLine

getNextFoldLine(docRow: number, startFoldLine?: FoldLine): FoldLine | null
Parameters
- docRow: number
- OptionalstartFoldLine: FoldLine
Returns FoldLine | null
Inherited from Folding.getNextFoldLine
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:92

getOption

getOption<T extends keyof EditSessionOptions>(name: T): EditSessionOptions[T]
Type Parameters
- T extends keyof EditSessionOptions
Parameters
- name: T
Returns EditSessionOptions[T]
Overrides OptionsProvider.getOption
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:517

getOptions

getOptions(
optionNames?: string[] | { [key: string]: any },
): { [key: string]: any }
Parameters
- OptionaloptionNames: string[] | { [key: string]: any }
Returns { [key: string]: any }
Inherited from OptionsProvider.getOptions
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:469

getOverwrite

getOverwrite(): boolean
Returns boolean
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:542

getParentFoldRangeData

getParentFoldRangeData(
row: number,
ignoreCurrent?: boolean,
): { firstRange: Range; range?: Range }
Parameters
- row: number
- OptionalignoreCurrent: boolean
Returns { firstRange: Range; range?: Range }
Inherited from Folding.getParentFoldRangeData
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:120

getRowLineCount

getRowLineCount(row: number): number
Parameters
- row: number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:604

getRowSplitData

getRowSplitData(row: number): string | undefined
Parameters
- row: number
Returns string | undefined
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:609

getRowWrapIndent

getRowWrapIndent(screenRow: number): number
Parameters
- screenRow: number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:605

getScreenLastRowColumn

getScreenLastRowColumn(screenRow: number): number
Parameters
- screenRow: number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:606

getScreenLength

getScreenLength(): number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:620

getScreenTabSize

getScreenTabSize(screenColumn: number): number
Parameters
- screenColumn: number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:610

getScreenWidth

getScreenWidth(): number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:578

getScrollLeft

getScrollLeft(): number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:577

getScrollTop

getScrollTop(): number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:575

getSelection

getSelection(): Selection
Returns Selection
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:526

getState

getState(row: number): string
Parameters
- row: number
Returns string
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:527

getTabSize

getTabSize(): number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:537

getTabString

getTabString(): string
Returns string
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:533

getTextRange

getTextRange(range: Range): string
Parameters
- range: Range
Returns string
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:583

getTokenAt

getTokenAt(row: number, column: number): Token | null
Parameters
- row: number
- column: number
Returns Token | null
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:529

getTokens

getTokens(row: number): Token[]
Parameters
- row: number
Returns Token[]
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:528

getUndoManager

getUndoManager(): UndoManager
Returns UndoManager
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:532

getUseSoftTabs

getUseSoftTabs(): boolean
Returns boolean
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:535

getUseWorker

getUseWorker(): boolean
Returns boolean
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:571

getUseWrapMode

getUseWrapMode(): boolean
Returns boolean
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:598

getValue

getValue(): string
Returns string
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:525

getWordRange

getWordRange(row: number, column: number): Range
Parameters
- row: number
- column: number
Returns Range
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:566

getWrapLimit

getWrapLimit(): number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:601

getWrapLimitRange

getWrapLimitRange(): { max: number; min: number }
Returns { max: number; min: number }
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:603

highlight

highlight(re: RegExp): void
Parameters
- re: RegExp
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:558

highlightLines

highlightLines(
    startRow: number,
    endRow: number,
    className: string,
    inFront?: boolean,
): Range
Parameters
- startRow: number
- endRow: number
- className: string
- OptionalinFront: boolean
Returns Range
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:559

indentRows

indentRows(startRow: number, endRow: number, indentString: string): void
Parameters
- startRow: number
- endRow: number
- indentString: string
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:592

insert

insert(position: Position, text: string): void
Parameters
- position: Position
- text: string
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:584

isRowFolded

isRowFolded(docRow: number, startFoldRow?: FoldLine): boolean
Parameters
- docRow: number
- OptionalstartFoldRow: FoldLine
Returns boolean
Inherited from Folding.isRowFolded
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:102

isTabStop

isTabStop(position: Position): boolean
Parameters
- position: Position
Returns boolean
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:538

markUndoGroup

markUndoGroup(): void
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:531

moveLinesDown

moveLinesDown(firstRow: number, lastRow: number): void
Parameters
- firstRow: number
- lastRow: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:595

moveLinesUp

moveLinesUp(firstRow: number, lastRow: number): void
Parameters
- firstRow: number
- lastRow: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:594

moveText

moveText(fromRange: Range, toPosition: Position, copy?: boolean): void
Parameters
- fromRange: Range
- toPosition: Position
- Optionalcopy: boolean
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:591

off

off(name: string, callback: Function): void
Parameters
- name: string
- callback: Function
Returns void
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:258

on

on(
name: "changeFold",
callback: (obj: { action: string; data: Fold }) => void,
): Function
Parameters
- name: "changeFold"
- callback: (obj: { action: string; data: Fold }) => void
Returns Function
Overrides EventEmitter.on
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:506
on(name: "changeScrollLeft", callback: (scrollLeft: number) => void): Function
Parameters
- name: "changeScrollLeft"
- callback: (scrollLeft: number) => void
Returns Function
Overrides EventEmitter.on
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:508
on(name: "changeScrollTop", callback: (scrollTop: number) => void): Function
Parameters
- name: "changeScrollTop"
- callback: (scrollTop: number) => void
Returns Function
Overrides EventEmitter.on
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:509
on(
name: "tokenizerUpdate",
callback: (obj: { data: { first: number; last: number } }) => void,
): Function
Parameters
- name: "tokenizerUpdate"
- callback: (obj: { data: { first: number; last: number } }) => void
Returns Function
Overrides EventEmitter.on
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:510
on(name: "change", callback: () => void): Function
Parameters
- name: "change"
- callback: () => void
Returns Function
Overrides EventEmitter.on
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:512
on(name: "changeTabSize", callback: () => void): Function
Parameters
- name: "changeTabSize"
- callback: () => void
Returns Function
Overrides EventEmitter.on
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:513

once

once(name: string, callback: Function): void
Parameters
- name: string
- callback: Function
Returns void
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:253

outdentRows

outdentRows(range: Range): void
Parameters
- range: Range
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:593

redoChanges

redoChanges(deltas: Delta[], dontSelect?: boolean): void
Parameters
- deltas: Delta[]
- OptionaldontSelect: boolean
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:588

remove

remove(range: Range): void
Parameters
- range: Range
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:585

removeAllListeners

removeAllListeners(name?: string): void
Parameters
- Optionalname: string
Returns void
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:261

removeDefaultHandler

removeDefaultHandler(name: string, callback: Function): void
Parameters
- name: string
- callback: Function
Returns void
Inherited from EventEmitter.removeDefaultHandler
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:255

removeEventListener

removeEventListener(name: string, callback: Function): void
Parameters
- name: string
- callback: Function
Returns void
Inherited from EventEmitter.removeEventListener
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:260

removeFold

removeFold(fold: Fold): void
Parameters
- fold: Fold
Returns void
Inherited from Folding.removeFold
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:96

removeFolds

removeFolds(folds: Fold[]): void
Parameters
- folds: Fold[]
Returns void
Inherited from Folding.removeFolds
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:97

removeFullLines

removeFullLines(firstRow: number, lastRow: number): void
Parameters
- firstRow: number
- lastRow: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:586

removeGutterDecoration

removeGutterDecoration(row: number, className: string): void
Parameters
- row: number
- className: string
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:545

removeListener

removeListener(name: string, callback: Function): void
Parameters
- name: string
- callback: Function
Returns void
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:259

removeMarker

removeMarker(markerId: number): void
Parameters
- markerId: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:556

replace

replace(range: Range, text: string): void
Parameters
- range: Range
- text: string
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:590

resetCaches

resetCaches(): void
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:523

screenToDocumentColumn

screenToDocumentColumn(screenRow: number, screenColumn: number): number
Parameters
- screenRow: number
- screenColumn: number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:612

screenToDocumentPosition

screenToDocumentPosition(
    screenRow: number,
    screenColumn: number,
    offsetX?: number,
): Position
Parameters
- screenRow: number
- screenColumn: number
- OptionaloffsetX: number
Returns Position
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:613

screenToDocumentRow

screenToDocumentRow(screenRow: number, screenColumn: number): number
Parameters
- screenRow: number
- screenColumn: number
Returns number
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:611

setAnnotations

setAnnotations(annotations: Annotation[]): void
Parameters
- annotations: Annotation[]
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:563

setBreakpoint

setBreakpoint(row: number, className: string): void
Parameters
- row: number
- className: string
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:549

setBreakpoints

setBreakpoints(rows: number[]): void
Parameters
- rows: number[]
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:547

setDefaultHandler

setDefaultHandler(name: string, callback: Function): void
Parameters
- name: string
- callback: Function
Returns void
Inherited from EventEmitter.setDefaultHandler
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:254

setDocument

setDocument(doc: Document): void
Parameters
- doc: Document
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:521

setFoldStyle

setFoldStyle(style: string): void
Parameters
- style: string
Returns void
Inherited from Folding.setFoldStyle
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:119

setMode

setMode(mode: string | SyntaxMode, callback?: () => void): void
Parameters
- mode: string | SyntaxMode
- Optionalcallback: () => void
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:572

setNavigateWithinSoftTabs

setNavigateWithinSoftTabs(navigateWithinSoftTabs: boolean): void
Parameters
- navigateWithinSoftTabs: boolean
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:539

setNewLineMode

setNewLineMode(newLineMode: NewLineMode): void
Parameters
- newLineMode: NewLineMode
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:568

setOption

setOption<T extends keyof EditSessionOptions>(
name: T,
value: EditSessionOptions[T],
): void
Type Parameters
- T extends keyof EditSessionOptions
Parameters
- name: T
- value: EditSessionOptions[T]
Returns void
Overrides OptionsProvider.setOption
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:516

setOptions

setOptions(optList: { [key: string]: any }): void
Parameters
- optList: { [key: string]: any }
Returns void
Inherited from OptionsProvider.setOptions
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:468

setOverwrite

setOverwrite(overwrite: boolean): void
Parameters
- overwrite: boolean
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:541

setScrollLeft

setScrollLeft(scrollLeft: number): void
Parameters
- scrollLeft: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:576

setScrollTop

setScrollTop(scrollTop: number): void
Parameters
- scrollTop: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:574

setTabSize

setTabSize(tabSize: number): void
Parameters
- tabSize: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:536

setUndoManager

setUndoManager(undoManager: UndoManager): void
Parameters
- undoManager: UndoManager
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:530

setUndoSelect

setUndoSelect(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:589

setUseSoftTabs

setUseSoftTabs(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:534

setUseWorker

setUseWorker(useWorker: boolean): void
Parameters
- useWorker: boolean
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:570

setUseWrapMode

setUseWrapMode(useWrapMode: boolean): void
Parameters
- useWrapMode: boolean
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:597

setValue

setValue(text: string): void
Parameters
- text: string
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:524

setWrapLimit

setWrapLimit(limit: number): void
Parameters
- limit: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:602

setWrapLimitRange

setWrapLimitRange(min: number, max: number): void
Parameters
- min: number
- max: number
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:599

toggleFold

toggleFold(tryToUnfold?: boolean): void
Parameters
- OptionaltryToUnfold: boolean
Returns void
Inherited from Folding.toggleFold
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:114

toggleFoldWidget

toggleFoldWidget(toggleParent?: boolean): void
Parameters
- OptionaltoggleParent: boolean
Returns void
Inherited from Folding.toggleFoldWidget
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:124

toggleOverwrite

toggleOverwrite(): void
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:543

undoChanges

undoChanges(deltas: Delta[], dontSelect?: boolean): void
Parameters
- deltas: Delta[]
- OptionaldontSelect: boolean
Returns void
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:587

unfold

unfold(
location: number | Point | Range | null,
expandInner?: boolean,
): Fold[] | undefined
Parameters
- location: number | Point | Range | null
- OptionalexpandInner: boolean
Returns Fold[] | undefined
Inherited from Folding.unfold
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:100

updateFoldWidgets

updateFoldWidgets(delta: Delta): void
Parameters
- delta: Delta
Returns void
Inherited from Folding.updateFoldWidgets
- Defined in node_modules/.pnpm/ace-builds@1.20.0/node_modules/ace-builds/ace.d.ts:125

Interface EditSession

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonlydoc

selection

Methods

addDynamicMarker

Parameters

Returns MarkerLike

addEventListener

Parameters

Returns void

addFold

Parameters

Returns Fold

addFolds

Parameters

Returns void

addGutterDecoration

Parameters

Returns void

addMarker

Parameters

Returns number

adjustWrapLimit

Parameters

Returns boolean

clearAnnotations

Returns void

clearBreakpoint

Parameters

Returns void

clearBreakpoints

Returns void

destroy

Returns void

documentToScreenColumn

Parameters

Returns number

documentToScreenPosition

Parameters

Returns Position

Parameters

Returns Position

documentToScreenRow

Parameters

Returns number

duplicateLines

Parameters

Returns void

expandFold

Parameters

Returns void

expandFolds

Parameters

Returns void

foldAll

Parameters

Returns void

getAllFolds

Returns Fold[]

getAnnotations

Returns Annotation[]

getAWordRange

Parameters

Returns Range

getBreakpoints

Returns string[]

getCommentFoldRange

Parameters

Returns Range | undefined

getDisplayLine

Parameters

Returns string

getDocument

Returns Document

getDocumentLastRowColumn

`Readonly`doc