Interface INotebookModel

The definition of a model object for a notebook widget.

interface INotebookModel {
    cells: CellList;
    collaborative?: boolean;
    contentChanged: ISignal<INotebookModel, void>;
    defaultKernelLanguage: string;
    defaultKernelName: string;
    deletedCells: string[];
    dirty: boolean;
    isDisposed: boolean;
    metadata: INotebookMetadata;
    metadataChanged: ISignal<INotebookModel, IMapChange<any>>;
    nbformat: number;
    nbformatMinor: number;
    readOnly: boolean;
    sharedModel: ISharedNotebook;
    stateChanged: ISignal<INotebookModel, IChangedArgs<any, any, string>>;
    deleteMetadata(key: string): void;
    dispose(): void;
    fromJSON(value: ReadonlyPartialJSONValue): void;
    fromString(value: string): void;
    getMetadata(key: string): any;
    setMetadata(key: string, value: any): void;
    toJSON(): PartialJSONValue;
    toString(): string;
}

Hierarchy (View Summary)

Implemented by

Properties

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

Methods

deleteMetadata dispose fromJSON fromString getMetadata setMetadata toJSON toString

Properties

Readonlycells

cells: CellList

The list of cells in the notebook.

Optional Readonlycollaborative

collaborative?: boolean

Whether this document model supports collaboration when the collaborative flag is enabled globally. Defaults to false.

contentChanged

contentChanged: ISignal<INotebookModel, void>

A signal emitted when the document content changes.

ReadonlydefaultKernelLanguage

defaultKernelLanguage: string

The default kernel language of the document.

ReadonlydefaultKernelName

defaultKernelName: string

The default kernel name of the document.

ReadonlydeletedCells

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.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlymetadata

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.

ReadonlymetadataChanged

metadataChanged: ISignal<INotebookModel, IMapChange<any>>

Signal emitted when notebook metadata changes.

Readonlynbformat

nbformat: number

The major version number of the nbformat.

ReadonlynbformatMinor

nbformatMinor: number

The minor version number of the nbformat.

readOnly

readOnly: boolean

The read-only state of the model.

ReadonlysharedModel

sharedModel: ISharedNotebook

Shared model

stateChanged

stateChanged: ISignal<INotebookModel, IChangedArgs<any, any, string>>

A signal emitted when the model state changes.

Methods

deleteMetadata

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

  • Deserialize the model from JSON.

    Notes

    Should emit a [contentChanged] signal.

    Parameters

    • value: ReadonlyPartialJSONValue

    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

toString

  • toString(): string

  • Serialize the model to a string.

    Returns string

Settings

Member Visibility

On This Page

Properties
Methods