Interface IModel

The interface for a document model.

interface IModel {
    collaborative?: boolean;
    contentChanged: ISignal<DocumentRegistry.IModel, void>;
    defaultKernelLanguage: string;
    defaultKernelName: string;
    dirty: boolean;
    isDisposed: boolean;
    readOnly: boolean;
    sharedModel: ISharedDocument;
    stateChanged: ISignal<
        DocumentRegistry.IModel,
        IChangedArgs<any, any, string>,
    >;
    dispose(): void;
    fromJSON(value: ReadonlyPartialJSONValue): void;
    fromString(value: string): void;
    toJSON(): PartialJSONValue;
    toString(): string;
}

Hierarchy (View Summary)

Properties

collaborative? contentChanged defaultKernelLanguage defaultKernelName dirty isDisposed readOnly sharedModel stateChanged

Methods

dispose fromJSON fromString toJSON toString

Properties

Optional Readonlycollaborative

collaborative?: boolean

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

contentChanged

contentChanged: ISignal<DocumentRegistry.IModel, 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.

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.

readOnly

readOnly: boolean

The read-only state of the model.

ReadonlysharedModel

sharedModel: ISharedDocument

The shared notebook model.

stateChanged

stateChanged: ISignal<DocumentRegistry.IModel, IChangedArgs<any, any, string>>

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

  • Deserialize the model from JSON.

    Notes

    Should emit a [contentChanged] signal.

    Parameters

    • value: ReadonlyPartialJSONValue

    Returns void

fromString

toJSON

toString

Settings

Member Visibility

On This Page

Properties
Methods