Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface INotebookModel

The definition of a model object for a notebook widget.

Hierarchy

Implemented by

Index

Properties

cells

The list of cells in the notebook.

contentChanged

contentChanged: ISignal<this, void>

A signal emitted when the document content changes.

contentFactory

contentFactory: IContentFactory

The cell model factory for the notebook.

defaultKernelLanguage

defaultKernelLanguage: string

The default kernel language of the document.

defaultKernelName

defaultKernelName: string

The default kernel name of the document.

deletedCells

deletedCells: string[]

The array of deleted cells since the notebook was last run.

dirty

dirty: boolean

The dirty state of the model.

Notes

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

isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

metadata

metadata: IObservableJSON

The metadata associated with the notebook.

modelDB

modelDB: IModelDB

The underlying IModelDB instance in which model data is stored.

Notes

Making direct edits to the values stored in theIModelDB is not recommended, and may produce unpredictable results.

nbformat

nbformat: number

The major version number of the nbformat.

nbformatMinor

nbformatMinor: number

The minor version number of the nbformat.

readOnly

readOnly: boolean

The read-only state of the model.

stateChanged

stateChanged: ISignal<this, IChangedArgsGeneric<any>>

A signal emitted when the model state changes.

Methods

dispose

  • dispose(): void
  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

fromJSON

  • fromJSON(value: ReadonlyPartialJSONValue): void

fromString

  • fromString(value: string): void

initialize

  • initialize(): void

toJSON

  • toJSON(): PartialJSONValue

toString

  • toString(): string

Generated using TypeDoc