Class YBaseCell<Metadata>

Implements an API for nbformat.IBaseCell.

Type Parameters

Metadata extends nbformat.IBaseCellMetadata

Hierarchy

YBaseCell
- YCodeCell

Implements

ISharedBaseCell<Metadata>
IYText

Constructors

constructor

new YBaseCell<Metadata>(ymodel: YMap<any>, ysource: YText, options?: SharedCell.IOptions, ymetadata?: YMap<any>): YBaseCell<Metadata>
Base 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.
Type Parameters
- Metadata extends IBaseCellMetadata
Parameters
- ymodel: YMap<any>
  
  Cell map
- ysource: YText
  
  Cell source
- options: SharedCell.IOptions = {}
  
  { notebook?: The notebook the cell is attached to }
- Optional ymetadata: YMap<any>
  
  Cell metadata
Returns YBaseCell<Metadata>
- Defined in src/ycell.ts:158

Properties

`Private` _awareness

_awareness: null | Awareness

`Private` _changed

_changed: Signal<YBaseCell<Metadata>, CellChange> = ...

`Private` _disposed

_disposed: Signal<YBaseCell<Metadata>, void> = ...

`Private` _isDisposed

_isDisposed: boolean = false

`Protected` _metadataChanged

_metadataChanged: Signal<YBaseCell<Metadata>, IMapChange<any>> = ...

`Protected` _notebook

_notebook: null | YNotebook = null

The notebook that this cell belongs to.

`Private` _prevSourceLength

_prevSourceLength: number

`Private` _undoManager

_undoManager: null | UndoManager = null

`Private` _ymetadata

_ymetadata: YMap<any>

`Private` _ysource

_ysource: YText

`Readonly` ymodel

ymodel: YMap<any>

Accessors

awareness

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

Returns null | Awareness
Implementation of IYText.awareness
- Defined in src/ycell.ts:191

cell_type

get cell_type(): any
The type of the cell.

Returns any
Implementation of ISharedBaseCell.cell_type
- Defined in src/ycell.ts:198

changed

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

Returns ISignal<this, CellChange>
Implementation of IYText.changed
- Defined in src/ycell.ts:205

disposed

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

Returns ISignal<this, void>
Implementation of IYText.disposed
- Defined in src/ycell.ts:212

id

get id(): string
Cell id

Returns string
Implementation of ISharedBaseCell.id
- Defined in src/ycell.ts:219

isDisposed

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

Returns boolean
Implementation of IYText.isDisposed
- Defined in src/ycell.ts:226

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 ISharedBaseCell.isStandalone
- Defined in src/ycell.ts:237

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 ISharedBaseCell.metadata
- Defined in src/ycell.ts:247
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 ISharedBaseCell.metadata
- Defined in src/ycell.ts:250

metadataChanged

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

Returns ISignal<this, IMapChange<any>>
Implementation of ISharedBaseCell.metadataChanged
- Defined in src/ycell.ts:257

notebook

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

Returns null | YNotebook
Implementation of ISharedBaseCell.notebook
- Defined in src/ycell.ts:264

source

get source(): string
Cell input content.

Returns string
Implementation of IYText.source
- Defined in src/ycell.ts:271
set source(v: string): void
Text
Parameters
- v: string
Returns void
Implementation of IYText.source
- Defined in src/ycell.ts:274

undoManager

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

Returns null | UndoManager
Implementation of IYText.undoManager
- Defined in src/ycell.ts:281

ysource

get ysource(): YText
Shareable text

Returns YText
Implementation of IYText.ysource
- Defined in src/ycell.ts:308

Methods

`Private` _modelObserver

_modelObserver(events: YEvent<any>[]): void
Handle a change to the ymodel.
Parameters
- events: YEvent<any>[]
Returns void
- Defined in src/ycell.ts:659

canRedo

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

Returns boolean
Implementation of IYText.canRedo
- Defined in src/ycell.ts:322

canUndo

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

Returns boolean
Implementation of IYText.canUndo
- Defined in src/ycell.ts:315

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

Returns void
Implementation of IYText.clearUndoHistory
- Defined in src/ycell.ts:329

deleteMetadata

deleteMetadata(key: string): void
Delete a metadata cell.
Parameters
- key: string
  
  The key to delete
Returns void
Implementation of ISharedBaseCell.deleteMetadata
- Defined in src/ycell.ts:429

dispose

dispose(): void
Dispose of the resources.

Returns void
Implementation of IYText.dispose
- Defined in src/ycell.ts:350

`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>
- Defined in src/ycell.ts:581

getId

getId(): string
Get cell id.

Returns
Cell id

Returns string
Implementation of ISharedBaseCell.getId
- Defined in src/ycell.ts:378

getMetadata

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

Returns
cell's metadata.

Returns Partial<Metadata>
Implementation of ISharedBaseCell.getMetadata
- Defined in src/ycell.ts:459
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 ISharedBaseCell.getMetadata
- Defined in src/ycell.ts:460

getSource

getSource(): string
Gets cell's source.

Returns
Cell's source.

Returns string
Implementation of IYText.getSource
- Defined in src/ycell.ts:387

redo

redo(): void
Redo an operation.

Returns void
Implementation of IYText.redo
- Defined in src/ycell.ts:343

setMetadata

setMetadata(metadata: Partial<Metadata>): 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<Metadata>
  
  Cell's metadata key or cell's metadata.
Returns void
Implementation of ISharedBaseCell.setMetadata
- Defined in src/ycell.ts:488
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 ISharedBaseCell.setMetadata
- Defined in src/ycell.ts:489

setSource

setSource(value: string): void
Sets cell's source.
Parameters
- value: string
Returns void
Implementation of IYText.setSource
- Defined in src/ycell.ts:396

setUndoManager

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

Returns void
- Defined in src/ycell.ts:294

toJSON

toJSON(): IBaseCell
Serialize the model to JSON.

Returns IBaseCell
Implementation of ISharedBaseCell.toJSON
- Defined in src/ycell.ts:551

transact

transact(f: (() => void), undoable?: boolean): 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)
Returns void
Implementation of IYText.transact
- Defined in src/ycell.ts:567

undo

undo(): void
Undo an operation.

Returns void
Implementation of IYText.undo
- Defined in src/ycell.ts:336

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 IYText.updateSource
- Defined in src/ycell.ts:414

`Static` create

create(id?: string): YBaseCell<any>
Create a new YCell 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 YBaseCell<any>
- Defined in src/ycell.ts:138

Class YBaseCell<Metadata>

Type Parameters

Metadata extends nbformat.IBaseCellMetadata

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Notes

Type Parameters

Metadata extends IBaseCellMetadata

Parameters

ymodel: YMap<any>

ysource: YText

options: SharedCell.IOptions = {}

Optional ymetadata: YMap<any>

Returns YBaseCell<Metadata>

Properties

Private _awareness

Private _changed

Private _disposed

Private _isDisposed

Protected _metadataChanged

Protected _notebook

Private _prevSourceLength

Private _undoManager

Private _ymetadata

Private _ysource

Readonly ymodel

Accessors

awareness

Returns null | Awareness

cell_type

Returns any

changed

Returns ISignal<this, CellChange>

disposed

Returns ISignal<this, 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

source

Returns string

Parameters

v: string

Returns void

undoManager

Returns null | UndoManager

ysource

Returns YText

Methods

Private _modelObserver

Parameters

events: YEvent<any>[]

Returns void

canRedo

Returns boolean

canUndo

Returns boolean

clearUndoHistory

Returns void

deleteMetadata

`Optional` ymetadata: YMap<any>

`Private` _awareness

`Private` _changed

`Private` _disposed

`Private` _isDisposed

`Protected` _metadataChanged

`Protected` _notebook

`Private` _prevSourceLength

`Private` _undoManager

`Private` _ymetadata

`Private` _ysource

`Readonly` ymodel

`Private` _modelObserver

`Protected` getChanges

`Static` create

`Optional` id: string