Class NotebookService

Implements

Disposable

Constructors

constructor

new NotebookService(): NotebookService
Returns NotebookService

Properties

`Protected` `Readonly`didAddNotebookDocumentEmitter

didAddNotebookDocumentEmitter: Emitter<NotebookModel> = ...

`Protected` `Readonly`didRegisterNotebookSerializerEmitter

didRegisterNotebookSerializerEmitter: Emitter<string> = ...

`Protected` `Readonly`didRemoveNotebookDocumentEmitter

didRemoveNotebookDocumentEmitter: Emitter<NotebookModel> = ...

`Protected` `Readonly`didRemoveViewTypeEmitter

didRemoveViewTypeEmitter: Emitter<string> = ...

`Protected` `Readonly`disposables

disposables: DisposableCollection = ...

`Protected`fileService

fileService: FileService

`Protected`notebookCellModelFactory

notebookCellModelFactory: (props: NotebookCellModelProps) => NotebookCellModel

`Protected`notebookModelFactory

notebookModelFactory: (props: NotebookModelProps) => NotebookModel

`Protected` `Readonly`notebookModels

notebookModels: Map<string, NotebookModel> = ...

`Protected` `Readonly`notebookProviders

notebookProviders: Map<string, NotebookProviderInfo> = ...

`Readonly`onDidAddNotebookDocument

onDidAddNotebookDocument: Event<NotebookModel> = ...

`Readonly`onDidRegisterNotebookSerializer

onDidRegisterNotebookSerializer: Event<string> = ...

`Readonly`onDidRemoveNotebookDocument

onDidRemoveNotebookDocument: Event<NotebookModel> = ...

`Readonly`onDidRemoveViewType

onDidRemoveViewType: Event<string> = ...

`Readonly`onWillOpenNotebook

onWillOpenNotebook: Event<string> = ...

`Readonly`onWillUseNotebookSerializer

onWillUseNotebookSerializer: Event<string> = ...

`Protected` `Readonly`ready

ready: Deferred<void> = ...

`Protected`textModelService

textModelService: NotebookMonacoTextModelService

`Protected` `Readonly`willOpenNotebookTypeEmitter

willOpenNotebookTypeEmitter: Emitter<string> = ...

`Protected`willUseNotebookSerializerEmitter

willUseNotebookSerializerEmitter: Emitter<string> = ...

Methods

applyWorkspaceEdit

applyWorkspaceEdit(workspaceEdit: NotebookWorkspaceEdit): boolean
Parameters
- workspaceEdit: NotebookWorkspaceEdit
Returns boolean
- Defined in packages/notebook/src/browser/service/notebook-service.ts:197

createNotebookModel

createNotebookModel(
    data: NotebookData,
    viewType: string,
    resource: Resource,
): Promise<NotebookModel>
Parameters
- data: NotebookData
- viewType: string
- resource: Resource
Returns Promise<NotebookModel>
- Defined in packages/notebook/src/browser/service/notebook-service.ts:112

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in packages/notebook/src/browser/service/notebook-service.ts:85

getCodeCellLanguage

getCodeCellLanguage(model: NotebookModel): string
Parameters
- model: NotebookModel
Returns string
- Defined in packages/notebook/src/browser/service/notebook-service.ts:210

getNotebookDataProvider

getNotebookDataProvider(viewType: string): Promise<NotebookProviderInfo>
Parameters
- viewType: string
Returns Promise<NotebookProviderInfo>
- Defined in packages/notebook/src/browser/service/notebook-service.ts:128

markReady

markReady(): void
Marks the notebook service as ready. From this point on, the service will start dispatching the onNotebookSerializer event.

Returns void
- Defined in packages/notebook/src/browser/service/notebook-service.ts:94

registerNotebookSerializer

registerNotebookSerializer(
viewType: string,
serializer: NotebookSerializer,
): Disposable
Parameters
- viewType: string
- serializer: NotebookSerializer
Returns Disposable
- Defined in packages/notebook/src/browser/service/notebook-service.ts:98

`Protected`waitForNotebookProvider

waitForNotebookProvider(type: string): Promise<NotebookProviderInfo>
When the application starts up, notebook providers from plugins are not registered yet. It takes a few seconds for the plugin host to start so that notebook data providers can be registered. This methods waits until the notebook provider is registered.
Parameters
- type: string
Returns Promise<NotebookProviderInfo>
- Defined in packages/notebook/src/browser/service/notebook-service.ts:141

willOpenNotebook

willOpenNotebook(type: string): Promise<void>
Parameters
- type: string
Returns Promise<void>
- Defined in packages/notebook/src/browser/service/notebook-service.ts:189

Class NotebookService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns NotebookService

Properties

Protected ReadonlydidAddNotebookDocumentEmitter

Protected ReadonlydidRegisterNotebookSerializerEmitter

Protected ReadonlydidRemoveNotebookDocumentEmitter

Protected ReadonlydidRemoveViewTypeEmitter

Protected Readonlydisposables

ProtectedfileService

ProtectednotebookCellModelFactory

ProtectednotebookModelFactory

Protected ReadonlynotebookModels

Protected ReadonlynotebookProviders

ReadonlyonDidAddNotebookDocument

ReadonlyonDidRegisterNotebookSerializer

ReadonlyonDidRemoveNotebookDocument

ReadonlyonDidRemoveViewType

ReadonlyonWillOpenNotebook

ReadonlyonWillUseNotebookSerializer

Protected Readonlyready

ProtectedtextModelService

Protected ReadonlywillOpenNotebookTypeEmitter

ProtectedwillUseNotebookSerializerEmitter

Methods

applyWorkspaceEdit

Parameters

Returns boolean

createNotebookModel

Parameters

Returns Promise<NotebookModel>

dispose

Returns void

getCodeCellLanguage

Parameters

Returns string

getNotebookDataProvider

Parameters

Returns Promise<NotebookProviderInfo>

getNotebookEditorModel

Parameters

Returns undefined | NotebookModel

getNotebookModels

Returns Iterable<NotebookModel>

listNotebookDocuments

Returns NotebookModel[]

markReady

Returns void

registerNotebookSerializer

Parameters

Returns Disposable

ProtectedwaitForNotebookProvider

Parameters

Returns Promise<NotebookProviderInfo>

willOpenNotebook

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`didAddNotebookDocumentEmitter

`Protected` `Readonly`didRegisterNotebookSerializerEmitter

`Protected` `Readonly`didRemoveNotebookDocumentEmitter

`Protected` `Readonly`didRemoveViewTypeEmitter

`Protected` `Readonly`disposables

`Protected`fileService

`Protected`notebookCellModelFactory

`Protected`notebookModelFactory

`Protected` `Readonly`notebookModels

`Protected` `Readonly`notebookProviders

`Readonly`onDidAddNotebookDocument

`Readonly`onDidRegisterNotebookSerializer

`Readonly`onDidRemoveNotebookDocument

`Readonly`onDidRemoveViewType

`Readonly`onWillOpenNotebook

`Readonly`onWillUseNotebookSerializer

`Protected` `Readonly`ready

`Protected`textModelService

`Protected` `Readonly`willOpenNotebookTypeEmitter

`Protected`willUseNotebookSerializerEmitter

`Protected`waitForNotebookProvider