Interface IMarkdownCellModel

The definition of a markdown cell.

interface IMarkdownCellModel {
    attachments: IAttachmentsModel;
    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: "markdown";
    deleteMetadata(key): void;
    dispose(): void;
    getMetadata(key): any;
    setMetadata(key, value): void;
    toJSON(): IMarkdownCell;
}

Hierarchy (view full)

Properties

attachments contentChanged id isDisposed metadata metadataChanged mimeType mimeTypeChanged selections sharedModel stateChanged trusted type

Methods

deleteMetadata dispose getMetadata setMetadata toJSON

Properties

Readonly attachments

attachments: IAttachmentsModel

The cell attachments

Readonly contentChanged

contentChanged: ISignal<ICellModel, void>

A signal emitted when the content of the model changes.

Readonly id

id: string

A unique identifier for the cell.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly metadata

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.

Readonly metadataChanged

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.

Readonly selections

selections: IObservableMap<ITextSelection[]>

The currently selected code.

Readonly sharedModel

sharedModel: ISharedCell

The cell shared model.

Readonly stateChanged

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

A signal emitted when a model state changes.

trusted

trusted: boolean

Whether the cell is trusted.

Readonly type

type: "markdown"

The type of the cell.

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

getMetadata

setMetadata

toJSON

Settings

Member Visibility

Theme

On This Page

attachmentscontentChangedidisDisposedmetadatametadataChangedmimeTypemimeTypeChangedselectionssharedModelstateChangedtrustedtypedeleteMetadatadisposegetMetadatasetMetadatatoJSON