Interface NotebookCell

Represents a cell of a notebook, either a code-cell or markup-cell.

NotebookCell instances are immutable and are kept in sync for as long as they are part of their notebook.

interface NotebookCell {
    document: TextDocument;
    executionSummary: undefined | NotebookCellExecutionSummary;
    index: number;
    kind: NotebookCellKind;
    metadata: {
        [key: string]: any;
    };
    notebook: NotebookDocument;
    outputs: readonly NotebookCellOutput[];
}

Properties

document executionSummary index kind metadata notebook outputs

Properties

Readonly document

document: TextDocument

The text of this cell, represented as text document.

Readonly executionSummary

executionSummary: undefined | NotebookCellExecutionSummary

The most recent execution summary for this cell.

Readonly index

index: number

The index of this cell in its containing notebook. The index is updated when a cell is moved within its notebook. The index is -1 when the cell has been removed from its notebook.

Readonly kind

kind: NotebookCellKind

The kind of this cell.

Readonly metadata

metadata: {
    [key: string]: any;
}

The metadata of this cell. Can be anything but must be JSON-stringifyable.

Type declaration

  • [key: string]: any

Readonly notebook

notebook: NotebookDocument

The notebook that contains this cell.

Readonly outputs

outputs: readonly NotebookCellOutput[]

The outputs of this cell.

Settings

Member Visibility

Theme

On This Page

documentexecutionSummaryindexkindmetadatanotebookoutputs