Class NotebookModel

An implementation of a notebook Model.

Hierarchy

  • NotebookModel

Implements

Constructors

constructor

Properties

_cells _collaborationEnabled _contentChanged _deletedCells _dirty _ensureMetadata _isDisposed _metadataChanged _onCellsChanged _onMetadataChanged _onStateChanged _readOnly _stateChanged _trans sharedModel standaloneModel

Accessors

cells collaborative contentChanged defaultKernelLanguage defaultKernelName deletedCells dirty isDisposed metadata metadataChanged nbformat nbformatMinor readOnly stateChanged

Methods

deleteMetadata dispose fromJSON fromString getMetadata setMetadata toJSON toString triggerContentChange triggerStateChange

Constructors

constructor

Properties

Private _cells

_cells: any

Private _collaborationEnabled

_collaborationEnabled: any

Private _contentChanged

_contentChanged: any

Private _deletedCells

_deletedCells: any

Private _dirty

_dirty: any

Private _ensureMetadata

_ensureMetadata: any

Make sure we have the required metadata fields.

Private _isDisposed

_isDisposed: any

Private _metadataChanged

_metadataChanged: any

Private _onCellsChanged

_onCellsChanged: any

Handle a change in the cells list.

Private _onMetadataChanged

_onMetadataChanged: any

Private _onStateChanged

_onStateChanged: any

Private _readOnly

_readOnly: any

Private _stateChanged

_stateChanged: any

Private _trans

_trans: any

Readonly sharedModel

sharedModel: ISharedNotebook

The shared notebook model.

Protected standaloneModel

standaloneModel: boolean

Whether the model should disposed the shared model on disposal or not.

Accessors

cells

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): 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

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): void

  • The read-only state of the model.

    Parameters

    • newValue: boolean

    Returns void

stateChanged

Methods

deleteMetadata

  • Delete a metadata

    Parameters

    • key: string

      Metadata key

    Returns void

dispose

  • Dispose of the resources held by the model.

    Returns void

fromJSON

  • Deserialize the model from JSON.

    Notes

    Should emit a [contentChanged] signal.

    Parameters

    Returns void

fromString

  • Deserialize the model from a string.

    Notes

    Should emit a [contentChanged] signal.

    Parameters

    • value: string

    Returns void

getMetadata

  • Get a metadata

    Notes

    This returns a copy of the key value.

    Parameters

    • key: string

      Metadata key

    Returns any

setMetadata

  • Set a metadata

    Parameters

    • key: string

      Metadata key

    • value: any

      Metadata value

    Returns void

toJSON

toString

  • Serialize the model to a string.

    Returns string

Protected triggerContentChange

  • Trigger a content changed signal.

    Returns void

Protected triggerStateChange

  • Trigger a state change signal.

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc