Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotebookEditorEdit

A complex edit that will be applied in one transaction on a TextEditor. This holds a description of the edits and if the edits are valid (i.e. no overlapping regions, document was not changed in the meantime, etc.) they can be applied on a document associated with a text editor.

Hierarchy

  • NotebookEditorEdit

Index

Methods

deleteCell

  • deleteCell(index: number): void
  • Delete a certain cell.

    Parameters

    • index: number

      The index of the cell to remove.

    Returns void

insertCell

  • insertCell(value: ICellContents, index?: number, collapsed?: boolean): void
  • Insert a cell (optionally) at a specific index. Any index outside of the length of the cells will result in the cell being added at the end.

    Parameters

    • value: ICellContents

      The new text this operation should insert.

    • Optional index: number

      The position where the new text should be inserted.

    • Optional collapsed: boolean

      The collapsed state of the new cell. Default value is false if not provided.

    Returns void

replace

  • Replace a cell range with a new cell.

    Parameters

    • location: number | CellRange

      The range this operation should remove.

    • value: ICellContents

      The new cell this operation should insert after removing location.

    Returns void

Generated using TypeDoc