Protected_Protected_Protected Readonly_Internal Yjs cells list
ReadonlycellsCells list
ReadonlyversionDocument version
ReadonlyymetaYJS map for the notebook metadata
Shared awareness
Document dirty state
Set the document dirty state
The dirty state to set
Wether the undo/redo logic should be considered on the full document across all cells.
Default: false
A signal emitted when the document is disposed.
Whether the document is disposed or not.
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
YJS document.
Shared state
Add a shared cell at the notebook bottom.
Cell to add.
The added cell.
Whether the object can redo changes.
Whether the object can undo changes.
Clear the change stack.
Remove a cell.
Index of the cell to remove.
Remove a range of cells.
The start index of the range to remove (inclusive).
The end index of the range to remove (exclusive).
Delete a metadata notebook.
The key to delete
Dispose of the resources.
Override the notebook with a JSON-serialized document.
The notebook
Get a shared cell by index.
Cell's position.
The requested shared cell.
Returns a single metadata value.
Key to get from the metadata
The metadata value for the key.
Insert a shared cell into a specific position.
Cell's position.
Cell to insert.
The inserted cell.
Insert a list of shared cells into a specific position.
Position to insert the cells.
Array of shared cells to insert.
The inserted cells.
Move a cell.
Index of the cell to move.
New position of the cell.
Move cells.
Index of the first cells to move.
New position of the first cell (in the current array).
Number of cells to move (default 1)
ProtectedonRedo an operation.
Overrides all notebook metadata.
All Notebook's metadata.
Sets a single notebook metadata key.
The key to set.
New metadata value
Set the value of a state attribute
Key to set
New attribute value
Serialize the model to JSON with deterministic object key ordering.
Perform a transaction. While the function f is called, all changes to the shared document are bundled into a single event.
Undo an operation.
Updates the metadata associated with the notebook.
Metadata's attribute to update.
StaticcreateCreates a standalone YNotebook
Note: This method is useful when we need to initialize the YNotebook from the JavaScript side.
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.