View source

class VscodeNotebooks

no package

import Vscode

Methods

createNotebookController(id:String, notebookType:String, label:String, ?handler:(cells:Array<NotebookCell>, notebook:NotebookDocument, controller:NotebookController) ‑> Thenable<Void>):NotebookController

Creates a new notebook controller.

Parameters:

id

Identifier of the controller. Must be unique per extension.

notebookType

A notebook type for which this controller is for.

label

The label of the controller.

handler

The execute-handler of the controller.

createRendererMessaging(rendererId:String):NotebookRendererMessaging

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

The renderer ID to communicate with

Returns:

A new notebook renderer messaging object.

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

Register a {@link NotebookCellStatusBarItemProvider cell statusbar item provider} for the given notebook type.

@link Disposable} that unregisters this provider when being disposed.

Parameters:

notebookType

The notebook type to register for.

provider

A cell status bar provider.

Returns:

A {