Class CodeCellModel

An implementation of a code cell Model.

Hierarchy

CellModel

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CodeCellModel(cell?: IBaseCell): CodeCellModel

Overwrites CellModel.constructor
- Defined in cells/model.ts:307
Construct a new code cell with optional original cell content.

Parameters
- Optional cell: IBaseCell
Returns CodeCellModel

Properties

Private _executionCount

_executionCount: number

Private _outputs

_outputs: ObservableOutputs

Accessors

contentChanged

get (): ISignal<ICellModel, void>

Inherited from CellModel.contentChanged
- Defined in cells/model.ts:139
A signal emitted when the state of the model changes.

Returns ISignal<ICellModel, void>

executionCount

get (): number
set (newValue: number): void

- Defined in cells/model.ts:336
The execution count of the cell.

Returns number
- Defined in cells/model.ts:339
The execution count of the cell.

Parameters
- newValue: number
Returns void

isDisposed

get (): boolean

Inherited from CellModel.isDisposed
- Defined in cells/model.ts:179
Get whether the model is disposed.

Notes

This is a read-only property.

Returns boolean

metadataChanged

get (): ISignal<ICellModel, IChangedArgs<any>>

Inherited from CellModel.metadataChanged
- Defined in cells/model.ts:153
A signal emitted when a metadata field changes.

Returns ISignal<ICellModel, IChangedArgs<any>>

outputs

get (): ObservableOutputs

- Defined in cells/model.ts:355
The cell outputs.

Notes

This is a read-only property.

Returns ObservableOutputs

source

get (): string
set (newValue: string): void

Inherited from CellModel.source
- Defined in cells/model.ts:160
The input content of the cell.

Returns string
Inherited from CellModel.source
- Defined in cells/model.ts:163
The input content of the cell.

Parameters
- newValue: string
Returns void

stateChanged

get (): ISignal<ICellModel, IChangedArgs<any>>

Inherited from CellModel.stateChanged
- Defined in cells/model.ts:146
A signal emitted when a model state changes.

Returns ISignal<ICellModel, IChangedArgs<any>>

type

get (): "code"

Overwrites CellModel.type
- Defined in cells/model.ts:329
The type of the cell.

Notes

This is a read-only property.

Returns "code"

Methods

dispose

dispose(): void

Implementation of ICodeCellModel.dispose

Overwrites CellModel.dispose
- Defined in cells/model.ts:362
Dispose of the resources held by the model.

Returns void

getMetadata

getMetadata(name: string): IMetadataCursor

Implementation of ICodeCellModel.getMetadata

Inherited from CellModel.getMetadata
- Defined in cells/model.ts:218
Get a metadata cursor for the cell.

Notes

Metadata associated with the nbformat spec are set directly on the model. This method is used to interact with a namespaced set of metadata on the cell.

Parameters
- name: string
Returns IMetadataCursor

listMetadata

listMetadata(): string[]

Implementation of ICodeCellModel.listMetadata

Inherited from CellModel.listMetadata
- Defined in cells/model.ts:241
List the metadata namespace keys for the notebook.

Notes

Metadata associated with the nbformat are not included.

Returns string[]

Protected setCursorData

setCursorData(name: string, newValue: any): void

Inherited from CellModel.setCursorData
- Defined in cells/model.ts:248
Set the cursor data for a given field.

Parameters
- name: string
- newValue: any
Returns void

toJSON

toJSON(): ICodeCell

Implementation of ICodeCellModel.toJSON

Overwrites CellModel.toJSON
- Defined in cells/model.ts:374
Serialize the model to JSON.

Returns ICodeCell

Generated using TypeDoc