Liking cljdoc? Tell your friends :D

dots.vscode.notebook-edit

A notebook edit represents edits that should be applied to the contents of a notebook.

A notebook edit represents edits that should be applied to the contents of a notebook.
raw docstring

delete-cellscljs

(delete-cells range)

Utility to create an edit that deletes cells in a notebook.

Parameters:

  • range: NotebookRange - The range of cells to delete.

Returns: NotebookEdit

Utility to create an edit that deletes cells in a notebook.

**Parameters:**
- `range`: `NotebookRange` - The range of cells to delete.

**Returns:** `NotebookEdit`
sourceraw docstring

insert-cellscljs

(insert-cells index new-cells)

Utility to create an edit that replaces cells in a notebook.

Parameters:

  • index: number - The index to insert cells at.
  • new-cells: NotebookCellData[] - The new notebook cells.

Returns: NotebookEdit

Utility to create an edit that replaces cells in a notebook.

**Parameters:**
- `index`: `number` - The index to insert cells at.
- `new-cells`: `NotebookCellData[]` - The new notebook cells.

**Returns:** `NotebookEdit`
sourceraw docstring

new-cell-metadatacljs

(new-cell-metadata notebook-edit)

Optional new metadata for the cells.

Optional new metadata for the cells.
sourceraw docstring

new-cellscljs

(new-cells notebook-edit)

New cells being inserted. May be empty.

New cells being inserted. May be empty.
sourceraw docstring

new-notebook-metadatacljs

(new-notebook-metadata notebook-edit)

Optional new metadata for the notebook.

Optional new metadata for the notebook.
sourceraw docstring

rangecljs

(range notebook-edit)

Range of the cells being edited. May be empty.

Range of the cells being edited. May be empty.
sourceraw docstring

replace-cellscljs

(replace-cells range new-cells)

Utility to create a edit that replaces cells in a notebook.

Parameters:

  • range: NotebookRange - The range of cells to replace
  • new-cells: NotebookCellData[] - The new notebook cells.

Returns: NotebookEdit

Utility to create a edit that replaces cells in a notebook.

**Parameters:**
- `range`: `NotebookRange` - The range of cells to replace
- `new-cells`: `NotebookCellData[]` - The new notebook cells.

**Returns:** `NotebookEdit`
sourceraw docstring

set-new-cell-metadata!cljs

(set-new-cell-metadata! notebook-edit value)

Optional new metadata for the cells.

Optional new metadata for the cells.
sourceraw docstring

set-new-cells!cljs

(set-new-cells! notebook-edit value)

New cells being inserted. May be empty.

New cells being inserted. May be empty.
sourceraw docstring

set-new-notebook-metadata!cljs

(set-new-notebook-metadata! notebook-edit value)

Optional new metadata for the notebook.

Optional new metadata for the notebook.
sourceraw docstring

set-range!cljs

(set-range! notebook-edit value)

Range of the cells being edited. May be empty.

Range of the cells being edited. May be empty.
sourceraw docstring

update-cell-metadatacljs

(update-cell-metadata index new-cell-metadata)

Utility to create an edit that update a cell's metadata.

Parameters:

  • index: number - The index of the cell to update.
  • new-cell-metadata: { [key: string]: any; } - The new metadata for the cell.

Returns: NotebookEdit

Utility to create an edit that update a cell's metadata.

**Parameters:**
- `index`: `number` - The index of the cell to update.
- `new-cell-metadata`: `{ [key: string]: any; }` - The new metadata for the cell.

**Returns:** `NotebookEdit`
sourceraw docstring

update-notebook-metadatacljs

(update-notebook-metadata new-notebook-metadata)

Utility to create an edit that updates the notebook's metadata.

Parameters:

  • new-notebook-metadata: { [key: string]: any; } - The new metadata for the notebook.

Returns: NotebookEdit

Utility to create an edit that updates the notebook's metadata.

**Parameters:**
- `new-notebook-metadata`: `{ [key: string]: any; }` - The new metadata for the notebook.

**Returns:** `NotebookEdit`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close