Class CellModelAbstract

An implementation of the cell model.

Hierarchy

Implements

Constructors

constructor

Properties

_metadataChanged _onMetadataChanged _trusted contentChanged sharedModel standaloneModel stateChanged

Accessors

id isDisposed metadata metadataChanged mimeType mimeTypeChanged selections trusted type

Methods

deleteMetadata dispose getMetadata onGenericChange onTrustedChanged setMetadata toJSON

Constructors

constructor

Properties

Private _metadataChanged

_metadataChanged: any

Private _onMetadataChanged

_onMetadataChanged: any

Private _trusted

_trusted: any

Readonly contentChanged

contentChanged: Signal<CellModel, void>

A signal emitted when the state of the model changes.

Readonly sharedModel

sharedModel: ISharedCell

The cell shared model.

Protected standaloneModel

standaloneModel: boolean

Whether the model should disposed the shared model on disposal or not.

Readonly stateChanged

stateChanged: Signal<CellModel, IChangedArgs<any, any, "trusted" | "isDirty" | "executionCount">>

A signal emitted when a model state changes.

Accessors

id

  • get id(): string

  • The id for the cell.

    Returns string

isDisposed

  • get isDisposed(): boolean

  • Whether the model is disposed.

    Returns boolean

metadata

metadataChanged

mimeType

  • get mimeType(): string

  • A mime type of the model.

    Returns string

  • set mimeType(newValue): void

  • A mime type of the model.

    Notes

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

    Parameters

    • newValue: string

    Returns void

mimeTypeChanged

  • get mimeTypeChanged(): ISignal<this, IChangedArgs<string, string, string>>

  • A signal emitted when a mimetype changes.

    Returns ISignal<this, IChangedArgs<string, string, string>>

selections

  • get selections(): IObservableMap<ITextSelection[]>

  • Get the selections for the model.

    Returns IObservableMap<ITextSelection[]>

trusted

  • get trusted(): boolean

  • The trusted state of the model.

    Returns boolean

  • set trusted(newValue): void

  • Whether the cell is trusted.

    Parameters

    • newValue: boolean

    Returns void

Abstract type

  • get type(): string

  • The type of cell.

    Returns string

Methods

deleteMetadata

  • Delete a metadata

    Parameters

    • key: string

      Metadata key

    Returns any

dispose

  • Dispose of the resources held by the model.

    Returns void

getMetadata

  • Get a metadata

    Notes

    This returns a copy of the key value.

    Parameters

    • key: string

      Metadata key

    Returns any

Protected onGenericChange

  • Handle a change to the observable value.

    Returns void

onTrustedChanged

  • Handle a change to the trusted state.

    The default implementation is a no-op.

    Parameters

    Returns void

setMetadata

  • Set a metadata

    Parameters

    • key: string

      Metadata key

    • value: any

      Metadata value

    Returns void

toJSON

  • Serialize the model to JSON.

    Returns ICell

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc