Class NotebookEdit

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

Hierarchy

NotebookEdit

Index

Methods（5）

Constructors（1）

constructor

Properties（4）

Methods（5）

Static replaceCells

replaceCells(range: NotebookRange, newCells: NotebookCellData[]): NotebookEdit

- Defined in vscode.d.ts:3787
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

Static insertCells

insertCells(index: number, newCells: NotebookCellData[]): NotebookEdit

- Defined in vscode.d.ts:3795
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

Static deleteCells

deleteCells(range: NotebookRange): NotebookEdit

- Defined in vscode.d.ts:3802
Utility to create an edit that deletes cells in a notebook.

Parameters
- range: NotebookRange
  
  The range of cells to delete.
Returns NotebookEdit

Static updateCellMetadata

updateCellMetadata(index: number, newCellMetadata: {}): NotebookEdit

- Defined in vscode.d.ts:3810
Utility to create an edit that update a cell's metadata.

Parameters
- index: number
  
  The index of the cell to update.
- newCellMetadata: {}
  
  The new metadata for the cell.
  - [key: string]: any
Returns NotebookEdit

Static updateNotebookMetadata

updateNotebookMetadata(newNotebookMetadata: {}): NotebookEdit

- Defined in vscode.d.ts:3817
Utility to create an edit that updates the notebook's metadata.

Parameters
- newNotebookMetadata: {}
  
  The new metadata for the notebook.
  - [key: string]: any
Returns NotebookEdit

Constructors（1）

constructor

new NotebookEdit(range: NotebookRange, newCells: NotebookCellData[]): NotebookEdit

- Defined in vscode.d.ts:3845
Create a new notebook edit.

Parameters
- range: NotebookRange
  
  A notebook range.
- newCells: NotebookCellData[]
  
  An array of new cell data.
Returns NotebookEdit

Properties（4）

range

range: NotebookRange

Range of the cells being edited. May be empty.

newCells

newCells: NotebookCellData[]

New cells being inserted. May be empty.

Optional newCellMetadata

newCellMetadata: {}

Optional new metadata for the cells.

Type declaration

[key: string]: any

Optional newNotebookMetadata

newNotebookMetadata: {}

Optional new metadata for the notebook.

Type declaration

[key: string]: any

Generated by TypeDoc. Maintained by 洛竹