Interface EditSession

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

Hierarchy (view full)

Properties

curOp? doc selection widgetManager

Methods

addDynamicMarker addEventListener addFold addFolds addGutterDecoration addMarker adjustWrapLimit clearAnnotations clearBreakpoint clearBreakpoints destroy documentToScreenColumn documentToScreenPosition documentToScreenRow duplicateLines endOperation expandFold expandFolds foldAll getAWordRange getAllFolds getAnnotations getBreakpoints getCommentFoldRange getDisplayLine getDocument getDocumentLastRowColumn getFoldAt getFoldDisplayLine getFoldLine getFoldRowEnd getFoldRowStart getFoldStringAt getFoldedRowCount getFoldsInRange getFoldsInRangeList getLength getLine getLineWidgetMaxWidth getLines getMarkers getMode getNavigateWithinSoftTabs getNewLineMode getNextFoldLine getOption getOptions getOverwrite getParentFoldRangeData getPrecedingCharacter getRowLineCount getRowSplitData getRowWrapIndent getScreenLastRowColumn getScreenLength getScreenTabSize getScreenWidth getScrollLeft getScrollTop getSelection getState getTabSize getTabString getTextRange getTokenAt getTokens getUndoManager getUseSoftTabs getUseWorker getUseWrapMode getValue getWordRange getWrapLimit getWrapLimitRange getdocumentLastRowColumnPosition 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 startOperation toJSON toggleFold toggleFoldWidget toggleOverwrite undoChanges unfold updateFoldWidgets

Properties

Optional curOp

curOp?: {
    command?: {
        name?: string;
    };
    docChanged?: boolean;
    selectionChanged?: boolean;
}

Type declaration

  • Optional command?: {
        name?: string;
    }
    • Optional name?: string
  • Optional docChanged?: boolean
  • Optional selectionChanged?: boolean

Readonly doc

doc: Ace.Document

selection

selection: Ace.Selection

widgetManager

widgetManager: WidgetManager

Methods

addDynamicMarker

addEventListener

addFold

addFolds

addGutterDecoration

  • addGutterDecoration(row, className): void

  • Parameters

    • row: number
    • className: string

    Returns void

addMarker

  • addMarker(range, className, type, inFront?): number

  • Parameters

    • range: Ace.Range
    • className: string
    • type: "text" | "fullLine" | "screenLine" | MarkerRenderer
    • Optional inFront: boolean

    Returns number

adjustWrapLimit

  • adjustWrapLimit(desiredLimit): boolean

  • Parameters

    • desiredLimit: number

    Returns boolean

clearAnnotations

clearBreakpoint

  • clearBreakpoint(row): void

  • Parameters

    • row: number

    Returns void

clearBreakpoints

destroy

documentToScreenColumn

  • documentToScreenColumn(row, docColumn): number

  • Parameters

    • row: number
    • docColumn: number

    Returns number

documentToScreenPosition

documentToScreenRow

  • documentToScreenRow(docRow, docColumn): number

  • Parameters

    • docRow: number
    • docColumn: number

    Returns number

duplicateLines

  • duplicateLines(firstRow, lastRow): void

  • Parameters

    • firstRow: number
    • lastRow: number

    Returns void

endOperation

expandFold

expandFolds

foldAll

  • foldAll(startRow?, endRow?, depth?): void

  • Parameters

    • Optional startRow: number
    • Optional endRow: number
    • Optional depth: number

    Returns void

getAWordRange

getAllFolds

getAnnotations

getBreakpoints

  • getBreakpoints(): string[]

  • Returns string[]

getCommentFoldRange

getDisplayLine

  • getDisplayLine(row, endColumn, startRow, startColumn): string

  • Parameters

    • row: number
    • endColumn: number
    • startRow: number
    • startColumn: number

    Returns string

getDocument

getDocumentLastRowColumn

  • getDocumentLastRowColumn(docRow, docColumn): number

  • Parameters

    • docRow: number
    • docColumn: number

    Returns number

getFoldAt

getFoldDisplayLine

  • getFoldDisplayLine(foldLine, endRow, endColumn, startRow, startColumn): string

  • Parameters

    • foldLine: Ace.FoldLine
    • endRow: number
    • endColumn: number
    • startRow: number
    • startColumn: number

    Returns string

getFoldLine

getFoldRowEnd

getFoldRowStart

getFoldStringAt

getFoldedRowCount

getFoldsInRange

getFoldsInRangeList

getLength

getLine

  • getLine(row): string

  • Parameters

    • row: number

    Returns string

getLineWidgetMaxWidth

  • getLineWidgetMaxWidth(): number

  • Returns number

getLines

  • getLines(firstRow, lastRow): string[]

  • Parameters

    • firstRow: number
    • lastRow: number

    Returns string[]

getMarkers

getMode

getNavigateWithinSoftTabs

  • getNavigateWithinSoftTabs(): boolean

  • Returns boolean

getNewLineMode

getNextFoldLine

getOption

getOptions

  • getOptions(optionNames?): {
        [key: string]: any;
    }

  • Parameters

    • Optional optionNames: string[] | {
          [key: string]: any;
      }

    Returns {
        [key: string]: any;
    }

    • [key: string]: any

getOverwrite

  • getOverwrite(): boolean

  • Returns boolean

getParentFoldRangeData

getPrecedingCharacter

  • getPrecedingCharacter(): string

  • Returns string

getRowLineCount

  • getRowLineCount(row): number

  • Parameters

    • row: number

    Returns number

getRowSplitData

  • getRowSplitData(row): string

  • Parameters

    • row: number

    Returns string

getRowWrapIndent

  • getRowWrapIndent(screenRow): number

  • Parameters

    • screenRow: number

    Returns number

getScreenLastRowColumn

  • getScreenLastRowColumn(screenRow): number

  • Parameters

    • screenRow: number

    Returns number

getScreenLength

  • getScreenLength(): number

  • Returns number

getScreenTabSize

  • getScreenTabSize(screenColumn): number

  • Parameters

    • screenColumn: number

    Returns number

getScreenWidth

  • getScreenWidth(): number

  • Returns number

getScrollLeft

  • getScrollLeft(): number

  • Returns number

getScrollTop

getSelection

getState

  • getState(row): string

  • Parameters

    • row: number

    Returns string

getTabSize

getTabString

getTextRange

getTokenAt

getTokens

getUndoManager

getUseSoftTabs

  • getUseSoftTabs(): boolean

  • Returns boolean

getUseWorker

  • getUseWorker(): boolean

  • Returns boolean

getUseWrapMode

  • getUseWrapMode(): boolean

  • Returns boolean

getValue

getWordRange

getWrapLimit

getWrapLimitRange

  • getWrapLimitRange(): {
        max: number;
        min: number;
    }

  • Returns {
        max: number;
        min: number;
    }

    • max: number
    • min: number

getdocumentLastRowColumnPosition

highlight

  • highlight(re): void

  • Parameters

    • re: RegExp

    Returns void

highlightLines

  • highlightLines(startRow, endRow, className, inFront?): Ace.Range

  • Parameters

    • startRow: number
    • endRow: number
    • className: string
    • Optional inFront: boolean

    Returns Ace.Range

indentRows

  • indentRows(startRow, endRow, indentString): void

  • Parameters

    • startRow: number
    • endRow: number
    • indentString: string

    Returns void

insert

isRowFolded

isTabStop

markUndoGroup

moveLinesDown

  • moveLinesDown(firstRow, lastRow): void

  • Parameters

    • firstRow: number
    • lastRow: number

    Returns void

moveLinesUp

  • moveLinesUp(firstRow, lastRow): void

  • Parameters

    • firstRow: number
    • lastRow: number

    Returns void

moveText

  • moveText(fromRange, toPosition, copy?): void

  • Parameters

    Returns void

off

on

  • on(name, callback): Function

  • Parameters

    • name: "changeFold"
    • callback: ((obj) => void)
        • (obj): void

        • Parameters

          • obj: {
                action: string;
                data: Ace.Fold;
            }

          Returns void

    Returns Function

  • on(name, callback): Function

  • Parameters

    • name: "changeScrollLeft"
    • callback: ((scrollLeft) => void)
        • (scrollLeft): void

        • Parameters

          • scrollLeft: number

          Returns void

    Returns Function

  • on(name, callback): Function

  • Parameters

    • name: "changeScrollTop"
    • callback: ((scrollTop) => void)
        • (scrollTop): void

        • Parameters

          • scrollTop: number

          Returns void

    Returns Function

  • on(name, callback): Function

  • Parameters

    • name: "tokenizerUpdate"
    • callback: ((obj) => void)
        • (obj): void

        • Parameters

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

          Returns void

    Returns Function

  • on(name, callback): Function

  • Parameters

    • name: "change"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns Function

  • on(name, callback): Function

  • Parameters

    • name: "changeTabSize"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns Function

  • on(name, callback): Function

  • Parameters

    • name: "beforeEndOperation"
    • callback: (() => void)
        • (): void

        • Returns void

    Returns Function

once

outdentRows

redoChanges

  • redoChanges(deltas, dontSelect?): void

  • Parameters

    • deltas: Ace.Delta[]
    • Optional dontSelect: boolean

    Returns void

remove

removeAllListeners

removeDefaultHandler

removeEventListener

removeFold

removeFolds

removeFullLines

  • removeFullLines(firstRow, lastRow): void

  • Parameters

    • firstRow: number
    • lastRow: number

    Returns void

removeGutterDecoration

  • removeGutterDecoration(row, className): void

  • Parameters

    • row: number
    • className: string

    Returns void

removeListener

removeMarker

  • removeMarker(markerId): void

  • Parameters

    • markerId: number

    Returns void

replace

resetCaches

screenToDocumentColumn

  • screenToDocumentColumn(screenRow, screenColumn): number

  • Parameters

    • screenRow: number
    • screenColumn: number

    Returns number

screenToDocumentPosition

  • screenToDocumentPosition(screenRow, screenColumn, offsetX?): Ace.Position

  • Parameters

    • screenRow: number
    • screenColumn: number
    • Optional offsetX: number

    Returns Ace.Position

screenToDocumentRow

  • screenToDocumentRow(screenRow, screenColumn): number

  • Parameters

    • screenRow: number
    • screenColumn: number

    Returns number

setAnnotations

setBreakpoint

  • setBreakpoint(row, className): void

  • Parameters

    • row: number
    • className: string

    Returns void

setBreakpoints

  • setBreakpoints(rows): void

  • Parameters

    • rows: number[]

    Returns void

setDefaultHandler

setDocument

setFoldStyle

setMode

  • setMode(mode, callback?): void

  • Parameters

    • mode: string | Ace.SyntaxMode
    • Optional callback: (() => void)
        • (): void

        • Returns void

    Returns void

setNavigateWithinSoftTabs

  • setNavigateWithinSoftTabs(navigateWithinSoftTabs): void

  • Parameters

    • navigateWithinSoftTabs: boolean

    Returns void

setNewLineMode

setOption

setOptions

setOverwrite

  • setOverwrite(overwrite): void

  • Parameters

    • overwrite: boolean

    Returns void

setScrollLeft

  • setScrollLeft(scrollLeft): void

  • Parameters

    • scrollLeft: number

    Returns void

setScrollTop

  • setScrollTop(scrollTop): void

  • Parameters

    • scrollTop: number

    Returns void

setTabSize

  • setTabSize(tabSize): void

  • Parameters

    • tabSize: number

    Returns void

setUndoManager

setUndoSelect

  • setUndoSelect(enable): void

  • Parameters

    • enable: boolean

    Returns void

setUseSoftTabs

  • setUseSoftTabs(val): void

  • Parameters

    • val: boolean

    Returns void

setUseWorker

  • setUseWorker(useWorker): void

  • Parameters

    • useWorker: boolean

    Returns void

setUseWrapMode

  • setUseWrapMode(useWrapMode): void

  • Parameters

    • useWrapMode: boolean

    Returns void

setValue

  • setValue(text): void

  • Parameters

    • text: string

    Returns void

setWrapLimit

  • setWrapLimit(limit): void

  • Parameters

    • limit: number

    Returns void

setWrapLimitRange

  • setWrapLimitRange(min, max): void

  • Parameters

    • min: number
    • max: number

    Returns void

startOperation

  • startOperation(commandEvent): void

  • Parameters

    • commandEvent: {
          command: {
              name: string;
          };
      }
      • command: {
            name: string;
        }
        • name: string

    Returns void

toJSON

toggleFold

toggleFoldWidget

toggleOverwrite

undoChanges

  • undoChanges(deltas, dontSelect?): void

  • Parameters

    • deltas: Ace.Delta[]
    • Optional dontSelect: boolean

    Returns void

unfold

updateFoldWidgets

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc