Interface NotebookDocuments<T>

interface NotebookDocuments<T> {
    get cellTextDocuments(): TextDocuments<T>;
    get onDidChange(): Event<NotebookDocumentChangeEvent>;
    get onDidClose(): Event<NotebookDocument>;
    get onDidOpen(): Event<NotebookDocument>;
    get onDidSave(): Event<NotebookDocument>;
    findNotebookDocumentForCell(cell: string | URI | NotebookCell): undefined | NotebookDocument;
    getCellTextDocument(cell: NotebookCell): undefined | T;
    getNotebookCell(uri: string | URI): undefined | NotebookCell;
    getNotebookDocument(uri: string | URI): undefined | NotebookDocument;
    listen(connection: Connection): Disposable;
}

Type Parameters

  • T extends {
        uri: string;
    }

Implemented by

Accessors

Methods

  • Listens for low level notification on the given connection to update the notebook documents managed by this instance.

    Please note that the connection only provides handlers not an event model. Therefore listening on a connection will overwrite the following handlers on a connection: onDidOpenNotebookDocument, onDidChangeNotebookDocument, onDidSaveNotebookDocument, and onDidCloseNotebookDocument.

    Parameters

    • connection: Connection

      The connection to listen on.

    Returns Disposable