Class CellModel`Abstract`

An implementation of the cell model.

Hierarchy (view full)

CodeEditor.Model
- CellModel
  - AttachmentsCellModel
  - CodeCellModel

Implements

ICellModel

Index

Constructors

constructor

new CellModel(options?): CellModel
Parameters
- options: CellModel.IOptions<ISharedCell> = {}
Returns CellModel
Overrides Model.constructor
- Defined in packages/cells/src/model.ts:220

Properties

`Private` _metadataChanged

_metadataChanged: Signal<CellModel, IMapChange<any>> = ...

`Private` _trusted

_trusted: boolean = false

`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
Implementation of ICellModel.id
- Defined in packages/cells/src/model.ts:268

isDisposed

get isDisposed(): boolean
Whether the model is disposed.

Returns boolean
Implementation of ICellModel.isDisposed
Inherited from CodeEditor.Model.isDisposed
- Defined in packages/codeeditor/lib/editor.d.ts:164

metadata

get metadata(): Omit<IBaseCellMetadata, "trusted">
The metadata associated with the cell.

Returns Omit<IBaseCellMetadata, "trusted">
Implementation of ICellModel.metadata
- Defined in packages/cells/src/model.ts:275

metadataChanged

get metadataChanged(): ISignal<ICellModel, IMapChange<any>>
Signal emitted when cell metadata changes.

Returns ISignal<ICellModel, IMapChange<any>>
Implementation of ICellModel.metadataChanged
- Defined in packages/cells/src/model.ts:253

mimeType

get mimeType(): string
A mime type of the model.

Returns string
Implementation of ICellModel.mimeType
Inherited from CodeEditor.Model.mimeType
- Defined in packages/codeeditor/lib/editor.d.ts:159
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
Implementation of ICellModel.mimeType
Inherited from CodeEditor.Model.mimeType
- Defined in packages/codeeditor/lib/editor.d.ts:160

mimeTypeChanged

get mimeTypeChanged(): ISignal<this, IChangedArgs<string, string, string>>
A signal emitted when a mimetype changes.

Returns ISignal<this, IChangedArgs<string, string, string>>
Implementation of ICellModel.mimeTypeChanged
Inherited from CodeEditor.Model.mimeTypeChanged
- Defined in packages/codeeditor/lib/editor.d.ts:151

selections

get selections(): IObservableMap<ITextSelection[]>
Get the selections for the model.

Returns IObservableMap<ITextSelection[]>
Implementation of ICellModel.selections
Inherited from CodeEditor.Model.selections
- Defined in packages/codeeditor/lib/editor.d.ts:155

trusted

get trusted(): boolean
The trusted state of the model.

Returns boolean
Implementation of ICellModel.trusted
- Defined in packages/cells/src/model.ts:282
set trusted(newValue): void
Whether the cell is trusted.
Parameters
- newValue: boolean
Returns void
Implementation of ICellModel.trusted
- Defined in packages/cells/src/model.ts:285

`Abstract` type

get type(): string
The type of cell.

Returns string
Implementation of ICellModel.type
- Defined in packages/cells/src/model.ts:243

Methods

`Private` _onMetadataChanged

_onMetadataChanged(sender, change): void
Parameters
- sender: ISharedCell
- change: IMapChange<any>
Returns void
- Defined in packages/cells/src/model.ts:366

deleteMetadata

deleteMetadata(key): any
Delete a metadata
Parameters
- key: string
  Metadata key
Returns any
Implementation of ICellModel.deleteMetadata
- Defined in packages/cells/src/model.ts:322

dispose

dispose(): void
Dispose of the resources held by the model.

Returns void
Implementation of ICellModel.dispose
Overrides Model.dispose
- Defined in packages/cells/src/model.ts:296

getMetadata

getMetadata(key): any
Get a metadata

Notes
This returns a copy of the key value.
Parameters
- key: string
  Metadata key
Returns any
Implementation of ICellModel.getMetadata
- Defined in packages/cells/src/model.ts:334

`Protected` onGenericChange

onGenericChange(): void
Handle a change to the observable value.

Returns void
- Defined in packages/cells/src/model.ts:362

onTrustedChanged

onTrustedChanged(trusted, args): void
Handle a change to the trusted state.

The default implementation is a no-op.
Parameters
- trusted: CellModel
- args: ObservableValue.IChangedArgs
Returns void
- Defined in packages/cells/src/model.ts:310

setMetadata

setMetadata(key, value): void
Set a metadata
Parameters
- key: string
  Metadata key
- value: any
  Metadata value
Returns void
Implementation of ICellModel.setMetadata
- Defined in packages/cells/src/model.ts:344

toJSON

toJSON(): ICell
Serialize the model to JSON.

Returns ICell
Implementation of ICellModel.toJSON
- Defined in packages/cells/src/model.ts:355