The document context object.
The document metadata, stored as a services contents model.
This will be null until the context is 'ready'. Since we only store
metadata here, the
.contents attribute will always be empty.
A signal emitted when the context is disposed.
A signal emitted when the contentsModel changes.
Test whether the object has been disposed.
This property is always safe to access.
Whether the context is ready.
The current local path associated with the document. If the document is in the default notebook file browser, this is the same as the path.
The data model for the document.
The current path associated with the document.
A signal emitted when the path changes.
A promise that is fulfilled when the context is ready.
A signal emitted on the start and end of a saving operation.
The client session object associated with the context.
The url resolver for the context.
Add a sibling widget to the document manager.
The widget to add to the document manager.
The desired options for adding the sibling.
A disposable used to remove the sibling if desired.
It is assumed that the widget has the same model and context as the original widget.
Create a checkpoint for the file.
A promise which resolves with the new checkpoint model when the checkpoint is created.
Delete a checkpoint for the file.
The id of the checkpoint to delete.
A promise which resolves when the checkpoint is deleted.
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.
List available checkpoints for the file.
A promise which resolves with a list of checkpoint models for the file.
Restore the file to a known checkpoint state.
The optional id of the checkpoint to restore, defaults to the most recent checkpoint.
A promise which resolves when the checkpoint is restored.
Revert the document contents to disk contents.
Save the document contents to disk.
Save the document to a different path chosen by the user.
Generated using TypeDoc