Class YCodeCell

Shareable code cell.

Hierarchy

YBaseCell<nbformat.IBaseCellMetadata>
- YCodeCell

Implements

ISharedCodeCell

Constructors

constructor

new YCodeCell(ymodel: YMap<any>, ysource: YText, youtputs: YArray<any>, options?: SharedCell.IOptions, ymetadata?: YMap<any>): YCodeCell
Code cell constructor

Notes

Don't use the constructor directly - prefer using YNotebook.insertCell

The ysource is needed because ymodel.get('source') will not return the real source if the model is not yet attached to a document. Requesting it explicitly allows to introspect a non-empty source before the cell is attached to the document.
Parameters
- ymodel: YMap<any>
  
  Cell map
- ysource: YText
  
  Cell source
- youtputs: YArray<any>
  
  Code cell outputs
- options: SharedCell.IOptions = {}
  
  { notebook?: The notebook the cell is attached to }
- Optional ymetadata: YMap<any>
  
  Cell metadata
Returns YCodeCell
Overrides YBaseCell.constructor
- Defined in src/ycell.ts:717

Properties

`Protected` _metadataChanged

_metadataChanged: Signal<YCodeCell, IMapChange<any>> = ...

`Protected` _notebook

_notebook: null | YNotebook = null

The notebook that this cell belongs to.

`Private` _youtputs

_youtputs: YArray<YMap<any>>

`Readonly` ymodel

ymodel: YMap<any>

Accessors

awareness

get awareness(): null | Awareness
Cell notebook awareness or null if the cell is standalone.

Returns null | Awareness
Inherited from YBaseCell.awareness
- Defined in src/ycell.ts:192

cell_type

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

Returns "code"
Implementation of ISharedCodeCell.cell_type

Overrides YBaseCell.cell_type
- Defined in src/ycell.ts:731

changed

get changed(): ISignal<this, CellChange>
The changed signal.

Returns ISignal<this, CellChange>
Implementation of ISharedCodeCell.changed

Inherited from YBaseCell.changed
- Defined in src/ycell.ts:206

disposed

get disposed(): ISignal<this, void>
Signal emitted when the cell is disposed.

Returns ISignal<this, void>
Implementation of ISharedCodeCell.disposed

Inherited from YBaseCell.disposed
- Defined in src/ycell.ts:213

executionState

get executionState(): IExecutionState
The code cell's execution state.

Returns IExecutionState
Implementation of ISharedCodeCell.executionState
- Defined in src/ycell.ts:756
set executionState(state: IExecutionState): void
The code cell's execution state.
Parameters
- state: IExecutionState
Returns void
Implementation of ISharedCodeCell.executionState
- Defined in src/ycell.ts:759

execution_count

get execution_count(): null | number
The code cell's prompt number. Will be null if the cell has not been run.

Returns null | number
Implementation of ISharedCodeCell.execution_count
- Defined in src/ycell.ts:738
set execution_count(count: null | number): void
The code cell's prompt number. Will be null if the cell has not been run.
Parameters
- count: null | number
Returns void
Implementation of ISharedCodeCell.execution_count
- Defined in src/ycell.ts:741

id

get id(): string
Cell id

Returns string
Implementation of ISharedCodeCell.id

Inherited from YBaseCell.id
- Defined in src/ycell.ts:220

isDisposed

get isDisposed(): boolean
Whether the model has been disposed or not.

Returns boolean
Implementation of ISharedCodeCell.isDisposed

Inherited from YBaseCell.isDisposed
- Defined in src/ycell.ts:227

isStandalone

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

Returns boolean
Implementation of ISharedCodeCell.isStandalone

Inherited from YBaseCell.isStandalone
- Defined in src/ycell.ts:238

metadata

get metadata(): Partial<Metadata>
Cell metadata.

Notes

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

Returns Partial<Metadata>
Implementation of ISharedCodeCell.metadata

Inherited from YBaseCell.metadata
- Defined in src/ycell.ts:248
set metadata(v: Partial<Metadata>): void
Cell metadata.

Notes

You should prefer to access and modify the specific key of interest.
Parameters
- v: Partial<Metadata>
Returns void
Implementation of ISharedCodeCell.metadata

Inherited from YBaseCell.metadata
- Defined in src/ycell.ts:251

metadataChanged

get metadataChanged(): ISignal<this, IMapChange<any>>
Signal triggered when the cell metadata changes.

Returns ISignal<this, IMapChange<any>>
Implementation of ISharedCodeCell.metadataChanged

Inherited from YBaseCell.metadataChanged
- Defined in src/ycell.ts:258

notebook

get notebook(): null | YNotebook
The notebook that this cell belongs to.

Returns null | YNotebook
Implementation of ISharedCodeCell.notebook

Inherited from YBaseCell.notebook
- Defined in src/ycell.ts:265

outputs

get outputs(): IOutput[]
Cell outputs.

Returns IOutput[]
Implementation of ISharedCodeCell.outputs
- Defined in src/ycell.ts:770
set outputs(v: IOutput[]): void
Cell outputs
Parameters
- v: IOutput[]
Returns void
Implementation of ISharedCodeCell.outputs
- Defined in src/ycell.ts:773

source

get source(): string
Cell input content.

Returns string
Implementation of ISharedCodeCell.source

Inherited from YBaseCell.source
- Defined in src/ycell.ts:272
set source(v: string): void
Text
Parameters
- v: string
Returns void
Implementation of ISharedCodeCell.source

Inherited from YBaseCell.source
- Defined in src/ycell.ts:275

undoManager

get undoManager(): null | UndoManager
The cell undo manager.

Returns null | UndoManager
Inherited from YBaseCell.undoManager
- Defined in src/ycell.ts:282

youtputs

get youtputs(): YArray<any>
Returns YArray<any>
- Defined in src/ycell.ts:776

ysource

get ysource(): YText
Shareable text

Returns YText
Inherited from YBaseCell.ysource
- Defined in src/ycell.ts:309

Methods

appendStreamOutput

appendStreamOutput(index: number, text: string, origin?: any): void
Append text to a stream output.
Parameters
- index: number
- text: string
- origin: any = null
Returns void
- Defined in src/ycell.ts:842

canRedo

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

Returns boolean
Implementation of ISharedCodeCell.canRedo

Inherited from YBaseCell.canRedo
- Defined in src/ycell.ts:323

canUndo

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

Returns boolean
Implementation of ISharedCodeCell.canUndo

Inherited from YBaseCell.canUndo
- Defined in src/ycell.ts:316

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

Returns void
Implementation of ISharedCodeCell.clearUndoHistory

Inherited from YBaseCell.clearUndoHistory
- Defined in src/ycell.ts:330

createOutputs

createOutputs(outputs: IOutput[]): YMap<any>[]
Parameters
- outputs: IOutput[]
Returns YMap<any>[]
- Defined in src/ycell.ts:787

deleteMetadata

deleteMetadata(key: string): void
Delete a metadata cell.
Parameters
- key: string
  
  The key to delete
Returns void
Implementation of ISharedCodeCell.deleteMetadata

Inherited from YBaseCell.deleteMetadata
- Defined in src/ycell.ts:430

dispose

dispose(): void
Dispose of the resources.

Returns void
Implementation of ISharedCodeCell.dispose

Inherited from YBaseCell.dispose
- Defined in src/ycell.ts:351

`Protected` getChanges

getChanges(events: YEvent<any>[]): Partial<CellChange>
Extract changes from YJS events

Returns
Cell changes
Parameters
- events: YEvent<any>[]
  
  YJS events
Returns Partial<CellChange>
Overrides YBaseCell.getChanges
- Defined in src/ycell.ts:899

getId

getId(): string
Get cell id.

Returns
Cell id

Returns string
Implementation of ISharedCodeCell.getId

Inherited from YBaseCell.getId
- Defined in src/ycell.ts:379

getMetadata

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

Returns
cell's metadata.

Returns Partial<IBaseCellMetadata>
Implementation of ISharedCodeCell.getMetadata

Inherited from YBaseCell.getMetadata
- Defined in src/ycell.ts:460
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
Implementation of ISharedCodeCell.getMetadata

Inherited from YBaseCell.getMetadata
- Defined in src/ycell.ts:461

getOutputs

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

Returns IOutput[]
Implementation of ISharedCodeCell.getOutputs
- Defined in src/ycell.ts:783

getSource

getSource(): string
Gets cell's source.

Returns
Cell's source.

Returns string
Implementation of ISharedCodeCell.getSource

Inherited from YBaseCell.getSource
- Defined in src/ycell.ts:388

redo

redo(): void
Redo an operation.

Returns void
Implementation of ISharedCodeCell.redo

Inherited from YBaseCell.redo
- Defined in src/ycell.ts:344

removeStreamOutput

removeStreamOutput(index: number, start: number, origin?: any): void
Remove text from a stream output.
Parameters
- index: number
- start: number
- origin: any = null
Returns void
- Defined in src/ycell.ts:826

setMetadata

setMetadata(metadata: Partial<IBaseCellMetadata>): void
Sets all or a single cell metadata.

If only one argument is provided, it will override all cell metadata. Otherwise a single key will be set to a new value.
Parameters
- metadata: Partial<IBaseCellMetadata>
  
  Cell's metadata key or cell's metadata.
Returns void
Implementation of ISharedCodeCell.setMetadata

Inherited from YBaseCell.setMetadata
- Defined in src/ycell.ts:489
setMetadata(metadata: string, value: PartialJSONValue): void
Sets a cell metadata.
Parameters
- metadata: string
  
  Cell's metadata key.
- value: PartialJSONValue
  
  Metadata value
Returns void
Implementation of ISharedCodeCell.setMetadata

Inherited from YBaseCell.setMetadata
- Defined in src/ycell.ts:490

setOutputs

setOutputs(outputs: IOutput[]): void
Replace all outputs.
Parameters
- outputs: IOutput[]
Returns void
Implementation of ISharedCodeCell.setOutputs
- Defined in src/ycell.ts:815

setSource

setSource(value: string): void
Sets cell's source.
Parameters
- value: string
Returns void
Implementation of ISharedCodeCell.setSource

Inherited from YBaseCell.setSource
- Defined in src/ycell.ts:397

setUndoManager

setUndoManager(): void
Defer setting the undo manager as it requires the cell to be attached to the notebook Y document.

Returns void
Inherited from YBaseCell.setUndoManager
- Defined in src/ycell.ts:295

toJSON

toJSON(): ICodeCell
Serialize the model to JSON.

Returns ICodeCell
Implementation of ISharedCodeCell.toJSON

Overrides YBaseCell.toJSON
- Defined in src/ycell.ts:885

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
- undoable: boolean = true
  
  Whether to track the change in the action history or not (default true)
- origin: any = null
Returns void
Implementation of ISharedCodeCell.transact

Inherited from YBaseCell.transact
- Defined in src/ycell.ts:568

undo

undo(): void
Undo an operation.

Returns void
Implementation of ISharedCodeCell.undo

Inherited from YBaseCell.undo
- Defined in src/ycell.ts:337

updateOutputs

updateOutputs(start: number, end: number, outputs?: IOutput[], origin?: any): void
Replace content from start' to endwithoutputs`.
Parameters
- start: number
- end: number
- outputs: IOutput[] = []
- origin: any = null
Returns void
Implementation of ISharedCodeCell.updateOutputs
- Defined in src/ycell.ts:863

updateSource

updateSource(start: number, end: number, value?: string): void
Replace content from start' to endwithvalue`.
Parameters
- start: number
- end: number
- value: string = ''
Returns void
Implementation of ISharedCodeCell.updateSource

Inherited from YBaseCell.updateSource
- Defined in src/ycell.ts:415

`Static` create

create(id?: string): YCodeCell
Create a new YCodeCell that works standalone. It cannot be inserted into a YNotebook because the Yjs model is already attached to an anonymous Y.Doc instance.
Parameters
- Optional id: string
Returns YCodeCell
Overrides YBaseCell.create
- Defined in src/ycell.ts:696

Class YCodeCell

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Notes

Parameters

ymodel: YMap<any>

ysource: YText

youtputs: YArray<any>

options: SharedCell.IOptions = {}

Optional ymetadata: YMap<any>

Returns YCodeCell

Properties

Protected _metadataChanged

Protected _notebook

Private _youtputs

Readonly ymodel

Accessors

awareness

Returns null | Awareness

cell_type

Returns "code"

changed

Returns ISignal<this, CellChange>

disposed

Returns ISignal<this, void>

executionState

Returns IExecutionState

Parameters

state: IExecutionState

Returns void

execution_count

Returns null | number

Parameters

count: null | number

Returns void

id

Returns string

isDisposed

Returns boolean

isStandalone

Returns boolean

metadata

Notes

Returns Partial<Metadata>

Notes

Parameters

v: Partial<Metadata>

Returns void

metadataChanged

Returns ISignal<this, IMapChange<any>>

notebook

Returns null | YNotebook

outputs

Returns IOutput[]

Parameters

v: IOutput[]

Returns void

source

Returns string

Parameters

v: string

Returns void

undoManager

Returns null | UndoManager

youtputs

Returns YArray<any>

ysource

Returns YText

Methods

appendStreamOutput

Parameters

index: number

text: string

`Optional` ymetadata: YMap<any>

`Protected` _metadataChanged

`Protected` _notebook

`Private` _youtputs

`Readonly` ymodel

`Protected` getChanges