Class NotebookEdit

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

Hierarchy

NotebookEdit

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in packages/plugin/src/theia.d.ts:15284
Parameters
- range: NotebookRange
- newCells: NotebookCellData[]
Returns NotebookEdit

Properties

Optional newCellMetadata

newCellMetadata?: {}

Optional new metadata for the cells.

stubbed

Type declaration

[key: string]: any

newCells

newCells: NotebookCellData[]

New cells being inserted. May be empty.

stubbed

Optional newNotebookMetadata

newNotebookMetadata?: {}

Optional new metadata for the notebook.

stubbed

Type declaration

[key: string]: any

range

range: NotebookRange

Range of the cells being edited. May be empty.

stubbed

Methods

Static deleteCells

deleteCells(range: NotebookRange): NotebookEdit

- Defined in packages/plugin/src/theia.d.ts:15241
Utility to create an edit that deletes cells in a notebook.

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

Static insertCells

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

- Defined in packages/plugin/src/theia.d.ts:15233
Utility to create an edit that replaces cells in a notebook.

stubbed
Parameters
- index: number
  
  The index to insert cells at.
- newCells: NotebookCellData[]
  
  The new notebook cells.
Returns NotebookEdit

Static replaceCells

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

- Defined in packages/plugin/src/theia.d.ts:15224
Utility to create a edit that replaces cells in a notebook.

stubbed
Parameters
- range: NotebookRange
  
  The range of cells to replace
- newCells: NotebookCellData[]
  
  The new notebook cells.
Returns NotebookEdit

Static updateCellMetadata

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

- Defined in packages/plugin/src/theia.d.ts:15250
Utility to create an edit that update a cell's metadata.

stubbed
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 packages/plugin/src/theia.d.ts:15258
Utility to create an edit that updates the notebook's metadata.

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