Class CodeCellModel

An implementation of a code cell Model.

Hierarchy

CellModel
- CodeCellModel

Implements

ICodeCellModel

Index

Constructors

constructor

new CodeCellModel(options?): CodeCellModel
Construct a new code cell with optional original cell content.
Parameters
- Optional options: CodeCellModel.IOptions
Returns CodeCellModel
Overrides CellModel.constructor
- Defined in packages/cells/lib/model.d.ts:364

Properties

`Private` _executedCode

_executedCode: any

`Private` _isDirty

_isDirty: any

`Private` _onSharedModelChanged

_onSharedModelChanged: any

Handle a change to the code cell value.

`Private` _outputs

_outputs: any

`Private` _setDirty

_setDirty: any

Set whether the cell is dirty or not.

`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">>

A signal emitted when a model state changes.

Accessors

executionCount

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

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

id

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

Returns string
Implementation of ICodeCellModel.id

Inherited from CellModel.id
- Defined in packages/cells/lib/model.d.ts:177

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/lib/model.d.ts:380

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/lib/model.d.ts:181

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/lib/model.d.ts:169

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): 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/lib/model.d.ts:384

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/lib/model.d.ts:185
set trusted(newValue): void
Whether the cell is trusted.
Parameters
- newValue: boolean
Returns void
Implementation of ICodeCellModel.trusted

Inherited from CellModel.trusted
- Defined in packages/cells/lib/model.d.ts:186

type

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

Returns "code"
Implementation of ICodeCellModel.type

Overrides CellModel.type
- Defined in packages/cells/lib/model.d.ts:368

Methods

clearExecution

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

Returns void
Implementation of ICodeCellModel.clearExecution
- Defined in packages/cells/lib/model.d.ts:386

deleteMetadata

deleteMetadata(key): any
Delete a metadata
Parameters
- key: string
  
  Metadata key
Returns any
Implementation of ICodeCellModel.deleteMetadata

Inherited from CellModel.deleteMetadata
- Defined in packages/cells/lib/model.d.ts:202

dispose

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

Returns void
Implementation of ICodeCellModel.dispose

Overrides CellModel.dispose
- Defined in packages/cells/lib/model.d.ts:390

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 ICodeCellModel.getMetadata

Inherited from CellModel.getMetadata
- Defined in packages/cells/lib/model.d.ts:211

`Protected` onGenericChange

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

Returns void
Inherited from CellModel.onGenericChange
- Defined in packages/cells/lib/model.d.ts:226

`Protected` onOutputsChange

onOutputsChange(sender, event): 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/lib/model.d.ts:402

onTrustedChanged

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

setMetadata

setMetadata(key, value): 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/lib/model.d.ts:218

toJSON

toJSON(): ICodeCell
Serialize the model to JSON.

Returns ICodeCell
Implementation of ICodeCellModel.toJSON

Overrides CellModel.toJSON
- Defined in packages/cells/lib/model.d.ts:398

Class CodeCellModel

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: CodeCellModel.IOptions

Returns CodeCellModel

Properties

Private _executedCode

Private _isDirty

Private _onSharedModelChanged

Private _outputs

Private _setDirty

Readonly contentChanged

Readonly sharedModel

Protected standaloneModel

Readonly stateChanged

Accessors

executionCount

Returns number

Parameters

newValue: number

Returns void

id

Returns string

isDirty

Returns boolean

isDisposed

Returns boolean

metadata

Returns Omit<IBaseCellMetadata, "trusted">

metadataChanged

Returns ISignal<ICellModel, IMapChange<any>>

mimeType

Returns string

Notes

Parameters

newValue: string

Returns void

mimeTypeChanged

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

outputs

Returns IOutputAreaModel

selections

Returns IObservableMap<ITextSelection[]>

trusted

Returns boolean

Parameters

newValue: boolean

Returns void

type

Returns "code"

Methods

clearExecution

Returns void

deleteMetadata

Parameters

key: string

Returns any

dispose

Returns void

getMetadata

Notes

Parameters

key: string

Returns any

Protected onGenericChange

Returns void

Protected onOutputsChange

Parameters

sender: IOutputAreaModel

event: IOutputAreaModel.ChangedArgs

Returns void

onTrustedChanged

`Optional` options: CodeCellModel.IOptions

`Private` _executedCode

`Private` _isDirty

`Private` _onSharedModelChanged

`Private` _outputs

`Private` _setDirty

`Readonly` contentChanged

`Readonly` sharedModel

`Protected` standaloneModel

`Readonly` stateChanged

`Protected` onGenericChange

`Protected` onOutputsChange