Interface ICodeCellModel

The definition of a code cell.

interface ICodeCellModel {
    contentChanged: ISignal<ICellModel, void>;
    executionCount: ExecutionCount;
    executionState: IExecutionState;
    id: string;
    isDirty: boolean;
    isDisposed: boolean;
    metadata: Omit<IBaseCellMetadata, "trusted">;
    metadataChanged: ISignal<ICellModel, IMapChange<any>>;
    mimeType: string;
    mimeTypeChanged: ISignal<
        CodeEditor.IModel,
        IChangedArgs<string, string, string>,
    >;
    outputs: IOutputAreaModel;
    selections: IObservableMap<ITextSelection[]>;
    sharedModel: ISharedCodeCell;
    stateChanged: ISignal<ICellModel, IChangedArgs<boolean, boolean, any>>;
    trusted: boolean;
    type: "code";
    clearExecution(): void;
    deleteMetadata(key: string): void;
    dispose(): void;
    getMetadata(key: string): any;
    setMetadata(key: string, value: any): void;
    toJSON(): ICodeCell;
}

Hierarchy (View Summary)

Implemented by

Properties

contentChanged executionCount executionState id isDirty isDisposed metadata metadataChanged mimeType mimeTypeChanged outputs selections sharedModel stateChanged trusted type

Methods

clearExecution deleteMetadata dispose getMetadata setMetadata toJSON

Properties

ReadonlycontentChanged

contentChanged: ISignal<ICellModel, void>

A signal emitted when the content of the model changes.

executionCount

executionCount: ExecutionCount

The code cell's prompt number. Will be null if the cell has not been run.

executionState

executionState: IExecutionState

The code cell's state.

Readonlyid

id: string

A unique identifier for the cell.

ReadonlyisDirty

isDirty: boolean

Whether the code cell has been edited since the last run.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlymetadata

metadata: Omit<IBaseCellMetadata, "trusted">

The metadata associated with the cell.

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<ICellModel, IMapChange<any>>

Signal emitted when cell metadata changes.

mimeType

mimeType: string

A mime type of the model.

Notes

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

mimeTypeChanged

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

A signal emitted when a property changes.

Readonlyoutputs

outputs: IOutputAreaModel

The cell outputs.

Readonlyselections

selections: IObservableMap<ITextSelection[]>

The currently selected code.

ReadonlysharedModel

sharedModel: ISharedCodeCell

The code cell shared model

ReadonlystateChanged

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

A signal emitted when a model state changes.

trusted

trusted: boolean

Whether the cell is trusted.

Readonlytype

type: "code"

The type of the cell.

Notes

This is a read-only property.

Methods

clearExecution

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

getMetadata

setMetadata

toJSON

Settings

Member Visibility

On This Page

Properties
Methods