Class CellModel

An implementation of the cell model.

Hierarchy

CellModel

Implements

ICellModel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CellModel(cell?: IBaseCell): CellModel

- Defined in cells/model.ts:116
Construct a cell model from optional cell content.

Parameters
- Optional cell: IBaseCell
Returns CellModel

Properties

Private _cursors

_cursors: object

Type declaration

[key: string]: MetadataCursor

Private _metadata

_metadata: object

Type declaration

[key: string]: any

Private _source

_source: string

type

The type of cell.

Accessors

contentChanged

get (): ISignal<ICellModel, void>

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

Returns ISignal<ICellModel, void>

isDisposed

get (): boolean

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

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

Returns ISignal<ICellModel, IChangedArgs<any>>

source

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

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

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

Parameters
- newValue: string
Returns void

stateChanged

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

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

Returns ISignal<ICellModel, IChangedArgs<any>>

Methods

dispose

dispose(): void

Implementation of ICellModel.dispose
- Defined in cells/model.ts:186
Dispose of the resources held by the model.

Returns void

getMetadata

getMetadata(name: string): IMetadataCursor

Implementation of ICellModel.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 ICellModel.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

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

Parameters
- name: string
- newValue: any
Returns void

toJSON

toJSON(): IBaseCell

Implementation of ICellModel.toJSON
- Defined in cells/model.ts:202
Serialize the model to JSON.

Returns IBaseCell

Generated using TypeDoc