IEditor | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• ISelectionOwner
• IDisposable
  • IEditor

Implemented by

• CodeMirrorEditor

Index

Properties

ReadonlycharWidth

charWidth: number

ReadonlyedgeRequested

Readonlyhost

ReadonlyisDisposed

isDisposed: boolean

ReadonlylineCount

lineCount: number

ReadonlylineHeight

lineHeight: number

Readonlymodel

uuid

uuid: string

Methods

blur

• blur(): void

• Returns void

clearHistory

• clearHistory(): void

• Returns void

dispose

• dispose(): void

• Returns void

focus

• focus(): void

• Returns void

getCoordinateForPosition

• getCoordinateForPosition(position: IPosition): null | ICoordinate

• Returns null | ICoordinate

The coordinates of the position.

getCursorPosition

• getCursorPosition(): IPosition

• Returns IPosition

getLine

• getLine(line: number): undefined | string

• Returns undefined | string

The value of the line.

Notes

Lines are 0-based, and accessing a line out of range returnsundefined.

getOffsetAt

• getOffsetAt(position: IPosition): number

• Returns number

The offset at the position, clamped to the extent of the editor contents.

getOption

• getOption(option: string): unknown

• Returns unknown

getPositionAt

• getPositionAt(offset: number): undefined | IPosition

• Returns undefined | IPosition

The position at the offset, clamped to the extent of the editor contents.

getPositionForCoordinate

• getPositionForCoordinate(coordinate: ICoordinate): null | IPosition

• Returns null | IPosition

The position of the coordinates, or null if not contained in the editor.

getSelection

• getSelection(): IRange

• Returns IRange

getSelections

• getSelections(): IRange[]

• Returns IRange[]

getTokenAt

• getTokenAt(offset: number): CodeEditor.IToken

• Returns CodeEditor.IToken

getTokenAtCursor

• getTokenAtCursor(): CodeEditor.IToken

• Returns CodeEditor.IToken

getTokens

• getTokens(): CodeEditor.IToken[]

• Returns CodeEditor.IToken[]

hasFocus

• hasFocus(): boolean

• Returns boolean

injectExtension

• injectExtension(ext: Extension): void
• Alpha Experimental

Returns void

newIndentedLine

• newIndentedLine(): void

• Returns void

redo

• redo(): void

• Returns void

OptionalreplaceSelection

• replaceSelection(text: string): void

• Returns void

revealPosition

• revealPosition(position: IPosition): void

• Returns void

revealSelection

• revealSelection(selection: IRange): void

• Returns void

setBaseOptions

• setBaseOptions(options: Record<string, any>): void

• Parameters

  • options: Record<string, any>

Returns void

setCursorPosition

• setCursorPosition(position: IPosition, options?: { scroll?: boolean }): void

• Parameters

  • position: IPosition
  • Optionaloptions: { scroll?: boolean }

Returns void

setOption

• setOption(option: string, value: unknown): void

• Parameters

  • option: string
  • value: unknown

Returns void

setOptions

• setOptions(options: Record<string, any>): void

• Parameters

  • options: Record<string, any>

Returns void

setSelection

• setSelection(selection: IRange): void

• Returns void

setSelections

• setSelections(selections: IRange[]): void

• Parameters

  • selections: IRange[]

Returns void

undo

• undo(): void

• Returns void