Class NotebooksExtImpl

Implements

NotebooksExt

Index

Constructors

Accessors

activeApiNotebookEditor visibleApiNotebookEditors

Methods

$acceptActiveCellEditorChange $acceptDocumentsAndEditorsDelta $dataToNotebook $notebookToData $provideNotebookCellStatusBarItems $releaseNotebookCellStatusBarItems createExtHostEditor createNotebookDocument getAllApiDocuments getEditorById getNotebookDocument openNotebookDocument registerNotebookCellStatusBarItemProvider registerNotebookSerializer showNotebookDocument waitForNotebookDocument waitForNotebookEditor

Constructors

constructor

new NotebooksExtImpl(rpc, commands, textDocumentsAndEditors, textDocuments): NotebooksExtImpl
Parameters
- rpc: RPCProtocol
- commands: CommandRegistryImpl
- textDocumentsAndEditors: EditorsAndDocumentsExtImpl
- textDocuments: DocumentsExtImpl
Returns NotebooksExtImpl
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:75

Properties

`Private` activeNotebookEditor

activeNotebookEditor: undefined | NotebookEditor

`Private` `Readonly` commandsConverter

commandsConverter: CommandsConverter

`Private` currentSerializerHandle

currentSerializerHandle: number = 0

`Private` `Readonly` documents

documents: Map<string, NotebookDocument> = ...

`Private` `Readonly` editors

editors: Map<string, NotebookEditor> = ...

`Private` notebookDocumentsProxy

notebookDocumentsProxy: NotebookDocumentsMain

`Private` notebookEditors

notebookEditors: NotebookEditorsMain

`Private` notebookProxy

notebookProxy: NotebooksMain

`Private` `Readonly` notebookSerializer

notebookSerializer: Map<number, NotebookSerializer> = ...

`Private` `Readonly` notebookStatusBarItemProviders

notebookStatusBarItemProviders: Map<number, NotebookCellStatusBarItemProvider> = ...

`Readonly` onDidChangeActiveNotebookEditor

onDidChangeActiveNotebookEditor: Event<undefined | NotebookEditor> = ...

`Private` `Readonly` onDidChangeActiveNotebookEditorEmitter

onDidChangeActiveNotebookEditorEmitter: Emitter<undefined | NotebookEditor> = ...

onDidChangeVisibleNotebookEditors

onDidChangeVisibleNotebookEditors: Event<NotebookEditor[]> = ...

`Private` `Readonly` onDidChangeVisibleNotebookEditorsEmitter

onDidChangeVisibleNotebookEditorsEmitter: Emitter<NotebookEditor[]> = ...

onDidCloseNotebookDocument

onDidCloseNotebookDocument: Event<NotebookDocument> = ...

`Private` `Readonly` onDidCloseNotebookDocumentEmitter

onDidCloseNotebookDocumentEmitter: Emitter<NotebookDocument> = ...

onDidOpenNotebookDocument

onDidOpenNotebookDocument: Event<NotebookDocument> = ...

`Private` `Readonly` onDidOpenNotebookDocumentEmitter

onDidOpenNotebookDocumentEmitter: Emitter<NotebookDocument> = ...

`Private` statusBarRegistry

statusBarRegistry: Cache<Disposable> = ...

`Private` textDocuments

textDocuments: DocumentsExtImpl

`Private` textDocumentsAndEditors

textDocumentsAndEditors: EditorsAndDocumentsExtImpl

`Private` visibleNotebookEditors

visibleNotebookEditors: NotebookEditor[] = []

Accessors

activeApiNotebookEditor

get activeApiNotebookEditor(): undefined | NotebookEditor
Returns undefined | NotebookEditor
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:58

visibleApiNotebookEditors

get visibleApiNotebookEditors(): NotebookEditor[]
Returns NotebookEditor[]
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:63

Methods

$acceptActiveCellEditorChange

$acceptActiveCellEditorChange(newActiveEditor): void
Parameters
- newActiveEditor: null | string
Returns void
Implementation of NotebooksExt.$acceptActiveCellEditorChange
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:142

$acceptDocumentsAndEditorsDelta

$acceptDocumentsAndEditorsDelta(delta): Promise<void>
Parameters
- delta: NotebookDocumentsAndEditorsDelta
Returns Promise<void>
Implementation of NotebooksExt.$acceptDocumentsAndEditorsDelta
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:223

$dataToNotebook

$dataToNotebook(handle, bytes, token): Promise<NotebookDataDto>
Parameters
- handle: number
- bytes: BinaryBuffer
- token: CancellationToken
Returns Promise<NotebookDataDto>
Implementation of NotebooksExt.$dataToNotebook
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:173

$notebookToData

$notebookToData(handle, data, token): Promise<BinaryBuffer>
Parameters
- handle: number
- data: NotebookDataDto
- token: CancellationToken
Returns Promise<BinaryBuffer>
Implementation of NotebooksExt.$notebookToData
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:182

$provideNotebookCellStatusBarItems

$provideNotebookCellStatusBarItems(handle, uri, index, token): Promise<undefined | NotebookCellStatusBarListDto>
Parameters
- handle: number
- uri: UriComponents
- index: number
- token: CancellationToken
Returns Promise<undefined | NotebookCellStatusBarListDto>
Implementation of NotebooksExt.$provideNotebookCellStatusBarItems
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:110

$releaseNotebookCellStatusBarItems

$releaseNotebookCellStatusBarItems(cacheId): void
Parameters
- cacheId: number
Returns void
Implementation of NotebooksExt.$releaseNotebookCellStatusBarItems
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:138

`Private` createExtHostEditor

createExtHostEditor(document, editorId, data): void
Parameters
- document: NotebookDocument
- editorId: string
- data: NotebookEditorAddData
Returns void
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:381

createNotebookDocument

createNotebookDocument(options): Promise<URI>
Parameters
- options: {
  content?: NotebookData;
  viewType: string;
  }
  - Optional content?: NotebookData
  - viewType: string
Returns Promise<URI>
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:419

registerNotebookCellStatusBarItemProvider

registerNotebookCellStatusBarItemProvider(notebookType, provider): Disposable
Parameters
- notebookType: string
- provider: NotebookCellStatusBarItemProvider
Returns Disposable
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:191

registerNotebookSerializer

registerNotebookSerializer(plugin, viewType, serializer, options?): Disposable
Parameters
- plugin: Plugin
- viewType: string
- serializer: NotebookSerializer
- Optional options: NotebookDocumentContentOptions
Returns Disposable
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:156

showNotebookDocument

showNotebookDocument(notebookOrUri, options?): Promise<NotebookEditor>
Parameters
- notebookOrUri: URI | NotebookDocument
- Optional options: NotebookDocumentShowOptions
Returns Promise<NotebookEditor>
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:437

waitForNotebookDocument

waitForNotebookDocument(uri, duration?): Promise<NotebookDocument>
Parameters
- uri: URI
- duration: number = 2000
Returns Promise<NotebookDocument>
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:361

`Private` waitForNotebookEditor

waitForNotebookEditor(editorId, duration?): Promise<NotebookEditor>
Parameters
- editorId: string
- duration: number = 2000
Returns Promise<NotebookEditor>
- Defined in packages/plugin-ext/src/plugin/notebook/notebooks.ts:398

Class NotebooksExtImpl

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NotebooksExtImpl

Properties

Private activeNotebookEditor

Private Readonly commandsConverter

Private currentSerializerHandle

Private Readonly documents

Private Readonly editors

Private notebookDocumentsProxy

Private notebookEditors

Private notebookProxy

Private Readonly notebookSerializer

Private Readonly notebookStatusBarItemProviders

Readonly onDidChangeActiveNotebookEditor

Private Readonly onDidChangeActiveNotebookEditorEmitter

onDidChangeVisibleNotebookEditors

Private Readonly onDidChangeVisibleNotebookEditorsEmitter

onDidCloseNotebookDocument

Private Readonly onDidCloseNotebookDocumentEmitter

onDidOpenNotebookDocument

Private Readonly onDidOpenNotebookDocumentEmitter

Private statusBarRegistry

Private textDocuments

Private textDocumentsAndEditors

Private visibleNotebookEditors

Accessors

activeApiNotebookEditor

Returns undefined | NotebookEditor

visibleApiNotebookEditors

Returns NotebookEditor[]

Methods

$acceptActiveCellEditorChange

Parameters

Returns void

$acceptDocumentsAndEditorsDelta

Parameters

Returns Promise<void>

$dataToNotebook

Parameters

Returns Promise<NotebookDataDto>

$notebookToData

Parameters

Returns Promise<BinaryBuffer>

$provideNotebookCellStatusBarItems

Parameters

Returns Promise<undefined | NotebookCellStatusBarListDto>

$releaseNotebookCellStatusBarItems

Parameters

Returns void

Private createExtHostEditor

Parameters

Returns void

createNotebookDocument

Parameters

Optional content?: NotebookData

viewType: string

Returns Promise<URI>

getAllApiDocuments

Returns NotebookDocument[]

getEditorById

Parameters

Returns NotebookEditor

getNotebookDocument

Parameters

Returns undefined | NotebookDocument

Parameters

Returns NotebookDocument

openNotebookDocument

Parameters

Returns Promise<NotebookDocument>

registerNotebookCellStatusBarItemProvider

`Private` activeNotebookEditor

`Private` `Readonly` commandsConverter

`Private` currentSerializerHandle

`Private` `Readonly` documents

`Private` `Readonly` editors

`Private` notebookDocumentsProxy

`Private` notebookEditors

`Private` notebookProxy

`Private` `Readonly` notebookSerializer

`Private` `Readonly` notebookStatusBarItemProviders

`Readonly` onDidChangeActiveNotebookEditor

`Private` `Readonly` onDidChangeActiveNotebookEditorEmitter

`Private` `Readonly` onDidChangeVisibleNotebookEditorsEmitter

`Private` `Readonly` onDidCloseNotebookDocumentEmitter

`Private` `Readonly` onDidOpenNotebookDocumentEmitter

`Private` statusBarRegistry

`Private` textDocuments

`Private` textDocumentsAndEditors

`Private` visibleNotebookEditors

`Private` createExtHostEditor

`Optional` content?: NotebookData

`Private` waitForNotebookEditor