Class CodeCellModel

An implementation of a code cell Model.

Hierarchy (View Summary)

CellModel
- CodeCellModel

Implements

ICodeCellModel

Index

Constructors

constructor

new CodeCellModel(options?: CodeCellModel.IOptions): CodeCellModel
Construct a new code cell with optional original cell content.
Parameters
- options: CodeCellModel.IOptions = {}
Returns CodeCellModel
Overrides CellModel.constructor
- Defined in packages/cells/src/model.ts:616

Properties

`Readonly`contentChanged

contentChanged: Signal<CodeCellModel, void> = ...

A signal emitted when the state of the model changes.

`Readonly`sharedModel

sharedModel: ISharedCodeCell

The code cell shared model

`Protected`standaloneModel

standaloneModel: boolean

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

`Readonly`stateChanged

stateChanged: Signal<
    CodeCellModel,
    IChangedArgs<
        any,
        any,
        "trusted"
        | "isDirty"
        | "executionCount"
        | "executionState",
    >,
> = ...

A signal emitted when a model state changes.

Accessors

executionCount

get executionCount(): ExecutionCount
The execution count of the cell.

Returns ExecutionCount
Implementation of ICodeCellModel.executionCount
- Defined in packages/cells/src/model.ts:643
set executionCount(newValue: ExecutionCount): void
The code cell's prompt number. Will be null if the cell has not been run.
Parameters
- newValue: ExecutionCount
Returns void
Implementation of ICodeCellModel.executionCount
- Defined in packages/cells/src/model.ts:646

executionState

get executionState(): IExecutionState
The execution state of the cell.

Returns IExecutionState
Implementation of ICodeCellModel.executionState
- Defined in packages/cells/src/model.ts:653
set executionState(newValue: IExecutionState): void
The code cell's state.
Parameters
- newValue: IExecutionState
Returns void
Implementation of ICodeCellModel.executionState
- Defined in packages/cells/src/model.ts:656

id

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

Returns string
Implementation of ICodeCellModel.id
Inherited from CellModel.id
- Defined in packages/cells/src/model.ts:278

isDirty

get isDirty(): boolean
Whether the cell is dirty or not.

A cell is dirty if it is output is not empty and does not result of the input code execution.

Returns boolean
Implementation of ICodeCellModel.isDirty
- Defined in packages/cells/src/model.ts:666
set isDirty(dirty: boolean): void
Public Set whether the cell is dirty or not.
Parameters
- dirty: boolean
Returns void
Implementation of ICodeCellModel.isDirty
- Defined in packages/cells/src/model.ts:675

isDisposed

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

Returns boolean
Implementation of ICodeCellModel.isDisposed
Inherited from CellModel.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 ICodeCellModel.metadata
Inherited from CellModel.metadata
- Defined in packages/cells/src/model.ts:285

metadataChanged

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

Returns ISignal<ICellModel, IMapChange<any>>
Implementation of ICodeCellModel.metadataChanged
Inherited from CellModel.metadataChanged
- Defined in packages/cells/src/model.ts:259

mimeType

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

Returns string
Implementation of ICodeCellModel.mimeType
Inherited from CellModel.mimeType
- Defined in packages/codeeditor/lib/editor.d.ts:159
set mimeType(newValue: string): 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 ICodeCellModel.mimeType
Inherited from CellModel.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 ICodeCellModel.mimeTypeChanged
Inherited from CellModel.mimeTypeChanged
- Defined in packages/codeeditor/lib/editor.d.ts:151

outputs

get outputs(): IOutputAreaModel
The cell outputs.

Returns IOutputAreaModel
Implementation of ICodeCellModel.outputs
- Defined in packages/cells/src/model.ts:682

selections

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

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

trusted

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

Returns boolean
Implementation of ICodeCellModel.trusted
Inherited from CellModel.trusted
- Defined in packages/cells/src/model.ts:292
set trusted(newValue: boolean): void
Whether the cell is trusted.
Parameters
- newValue: boolean
Returns void
Implementation of ICodeCellModel.trusted
Inherited from CellModel.trusted
- Defined in packages/cells/src/model.ts:295

type

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

Returns "code"
Implementation of ICodeCellModel.type
Overrides CellModel.type
- Defined in packages/cells/src/model.ts:636

Methods

clearExecution

clearExecution(): void
Clear execution, outputs, and related metadata

Returns void
Implementation of ICodeCellModel.clearExecution
- Defined in packages/cells/src/model.ts:688

deleteMetadata

deleteMetadata(key: string): any
Delete a metadata
Parameters
- key: string
  Metadata key
Returns any
Implementation of ICodeCellModel.deleteMetadata
Inherited from CellModel.deleteMetadata
- Defined in packages/cells/src/model.ts:332

dispose

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

Returns void
Implementation of ICodeCellModel.dispose
Overrides CellModel.dispose
- Defined in packages/cells/src/model.ts:701

getMetadata

getMetadata(key: string): any
Get a metadata

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

`Protected`onGenericChange

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

Returns void
Inherited from CellModel.onGenericChange
- Defined in packages/cells/src/model.ts:372

`Protected`onOutputsChange

onOutputsChange(
sender: IOutputAreaModel,
event: IOutputAreaModel.ChangedArgs,
): void
Handle a change to the cell outputs modelDB and reflect it in the shared model.
Parameters
- sender: IOutputAreaModel
- event: IOutputAreaModel.ChangedArgs
Returns void
- Defined in packages/cells/src/model.ts:747

onTrustedChanged

onTrustedChanged(trusted: CellModel, args: ObservableValue.IChangedArgs): void
Handle a change to the trusted state.
Parameters
- trusted: CellModel
- args: ObservableValue.IChangedArgs
Returns void
Overrides CellModel.onTrustedChanged
- Defined in packages/cells/src/model.ts:716

setMetadata

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

toJSON

toJSON(): ICodeCell
Serialize the model to JSON.

Returns ICodeCell
Implementation of ICodeCellModel.toJSON
Overrides CellModel.toJSON
- Defined in packages/cells/src/model.ts:740

Class CodeCellModel

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CodeCellModel

Properties

ReadonlycontentChanged

ReadonlysharedModel

ProtectedstandaloneModel

ReadonlystateChanged

Accessors

executionCount

Returns ExecutionCount

Parameters

Returns void

executionState

Returns IExecutionState

Parameters

Returns void

id

Returns string

isDirty

Returns boolean

Parameters

Returns void

isDisposed

Returns boolean

metadata

Returns Omit<IBaseCellMetadata, "trusted">

metadataChanged

Returns ISignal<ICellModel, IMapChange<any>>

mimeType

Returns string

Notes

Parameters

Returns void

mimeTypeChanged

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

outputs

Returns IOutputAreaModel

selections

Returns IObservableMap<ITextSelection[]>

trusted

Returns boolean

Parameters

Returns void

type

Returns "code"

Methods

clearExecution

Returns void

deleteMetadata

Parameters

Returns any

dispose

Returns void

getMetadata

Notes

Parameters

Returns any

ProtectedonGenericChange

Returns void

ProtectedonOutputsChange

Parameters

Returns void

onTrustedChanged

Parameters

Returns void

setMetadata

Parameters

Returns void

toJSON

Returns ICodeCell

`Readonly`contentChanged

`Readonly`sharedModel

`Protected`standaloneModel

`Readonly`stateChanged

`Protected`onGenericChange

`Protected`onOutputsChange