Class AcePopup

This object is used in some places where needed to show popups - like prompt; autocomplete etc.

Hierarchy (View Summary)

AcePopupWithEditor
- AcePopup

Index

Constructors

Properties

$blockSelectEnabled? $checkMultiselectChange $codeLensClickHandler? $multiselectOnSessionChange? $onAddRange $onMultiSelect $onMultiSelectExec $onRemoveRange $onSingleSelect $options? $reAlignText $updateLenses? $updateLensesOnInput? addSelectionMarker alignCursors anchor anchorPos anchorPosition autoSelect cmdLine? codeLensProviders? commands completer? completers container curOp data elasticTabstops? env? exitMultiSelectMode filterText findAll forEachSelection getData getHoveredRow getRow getSelectedText getTextLeftOffset goTo hide id inMultiSelectMode? inVirtualSelectionMode isMouseOver? isOpen isTopdown keyBinding mergeNextCommand multiSelect? previousCommand prevOp removeSelectionMarker removeSelectionMarkers renderer searchBox? selectedNode? selection selectMore selectMoreLines sequenceStartTime session setData setDisplaySettings? setRow setSelectOnHover show showKeyboardShortcuts? showSettingsMenu? textInput transposeSelections tryShow updateSelectionMarkers widgetManager?

Methods

_dispatchEvent _emit _signal addEventListener applyComposition autoIndent blockIndent blockOutdent blur centerSelection clearSelection copyLinesDown copyLinesUp destroy duplicateSelection endOperation execCommand find findLinkAt findNext findPrevious focus getAnimatedScroll getBehavioursEnabled getCopyText getCursorPosition getCursorPositionScreen getDisplayIndentGuides getDragDelay getFadeFoldWidgets getFirstVisibleRow getFontSize getHighlightActiveLine getHighlightGutterLine getHighlightIndentGuides getHighlightSelectedWord getKeyboardHandler getLastSearchOptions getLastVisibleRow getNumberAt getOption getOptions getOverwrite getPrintMarginColumn getReadOnly getScrollSpeed getSelection getSelectionRange getSelectionStyle getSession getShowFoldWidgets getShowInvisibles getShowPrintMargin getTheme getValue getWrapBehavioursEnabled gotoLine gotoPageDown gotoPageUp indent insert isFocused isRowFullyVisible isRowVisible jumpToMatching modifyNumber moveCursorTo moveCursorToPosition moveLinesDown moveLinesUp moveText navigateDown navigateFileEnd navigateFileStart navigateLeft navigateLineEnd navigateLineStart navigateRight navigateTo navigateUp navigateWordLeft navigateWordRight off on once onEndOperation onStartOperation openLink prompt redo remove removeAllListeners removeDefaultHandler removeEventListener removeGhostText removeLines removeListener removeToLineEnd removeToLineStart removeWordLeft removeWordRight replace replaceAll resize revealRange scrollPageDown scrollPageUp scrollToLine scrollToRow selectAll selectPageDown selectPageUp setAnimatedScroll setAutoScrollEditorIntoView setBehavioursEnabled setDefaultHandler setDisplayIndentGuides setDragDelay setFadeFoldWidgets setFontSize setGhostText setHighlightActiveLine setHighlightGutterLine setHighlightIndentGuides setHighlightSelectedWord setKeyboardHandler setOption setOptions setOverwrite setPrintMarginColumn setReadOnly setScrollSpeed setSelectionStyle setSession setShowFoldWidgets setShowInvisibles setShowPrintMargin setStyle setTheme setValue setWrapBehavioursEnabled sortLines splitLine startOperation toggleBlockComment toggleCommentLines toggleOverwrite toggleWord toLowerCase toUpperCase transposeLetters undo unsetStyle

Constructors

constructor

new AcePopup(parentNode?: Element): AcePopup
Creates and renders single line editor in popup window. If parentNode param is isset, then attaching it to this element.
Parameters
- OptionalparentNode: Element
Returns AcePopup
- Defined in src/autocomplete/popup.js:50

Properties

`Optional`$blockSelectEnabled

$blockSelectEnabled?: boolean

$checkMultiselectChange

$checkMultiselectChange: (e: any, anchor: Anchor) => void

`Optional`$codeLensClickHandler

$codeLensClickHandler?: any

`Optional`$multiselectOnSessionChange

$multiselectOnSessionChange?: any

$onAddRange

$onAddRange: (e: any) => void

$onMultiSelect

$onMultiSelect: (e: any) => void

$onMultiSelectExec

$onMultiSelectExec: (e: any) => void

$onRemoveRange

$onRemoveRange: (e: any) => void

$onSingleSelect

$onSingleSelect: (e: any) => void

`Optional`$options

$options?: any

$reAlignText

$reAlignText: (lines: string[], forceLeft: boolean) => string[]

`Optional`$updateLenses

$updateLenses?: () => void

`Optional`$updateLensesOnInput

$updateLensesOnInput?: () => void

addSelectionMarker

addSelectionMarker: (
orientedRange: Range & { marker?: any },
) => Range & { marker?: any }

Adds the selection and cursor.

Type declaration

- (orientedRange: Range & { marker?: any }): Range & { marker?: any }
- Parameters
  - orientedRange: Range & { marker?: any }
    A range containing a cursor
  Returns Range & { marker?: any }

alignCursors

alignCursors: () => void

Aligns the cursors or selected text.

anchor

anchor: "top" | "bottom"

anchorPos

anchorPos: any

anchorPosition

anchorPosition: Point

autoSelect

autoSelect: boolean

`Optional`cmdLine

cmdLine?: Editor

`Optional`codeLensProviders

codeLensProviders?: CodeLenseProvider[]

commands

commands: CommandManager

`Optional`completer

completer?: Autocomplete | InlineAutocomplete

completers

completers: Completer[]

container

container: HTMLElement & { env?: any; value?: any }

}

curOp

curOp: {}

data

data: Completion[]

`Optional`elasticTabstops

elasticTabstops?: ElasticTabstopsLite

`Optional`env

env?: any

exitMultiSelectMode

exitMultiSelectMode: () => void

Removes all the selections except the last added one.

filterText

filterText: string

findAll

findAll: (
    needle?: string,
    options?: Partial<SearchOptions>,
    additive?: boolean,
) => number

Finds and selects all the occurrences of needle.

Type declaration

- (needle?: string, options?: Partial<SearchOptions>, additive?: boolean): number
- Parameters
  - Optionalneedle: string
    The text to find
  - Optionaloptions: Partial<SearchOptions>
    The search options
  - Optionaladditive: boolean
    keeps
  Returns number
  The cumulative count of all found matches

forEachSelection

forEachSelection: (cmd: Object, args?: string, options?: Object) => void

Executes a command for each selection range.

Type declaration

- (cmd: Object, args?: string, options?: Object): void
- Parameters
  - cmd: Object
    The command to execute
  - Optionalargs: string
    Any arguments for the command
  - Optionaloptions: Object
  Returns void

getData

getData: (row: number) => Completion

getHoveredRow

getHoveredRow: () => number

getRow

getRow: () => number

getSelectedText

getSelectedText: () => string

getTextLeftOffset

getTextLeftOffset: () => number

goTo

goTo: (where: AcePopupNavigation) => void

hide

hide: () => void

id

id: string

`Optional`inMultiSelectMode

inMultiSelectMode?: boolean

inVirtualSelectionMode

inVirtualSelectionMode: boolean

`Optional`isMouseOver

isMouseOver?: boolean

isOpen

isOpen: boolean

isTopdown

isTopdown: boolean

keyBinding

keyBinding: KeyBinding

mergeNextCommand

mergeNextCommand: boolean

`Optional`multiSelect

multiSelect?: any

previousCommand

previousCommand: any

prevOp

prevOp: {}

removeSelectionMarker

removeSelectionMarker: (range: Range & { marker?: any }) => void

Removes the selection marker.

Type declaration

- (range: Range & { marker?: any }): void
- Parameters
  - range: Range & { marker?: any }
    The selection range added with [[Editor.addSelectionMarker addSelectionMarker()]].
  Returns void

removeSelectionMarkers

removeSelectionMarkers: (ranges: (Range & { marker?: any })[]) => void

renderer

renderer: VirtualRenderer

`Optional`searchBox

searchBox?: SearchBox

`Optional`selectedNode

selectedNode?: HTMLElement

selection

selection: Selection

selectMore

selectMore: (dir: number, skip?: boolean, stopAtFirst?: boolean) => void

Finds the next occurrence of text in an active selection and adds it to the selections.

Type declaration

- (dir: number, skip?: boolean, stopAtFirst?: boolean): void
- Parameters
  - dir: number
    The direction of lines to select: -1 for up, 1 for down
  - Optionalskip: boolean
    If true, removes the active selection range
  - OptionalstopAtFirst: boolean
  Returns void

selectMoreLines

selectMoreLines: (dir: number, skip?: boolean) => void

Adds a cursor above or below the active cursor.

Type declaration

- (dir: number, skip?: boolean): void
- Parameters
  - dir: number
    The direction of lines to select: -1 for up, 1 for down
  - Optionalskip: boolean
    If true, removes the active selection range
  Returns void

sequenceStartTime

sequenceStartTime: number

session

session: EditSession

setData

setData: (data: Completion[], filterText?: string) => void

`Optional`setDisplaySettings

setDisplaySettings?: (settings: any) => void

setRow

setRow: (line: number) => void

setSelectOnHover

setSelectOnHover: (val: boolean) => void

show

show: (pos: any, lineHeight: number, topdownOnly?: boolean) => void

`Optional`showKeyboardShortcuts

showKeyboardShortcuts?: () => void

`Optional`showSettingsMenu

showSettingsMenu?: () => void

textInput

textInput: any

transposeSelections

transposeSelections: (dir: number) => void

Transposes the selected ranges.

Type declaration

- (dir: number): void
- Parameters
  - dir: number
    The direction to rotate selections
  Returns void

tryShow

tryShow: (
    pos: any,
    lineHeight: number,
    anchor: "top" | "bottom",
    forceShow?: boolean,
) => boolean

updateSelectionMarkers

updateSelectionMarkers: () => void

Updates the cursor and marker layers.

`Optional`widgetManager

widgetManager?: LineWidgets

Methods

_dispatchEvent

_dispatchEvent<
    K extends
        | "change"
        | "changeSelection"
        | "input"
        | "changeSession"
        | "blur"
        | "mousedown"
        | "mousemove"
        | "changeStatus"
        | "keyboardActivity"
        | "mousewheel"
        | "mouseup"
        | "beforeEndOperation"
        | "nativecontextmenu"
        | "destroy"
        | "focus"
        | "copy"
        | "paste"
        | "changeSelectionStyle"
        | "changeMode"
        | "findSearchBox"
        | "codeLensClick"
        | "select"
        | "gutterkeydown"
        | "gutterclick"
        | "showGutterTooltip"
        | "hideGutterTooltip"
        | "compositionStart"
        | "click"
        | "dblclick"
        | "tripleclick"
        | "quadclick"
        | "show"
        | "hide"
        | "changeHoverMarker",
>(
    eventName: K,
    ...args: Parameters<AcePopupEventsCombined[K]>,
): void
Type Parameters
- K extends
      | "change"
      | "changeSelection"
      | "input"
      | "changeSession"
      | "blur"
      | "mousedown"
      | "mousemove"
      | "changeStatus"
      | "keyboardActivity"
      | "mousewheel"
      | "mouseup"
      | "beforeEndOperation"
      | "nativecontextmenu"
      | "destroy"
      | "focus"
      | "copy"
      | "paste"
      | "changeSelectionStyle"
      | "changeMode"
      | "findSearchBox"
      | "codeLensClick"
      | "select"
      | "gutterkeydown"
      | "gutterclick"
      | "showGutterTooltip"
      | "hideGutterTooltip"
      | "compositionStart"
      | "click"
      | "dblclick"
      | "tripleclick"
      | "quadclick"
      | "show"
      | "hide"
      | "changeHoverMarker"
Parameters
- eventName: K
- ...args: Parameters<AcePopupEventsCombined[K]>
Returns void
- Defined in interfaces.d.ts:635
_dispatchEvent<K extends keyof EditorEvents>(
eventName: K,
...args: Parameters<EditorEvents[K]>,
): void
Type Parameters
- K extends keyof EditorEvents
Parameters
- eventName: K
- ...args: Parameters<EditorEvents[K]>
Returns void
- Defined in interfaces.d.ts:635

_emit

_emit<
    K extends
        | "change"
        | "changeSelection"
        | "input"
        | "changeSession"
        | "blur"
        | "mousedown"
        | "mousemove"
        | "changeStatus"
        | "keyboardActivity"
        | "mousewheel"
        | "mouseup"
        | "beforeEndOperation"
        | "nativecontextmenu"
        | "destroy"
        | "focus"
        | "copy"
        | "paste"
        | "changeSelectionStyle"
        | "changeMode"
        | "findSearchBox"
        | "codeLensClick"
        | "select"
        | "gutterkeydown"
        | "gutterclick"
        | "showGutterTooltip"
        | "hideGutterTooltip"
        | "compositionStart"
        | "click"
        | "dblclick"
        | "tripleclick"
        | "quadclick"
        | "show"
        | "hide"
        | "changeHoverMarker",
>(
    eventName: K,
    ...args: Parameters<AcePopupEventsCombined[K]>,
): void
Type Parameters
- K extends
      | "change"
      | "changeSelection"
      | "input"
      | "changeSession"
      | "blur"
      | "mousedown"
      | "mousemove"
      | "changeStatus"
      | "keyboardActivity"
      | "mousewheel"
      | "mouseup"
      | "beforeEndOperation"
      | "nativecontextmenu"
      | "destroy"
      | "focus"
      | "copy"
      | "paste"
      | "changeSelectionStyle"
      | "changeMode"
      | "findSearchBox"
      | "codeLensClick"
      | "select"
      | "gutterkeydown"
      | "gutterclick"
      | "showGutterTooltip"
      | "hideGutterTooltip"
      | "compositionStart"
      | "click"
      | "dblclick"
      | "tripleclick"
      | "quadclick"
      | "show"
      | "hide"
      | "changeHoverMarker"
Parameters
- eventName: K
- ...args: Parameters<AcePopupEventsCombined[K]>
Returns void
- Defined in interfaces.d.ts:633
_emit<K extends keyof EditorEvents>(
eventName: K,
...args: Parameters<EditorEvents[K]>,
): void
Type Parameters
- K extends keyof EditorEvents
Parameters
- eventName: K
- ...args: Parameters<EditorEvents[K]>
Returns void
- Defined in interfaces.d.ts:633

_signal

_signal<
    K extends
        | "change"
        | "changeSelection"
        | "input"
        | "changeSession"
        | "blur"
        | "mousedown"
        | "mousemove"
        | "changeStatus"
        | "keyboardActivity"
        | "mousewheel"
        | "mouseup"
        | "beforeEndOperation"
        | "nativecontextmenu"
        | "destroy"
        | "focus"
        | "copy"
        | "paste"
        | "changeSelectionStyle"
        | "changeMode"
        | "findSearchBox"
        | "codeLensClick"
        | "select"
        | "gutterkeydown"
        | "gutterclick"
        | "showGutterTooltip"
        | "hideGutterTooltip"
        | "compositionStart"
        | "click"
        | "dblclick"
        | "tripleclick"
        | "quadclick"
        | "show"
        | "hide"
        | "changeHoverMarker",
>(
    eventName: K,
    ...args: Parameters<AcePopupEventsCombined[K]>,
): void
Type Parameters
- K extends
      | "change"
      | "changeSelection"
      | "input"
      | "changeSession"
      | "blur"
      | "mousedown"
      | "mousemove"
      | "changeStatus"
      | "keyboardActivity"
      | "mousewheel"
      | "mouseup"
      | "beforeEndOperation"
      | "nativecontextmenu"
      | "destroy"
      | "focus"
      | "copy"
      | "paste"
      | "changeSelectionStyle"
      | "changeMode"
      | "findSearchBox"
      | "codeLensClick"
      | "select"
      | "gutterkeydown"
      | "gutterclick"
      | "showGutterTooltip"
      | "hideGutterTooltip"
      | "compositionStart"
      | "click"
      | "dblclick"
      | "tripleclick"
      | "quadclick"
      | "show"
      | "hide"
      | "changeHoverMarker"
Parameters
- eventName: K
- ...args: Parameters<AcePopupEventsCombined[K]>
Returns void
- Defined in interfaces.d.ts:631
_signal<K extends keyof EditorEvents>(
eventName: K,
...args: Parameters<EditorEvents[K]>,
): void
Type Parameters
- K extends keyof EditorEvents
Parameters
- eventName: K
- ...args: Parameters<EditorEvents[K]>
Returns void
- Defined in interfaces.d.ts:631

addEventListener

addEventListener<
    K extends
        | "change"
        | "changeSelection"
        | "input"
        | "changeSession"
        | "blur"
        | "mousedown"
        | "mousemove"
        | "changeStatus"
        | "keyboardActivity"
        | "mousewheel"
        | "mouseup"
        | "beforeEndOperation"
        | "nativecontextmenu"
        | "destroy"
        | "focus"
        | "copy"
        | "paste"
        | "changeSelectionStyle"
        | "changeMode"
        | "findSearchBox"
        | "codeLensClick"
        | "select"
        | "gutterkeydown"
        | "gutterclick"
        | "showGutterTooltip"
        | "hideGutterTooltip"
        | "compositionStart"
        | "click"
        | "dblclick"
        | "tripleclick"
        | "quadclick"
        | "show"
        | "hide"
        | "changeHoverMarker",
>(
    name: K,
    callback: AcePopupEventsCombined[K],
    capturing?: boolean,
): AcePopupEventsCombined[K]
Type Parameters
- K extends
      | "change"
      | "changeSelection"
      | "input"
      | "changeSession"
      | "blur"
      | "mousedown"
      | "mousemove"
      | "changeStatus"
      | "keyboardActivity"
      | "mousewheel"
      | "mouseup"
      | "beforeEndOperation"
      | "nativecontextmenu"
      | "destroy"
      | "focus"
      | "copy"
      | "paste"
      | "changeSelectionStyle"
      | "changeMode"
      | "findSearchBox"
      | "codeLensClick"
      | "select"
      | "gutterkeydown"
      | "gutterclick"
      | "showGutterTooltip"
      | "hideGutterTooltip"
      | "compositionStart"
      | "click"
      | "dblclick"
      | "tripleclick"
      | "quadclick"
      | "show"
      | "hide"
      | "changeHoverMarker"
Parameters
- name: K
- callback: AcePopupEventsCombined[K]
- Optionalcapturing: boolean
Returns AcePopupEventsCombined[K]
- Defined in interfaces.d.ts:621
addEventListener<K extends keyof EditorEvents>(
    name: K,
    callback: EditorEvents[K],
    capturing?: boolean,
): EditorEvents[K]
Type Parameters
- K extends keyof EditorEvents
Parameters
- name: K
- callback: EditorEvents[K]
- Optionalcapturing: boolean
Returns EditorEvents[K]
- Defined in interfaces.d.ts:621

applyComposition

applyComposition(text?: string, composition?: any): void
Parameters
- Optionaltext: string
- Optionalcomposition: any
Returns void
- Defined in src/editor.js:1061

autoIndent

autoIndent(): void
Returns void
- Defined in src/editor.js:996

blockIndent

blockIndent(): void
Indents the current line.

Returns void
Related
EditSession.indentRows
- Defined in src/editor.js:1605

blockOutdent

blockOutdent(): void
Outdents the current line.

Returns void
Related
EditSession.outdentRows
- Defined in src/editor.js:1614

blur

blur(): void
Blurs the current textInput.

Returns void
- Defined in src/editor.js:569

centerSelection

centerSelection(): void
Attempts to center the current selection on the screen.

Returns void
- Defined in src/editor.js:2132

clearSelection

clearSelection(): void
{:Selection.clearSelection}

Returns void
Related
Selection.clearSelection
- Defined in src/editor.js:2185

copyLinesDown

copyLinesDown(): void
Copies all the selected lines down one row.

Returns void
Related
EditSession.duplicateLines
- Defined in src/editor.js:1894

copyLinesUp

copyLinesUp(): void
Copies all the selected lines up one row.

Returns void
- Defined in src/editor.js:1885

destroy

destroy(): void
Cleans up the entire editor.

Returns void
- Defined in src/autocomplete.js:761

duplicateSelection

duplicateSelection(): void
Returns void
- Defined in src/editor.js:1830

endOperation

endOperation(e: any): void
Parameters
- e: any
Returns void
Arg
e
- Defined in src/editor.js:111

execCommand

execCommand(command: string | string[], args?: any): boolean
Parameters
- command: string | string[]
- Optionalargs: any
Returns boolean
- Defined in src/editor.js:912

find

find(
    needle: any,
    options?: Partial<SearchOptions>,
    animate?: boolean,
): false | Range
Attempts to find needle within the document. For more information on options, see [[Search Search]].
Parameters
- needle: any
  The text to search for (optional)
- Optionaloptions: Partial<SearchOptions>
  An object defining various search properties
- Optionalanimate: boolean
  If true animate scrolling
Returns false | Range
Related
Search.find
- Defined in src/editor.js:2593

findLinkAt

findLinkAt(row: any, column: any): string
Finds link at defined {row} and {column}
Parameters
- row: any
- column: any
Returns string
- Defined in src/editor.js:1789

findNext

findNext(options?: Partial<SearchOptions>, animate?: boolean): void
Performs another search for needle in the document. For more information on options, see [[Search Search]].
Parameters
- Optionaloptions: Partial<SearchOptions>
  search options
- Optionalanimate: boolean
  If true animate scrolling
Returns void
Related
Editor.find
- Defined in src/editor.js:2639

findPrevious

findPrevious(options?: Partial<SearchOptions>, animate?: boolean): void
Performs a search for needle backwards. For more information on options, see [[Search Search]].
Parameters
- Optionaloptions: Partial<SearchOptions>
  search options
- Optionalanimate: boolean
  If true animate scrolling
Returns void
Related
Editor.find
- Defined in src/editor.js:2650

focus

focus(): void
Brings the current textInput into focus.

Returns void
- Defined in src/editor.js:553

getAnimatedScroll

getAnimatedScroll(): boolean
Returns boolean
- Defined in src/editor.js:1221

getBehavioursEnabled

getBehavioursEnabled(): boolean
Returns true if the behaviors are currently enabled. {:BehaviorsDef}

Returns boolean
- Defined in src/editor.js:1331

getCopyText

getCopyText(): string
Returns the string of text currently highlighted.

Returns string
- Defined in src/editor.js:818

getCursorPosition

getCursorPosition(): Point
Gets the current position of the cursor.

Returns Point
An object that looks something like this:
```
{ row: currRow, column: currCol }
```
Related
Selection.getCursor
- Defined in src/editor.js:2151

getCursorPositionScreen

getCursorPositionScreen(): Point
Returns the screen position of the cursor.

Returns Point
Related
EditSession.documentToScreenPosition
- Defined in src/editor.js:2160

getDisplayIndentGuides

getDisplayIndentGuides(): boolean
Returns boolean
- Defined in src/editor.js:1251

getDragDelay

getDragDelay(): number
Returns the current mouse drag delay.

Returns number
- Defined in src/editor.js:1145

getFadeFoldWidgets

getFadeFoldWidgets(): boolean
Returns boolean
- Defined in src/editor.js:1378

getFirstVisibleRow

getFirstVisibleRow(): number
{:VirtualRenderer.getFirstVisibleRow}

Returns number
Related
VirtualRenderer.getFirstVisibleRow
- Defined in src/editor.js:1999

getFontSize

getFontSize(): string | number
Gets the current font size of the editor text.

Returns string | number
- Defined in src/editor.js:467

getHighlightActiveLine

getHighlightActiveLine(): boolean
Returns true if current lines are always highlighted.

Returns boolean
- Defined in src/editor.js:1177

getHighlightGutterLine

getHighlightGutterLine(): boolean
Returns boolean
- Defined in src/editor.js:1191

getHighlightIndentGuides

getHighlightIndentGuides(): boolean
Returns boolean
- Defined in src/editor.js:1265

getHighlightSelectedWord

getHighlightSelectedWord(): boolean
Returns true if currently highlighted words are to be highlighted.

Returns boolean
- Defined in src/editor.js:1207

getKeyboardHandler

getKeyboardHandler(): any
Returns the keyboard handler, such as "vim" or "windows".

Returns any
- Defined in src/editor.js:237

getLastSearchOptions

getLastSearchOptions(): Partial<SearchOptions>
{:Search.getOptions} For more information on options, see [[Search Search]].

Returns Partial<SearchOptions>
Related
Search.getOptions
- Defined in src/editor.js:2582

getLastVisibleRow

getLastVisibleRow(): number
{:VirtualRenderer.getLastVisibleRow}

Returns number
Related
VirtualRenderer.getLastVisibleRow
- Defined in src/editor.js:2009

getNumberAt

getNumberAt(row: any, column: any): any
Works like [[EditSession.getTokenAt]], except it returns a number.
Parameters
- row: any
- column: any
Returns any
- Defined in src/editor.js:1664

getOption

getOption<K extends keyof EditorOptions>(name: K): EditorOptions[K]
Type Parameters
- K extends keyof EditorOptions
Parameters
- name: K
Returns EditorOptions[K]
- Defined in src/ext/options.js:395

getOptions

getOptions(
optionNames?: Partial<EditorOptions> | (keyof EditorOptions)[],
): Partial<EditorOptions>
Parameters
- OptionaloptionNames: Partial<EditorOptions> | (keyof EditorOptions)[]
Returns Partial<EditorOptions>
- Defined in src/search.js:35

getOverwrite

getOverwrite(): boolean
Returns true if overwrites are enabled; false otherwise.

Returns boolean
Related
EditSession.getOverwrite
- Defined in src/editor.js:1105

getPrintMarginColumn

getPrintMarginColumn(): number
Returns the column number of where the print margin is.

Returns number
- Defined in src/editor.js:1299

getReadOnly

getReadOnly(): boolean
Returns true if the editor is set to read-only mode.

Returns boolean
- Defined in src/editor.js:1315

getScrollSpeed

getScrollSpeed(): number
Returns the value indicating how fast the mouse scroll speed is (in milliseconds).

Returns number
- Defined in src/editor.js:1129

getSelection

getSelection(): Selection
Returns the currently highlighted selection.

Returns Selection
The selection object
- Defined in src/editor.js:413

getSelectionRange

getSelectionRange(): Range
{:Selection.getRange}

Returns Range
Related
Selection.getRange
- Defined in src/editor.js:2169

getSelectionStyle

getSelectionStyle(): "fullLine" | "screenLine" | "text" | "line"
Returns the current selection style.

Returns "fullLine" | "screenLine" | "text" | "line"
- Defined in src/editor.js:1162

getSession

getSession(): EditSession
Returns the current session being used.

Returns EditSession
- Defined in src/editor.js:373

getShowFoldWidgets

getShowFoldWidgets(): boolean
Returns true if the fold widgets are shown.

Returns boolean
- Defined in src/editor.js:1364

getShowInvisibles

getShowInvisibles(): boolean
Returns true if invisible characters are being shown.

Returns boolean
- Defined in src/editor.js:1237

getShowPrintMargin

getShowPrintMargin(): boolean
Returns true if the print margin is being shown.

Returns boolean
- Defined in src/editor.js:1282

getTheme

getTheme(): string
{:VirtualRenderer.getTheme}

Returns string
The set theme

Related
VirtualRenderer.getTheme
- Defined in src/editor.js:441

getValue

getValue(): string
Returns the current session's content.

Returns string
Related
EditSession.getValue
- Defined in src/document.js:55

getWrapBehavioursEnabled

getWrapBehavioursEnabled(): boolean
Returns true if the wrapping behaviors are currently enabled.

Returns boolean
- Defined in src/editor.js:1348

gotoLine

gotoLine(lineNumber: number, column?: number, animate?: boolean): void
Moves the cursor to the specified line number, and also into the indicated column.
Parameters
- lineNumber: number
  The line number to go to
- Optionalcolumn: number
  A column number to go to
- Optionalanimate: boolean
  If true animates scolling
Returns void
- Defined in src/editor.js:2364

gotoPageDown

gotoPageDown(): void
Shifts the document to wherever "page down" is, as well as moving the cursor position.

Returns void
- Defined in src/editor.js:2082

gotoPageUp

gotoPageUp(): void
Shifts the document to wherever "page up" is, as well as moving the cursor position.

Returns void
- Defined in src/editor.js:2089

indent

indent(): void
Inserts an indentation into the current cursor position or indents the selected lines.

Returns void
Related
EditSession.indentRows
- Defined in src/editor.js:1564

insert

insert(text: string, pasted?: boolean): void
Inserts text into wherever the cursor is pointing.
Parameters
- text: string
  The new text to add
- Optionalpasted: boolean
Returns void
- Defined in src/document.js:235

isFocused

isFocused(): boolean
Returns true if the current textInput is in focus.

Returns boolean
- Defined in src/editor.js:561

isRowFullyVisible

isRowFullyVisible(row: number): boolean
Indicates if the entire row is currently visible on the screen.
Parameters
- row: number
  The row to check
Returns boolean
- Defined in src/editor.js:2030

isRowVisible

isRowVisible(row: number): boolean
Indicates if the row is currently visible on the screen.
Parameters
- row: number
  The row to check
Returns boolean
- Defined in src/editor.js:2019

jumpToMatching

jumpToMatching(select?: boolean, expand?: boolean): void
Moves the cursor's row and column to the next matching bracket or HTML tag.
Parameters
- Optionalselect: boolean
- Optionalexpand: boolean
Returns void
- Defined in src/editor.js:2213

modifyNumber

modifyNumber(amount: number): void
If the character before the cursor is a number, this functions changes its value by amount.
Parameters
- amount: number
  The value to change the numeral by (can be negative to decrease value)
Returns void
- Defined in src/editor.js:1687

moveCursorTo

moveCursorTo(row: number, column: number): void
Moves the cursor to the specified row and column. Note that this does not de-select the current selection.
Parameters
- row: number
  The new row number
- column: number
  The new column number
Returns void
Related
Selection.moveCursorTo
- Defined in src/editor.js:2195

moveCursorToPosition

moveCursorToPosition(pos: Point): void
Moves the cursor to the position indicated by pos.row and pos.column.
Parameters
- pos: Point
  An object with two properties, row and column
Returns void
Related
Selection.moveCursorToPosition
- Defined in src/editor.js:2204

moveLinesDown

moveLinesDown(): void
Shifts all the selected lines down one row.

Returns void
Related
EditSession.moveLinesUp
- Defined in src/editor.js:1853

moveLinesUp

moveLinesUp(): void
Shifts all the selected lines up one row.

Returns void
Related
EditSession.moveLinesDown
- Defined in src/editor.js:1861

moveText

moveText(range: Range, toPosition: Point, copy?: boolean): Range
Moves a range of text from the given range to the given position. toPosition is an object that looks like this:
```
   { row: newRowLocation, column: newColumnLocation }
```
Parameters
- range: Range
  The range of text you want moved within the document
- toPosition: Point
  The location (row and column) where you want to move the text to
- Optionalcopy: boolean
Returns Range
The new range where the text was moved to.

Related
EditSession.moveText
- Defined in src/editor.js:1877

navigateDown

navigateDown(times?: number): void
Moves the cursor down in the document the specified number of times. Note that this does de-select the current selection.
Parameters
- Optionaltimes: number
  The number of times to change navigation
Returns void
- Defined in src/editor.js:2406

navigateFileEnd

navigateFileEnd(): void
Moves the cursor to the end of the current file. Note that this does de-select the current selection.

Returns void
- Defined in src/editor.js:2475

navigateFileStart

navigateFileStart(): void
Moves the cursor to the start of the current file. Note that this does de-select the current selection.

Returns void
- Defined in src/editor.js:2484

navigateLeft

navigateLeft(times?: number): void
Moves the cursor left in the document the specified number of times. Note that this does de-select the current selection.
Parameters
- Optionaltimes: number
  The number of times to change navigation
Returns void
- Defined in src/editor.js:2420

navigateLineEnd

navigateLineEnd(): void
Moves the cursor to the end of the current line. Note that this does de-select the current selection.

Returns void
- Defined in src/editor.js:2466

navigateLineStart

navigateLineStart(): void
Moves the cursor to the start of the current line. Note that this does de-select the current selection.

Returns void
- Defined in src/editor.js:2457

navigateRight

navigateRight(times?: number): void
Moves the cursor right in the document the specified number of times. Note that this does de-select the current selection.
Parameters
- Optionaltimes: number
  The number of times to change navigation
Returns void
- Defined in src/editor.js:2439

navigateTo

navigateTo(row: number, column: number): void
Moves the cursor to the specified row and column. Note that this does de-select the current selection.
Parameters
- row: number
  The new row number
- column: number
  The new column number
Returns void
Related
Editor.moveCursorTo
- Defined in src/editor.js:2383

navigateUp

navigateUp(times?: number): void
Moves the cursor up in the document the specified number of times. Note that this does de-select the current selection.
Parameters
- Optionaltimes: number
  The number of times to change navigation
Returns void
- Defined in src/editor.js:2392

navigateWordLeft

navigateWordLeft(): void
Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the current selection.

Returns void
- Defined in src/editor.js:2502

navigateWordRight

navigateWordRight(): void
Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the current selection.

Returns void
- Defined in src/editor.js:2493

off

off<
    K extends
        | "change"
        | "changeSelection"
        | "input"
        | "changeSession"
        | "blur"
        | "mousedown"
        | "mousemove"
        | "changeStatus"
        | "keyboardActivity"
        | "mousewheel"
        | "mouseup"
        | "beforeEndOperation"
        | "nativecontextmenu"
        | "destroy"
        | "focus"
        | "copy"
        | "paste"
        | "changeSelectionStyle"
        | "changeMode"
        | "findSearchBox"
        | "codeLensClick"
        | "select"
        | "gutterkeydown"
        | "gutterclick"
        | "showGutterTooltip"
        | "hideGutterTooltip"
        | "compositionStart"
        | "click"
        | "dblclick"
        | "tripleclick"
        | "quadclick"
        | "show"
        | "hide"
        | "changeHoverMarker",
>(
    name: K,
    callback: AcePopupEventsCombined[K],
): void
Type Parameters
- K extends
      | "change"
      | "changeSelection"
      | "input"
      | "changeSession"
      | "blur"
      | "mousedown"
      | "mousemove"
      | "changeStatus"
      | "keyboardActivity"
      | "mousewheel"
      | "mouseup"
      | "beforeEndOperation"
      | "nativecontextmenu"
      | "destroy"
      | "focus"
      | "copy"
      | "paste"
      | "changeSelectionStyle"
      | "changeMode"
      | "findSearchBox"
      | "codeLensClick"
      | "select"
      | "gutterkeydown"
      | "gutterclick"
      | "showGutterTooltip"
      | "hideGutterTooltip"
      | "compositionStart"
      | "click"
      | "dblclick"
      | "tripleclick"
      | "quadclick"
      | "show"
      | "hide"
      | "changeHoverMarker"
Parameters
- name: K
- callback: AcePopupEventsCombined[K]
Returns void
- Defined in interfaces.d.ts:623
off<K extends keyof EditorEvents>(name: K, callback: EditorEvents[K]): void
Type Parameters
- K extends keyof EditorEvents
Parameters
- name: K
- callback: EditorEvents[K]
Returns void
- Defined in interfaces.d.ts:623

on

on<
    K extends
        | "change"
        | "changeSelection"
        | "input"
        | "changeSession"
        | "blur"
        | "mousedown"
        | "mousemove"
        | "changeStatus"
        | "keyboardActivity"
        | "mousewheel"
        | "mouseup"
        | "beforeEndOperation"
        | "nativecontextmenu"
        | "destroy"
        | "focus"
        | "copy"
        | "paste"
        | "changeSelectionStyle"
        | "changeMode"
        | "findSearchBox"
        | "codeLensClick"
        | "select"
        | "gutterkeydown"
        | "gutterclick"
        | "showGutterTooltip"
        | "hideGutterTooltip"
        | "compositionStart"
        | "click"
        | "dblclick"
        | "tripleclick"
        | "quadclick"
        | "show"
        | "hide"
        | "changeHoverMarker",
>(
    name: K,
    callback: AcePopupEventsCombined[K],
    capturing?: boolean,
): AcePopupEventsCombined[K]
Type Parameters
- K extends
      | "change"
      | "changeSelection"
      | "input"
      | "changeSession"
      | "blur"
      | "mousedown"
      | "mousemove"
      | "changeStatus"
      | "keyboardActivity"
      | "mousewheel"
      | "mouseup"
      | "beforeEndOperation"
      | "nativecontextmenu"
      | "destroy"
      | "focus"
      | "copy"
      | "paste"
      | "changeSelectionStyle"
      | "changeMode"
      | "findSearchBox"
      | "codeLensClick"
      | "select"
      | "gutterkeydown"
      | "gutterclick"
      | "showGutterTooltip"
      | "hideGutterTooltip"
      | "compositionStart"
      | "click"
      | "dblclick"
      | "tripleclick"
      | "quadclick"
      | "show"
      | "hide"
      | "changeHoverMarker"
Parameters
- name: K
- callback: AcePopupEventsCombined[K]
- Optionalcapturing: boolean
Returns AcePopupEventsCombined[K]
- Defined in interfaces.d.ts:619
on<K extends keyof EditorEvents>(
    name: K,
    callback: EditorEvents[K],
    capturing?: boolean,
): EditorEvents[K]
Type Parameters
- K extends keyof EditorEvents
Parameters
- name: K
- callback: EditorEvents[K]
- Optionalcapturing: boolean
Returns EditorEvents[K]
- Defined in interfaces.d.ts:619

once

once<
    K extends
        | "change"
        | "changeSelection"
        | "input"
        | "changeSession"
        | "blur"
        | "mousedown"
        | "mousemove"
        | "changeStatus"
        | "keyboardActivity"
        | "mousewheel"
        | "mouseup"
        | "beforeEndOperation"
        | "nativecontextmenu"
        | "destroy"
        | "focus"
        | "copy"
        | "paste"
        | "changeSelectionStyle"
        | "changeMode"
        | "findSearchBox"
        | "codeLensClick"
        | "select"
        | "gutterkeydown"
        | "gutterclick"
        | "showGutterTooltip"
        | "hideGutterTooltip"
        | "compositionStart"
        | "click"
        | "dblclick"
        | "tripleclick"
        | "quadclick"
        | "show"
        | "hide"
        | "changeHoverMarker",
>(
    name: K,
    callback: AcePopupEventsCombined[K],
): void
Type Parameters
- K extends
      | "change"
      | "changeSelection"
      | "input"
      | "changeSession"
      | "blur"
      | "mousedown"
      | "mousemove"
      | "changeStatus"
      | "keyboardActivity"
      | "mousewheel"
      | "mouseup"
      | "beforeEndOperation"
      | "nativecontextmenu"
      | "destroy"
      | "focus"
      | "copy"
      | "paste"
      | "changeSelectionStyle"
      | "changeMode"
      | "findSearchBox"
      | "codeLensClick"
      | "select"
      | "gutterkeydown"
      | "gutterclick"
      | "showGutterTooltip"
      | "hideGutterTooltip"
      | "compositionStart"
      | "click"
      | "dblclick"
      | "tripleclick"
      | "quadclick"
      | "show"
      | "hide"
      | "changeHoverMarker"
Parameters
- name: K
- callback: AcePopupEventsCombined[K]
Returns void
- Defined in interfaces.d.ts:613
once<K extends keyof EditorEvents>(name: K, callback: EditorEvents[K]): void
Type Parameters
- K extends keyof EditorEvents
Parameters
- name: K
- callback: EditorEvents[K]
Returns void
- Defined in interfaces.d.ts:613

onEndOperation

onEndOperation(e: any): void
Parameters
- e: any
Returns void
Arg
e
- Defined in src/editor.js:128

onStartOperation

onStartOperation(commandEvent: any): void
Parameters
- commandEvent: any
Returns void
- Defined in src/editor.js:115

openLink

openLink(): boolean
Open valid url under cursor in another tab

Returns boolean
- Defined in src/editor.js:1812

prompt

prompt(message: any, options: any, callback: any): void
opens a prompt displaying message
Parameters
- message: any
- options: any
- callback: any
Returns void
- Defined in src/editor.js:2781

redo

redo(): void
{:UndoManager.redo}

Returns void
Related
UndoManager.redo
- Defined in src/editor.js:2682

remove

remove(dir?: "left" | "right"): void
Removes the current selection or one character.
Parameters
- Optionaldir: "left" | "right"
  The direction of the deletion to occur, either "left" or "right"
Returns void
- Defined in src/document.js:389

removeAllListeners

removeAllListeners(name?: string): void
Parameters
- Optionalname: string
Returns void
- Defined in interfaces.d.ts:629

removeDefaultHandler

removeDefaultHandler(name: string, callback: Function): void
Parameters
- name: string
- callback: Function
Returns void
- Defined in interfaces.d.ts:617

removeEventListener

removeEventListener<
    K extends
        | "change"
        | "changeSelection"
        | "input"
        | "changeSession"
        | "blur"
        | "mousedown"
        | "mousemove"
        | "changeStatus"
        | "keyboardActivity"
        | "mousewheel"
        | "mouseup"
        | "beforeEndOperation"
        | "nativecontextmenu"
        | "destroy"
        | "focus"
        | "copy"
        | "paste"
        | "changeSelectionStyle"
        | "changeMode"
        | "findSearchBox"
        | "codeLensClick"
        | "select"
        | "gutterkeydown"
        | "gutterclick"
        | "showGutterTooltip"
        | "hideGutterTooltip"
        | "compositionStart"
        | "click"
        | "dblclick"
        | "tripleclick"
        | "quadclick"
        | "show"
        | "hide"
        | "changeHoverMarker",
>(
    name: K,
    callback: AcePopupEventsCombined[K],
): void
Type Parameters
- K extends
      | "change"
      | "changeSelection"
      | "input"
      | "changeSession"
      | "blur"
      | "mousedown"
      | "mousemove"
      | "changeStatus"
      | "keyboardActivity"
      | "mousewheel"
      | "mouseup"
      | "beforeEndOperation"
      | "nativecontextmenu"
      | "destroy"
      | "focus"
      | "copy"
      | "paste"
      | "changeSelectionStyle"
      | "changeMode"
      | "findSearchBox"
      | "codeLensClick"
      | "select"
      | "gutterkeydown"
      | "gutterclick"
      | "showGutterTooltip"
      | "hideGutterTooltip"
      | "compositionStart"
      | "click"
      | "dblclick"
      | "tripleclick"
      | "quadclick"
      | "show"
      | "hide"
      | "changeHoverMarker"
Parameters
- name: K
- callback: AcePopupEventsCombined[K]
Returns void
- Defined in interfaces.d.ts:627
removeEventListener<K extends keyof EditorEvents>(
name: K,
callback: EditorEvents[K],
): void
Type Parameters
- K extends keyof EditorEvents
Parameters
- name: K
- callback: EditorEvents[K]
Returns void
- Defined in interfaces.d.ts:627

removeGhostText

removeGhostText(): void
Removes "ghost" text currently displayed in the editor.

Returns void
- Defined in src/editor.js:1498

removeLines

removeLines(): void
Removes all the lines in the current selection

Returns void
Related
EditSession.remove
- Defined in src/document.js:212

removeListener

removeListener<
    K extends
        | "change"
        | "changeSelection"
        | "input"
        | "changeSession"
        | "blur"
        | "mousedown"
        | "mousemove"
        | "changeStatus"
        | "keyboardActivity"
        | "mousewheel"
        | "mouseup"
        | "beforeEndOperation"
        | "nativecontextmenu"
        | "destroy"
        | "focus"
        | "copy"
        | "paste"
        | "changeSelectionStyle"
        | "changeMode"
        | "findSearchBox"
        | "codeLensClick"
        | "select"
        | "gutterkeydown"
        | "gutterclick"
        | "showGutterTooltip"
        | "hideGutterTooltip"
        | "compositionStart"
        | "click"
        | "dblclick"
        | "tripleclick"
        | "quadclick"
        | "show"
        | "hide"
        | "changeHoverMarker",
>(
    name: K,
    callback: AcePopupEventsCombined[K],
): void
Type Parameters
- K extends
      | "change"
      | "changeSelection"
      | "input"
      | "changeSession"
      | "blur"
      | "mousedown"
      | "mousemove"
      | "changeStatus"
      | "keyboardActivity"
      | "mousewheel"
      | "mouseup"
      | "beforeEndOperation"
      | "nativecontextmenu"
      | "destroy"
      | "focus"
      | "copy"
      | "paste"
      | "changeSelectionStyle"
      | "changeMode"
      | "findSearchBox"
      | "codeLensClick"
      | "select"
      | "gutterkeydown"
      | "gutterclick"
      | "showGutterTooltip"
      | "hideGutterTooltip"
      | "compositionStart"
      | "click"
      | "dblclick"
      | "tripleclick"
      | "quadclick"
      | "show"
      | "hide"
      | "changeHoverMarker"
Parameters
- name: K
- callback: AcePopupEventsCombined[K]
Returns void
- Defined in interfaces.d.ts:625
removeListener<K extends keyof EditorEvents>(
name: K,
callback: EditorEvents[K],
): void
Type Parameters
- K extends keyof EditorEvents
Parameters
- name: K
- callback: EditorEvents[K]
Returns void
- Defined in interfaces.d.ts:625

removeToLineEnd

removeToLineEnd(): void
Removes all the words to the right of the current selection, until the end of the line.

Returns void
- Defined in src/editor.js:1455

removeToLineStart

removeToLineStart(): void
Removes all the words to the left of the current selection, until the start of the line.

Returns void
- Defined in src/editor.js:1443

removeWordLeft

removeWordLeft(): void
Removes the word directly to the left of the current selection.

Returns void
- Defined in src/editor.js:1432

removeWordRight

removeWordRight(): void
Removes the word directly to the right of the current selection.

Returns void
- Defined in src/editor.js:1421

replace

replace(replacement?: string, options?: Partial<SearchOptions>): number
Replaces the first occurrence of options.needle with the value in replacement.
Parameters
- Optionalreplacement: string
  The text to replace with
- Optionaloptions: Partial<SearchOptions>
  The [[Search Search]] options to use
Returns number
- Defined in src/document.js:486

replaceAll

replaceAll(replacement?: string, options?: Partial<SearchOptions>): number
Replaces all occurrences of options.needle with the value in replacement.
Parameters
- Optionalreplacement: string
  The text to replace with
- Optionaloptions: Partial<SearchOptions>
  The [[Search Search]] options to use
Returns number
- Defined in src/editor.js:2538

resize

resize(force?: boolean): void
{:VirtualRenderer.onResize}
Parameters
- Optionalforce: boolean
  If true, recomputes the size, even if the height and width haven't changed
Returns void
Related
VirtualRenderer.onResize
- Defined in src/editor.js:422

revealRange

revealRange(range: Range, animate?: boolean): void
Parameters
- range: Range
- Optionalanimate: boolean
Returns void
- Defined in src/editor.js:2659

scrollPageDown

scrollPageDown(): void
Scrolls the document to wherever "page down" is, without changing the cursor position.

Returns void
- Defined in src/editor.js:2096

scrollPageUp

scrollPageUp(): void
Scrolls the document to wherever "page up" is, without changing the cursor position.

Returns void
- Defined in src/editor.js:2103

scrollToLine

scrollToLine(
    line: number,
    center: boolean,
    animate: boolean,
    callback?: () => void,
): void
Scrolls to a line. If center is true, it puts the line in middle of screen (or attempts to).
Parameters
- line: number
  The line to scroll to
- center: boolean
  If true
- animate: boolean
  If true animates scrolling
- Optionalcallback: () => void
  Function to be called when the animation has finished
Returns void
Related
VirtualRenderer.scrollToLine
- Defined in src/editor.js:2125

scrollToRow

scrollToRow(row: number): void
Moves the editor to the specified row.
Parameters
- row: number
Returns void
Related
VirtualRenderer.scrollToRow
- Defined in src/editor.js:2112

selectAll

selectAll(): void
Selects all the text in editor.

Returns void
Related
Selection.selectAll
- Defined in src/editor.js:2177

selectPageDown

selectPageDown(): void
Selects the text from the current position of the document until where a "page down" finishes.

Returns void
- Defined in src/editor.js:2068

selectPageUp

selectPageUp(): void
Selects the text from the current position of the document until where a "page up" finishes.

Returns void
- Defined in src/editor.js:2075

setAnimatedScroll

setAnimatedScroll(shouldAnimate: boolean): void
Parameters
- shouldAnimate: boolean
Returns void
- Defined in src/editor.js:1214

setAutoScrollEditorIntoView

setAutoScrollEditorIntoView(enable: boolean): void
Enables automatic scrolling of the cursor into view when editor itself is inside scrollable element
Parameters
- enable: boolean
  default true
Returns void
- Defined in src/editor.js:2714

setBehavioursEnabled

setBehavioursEnabled(enabled: boolean): void
Specifies whether to use behaviors or not. ["Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.]{: #BehaviorsDef}
Parameters
- enabled: boolean
  Enables or disables behaviors
Returns void
- Defined in src/editor.js:1323

setDefaultHandler

setDefaultHandler(name: string, callback: Function): void
Parameters
- name: string
- callback: Function
Returns void
- Defined in interfaces.d.ts:615

setDisplayIndentGuides

setDisplayIndentGuides(display: boolean): void
Parameters
- display: boolean
Returns void
- Defined in src/editor.js:1244

setDragDelay

setDragDelay(dragDelay: number): void
Sets the delay (in milliseconds) of the mouse drag.
Parameters
- dragDelay: number
  A value indicating the new delay
Returns void
- Defined in src/editor.js:1137

setFadeFoldWidgets

setFadeFoldWidgets(fade: boolean): void
Parameters
- fade: boolean
Returns void
- Defined in src/editor.js:1371

setFontSize

setFontSize(size: string | number): void
Set a new font size (in pixels) for the editor text.
Parameters
- size: string | number
  A font size ( e.g. "12px")
Returns void
- Defined in src/editor.js:476

setGhostText

setGhostText(text: string, position?: Point): void
Set the "ghost" text in provided position. "Ghost" text is a kind of preview text inside the editor which can be used to preview some code inline in the editor such as, for example, code completions.
Parameters
- text: string
  Text to be inserted as "ghost" text
- Optionalposition: Point
  Position to insert text to
Returns void
- Defined in src/editor.js:1491

setHighlightActiveLine

setHighlightActiveLine(shouldHighlight: boolean): void
Determines whether or not the current line should be highlighted.
Parameters
- shouldHighlight: boolean
  Set to true to highlight the current line
Returns void
- Defined in src/editor.js:1170

setHighlightGutterLine

setHighlightGutterLine(shouldHighlight: boolean): void
Parameters
- shouldHighlight: boolean
Returns void
- Defined in src/editor.js:1184

setHighlightIndentGuides

setHighlightIndentGuides(highlight: boolean): void
Parameters
- highlight: boolean
Returns void
- Defined in src/editor.js:1258

setHighlightSelectedWord

setHighlightSelectedWord(shouldHighlight: boolean): void
Determines if the currently selected word should be highlighted.
Parameters
- shouldHighlight: boolean
  Set to true to highlight the currently selected word
Returns void
- Defined in src/editor.js:1199

setKeyboardHandler

setKeyboardHandler(
keyboardHandler: string | KeyboardHandler,
cb?: () => void,
): void
Sets a new key handler, such as "vim" or "windows".
Parameters
- keyboardHandler: string | KeyboardHandler
  The new key handler
- Optionalcb: () => void
Returns void
- Defined in src/editor.js:216

setOption

setOption<K extends keyof EditorOptions>(name: K, value: EditorOptions[K]): void
Type Parameters
- K extends keyof EditorOptions
Parameters
- name: K
- value: EditorOptions[K]
Returns void
- Defined in src/ext/options.js:379

setOptions

setOptions(optList: Partial<EditorOptions>): void
Parameters
- optList: Partial<EditorOptions>
Returns void
- Defined in src/search.js:44

setOverwrite

setOverwrite(overwrite: boolean): void
Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emits the changeOverwrite event.
Parameters
- overwrite: boolean
  Defines whether or not to set overwrites
Returns void
Related
EditSession.setOverwrite
- Defined in src/editor.js:1096

setPrintMarginColumn

setPrintMarginColumn(showPrintMargin: number): void
Sets the column defining where the print margin should be.
Parameters
- showPrintMargin: number
  Specifies the new print margin
Returns void
- Defined in src/editor.js:1291

setReadOnly

setReadOnly(readOnly: boolean): void
If readOnly is true, then the editor is set to read-only mode, and none of the content can change.
Parameters
- readOnly: boolean
  Specifies whether the editor can be modified or not
Returns void
- Defined in src/editor.js:1307

setScrollSpeed

setScrollSpeed(speed: number): void
Sets how fast the mouse scrolling should do.
Parameters
- speed: number
  A value indicating the new speed (in milliseconds)
Returns void
- Defined in src/editor.js:1121

setSelectionStyle

setSelectionStyle(val: "fullLine" | "screenLine" | "text" | "line"): void
Draw selection markers spanning whole line, or only over selected text. Default value is "line"
Parameters
- val: "fullLine" | "screenLine" | "text" | "line"
  The new selection style "line"|"text"
Returns void
- Defined in src/editor.js:1154

setSession

setSession(session?: EditSession): void
Sets a new editsession to use. This method also emits the 'changeSession' event.
Parameters
- Optionalsession: EditSession
  The new session to use
Returns void
- Defined in src/editor.js:247

setShowFoldWidgets

setShowFoldWidgets(show: boolean): void
Indicates whether the fold widgets should be shown or not.
Parameters
- show: boolean
  Specifies whether the fold widgets are shown
Returns void
- Defined in src/editor.js:1356

setShowInvisibles

setShowInvisibles(showInvisibles: boolean): void
If showInvisibles is set to true, invisible characters—like spaces or new lines—are show in the editor.
Parameters
- showInvisibles: boolean
  Specifies whether or not to show invisible characters
Returns void
- Defined in src/bidihandler.js:198

setShowPrintMargin

setShowPrintMargin(showPrintMargin: boolean): void
If showPrintMargin is set to true, the print margin is shown in the editor.
Parameters
- showPrintMargin: boolean
  Specifies whether or not to show the print margin
Returns void
- Defined in src/editor.js:1274

setStyle

setStyle(style: string): void
{:VirtualRenderer.setStyle}
Parameters
- style: string
  A class name
Returns void
Related
VirtualRenderer.setStyle
- Defined in src/editor.js:450

setTheme

setTheme(theme: string | Theme, cb?: () => void): void
{:VirtualRenderer.setTheme}
Parameters
- theme: string | Theme
  The path to a theme
- Optionalcb: () => void
  optional callback called when theme is loaded
Returns void
- Defined in src/editor.js:431

setValue

setValue(val: string, cursorPos?: number): string
Sets the current document to val.
Parameters
- val: string
  The new value to set for the document
- OptionalcursorPos: number
  Where to set the new value. undefined or 0 is selectAll, -1 is at the document start, and 1 is at the end
Returns string
The current document value

Related
Document.setValue
- Defined in src/document.js:45

setWrapBehavioursEnabled

setWrapBehavioursEnabled(enabled: boolean): void
Specifies whether to use wrapping behaviors or not, i.e. automatically wrapping the selection with characters such as brackets when such a character is typed in.
Parameters
- enabled: boolean
  Enables or disables wrapping behaviors
Returns void
- Defined in src/editor.js:1340

sortLines

sortLines(): void
Returns void
- Defined in src/editor.js:1620

splitLine

splitLine(): void
Splits the line at the current selection (by inserting an '\n').

Returns void
- Defined in src/editor.js:1472

startOperation

startOperation(commandEvent: any): void
Parameters
- commandEvent: any
Returns void
- Defined in src/editor.js:104

toggleBlockComment

toggleBlockComment(): void
Returns void
- Defined in src/editor.js:1653

toggleCommentLines

toggleCommentLines(): void
Given the currently selected range, this function either comments all the lines, or uncomments all of them.

Returns void
- Defined in src/editor.js:1647

toggleOverwrite

toggleOverwrite(): void
Sets the value of overwrite to the opposite of whatever it currently is.

Returns void
Related
EditSession.toggleOverwrite
- Defined in src/editor.js:1113

toggleWord

toggleWord(): void
Returns void
- Defined in src/editor.js:1734

toLowerCase

toLowerCase(): void
Converts the current selection entirely into lowercase.

Returns void
- Defined in src/editor.js:1532

toUpperCase

toUpperCase(): void
Converts the current selection entirely into uppercase.

Returns void
- Defined in src/editor.js:1547

transposeLetters

transposeLetters(): void
Transposes current line.

Returns void
- Defined in src/editor.js:1505

undo

undo(): void
{:UndoManager.undo}

Returns void
Related
UndoManager.undo
- Defined in src/editor.js:2673

unsetStyle

unsetStyle(style: string): void
{:VirtualRenderer.unsetStyle}
Parameters
- style: string
Returns void
Related
VirtualRenderer.unsetStyle
- Defined in src/editor.js:459

Class AcePopup

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AcePopup

Properties

Optional$blockSelectEnabled

$checkMultiselectChange

Optional$codeLensClickHandler

Optional$multiselectOnSessionChange

$onAddRange

$onMultiSelect

$onMultiSelectExec

$onRemoveRange

$onSingleSelect

Optional$options

$reAlignText

Optional$updateLenses

Optional$updateLensesOnInput

addSelectionMarker

Type declaration

Parameters

Returns Range & { marker?: any }

alignCursors

anchor

anchorPos

anchorPosition

autoSelect

OptionalcmdLine

OptionalcodeLensProviders

commands

Optionalcompleter

completers

container

curOp

data

OptionalelasticTabstops

Optionalenv

exitMultiSelectMode

filterText

findAll

Type declaration

Parameters

Returns number

forEachSelection

Type declaration

Parameters

Returns void

getData

getHoveredRow

getRow

getSelectedText

getTextLeftOffset

goTo

hide

id

OptionalinMultiSelectMode

inVirtualSelectionMode

OptionalisMouseOver

isOpen

isTopdown

keyBinding

mergeNextCommand

OptionalmultiSelect

previousCommand

prevOp

removeSelectionMarker

Type declaration

Parameters

Returns void

removeSelectionMarkers

renderer

OptionalsearchBox

OptionalselectedNode

selection

`Optional`$blockSelectEnabled

`Optional`$codeLensClickHandler

`Optional`$multiselectOnSessionChange

`Optional`$options

`Optional`$updateLenses

`Optional`$updateLensesOnInput

`Optional`cmdLine

`Optional`codeLensProviders

`Optional`completer

`Optional`elasticTabstops

`Optional`env

`Optional`inMultiSelectMode

`Optional`isMouseOver

`Optional`multiSelect

`Optional`searchBox

`Optional`selectedNode

`Optional`setDisplaySettings

`Optional`showKeyboardShortcuts

`Optional`showSettingsMenu

`Optional`widgetManager