Interface NotebookDocumentChangeEvent

An event describing a transactional notebook change.

interface NotebookDocumentChangeEvent {
    cellChanges: readonly NotebookDocumentCellChange[];
    contentChanges: readonly NotebookDocumentContentChange[];
    metadata: undefined | {
        [key: string]: any;
    };
    notebook: NotebookDocument;
}

Index

Properties

cellChanges contentChanges metadata notebook

Properties

`Readonly` cellChanges

cellChanges: readonly NotebookDocumentCellChange[]

An array of cell changes.

`Readonly` contentChanges

contentChanges: readonly NotebookDocumentContentChange[]

An array of content changes describing added or removed cells.

`Readonly` metadata

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

The new metadata of the notebook or undefined when it did not change.

Type declaration

[key: string]: any

`Readonly` notebook

notebook: NotebookDocument

The affected notebook.