Interface IEditor

A widget that provides a code editor.

As of JupyterLab 4.0.0, it is not possible to provide an editor that is different of CodeMirror 6.

interface IEditor {
    charWidth: number;
    edgeRequested: ISignal<CodeEditor.IEditor, EdgeLocation>;
    host: HTMLElement;
    isDisposed: boolean;
    lineCount: number;
    lineHeight: number;
    model: CodeEditor.IModel;
    uuid: string;
    blur(): void;
    clearHistory(): void;
    dispose(): void;
    focus(): void;
    getCoordinateForPosition(
        position: CodeEditor.IPosition,
    ): null | ICoordinate;
    getCursorPosition(): CodeEditor.IPosition;
    getLine(line: number): undefined | string;
    getOffsetAt(position: CodeEditor.IPosition): number;
    getOption(option: string): unknown;
    getPositionAt(offset: number): undefined | CodeEditor.IPosition;
    getPositionForCoordinate(
        coordinate: ICoordinate,
    ): null | CodeEditor.IPosition;
    getSelection(): IRange;
    getSelections(): IRange[];
    getTokenAt(offset: number): CodeEditor.IToken;
    getTokenAtCursor(): CodeEditor.IToken;
    getTokens(): CodeEditor.IToken[];
    hasFocus(): boolean;
    injectExtension(ext: Extension): void;
    newIndentedLine(): void;
    redo(): void;
    replaceSelection(text: string): void;
    revealPosition(position: CodeEditor.IPosition): void;
    revealSelection(selection: IRange): void;
    setBaseOptions(options: Record<string, any>): void;
    setCursorPosition(
        position: CodeEditor.IPosition,
        options?: { scroll?: boolean },
    ): void;
    setOption(option: string, value: unknown): void;
    setOptions(options: Record<string, any>): void;
    setSelection(selection: IRange): void;
    setSelections(selections: IRange[]): void;
    undo(): void;
}

Hierarchy (View Summary)

ISelectionOwner
IDisposable
- IEditor

Implemented by

CodeMirrorEditor

Properties

`Readonly`charWidth

charWidth: number

The widget of a character in the editor in pixels.

`Readonly`edgeRequested

edgeRequested: ISignal<CodeEditor.IEditor, EdgeLocation>

A signal emitted when either the top or bottom edge is requested.

`Readonly`host

host: HTMLElement

The DOM node that hosts the editor.

`Readonly`isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly`lineCount

lineCount: number

Get the number of lines in the editor.

`Readonly`lineHeight

lineHeight: number

The height of a line in the editor in pixels.

`Readonly`model

model: CodeEditor.IModel

The model used by the editor.

uuid

uuid: string

The uuid of this selection owner.

Methods

blur

blur(): void
Explicitly blur the editor.

Returns void
- Defined in packages/codeeditor/src/editor.ts:448

clearHistory

clearHistory(): void
Clear the undo history.

Returns void
- Defined in packages/codeeditor/src/editor.ts:433

dispose

dispose(): void
Dispose of the resources held by the object.

Notes
If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void
Inherited from IDisposable.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

focus

focus(): void
Brings browser focus to this editor text.

Returns void
- Defined in packages/codeeditor/src/editor.ts:438

getCoordinateForPosition

getCoordinateForPosition(position: CodeEditor.IPosition): null | ICoordinate
Get the window coordinates given a cursor position.
Parameters
- position: CodeEditor.IPosition
  The desired position.
Returns null | ICoordinate
The coordinates of the position.
- Defined in packages/codeeditor/src/editor.ts:471

getCursorPosition

getCursorPosition(): CodeEditor.IPosition
Returns the primary position of the cursor, never null.

Returns CodeEditor.IPosition
Inherited from ISelectionOwner.getCursorPosition
- Defined in packages/codeeditor/src/editor.ts:255

getLine

getLine(line: number): undefined | string
Returns the content for the given line number.
Parameters
- line: number
  The line of interest.
Returns undefined | string
The value of the line.

Notes
Lines are 0-based, and accessing a line out of range returns undefined.
- Defined in packages/codeeditor/src/editor.ts:398

getOffsetAt

getOffsetAt(position: CodeEditor.IPosition): number
Find an offset for the given position.
Parameters
- position: CodeEditor.IPosition
  The position of interest.
Returns number
The offset at the position, clamped to the extent of the editor contents.
- Defined in packages/codeeditor/src/editor.ts:408

getOption

getOption(option: string): unknown
Get a config option for the editor.
Parameters
- option: string
Returns unknown
- Defined in packages/codeeditor/src/editor.ts:361

getPositionAt

getPositionAt(offset: number): undefined | CodeEditor.IPosition
Find a position for the given offset.
Parameters
- offset: number
  The offset of interest.
Returns undefined | CodeEditor.IPosition
The position at the offset, clamped to the extent of the editor contents.
- Defined in packages/codeeditor/src/editor.ts:418

getPositionForCoordinate

getPositionForCoordinate(coordinate: ICoordinate): null | CodeEditor.IPosition
Get the cursor position given window coordinates.
Parameters
- coordinate: ICoordinate
  The desired coordinate.
Returns null | CodeEditor.IPosition
The position of the coordinates, or null if not contained in the editor.
- Defined in packages/codeeditor/src/editor.ts:481

getSelection

getSelection(): IRange
Returns the primary selection, never null.

Returns IRange
Inherited from ISelectionOwner.getSelection
- Defined in packages/codeeditor/src/editor.ts:274

getSelections

getSelections(): IRange[]
Gets the selections for all the cursors, never null or empty.

Returns IRange[]
Inherited from ISelectionOwner.getSelections
- Defined in packages/codeeditor/src/editor.ts:289

getTokenAt

getTokenAt(offset: number): CodeEditor.IToken
Get the token at a given editor position.
Parameters
- offset: number
Returns CodeEditor.IToken
- Defined in packages/codeeditor/src/editor.ts:491

getTokenAtCursor

getTokenAtCursor(): CodeEditor.IToken
Get the token a the cursor position.

Returns CodeEditor.IToken
- Defined in packages/codeeditor/src/editor.ts:496

getTokens

getTokens(): CodeEditor.IToken[]
Get a list of tokens for the current editor text content.

Returns CodeEditor.IToken[]
- Defined in packages/codeeditor/src/editor.ts:486

hasFocus

hasFocus(): boolean
Test whether the editor has keyboard focus.

Returns boolean
- Defined in packages/codeeditor/src/editor.ts:443

injectExtension

injectExtension(ext: Extension): void
Alpha Experimental
Inject an extension into the editor
Parameters
- ext: Extension
  Editor extension
Returns void
- Defined in packages/codeeditor/src/editor.ts:385

newIndentedLine

newIndentedLine(): void
Inserts a new line at the cursor position and indents it.

Returns void
- Defined in packages/codeeditor/src/editor.ts:501

redo

redo(): void
Redo one undone edit.

Returns void
- Defined in packages/codeeditor/src/editor.ts:428

`Optional`replaceSelection

replaceSelection(text: string): void
Replaces selection with the given text.
Parameters
- text: string
Returns void
- Defined in packages/codeeditor/src/editor.ts:506

revealPosition

revealPosition(position: CodeEditor.IPosition): void
Reveals the given position in the editor.
Parameters
- position: CodeEditor.IPosition
  The desired position to reveal.
Returns void
- Defined in packages/codeeditor/src/editor.ts:455

revealSelection

revealSelection(selection: IRange): void
Reveals the given selection in the editor.
Parameters
- selection: IRange
  The desired selection to reveal.
Returns void
- Defined in packages/codeeditor/src/editor.ts:462

setBaseOptions

setBaseOptions(options: Record<string, any>): void
Set a base config options for the editor.
Parameters
- options: Record<string, any>
Returns void
- Defined in packages/codeeditor/src/editor.ts:376

setCursorPosition

setCursorPosition(
position: CodeEditor.IPosition,
options?: { scroll?: boolean },
): void
Set the primary position of the cursor.
Parameters
- position: CodeEditor.IPosition
  The new primary position.
- Optionaloptions: { scroll?: boolean }
  Adjustment options allowing to disable scrolling.
  
  Notes
  This will remove any secondary cursors.
Returns void
Inherited from ISelectionOwner.setCursorPosition
- Defined in packages/codeeditor/src/editor.ts:266

setOption

setOption(option: string, value: unknown): void
Set a config option for the editor.
Parameters
- option: string
- value: unknown
Returns void
- Defined in packages/codeeditor/src/editor.ts:366

setOptions

setOptions(options: Record<string, any>): void
Set config options for the editor.
Parameters
- options: Record<string, any>
Returns void
- Defined in packages/codeeditor/src/editor.ts:371

setSelection

setSelection(selection: IRange): void
Set the primary selection.
Parameters
- selection: IRange
  The desired selection range.
  
  Notes
  This will remove any secondary cursors.
Returns void
Inherited from ISelectionOwner.setSelection
- Defined in packages/codeeditor/src/editor.ts:284

setSelections

setSelections(selections: IRange[]): void
Sets the selections for all the cursors.
Parameters
- selections: IRange[]
  The new selections.
  
  Notes
  Cursors will be removed or added, as necessary. Passing an empty array resets a cursor position to the start of a document.
Returns void
Inherited from ISelectionOwner.setSelections
- Defined in packages/codeeditor/src/editor.ts:301

undo

undo(): void
Undo one edit (if any undo events are stored).

Returns void
- Defined in packages/codeeditor/src/editor.ts:423

Interface IEditor

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

ReadonlycharWidth

ReadonlyedgeRequested

Readonlyhost

ReadonlyisDisposed

Notes

ReadonlylineCount

ReadonlylineHeight

Readonlymodel

uuid

Methods

blur

Returns void

clearHistory

Returns void

dispose

Notes

Undefined Behavior

Returns void

focus

Returns void

getCoordinateForPosition

Parameters

Returns null | ICoordinate

getCursorPosition

Returns CodeEditor.IPosition

getLine

Parameters

Returns undefined | string

Notes

getOffsetAt

Parameters

Returns number

getOption

Parameters

Returns unknown

getPositionAt

Parameters

Returns undefined | CodeEditor.IPosition

getPositionForCoordinate

Parameters

Returns null | CodeEditor.IPosition

getSelection

Returns IRange

getSelections

Returns IRange[]

getTokenAt

Parameters

Returns CodeEditor.IToken

getTokenAtCursor

Returns CodeEditor.IToken

getTokens

Returns CodeEditor.IToken[]

hasFocus

Returns boolean

injectExtension

Parameters

Returns void

newIndentedLine

Returns void

redo

Returns void

OptionalreplaceSelection

Parameters

Returns void

revealPosition

Parameters

Returns void

revealSelection

Parameters

Returns void

setBaseOptions

Parameters

Returns void

`Readonly`charWidth

`Readonly`edgeRequested

`Readonly`host

`Readonly`isDisposed

`Readonly`lineCount

`Readonly`lineHeight

`Readonly`model

`Optional`replaceSelection