Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace nb

Index

Type aliases

CellType

CellType: "code" | "markdown" | "raw"

Channel

Channel: "shell" | "iopub" | "stdin" | "execute_reply"

The valid channel names.

KernelStatus

KernelStatus: "unknown" | "starting" | "reconnecting" | "idle" | "busy" | "restarting" | "dead" | "connected"

The valid Kernel status states.

MultilineString

MultilineString: string | string[]

A multiline string.

Output

OutputTypeName

OutputTypeName: "execute_result" | "display_data" | "stream" | "error" | "update_display_data"

StreamType

StreamType: "stdout" | "stderr"

An alias for a stream type.

Variables

Let activeNotebookEditor

activeNotebookEditor: NotebookEditor | undefined

The currently active Notebook editor or undefined. The active editor is the one that currently has focus or, when none has focus, the one that has changed input most recently.

Let notebookDocuments

notebookDocuments: NotebookDocument[]

All notebook documents currently known to the system.

Let visibleNotebookEditors

visibleNotebookEditors: NotebookEditor[]

The currently visible editors or an empty array.

Functions

Const onDidChangeNotebookCell

  • onDidChangeNotebookCell(listener: (e: NotebookCellChangeEvent) => any, thisArgs?: any, disposables?: Disposable[]): Disposable

Const onDidOpenNotebookDocument

  • onDidOpenNotebookDocument(listener: (e: NotebookDocument) => any, thisArgs?: any, disposables?: Disposable[]): Disposable

registerNavigationProvider

  • Parameters

    Returns vscode.Disposable

registerNotebookProvider

  • Register a notebook provider. The supported file types handled by this provider are defined in the `package.json:

    {
       "contributes": {
          "notebook.providers": [{
             "provider": "providername",
             "fileExtensions": ["FILEEXT"]
           }]
       }
    }
    

    Parameters

    Returns vscode.Disposable

    disposable

showNotebookDocument

  • Show the given document in a notebook editor. A column can be provided to control where the editor is being shown. Might change the active editor.

    The document is denoted by an uri. Depending on the scheme the following rules apply: file-scheme: Open a file on disk, will be rejected if the file does not exist or cannot be loaded. untitled-scheme: A new file that should be saved on disk, e.g. untitled:c:\frodo\new.js. The language will be derived from the file name. For all other schemes the registered notebook providers are consulted.

    Parameters

    Returns Thenable<NotebookEditor>

    A promise that resolves to a notebook editor.

Generated using TypeDoc