Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISharedNotebook

Implements an API for nbformat.INotebookContent

Hierarchy

Implemented by

Index

Properties

Readonly cells

cells: ISharedCell[]

The list of shared cells in the notebook.

Readonly changed

changed: ISignal<ISharedNotebook, NotebookChange>

The changed signal.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly nbformat

nbformat: number

The major version number of the nbformat.

Readonly nbformat_minor

nbformat_minor: number

The minor version number of the nbformat.

Methods

canRedo

  • canRedo(): boolean

canUndo

  • canUndo(): boolean

clearUndoHistory

  • clearUndoHistory(): void

deleteCell

  • deleteCell(index: number): void

deleteCellRange

  • deleteCellRange(from: number, to: number): void

dispose

  • dispose(): void
  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

getCell

getMetadata

insertCell

insertCells

  • insertCells(index: number, cells: ISharedCell[]): void

moveCell

  • moveCell(fromIndex: number, toIndex: number): void

redo

  • redo(): void

setMetadata

transact

  • transact(f: () => void): void

undo

  • undo(): void

updateMetadata

Generated using TypeDoc