Class MarkdownCellModel

An implementation of a markdown cell model.

Hierarchy (view full)

AttachmentsCellModel
- MarkdownCellModel

Index

Constructors

Properties

contentChanged sharedModel standaloneModel stateChanged

Accessors

attachments id isDisposed metadata metadataChanged mimeType mimeTypeChanged selections trusted type

Methods

deleteMetadata dispose getMetadata onGenericChange onTrustedChanged setMetadata toJSON

Constructors

constructor

new MarkdownCellModel(options?): MarkdownCellModel
Construct a markdown cell model from optional shared model.
Parameters
- options: Omit<AttachmentsCellModel.IOptions<ISharedMarkdownCell>, "cell_type"> = {}
Returns MarkdownCellModel
Overrides AttachmentsCellModel.constructor
- Defined in packages/cells/src/model.ts:570

Properties

`Readonly` contentChanged

contentChanged: Signal<MarkdownCellModel, 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<MarkdownCellModel, IChangedArgs<any, any, "trusted" | "isDirty" | "executionCount">> = ...

A signal emitted when a model state changes.

Accessors

attachments

get attachments(): IAttachmentsModel
Get the attachments of the model.

Returns IAttachmentsModel
Inherited from AttachmentsCellModel.attachments
- Defined in packages/cells/src/model.ts:428

id

get id(): string
The id for the cell.

Returns string
Inherited from AttachmentsCellModel.id
- Defined in packages/cells/src/model.ts:268

isDisposed

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

Returns boolean
Inherited from AttachmentsCellModel.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">
Inherited from AttachmentsCellModel.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>>
Inherited from AttachmentsCellModel.metadataChanged
- Defined in packages/cells/src/model.ts:253

mimeType

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

Returns string
Inherited from AttachmentsCellModel.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
Inherited from AttachmentsCellModel.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>>
Inherited from AttachmentsCellModel.mimeTypeChanged
- Defined in packages/codeeditor/lib/editor.d.ts:151

selections

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

Returns IObservableMap<ITextSelection[]>
Inherited from AttachmentsCellModel.selections
- Defined in packages/codeeditor/lib/editor.d.ts:155

trusted

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

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

type

get type(): "markdown"
The type of the cell.

Returns "markdown"
Overrides AttachmentsCellModel.type
- Defined in packages/cells/src/model.ts:587

Methods

deleteMetadata

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

dispose

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

Returns void
Inherited from AttachmentsCellModel.dispose
- Defined in packages/cells/src/model.ts:435

getMetadata

getMetadata(key): any
Get a metadata

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

`Protected` onGenericChange

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

Returns void
Inherited from AttachmentsCellModel.onGenericChange
- 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
Inherited from AttachmentsCellModel.onTrustedChanged
- 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
Inherited from AttachmentsCellModel.setMetadata
- Defined in packages/cells/src/model.ts:344

toJSON

toJSON(): IMarkdownCell
Serialize the model to JSON.

Returns IMarkdownCell
Overrides AttachmentsCellModel.toJSON
- Defined in packages/cells/src/model.ts:594