Protected
_changedPrivate
_disableProtected
_metadataPrivate
_ycellProtected
Readonly
_ycellsInternal Yjs cells list
Readonly
cellsCells list
Readonly
versionDocument version
Readonly
ymetaYJS map for the notebook metadata
Wether the undo/redo logic should be considered on the full document across all cells.
Default: false
Whether the document is disposed or not.
Notebook metadata
Notebook metadata.
Signal triggered when a metadata changes.
nbformat major version
The major version number of the nbformat.
nbformat minor version
The minor version number of the nbformat.
Document state
YJS document undo manager
Shared state
Private
_onPrivate
_onYCellsHandle a change to the list of cells.
Add a shared cell at the notebook bottom.
The added cell.
Cell to add.
Override the notebook with a JSON-serialized document.
The notebook
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.
Notebook's metadata.
Returns a metadata associated with the notebook.
Notebook's metadata.
Key to get from the metadata
Insert a shared cell into a specific position.
The inserted cell.
Insert a list of shared cells into a specific position.
The inserted cells.
Protected
onSets 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.
All Notebook's metadata or the key to set.
Sets a metadata associated with the notebook.
The key to set.
New metadata value
Serialize the model to JSON.
Updates the metadata associated with the notebook.
Static
createCreates a standalone YNotebook
Note: This method is useful when we need to initialize the YNotebook from the JavaScript side.
Generated using TypeDoc
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.