Interface ISharedCodeCell

Implements an API for nbformat.ICodeCell.

Hierarchy

ISharedBaseCell<nbformat.IBaseCellMetadata>
- ISharedCodeCell

Implemented by

YCodeCell

Properties

cell_type

cell_type: "code"

The type of the cell.

`Readonly` changed

changed: ISignal<ISharedCodeCell, CellChange>

The changed signal.

`Readonly` disposed

disposed: ISignal<ISharedCodeCell, void>

A signal emitted when the object is disposed.

executionState

executionState: IExecutionState

The code cell's execution state.

execution_count

execution_count: ExecutionCount

The code cell's prompt number. Will be null if the cell has not been run.

`Readonly` id

id: string

Cell id.

`Readonly` isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly` isStandalone

isStandalone: boolean

Whether the cell is standalone or not.

If the cell is standalone. It cannot be inserted into a YNotebook because the Yjs model is already attached to an anonymous Y.Doc instance.

metadata

metadata: Partial<IBaseCellMetadata>

Cell metadata.

Notes

You should prefer to access and modify the specific key of interest.

`Readonly` metadataChanged

metadataChanged: ISignal<ISharedCodeCell, IMapChange<any>>

Signal triggered when the cell metadata changes.

`Readonly` notebook

notebook: null | ISharedNotebook

The notebook that this cell belongs to.

outputs

outputs: IOutput[]

Cell outputs

source

source: string

Text

Methods

canRedo

canRedo(): boolean
Whether the object can undo changes.

Returns boolean
Inherited from ISharedBaseCell.canRedo
- Defined in src/api.ts:67

canUndo

canUndo(): boolean
Whether the object can redo changes.

Returns boolean
Inherited from ISharedBaseCell.canUndo
- Defined in src/api.ts:62

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

Returns void
Inherited from ISharedBaseCell.clearUndoHistory
- Defined in src/api.ts:72

deleteMetadata

deleteMetadata(key: string): void
Delete a metadata cell.
Parameters
- key: string
  
  The key to delete
Returns void
Inherited from ISharedBaseCell.deleteMetadata
- Defined in src/api.ts:479

dispose

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

Notes

If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior

It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void
Inherited from ISharedBaseCell.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

getId

getId(): string
Get Cell id.

Returns
Cell id.

Returns string
Inherited from ISharedBaseCell.getId
- Defined in src/api.ts:472

getMetadata

getMetadata(): Partial<IBaseCellMetadata>
Returns all metadata associated with the cell.

Returns
Cell's metadata.

Returns Partial<IBaseCellMetadata>
Inherited from ISharedBaseCell.getMetadata
- Defined in src/api.ts:486
getMetadata(key: string): undefined | PartialJSONValue
Returns a metadata associated with the cell.

Returns
Cell's metadata.
Parameters
- key: string
  
  Metadata key to get
Returns undefined | PartialJSONValue
Inherited from ISharedBaseCell.getMetadata
- Defined in src/api.ts:494

getOutputs

getOutputs(): IOutput[]
Execution, display, or stream outputs.

Returns IOutput[]
- Defined in src/api.ts:547

getSource

getSource(): string
Get text.

Returns
Text.

Returns string
Inherited from ISharedBaseCell.getSource
- Defined in src/api.ts:159

redo

redo(): void
Redo an operation.

Returns void
Inherited from ISharedBaseCell.redo
- Defined in src/api.ts:57

setMetadata

setMetadata(metadata: Partial<IBaseCellMetadata>): void
Sets some cell metadata.
Parameters
- metadata: Partial<IBaseCellMetadata>
  
  Cell's metadata.
Returns void
Inherited from ISharedBaseCell.setMetadata
- Defined in src/api.ts:501
setMetadata(metadata: string, value: PartialJSONValue): void
Sets a cell metadata.
Parameters
- metadata: string
  
  Cell's metadata key.
- value: PartialJSONValue
  
  Metadata value
Returns void
Inherited from ISharedBaseCell.setMetadata
- Defined in src/api.ts:509

setOutputs

setOutputs(outputs: IOutput[]): void
Add/Update output.
Parameters
- outputs: IOutput[]
Returns void
- Defined in src/api.ts:552

setSource

setSource(value: string): void
Set text.
Parameters
- value: string
  
  New text.
Returns void
Inherited from ISharedBaseCell.setSource
- Defined in src/api.ts:166

toJSON

toJSON(): IBaseCell
Serialize the model to JSON.

Returns IBaseCell
Overrides ISharedBaseCell.toJSON
- Defined in src/api.ts:572

transact

transact(f: (() => void), undoable?: boolean, origin?: any): void
Perform a transaction. While the function f is called, all changes to the shared document are bundled into a single event.
Parameters
- f: (() => void)
  
  Transaction to execute
  - - (): void
    - Returns void
- Optional undoable: boolean
  
  Whether to track the change in the action history or not (default true)
- Optional origin: any
Returns void
Inherited from ISharedBaseCell.transact
- Defined in src/api.ts:81

undo

undo(): void
Undo an operation.

Returns void
Inherited from ISharedBaseCell.undo
- Defined in src/api.ts:52

updateOutputs

updateOutputs(start: number, end: number, outputs: IOutput[]): void
Replace content from start' to endwithoutputs`.
Parameters
- start: number
- end: number
- outputs: IOutput[]
Returns void
- Defined in src/api.ts:563

updateSource

updateSource(start: number, end: number, value?: string): void
Replace content from start to end with value.
Parameters
- start: number
- end: number
- Optional value: string
Returns void
Inherited from ISharedBaseCell.updateSource
- Defined in src/api.ts:175

Interface ISharedCodeCell

Hierarchy

Implemented by

Index

Properties

Methods

Properties

cell_type

Readonly changed

Readonly disposed

executionState

execution_count

Readonly id

Readonly isDisposed

Notes

Readonly isStandalone

metadata

Notes

Readonly metadataChanged

Readonly notebook

outputs

source

Methods

canRedo

Returns boolean

canUndo

Returns boolean

clearUndoHistory

Returns void

deleteMetadata

Parameters

key: string

Returns void

dispose

Notes

Undefined Behavior

Returns void

getId

Returns

Returns string

getMetadata

Returns

Returns Partial<IBaseCellMetadata>

Returns

Parameters

key: string

Returns undefined | PartialJSONValue

getOutputs

Returns IOutput[]

getSource

Returns

Returns string

redo

Returns void

setMetadata

Parameters

metadata: Partial<IBaseCellMetadata>

Returns void

Parameters

metadata: string

value: PartialJSONValue

Returns void

setOutputs

Parameters

outputs: IOutput[]

Returns void

setSource

Parameters

value: string

Returns void

toJSON

Returns IBaseCell

transact

Parameters

f: (() => void)

Returns void

Optional undoable: boolean

Optional origin: any

Returns void

undo

`Readonly` changed

`Readonly` disposed

`Readonly` id

`Readonly` isDisposed

`Readonly` isStandalone

`Readonly` metadataChanged

`Readonly` notebook

`Optional` undoable: boolean

`Optional` origin: any

`Optional` value: string