Class YNotebook

Shared implementation of the Shared Document types.

Shared cells can be inserted into a SharedNotebook. Shared cells only start emitting events when they are connected to a SharedNotebook.

"Standalone" cells must not be inserted into a (Shared)Notebook. Standalone cells emit events immediately after they have been created, but they must not be included into a (Shared)Notebook.

Hierarchy

YDocument<NotebookChange>
- YNotebook

Implements

ISharedNotebook

Constructors

constructor

new YNotebook(options?: Omit<ISharedNotebook.IOptions, "data">): YNotebook
Create a new notebook

Notes

The document is empty and must be populated
Parameters
- options: Omit<ISharedNotebook.IOptions, "data"> = {}
Returns YNotebook
Overrides YDocument.constructor
- Defined in src/ynotebook.ts:50

Properties

`Protected` _changed

_changed: Signal<YNotebook, NotebookChange> = ...

`Private` _disableDocumentWideUndoRedo

_disableDocumentWideUndoRedo: boolean

`Protected` _metadataChanged

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

`Private` _ycellMapping

_ycellMapping: WeakMap<YMap<any>, YCellType> = ...

`Protected` `Readonly` _ycells

_ycells: YArray<YMap<any>> = ...

Internal Yjs cells list

`Readonly` cells

cells: YCellType[]

Cells list

`Readonly` version

version: string = '1.0.0'

Document version

`Readonly` ymeta

ymeta: YMap<any> = ...

YJS map for the notebook metadata

Accessors

awareness

get awareness(): Awareness
Shared awareness

Returns Awareness
Inherited from YDocument.awareness
- Defined in src/ydocument.ts:62

changed

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

Returns ISignal<this, T>
Implementation of ISharedNotebook.changed

Inherited from YDocument.changed
- Defined in src/ydocument.ts:69

disableDocumentWideUndoRedo

get disableDocumentWideUndoRedo(): boolean
Wether the undo/redo logic should be considered on the full document across all cells.

Default: false

Returns boolean
Implementation of ISharedNotebook.disableDocumentWideUndoRedo
- Defined in src/ynotebook.ts:111

disposed

get disposed(): ISignal<this, void>
A signal emitted when the document is disposed.

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

Inherited from YDocument.disposed
- Defined in src/ydocument.ts:76

isDisposed

get isDisposed(): boolean
Whether the document is disposed or not.

Returns boolean
Implementation of ISharedNotebook.isDisposed

Inherited from YDocument.isDisposed
- Defined in src/ydocument.ts:83

metadata

get metadata(): INotebookMetadata
Notebook metadata

Returns INotebookMetadata
Implementation of ISharedNotebook.metadata
- Defined in src/ynotebook.ts:118
set metadata(v: INotebookMetadata): void
Notebook metadata.
Parameters
- v: INotebookMetadata
Returns void
Implementation of ISharedNotebook.metadata
- Defined in src/ynotebook.ts:121

metadataChanged

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

Returns ISignal<this, IMapChange<any>>
Implementation of ISharedNotebook.metadataChanged
- Defined in src/ynotebook.ts:128

nbformat

get nbformat(): number
nbformat major version

Returns number
Implementation of ISharedNotebook.nbformat
- Defined in src/ynotebook.ts:135
set nbformat(value: number): void
The major version number of the nbformat.
Parameters
- value: number
Returns void
Implementation of ISharedNotebook.nbformat
- Defined in src/ynotebook.ts:138

nbformat_minor

get nbformat_minor(): number
nbformat minor version

Returns number
Implementation of ISharedNotebook.nbformat_minor
- Defined in src/ynotebook.ts:147
set nbformat_minor(value: number): void
The minor version number of the nbformat.
Parameters
- value: number
Returns void
Implementation of ISharedNotebook.nbformat_minor
- Defined in src/ynotebook.ts:150

state

get state(): JSONObject
Document state

Returns JSONObject
Implementation of ISharedNotebook.state

Inherited from YDocument.state
- Defined in src/ydocument.ts:90

undoManager

get undoManager(): UndoManager
YJS document undo manager

Returns UndoManager
Inherited from YDocument.undoManager
- Defined in src/ydocument.ts:55

ydoc

get ydoc(): Doc
YJS document.

Returns Doc
Inherited from YDocument.ydoc
- Defined in src/ydocument.ts:41

ystate

get ystate(): YMap<any>
Shared state

Returns YMap<any>
Inherited from YDocument.ystate
- Defined in src/ydocument.ts:48

Methods

`Private` _onMetaChanged

_onMetaChanged(events: YEvent<any>[]): void
Handle a change to the ystate.
Parameters
- events: YEvent<any>[]
Returns void
- Defined in src/ynotebook.ts:468

`Private` _onYCellsChanged

_onYCellsChanged(event: YArrayEvent<YMap<any>>): void
Handle a change to the list of cells.
Parameters
- event: YArrayEvent<YMap<any>>
Returns void
- Defined in src/ynotebook.ts:571

addCell

addCell(cell: Cell): YBaseCell<IBaseCellMetadata>
Add a shared cell at the notebook bottom.

Returns
The added cell.
Parameters
- cell: Cell
  
  Cell to add.
Returns YBaseCell<IBaseCellMetadata>
Implementation of ISharedNotebook.addCell
- Defined in src/ynotebook.ts:186

canRedo

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

Returns boolean
Implementation of ISharedNotebook.canRedo

Inherited from YDocument.canRedo
- Defined in src/ydocument.ts:104

canUndo

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

Returns boolean
Implementation of ISharedNotebook.canUndo

Inherited from YDocument.canUndo
- Defined in src/ydocument.ts:97

clearUndoHistory

clearUndoHistory(): void
Clear the change stack.

Returns void
Implementation of ISharedNotebook.clearUndoHistory

Inherited from YDocument.clearUndoHistory
- Defined in src/ydocument.ts:165

deleteCell

deleteCell(index: number): void
Remove a cell.
Parameters
- index: number
Returns void
Implementation of ISharedNotebook.deleteCell
- Defined in src/ynotebook.ts:273

deleteCellRange

deleteCellRange(from: number, to: number): void
Remove a range of cells.
Parameters
- from: number
- to: number
Returns void
Implementation of ISharedNotebook.deleteCellRange
- Defined in src/ynotebook.ts:283

deleteMetadata

deleteMetadata(key: string): void
Delete a metadata notebook.
Parameters
- key: string
  
  The key to delete
Returns void
Implementation of ISharedNotebook.deleteMetadata
- Defined in src/ynotebook.ts:295

dispose

dispose(): void
Dispose of the resources.

Returns void
Implementation of ISharedNotebook.dispose

Overrides YDocument.dispose
- Defined in src/ynotebook.ts:159

fromJSON

fromJSON(value: INotebookContent): void
Override the notebook with a JSON-serialized document.
Parameters
- value: INotebookContent
  
  The notebook
Returns void
Implementation of ISharedNotebook.fromJSON
- Defined in src/ynotebook.ts:412

getCell

getCell(index: number): YCellType
Get a shared cell by index.

Returns
The requested shared cell.
Parameters
- index: number
Returns YCellType
Implementation of ISharedNotebook.getCell
- Defined in src/ynotebook.ts:175

getMetadata

getMetadata(): INotebookMetadata
Returns some metadata associated with the notebook.

If no key is provided, it will return all metadata. Else it will return the value for that key.

Returns
Notebook's metadata.

Returns INotebookMetadata
Implementation of ISharedNotebook.getMetadata
- Defined in src/ynotebook.ts:314
getMetadata(key: string): undefined | PartialJSONValue
Returns a metadata associated with the notebook.

Returns
Notebook's metadata.
Parameters
- key: string
  
  Key to get from the metadata
Returns undefined | PartialJSONValue
Implementation of ISharedNotebook.getMetadata
- Defined in src/ynotebook.ts:315

getState

getState(key: string): undefined | JSONValue
Get the value for a state attribute
Parameters
- key: string
  
  Key to get
Returns undefined | JSONValue
Implementation of ISharedNotebook.getState

Inherited from YDocument.getState
- Defined in src/ydocument.ts:129

insertCell

insertCell(index: number, cell: Cell): YBaseCell<IBaseCellMetadata>
Insert a shared cell into a specific position.

Returns
The inserted cell.
Parameters
- index: number
- cell: Cell
Returns YBaseCell<IBaseCellMetadata>
Implementation of ISharedNotebook.insertCell
- Defined in src/ynotebook.ts:198

insertCells

insertCells(index: number, cells: Cell[]): YBaseCell<IBaseCellMetadata>[]
Insert a list of shared cells into a specific position.

Returns
The inserted cells.
Parameters
- index: number
- cells: Cell[]
Returns YBaseCell<IBaseCellMetadata>[]
Implementation of ISharedNotebook.insertCells
- Defined in src/ynotebook.ts:213

moveCell

moveCell(fromIndex: number, toIndex: number): void
Move a cell.
Parameters
- fromIndex: number
- toIndex: number
Returns void
Implementation of ISharedNotebook.moveCell
- Defined in src/ynotebook.ts:243

moveCells

moveCells(fromIndex: number, toIndex: number, n?: number): void
Move cells.
Parameters
- fromIndex: number
- toIndex: number
- n: number = 1
Returns void
Implementation of ISharedNotebook.moveCells
- Defined in src/ynotebook.ts:254

`Protected` onStateChanged

onStateChanged(event: YMapEvent<any>): void
Handle a change to the ystate.
Parameters
- event: YMapEvent<any>
Returns void
Inherited from YDocument.onStateChanged
- Defined in src/ydocument.ts:180

redo

redo(): void
Redo an operation.

Returns void
Implementation of ISharedNotebook.redo

Inherited from YDocument.redo
- Defined in src/ydocument.ts:158

setMetadata

setMetadata(metadata: INotebookMetadata): void
Sets some metadata associated with the notebook.

If only one argument is provided, it will override all notebook metadata. Otherwise a single key will be set to a new value.
Parameters
- metadata: INotebookMetadata
  
  All Notebook's metadata or the key to set.
Returns void
Implementation of ISharedNotebook.setMetadata
- Defined in src/ynotebook.ts:345
setMetadata(metadata: string, value: PartialJSONValue): void
Sets a metadata associated with the notebook.
Parameters
- metadata: string
  
  The key to set.
- value: PartialJSONValue
  
  New metadata value
Returns void
Implementation of ISharedNotebook.setMetadata
- Defined in src/ynotebook.ts:346

setState

setState(key: string, value: JSONValue): void
Set the value of a state attribute
Parameters
- key: string
  
  Key to set
- value: JSONValue
  
  New attribute value
Returns void
Implementation of ISharedNotebook.setState

Inherited from YDocument.setState
- Defined in src/ydocument.ts:142

toJSON

toJSON(): INotebookContent
Serialize the model to JSON.

Returns INotebookContent
Implementation of ISharedNotebook.toJSON
- Defined in src/ynotebook.ts:447

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)
  - - (): void
    - Returns void
- undoable: boolean = true
Returns void
Implementation of ISharedNotebook.transact

Inherited from YDocument.transact
- Defined in src/ydocument.ts:173

undo

undo(): void
Undo an operation.

Returns void
Implementation of ISharedNotebook.undo

Inherited from YDocument.undo
- Defined in src/ydocument.ts:151

updateMetadata

updateMetadata(value: Partial<INotebookMetadata>): void
Updates the metadata associated with the notebook.
Parameters
- value: Partial<INotebookMetadata>
Returns void
Implementation of ISharedNotebook.updateMetadata
- Defined in src/ynotebook.ts:390

`Static` create

create(options?: ISharedNotebook.IOptions): YNotebook
Creates a standalone YNotebook

Note: This method is useful when we need to initialize the YNotebook from the JavaScript side.
Parameters
- options: ISharedNotebook.IOptions = {}
Returns YNotebook
- Defined in src/ynotebook.ts:80

Class YNotebook

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Notes

Parameters

options: Omit<ISharedNotebook.IOptions, "data"> = {}

Returns YNotebook

Properties

Protected _changed

Private _disableDocumentWideUndoRedo

Protected _metadataChanged

Private _ycellMapping

Protected Readonly _ycells

Readonly cells

Readonly version

Readonly ymeta

Accessors

awareness

Returns Awareness

changed

Returns ISignal<this, T>

disableDocumentWideUndoRedo

Returns boolean

disposed

Returns ISignal<this, void>

isDisposed

Returns boolean

metadata

Returns INotebookMetadata

Parameters

v: INotebookMetadata

Returns void

metadataChanged

Returns ISignal<this, IMapChange<any>>

nbformat

Returns number

Parameters

value: number

Returns void

nbformat_minor

Returns number

Parameters

value: number

Returns void

state

Returns JSONObject

undoManager

Returns UndoManager

ydoc

Returns Doc

ystate

Returns YMap<any>

Methods

Private _onMetaChanged

Parameters

events: YEvent<any>[]

Returns void

Private _onYCellsChanged

Parameters

event: YArrayEvent<YMap<any>>

Returns void

addCell

Returns

Parameters

cell: Cell

Returns YBaseCell<IBaseCellMetadata>

canRedo

Returns boolean

canUndo

Returns boolean

clearUndoHistory

Returns void

deleteCell

`Protected` _changed

`Private` _disableDocumentWideUndoRedo

`Protected` _metadataChanged

`Private` _ycellMapping

`Protected` `Readonly` _ycells

`Readonly` cells

`Readonly` version

`Readonly` ymeta

`Private` _onMetaChanged

`Private` _onYCellsChanged

`Protected` onStateChanged