Namespace notebooks

Namespace for notebooks.

The notebooks functionality is composed of three loosely coupled components:

NotebookSerializer enable the editor to open, show, and save notebooks
NotebookController own the execution of notebooks, e.g they create output from code cells.
NotebookRenderer present notebook output in the editor. They run in a separate context.

Index

Functions（3）

Functions（3）

createNotebookController

createNotebookController(id: string, notebookType: string, label: string, handler?: (cells: NotebookCell[], notebook: NotebookDocument, controller: NotebookController) => void | Thenable<void>): NotebookController

- Defined in vscode.d.ts:15349
Creates a new notebook controller.

Parameters
- id: string
  
  Identifier of the controller. Must be unique per extension.
- notebookType: string
  
  A notebook type for which this controller is for.
- label: string
  
  The label of the controller.
- Optional handler: (cells: NotebookCell[], notebook: NotebookDocument, controller: NotebookController) => void | Thenable<void>
  
  The execute-handler of the controller.
  - - (cells: NotebookCell[], notebook: NotebookDocument, controller: NotebookController): void | Thenable<void>
    - Parameters
      - cells: NotebookCell[]
      - notebook: NotebookDocument
      - controller: NotebookController
      Returns void | Thenable<void>
Returns NotebookController

A new notebook controller.

registerNotebookCellStatusBarItemProvider

registerNotebookCellStatusBarItemProvider(notebookType: string, provider: NotebookCellStatusBarItemProvider): Disposable

- Defined in vscode.d.ts:15358
Register a cell statusbar item provider for the given notebook type.

Parameters
- notebookType: string
  
  The notebook type to register for.
- provider: NotebookCellStatusBarItemProvider
  
  A cell status bar provider.
Returns Disposable

A Disposable that unregisters this provider when being disposed.

createRendererMessaging

createRendererMessaging(rendererId: string): NotebookRendererMessaging

- Defined in vscode.d.ts:15370
Creates a new messaging instance used to communicate with a specific renderer.
- Note 1: Extensions can only create renderer that they have defined in their package.json-file
- Note 2: A renderer only has access to messaging if requiresMessaging is set to always or optional in its notebookRenderer contribution.
Parameters
- rendererId: string
  
  The renderer ID to communicate with
Returns NotebookRendererMessaging

A new notebook renderer messaging object.

Generated by TypeDoc. Maintained by 洛竹