Class NotebookEdit

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

Implements

NotebookEdit

Index

Constructors

Properties

newCellMetadata? newCells newNotebookMetadata? range

Methods

deleteCells insertCells isNotebookCellEdit replaceCells updateCellMetadata updateNotebookMetadata

Constructors

constructor

new NotebookEdit(range, newCells, newCellMetadata?, newNotebookMetadata?): NotebookEdit
Parameters
- range: NotebookRange
- newCells: NotebookCellData[]
- Optional newCellMetadata: {
  [key: string]: unknown;
  }
  - [key: string]: unknown
- Optional newNotebookMetadata: {
  [key: string]: unknown;
  }
  - [key: string]: unknown
Returns NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1407

Properties

`Optional` newCellMetadata

newCellMetadata?: {
[key: string]: any;
}

Optional new metadata for the cells.

Type declaration

[key: string]: any

newCells

newCells: NotebookCellData[]

New cells being inserted. May be empty.

`Optional` newNotebookMetadata

newNotebookMetadata?: {
[key: string]: any;
}

Optional new metadata for the notebook.

Type declaration

[key: string]: any

range

range: NotebookRange

Range of the cells being edited. May be empty.

Methods

`Static` deleteCells

deleteCells(range): NotebookEdit
Utility to create an edit that deletes cells in a notebook.
Parameters
- range: NotebookRange
  The range of cells to delete.
Returns NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1393

`Static` insertCells

insertCells(index, newCells): NotebookEdit
Utility to create an edit that replaces cells in a notebook.
Parameters
- index: number
  The index to insert cells at.
- newCells: NotebookCellData[]
  The new notebook cells.
Returns NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1389

`Static` isNotebookCellEdit

isNotebookCellEdit(thing): thing is NotebookEdit
Parameters
- thing: unknown
Returns thing is NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1374

`Static` replaceCells

replaceCells(range, newCells): NotebookEdit
Utility to create a edit that replaces cells in a notebook.
Parameters
- range: NotebookRange
  The range of cells to replace
- newCells: NotebookCellData[]
  The new notebook cells.
Returns NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1385

`Static` updateCellMetadata

updateCellMetadata(index, newCellMetadata): NotebookEdit
Utility to create an edit that update a cell's metadata.
Parameters
- index: number
  The index of the cell to update.
- newCellMetadata: {
  [key: string]: any;
  }
  The new metadata for the cell.
  - [key: string]: any
Returns NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1398

`Static` updateNotebookMetadata

updateNotebookMetadata(newNotebookMetadata): NotebookEdit
Utility to create an edit that updates the notebook's metadata.
Parameters
- newNotebookMetadata: {
  [key: string]: any;
  }
  The new metadata for the notebook.
  - [key: string]: any
Returns NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1403