Class NotebookModelFactory

A model factory for notebooks.

Implements

DocumentRegistry.IModelFactory<INotebookModel>

Index

Constructors

Properties

_collaborative _disableDocumentWideUndoRedo _disposed

Accessors

collaborative contentType disableDocumentWideUndoRedo fileFormat isDisposed name

Methods

createNew dispose preferredLanguage

Constructors

constructor

new NotebookModelFactory(options?): NotebookModelFactory
Construct a new notebook model factory.
Parameters
- options: NotebookModelFactory.IOptions = {}
Returns NotebookModelFactory
- Defined in packages/notebook/src/modelfactory.ts:18

Properties

`Private` _collaborative

_collaborative: boolean

`Private` _disableDocumentWideUndoRedo

_disableDocumentWideUndoRedo: boolean

Defines if the document can be undo/redo.

`Private` _disposed

_disposed: boolean = false

Accessors

collaborative

get collaborative(): boolean
Whether the model is collaborative or not.

Returns boolean
Implementation of IModelFactory.collaborative
- Defined in packages/notebook/src/modelfactory.ts:61

contentType

get contentType(): string
The content type of the file.

Returns string
Implementation of IModelFactory.contentType
- Defined in packages/notebook/src/modelfactory.ts:47

disableDocumentWideUndoRedo

get disableDocumentWideUndoRedo(): boolean
Experimental Alpha
Define the disableDocumentWideUndoRedo property.

Returns boolean
- Defined in packages/notebook/src/modelfactory.ts:30
set disableDocumentWideUndoRedo(disableDocumentWideUndoRedo): void
Parameters
- disableDocumentWideUndoRedo: boolean
Returns void
- Defined in packages/notebook/src/modelfactory.ts:33

fileFormat

get fileFormat(): FileFormat
The format of the file.

Returns FileFormat
Implementation of IModelFactory.fileFormat
- Defined in packages/notebook/src/modelfactory.ts:54

isDisposed

get isDisposed(): boolean
Get whether the model factory has been disposed.

Returns boolean
Implementation of IModelFactory.isDisposed
- Defined in packages/notebook/src/modelfactory.ts:68

name

get name(): string
The name of the model.

Returns string
Implementation of IModelFactory.name
- Defined in packages/notebook/src/modelfactory.ts:40

Methods

createNew

createNew(options?): INotebookModel
Create a new model for a given path.
Parameters
- options: DocumentRegistry.IModelOptions<ISharedNotebook> = {}
  Model options.
Returns INotebookModel
A new document model.
Implementation of IModelFactory.createNew
- Defined in packages/notebook/src/modelfactory.ts:86

dispose

dispose(): void
Dispose of the model factory.

Returns void
Implementation of IModelFactory.dispose
- Defined in packages/notebook/src/modelfactory.ts:75

preferredLanguage

preferredLanguage(path): string
Get the preferred kernel language given a path.
Parameters
- path: string
Returns string
Implementation of IModelFactory.preferredLanguage
- Defined in packages/notebook/src/modelfactory.ts:100