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.
(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`
(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`
(new-cell-metadata notebook-edit)
Optional new metadata for the cells.
Returns: { [key: string]: any; } | undefined
Optional new metadata for the cells. **Returns:** `{ [key: string]: any; } | undefined`
(new-cells notebook-edit)
New cells being inserted. May be empty.
Returns: NotebookCellData[]
New cells being inserted. May be empty. **Returns:** `NotebookCellData[]`
(new-notebook-metadata notebook-edit)
Optional new metadata for the notebook.
Returns: { [key: string]: any; } | undefined
Optional new metadata for the notebook. **Returns:** `{ [key: string]: any; } | undefined`
(range notebook-edit)
Range of the cells being edited. May be empty.
Returns: NotebookRange
Range of the cells being edited. May be empty. **Returns:** `NotebookRange`
(replace-cells range new-cells)
Utility to create a edit that replaces cells in a notebook.
Parameters:
range
: NotebookRange
- The range of cells to replacenew-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`
(set-new-cell-metadata! notebook-edit value)
Optional new metadata for the cells.
Optional new metadata for the cells.
(set-new-cells! notebook-edit value)
New cells being inserted. May be empty.
New cells being inserted. May be empty.
(set-new-notebook-metadata! notebook-edit value)
Optional new metadata for the notebook.
Optional new metadata for the notebook.
(set-range! notebook-edit value)
Range of the cells being edited. May be empty.
Range of the cells being edited. May be empty.
(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`
(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`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close