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: NotebookRange,
    newCells: NotebookCellData[],
    newCellMetadata?: { [key: string]: unknown },
    newNotebookMetadata?: { [key: string]: unknown },
): NotebookEdit
Parameters
- range: NotebookRange
- newCells: NotebookCellData[]
- OptionalnewCellMetadata: { [key: string]: unknown }
- OptionalnewNotebookMetadata: { [key: string]: unknown }
Returns NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1408

Properties

`Optional`newCellMetadata

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

eslint-disable-next-line @typescript-eslint/no-explicit-any

newCells

newCells: NotebookCellData[]

New cells being inserted. May be empty.

`Optional`newNotebookMetadata

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

eslint-disable-next-line @typescript-eslint/no-explicit-any

range

range: NotebookRange

Range of the cells being edited. May be empty.

Methods

`Static`deleteCells

deleteCells(range: NotebookRange): 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:1394

`Static`insertCells

insertCells(index: number, newCells: NotebookCellData[]): 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:1390

`Static`isNotebookCellEdit

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

`Static`replaceCells

replaceCells(range: NotebookRange, newCells: NotebookCellData[]): 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:1386

`Static`updateCellMetadata

updateCellMetadata(
index: number,
newCellMetadata: { [key: string]: any },
): NotebookEdit
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- index: number
- newCellMetadata: { [key: string]: any }
Returns NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1399

`Static`updateNotebookMetadata

updateNotebookMetadata(
newNotebookMetadata: { [key: string]: any },
): NotebookEdit
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- newNotebookMetadata: { [key: string]: any }
Returns NotebookEdit
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1404