dots.vscode.notebook-document
Represents a notebook which itself is a sequence of {@link NotebookCell code or markup cells}. Notebook documents are created from {@link NotebookData notebook data}.
Represents a notebook which itself is a sequence of {@link NotebookCell code or markup cells}. Notebook documents are
created from {@link NotebookData notebook data}.cell-atcljs
(cell-at notebook-document index)Return the cell at the specified index. The index will be adjusted to the notebook.
Parameters:
index:number- - The index of the cell to retrieve.
Returns: NotebookCell - A {@link NotebookCellcell}.
Return the cell at the specified index. The index will be adjusted to the notebook.
**Parameters:**
- `index`: `number` - - The index of the cell to retrieve.
**Returns:** `NotebookCell` - A {@link NotebookCellcell}.cell-countcljs
(cell-count notebook-document)The number of cells in the notebook.
Returns: number
The number of cells in the notebook. **Returns:** `number`
cellscljs
(cells notebook-document)(cells notebook-document range)Get the cells of this notebook. A subset can be retrieved by providing a range. The range will be adjusted to the notebook.
Parameters:
range:NotebookRange | undefined- A notebook range.
Returns: NotebookCell[] - The cells contained by the range or all cells.
Get the cells of this notebook. A subset can be retrieved by providing a range. The range will be adjusted to the notebook. **Parameters:** - `range`: `NotebookRange | undefined` - A notebook range. **Returns:** `NotebookCell[]` - The cells contained by the range or all cells.
closed?cljs
(closed? notebook-document)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.
Returns: 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. **Returns:** `boolean`
dirty?cljs
(dirty? notebook-document)true if there are unpersisted changes.
Returns: boolean
`true` if there are unpersisted changes. **Returns:** `boolean`
metadatacljs
(metadata notebook-document)Arbitrary metadata for this notebook. Can be anything but must be JSON-stringifyable.
Returns: { [key: string]: any; }
Arbitrary metadata for this notebook. Can be anything but must be JSON-stringifyable.
**Returns:** `{ [key: string]: any; }`notebook-typecljs
(notebook-type notebook-document)The type of notebook.
Returns: string
The type of notebook. **Returns:** `string`
savecljs
(save notebook-document)Save the document. The saving will be handled by the corresponding {@link NotebookSerializer serializer}.
Returns: Thenable<boolean> - A promise that will resolve to true when the document
has been saved. Will return false if the file was not dirty or when save failed.
Save the document. The saving will be handled by the corresponding {@link NotebookSerializer serializer}.
**Returns:** `Thenable<boolean>` - A promise that will resolve to true when the document
has been saved. Will return false if the file was not dirty or when save failed.untitled?cljs
(untitled? notebook-document)Is this notebook representing an untitled file which has not been saved yet.
Returns: boolean
Is this notebook representing an untitled file which has not been saved yet. **Returns:** `boolean`
uricljs
(uri notebook-document)The associated uri for this notebook.
Note that most notebooks use the file-scheme, which means they are files on disk. However, not all notebooks are
saved on disk and therefore the scheme must be checked before trying to access the underlying file or siblings on disk.
Returns: Uri
The associated uri for this notebook. *Note* that most notebooks use the `file`-scheme, which means they are files on disk. However, **not** all notebooks are saved on disk and therefore the `scheme` must be checked before trying to access the underlying file or siblings on disk. **Returns:** `Uri`
versioncljs
(version notebook-document)The version number of this notebook (it will strictly increase after each change, including undo/redo).
Returns: number
The version number of this notebook (it will strictly increase after each change, including undo/redo). **Returns:** `number`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close