Class NotebookModel

constructor

• new NotebookModel(options?: NotebookModel.IOptions): NotebookModel

• Construct a new notebook model.

  Parameters

  • options: NotebookModel.IOptions = {}

  Returns NotebookModel

ReadonlysharedModel

cells

• get cells(): CellList

• Get the observable list of notebook cells.

  Returns CellList

collaborative

• get collaborative(): boolean

• Whether the model is collaborative or not.

  Returns boolean

contentChanged

• get contentChanged(): ISignal<this, void>

• A signal emitted when the document content changes.

  Returns ISignal<this, void>

defaultKernelLanguage

• get defaultKernelLanguage(): string

• The default kernel language of the document.

  Returns string

defaultKernelName

• get defaultKernelName(): string

• The default kernel name of the document.

  Returns string

deletedCells

• get deletedCells(): string[]

• A list of deleted cells for the notebook..

  Returns string[]

dirty

• get dirty(): boolean

• The dirty state of the document.

  Returns boolean
• set dirty(newValue: boolean): void

• The dirty state of the model.

  Notes

  This should be cleared when the document is loaded from or saved to disk.

  Parameters

  • newValue: boolean

  Returns void

isDisposed

• get isDisposed(): boolean

• Whether the model is disposed.

  Returns boolean

metadata

• get metadata(): INotebookMetadata

• The metadata associated with the notebook.

  Notes

  This is a copy of the metadata. Changing a part of it won't affect the model. As this returns a copy of all metadata, it is advised to use getMetadata to speed up the process of getting a single key.

  Returns INotebookMetadata

metadataChanged

• get metadataChanged(): ISignal<INotebookModel, IMapChange<any>>

• Signal emitted when notebook metadata changes.

  Returns ISignal<INotebookModel, IMapChange<any>>

nbformat

• get nbformat(): number

• The major version number of the nbformat.

  Returns number

nbformatMinor

• get nbformatMinor(): number

• The minor version number of the nbformat.

  Returns number

readOnly

• get readOnly(): boolean

• The read only state of the document.

  Returns boolean
• set readOnly(newValue: boolean): void

• The read-only state of the model.

  Parameters

  • newValue: boolean

  Returns void

stateChanged

• get stateChanged(): ISignal<this, IChangedArgs<any, any, string>>

• A signal emitted when the document state changes.

  Returns ISignal<this, IChangedArgs<any, any, string>>

deleteMetadata

• deleteMetadata(key: string): void

• Delete a metadata

  Parameters

  • key: string

    Metadata key

  Returns void

dispose

• dispose(): void

• Dispose of the resources held by the model.

  Returns void

fromJSON

• fromJSON(value: INotebookContent): void

• Deserialize the model from JSON.

  Notes

  Should emit a [contentChanged] signal.

  Parameters

  • value: INotebookContent

  Returns void

fromString

• fromString(value: string): void

• Deserialize the model from a string.

  Notes

  Should emit a [contentChanged] signal.

  Parameters

  • value: string

  Returns void

getMetadata

• getMetadata(key: string): any

• Get a metadata

  Notes

  This returns a copy of the key value.

  Parameters

  • key: string

    Metadata key

  Returns any

setMetadata

• setMetadata(key: string, value: any): void

• Set a metadata

  Parameters

  • key: string

    Metadata key
  • value: any

    Metadata value

  Returns void

toJSON

• toJSON(): INotebookContent

• Serialize the model to JSON.

  Returns INotebookContent

toString

• toString(): string

• Serialize the model to a string.

  Returns string