Interface ICellModel

The definition of a model object for a cell.

interface ICellModel {
    contentChanged: ISignal<ICellModel, void>;
    id: string;
    isDisposed: boolean;
    metadata: Omit<IBaseCellMetadata, "trusted">;
    metadataChanged: ISignal<ICellModel, IMapChange<any>>;
    mimeType: string;
    mimeTypeChanged: ISignal<CodeEditor.IModel, IChangedArgs<string, string, string>>;
    selections: IObservableMap<ITextSelection[]>;
    sharedModel: ISharedCell;
    stateChanged: ISignal<ICellModel, IChangedArgs<boolean, boolean, any>>;
    trusted: boolean;
    type: string;
    deleteMetadata(key): void;
    dispose(): void;
    getMetadata(key): any;
    setMetadata(key, value): void;
    toJSON(): ICell;

Hierarchy (view full)

Implemented by


contentChanged: ISignal<ICellModel, void>

A signal emitted when the content of the model changes.

id: string

A unique identifier for the cell.

isDisposed: boolean

Test whether the object has been disposed.


This property is always safe to access.

metadata: Omit<IBaseCellMetadata, "trusted">

The metadata associated with the cell.


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.

metadataChanged: ISignal<ICellModel, IMapChange<any>>

Signal emitted when cell metadata changes.

mimeType: string

A mime type of the model.


It is never null, the default mime type is text/plain.

mimeTypeChanged: ISignal<CodeEditor.IModel, IChangedArgs<string, string, string>>

A signal emitted when a property changes.

The currently selected code.

sharedModel: ISharedCell

The cell shared model.

stateChanged: ISignal<ICellModel, IChangedArgs<boolean, boolean, any>>

A signal emitted when a model state changes.

trusted: boolean

Whether the cell is trusted.

type: string

The type of the cell.


  • Dispose of the resources held by the object.


    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

  • Set a metadata


    • key: string

      Metadata key

    • value: any

      Metadata value

    Returns void