Class AttachmentsCellModel

A base implementation for cell models with attachments.

Hierarchy

CellModel
- AttachmentsCellModel
  - RawCellModel
  - MarkdownCellModel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AttachmentsCellModel(options: IOptions): AttachmentsCellModel

Inherited from CellModel.constructor
- Defined in packages/cells/lib/model.d.ts:183
Construct a new cell with optional attachments.

Parameters
- options: IOptions
Returns AttachmentsCellModel

Properties

Private _attachments

_attachments: any

Readonly contentChanged

contentChanged: Signal<this, void>

A signal emitted when the state of the model changes.

Readonly id

id: string

The id for the cell.

Readonly modelDB

modelDB: IModelDB

The underlying IModelDB instance in which model data is stored.

Readonly stateChanged

stateChanged: Signal<this, IChangedArgs<any, any, string>>

A signal emitted when a model state changes.

Accessors

attachments

get attachments(): IAttachmentsModel

- Defined in packages/cells/lib/model.d.ts:191
Get the attachments of the model.

Returns IAttachmentsModel

isDisposed

get isDisposed(): boolean

- Defined in packages/codeeditor/lib/editor.d.ts:197
Whether the model is disposed.

Returns boolean

metadata

get metadata(): IObservableJSON

- Defined in packages/cells/lib/model.d.ts:134
The metadata associated with the cell.

Returns IObservableJSON

mimeType

get mimeType(): string
set mimeType(newValue: string): any

- Defined in packages/codeeditor/lib/editor.d.ts:192
A mime type of the model.

Returns string
- Defined in packages/codeeditor/lib/editor.d.ts:193
A mime type of the model.

Parameters
- newValue: string
Returns any

mimeTypeChanged

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

- Defined in packages/codeeditor/lib/editor.d.ts:180
A signal emitted when a mimetype changes.

Returns ISignal<this, IChangedArgs<string>>

selections

get selections(): IObservableMap<ITextSelection[]>

- Defined in packages/codeeditor/lib/editor.d.ts:188
Get the selections for the model.

Returns IObservableMap<ITextSelection[]>

trusted

get trusted(): boolean
set trusted(newValue: boolean): any

- Defined in packages/cells/lib/model.d.ts:138
Get the trusted state of the model.

Returns boolean
- Defined in packages/cells/lib/model.d.ts:142
Set the trusted state of the model.

Parameters
- newValue: boolean
Returns any

type

get type(): nbformat.CellType

- Defined in packages/cells/lib/model.d.ts:118
The type of cell.

Returns nbformat.CellType

value

get value(): IObservableString

- Defined in packages/codeeditor/lib/editor.d.ts:184
Get the value of the model.

Returns IObservableString

Methods

dispose

dispose(): void

Inherited from CellModel.dispose
- Defined in packages/codeeditor/lib/editor.d.ts:201
Dispose of the resources used by the model.

Returns void

Protected onGenericChange

onGenericChange(): void

Inherited from CellModel.onGenericChange
- Defined in packages/cells/lib/model.d.ts:156
Handle a change to the observable value.

Returns void

onTrustedChanged

onTrustedChanged(trusted: IObservableValue, args: IChangedArgs): void

Inherited from CellModel.onTrustedChanged
- Defined in packages/cells/lib/model.d.ts:152
Handle a change to the trusted state.

The default implementation is a no-op.

Parameters
- trusted: IObservableValue
- args: IChangedArgs
Returns void

toJSON

toJSON(): nbformat.IRawCell | nbformat.IMarkdownCell

Overrides CellModel.toJSON
- Defined in packages/cells/lib/model.d.ts:195
Serialize the model to JSON.

Returns nbformat.IRawCell | nbformat.IMarkdownCell

Generated using TypeDoc