Readonly
awarenessDocument awareness
Readonly
cellsThe list of shared cells in the notebook.
Readonly
changedThe changed signal.
Optional
Readonly
disableWether the undo/redo logic should be considered on the full document across all cells.
Readonly
disposedA signal emitted when the object is disposed.
Readonly
isNotebook metadata.
Readonly
metadataSignal triggered when a metadata changes.
Readonly
nbformatThe major version number of the nbformat.
Readonly
nbformat_The minor version number of the nbformat.
Readonly
stateDocument state
Readonly
versionDocument version
Add a shared cell at the notebook bottom.
The added cell.
Cell to add.
Dispose of the resources held by the object.
If the object's dispose
method is called more than once, all
calls made after the first will be a no-op.
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
Override the notebook with a JSON-serialized document.
The notebook
Get a shared cell by index.
The requested shared cell.
Returns all metadata associated with the notebook.
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.
Cell's position.
Cell to insert.
Insert a list of shared cells into a specific position.
The inserted cells.
Position to insert the cells.
Array of shared cells to insert.
Sets all metadata associated with the notebook.
All Notebook's metadata.
Sets a metadata associated with the notebook.
The key to set.
New metadata value
Serialize the model to JSON.
Perform a transaction. While the function f is called, all changes to the shared document are bundled into a single event.
Transaction to execute
Optional
undoable: booleanWhether to track the change in the action history or not (default true
)
Optional
origin: anyUpdates the metadata associated with the notebook.
Generated using TypeDoc
Implements an API for nbformat.INotebookContent