NotebookDocument

Represents a notebook which itself is a sequence of code or markup cells. Notebook documents are created from notebook data.

Properties

abstract external val cellCount: Int

The number of cells in the notebook.

abstract external val isClosed: Boolean

true if the notebook has been closed. A closed notebook isn't synchronized anymore and won't be re-used when the same resource is opened again.

abstract external val isDirty: Boolean

true if there are unpersisted changes.

abstract external val isUntitled: Boolean

Is this notebook representing an untitled file which has not been saved yet.

abstract external val metadata: ReadonlyRecord<JsString, *>

Arbitrary metadata for this notebook. Can be anything but must be JSON-stringifyable.

abstract external val notebookType: String

The type of notebook.

abstract external val uri: Uri

The associated uri for this notebook.

abstract external val version: Int

The version number of this notebook (it will strictly increase after each change, including undo/redo).

abstract external fun cellAt(index: Int): NotebookCell

Return the cell at the specified index. The index will be adjusted to the notebook.

abstract external fun getCells(range: NotebookRange = definedExternally): ReadonlyArray<NotebookCell>

Get the cells of this notebook. A subset can be retrieved by providing a range. The range will be adjusted to the notebook.

abstract external fun save(): PromiseLike<JsBoolean>

Save the document. The saving will be handled by the corresponding serializer.