Interface NotebookEditor

Represents a notebook editor that is attached to a notebook. Additional properties of the NotebookEditor are available in the proposed API, which will be finalized later.

interface NotebookEditor {
    notebook: NotebookDocument;
    selection: NotebookRange;
    selections: readonly NotebookRange[];
    viewColumn?: ViewColumn;
    visibleRanges: readonly NotebookRange[];
    revealRange(range, revealType?): void;
}

Properties

notebook selection selections viewColumn? visibleRanges

Methods

revealRange

Properties

Readonly notebook

notebook: NotebookDocument

The notebook document associated with this notebook editor.

selection

selection: NotebookRange

The primary selection in this notebook editor.

selections

selections: readonly NotebookRange[]

All selections in this notebook editor.

The primary selection (or focused range) is selections[0]. When the document has no cells, the primary selection is empty { start: 0, end: 0 };

Optional Readonly viewColumn

viewColumn?: ViewColumn

The column in which this editor shows.

Readonly visibleRanges

visibleRanges: readonly NotebookRange[]

The current visible ranges in the editor (vertically).

Methods

revealRange

Settings

Member Visibility

Theme

On This Page

notebookselectionselectionsviewColumnvisibleRangesrevealRange