Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISharedBaseCell<Metadata>

Implements an API for nbformat.IBaseCell.

Type parameters

Hierarchy

Implemented by

Index

Properties

Readonly cell_type

cell_type: CellType

The type of the cell.

Readonly changed

changed: ISignal<ISharedBaseCell<Metadata>, CellChange<Metadata>>

The changed signal.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly isStandalone

isStandalone: boolean

Whether the cell is standalone or not.

If the cell is standalone. It cannot be inserted into a YNotebook because the Yjs model is already attached to an anonymous Y.Doc instance.

Methods

canRedo

  • canRedo(): boolean

canUndo

  • canUndo(): boolean

clearUndoHistory

  • clearUndoHistory(): void

clone

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

getId

  • getId(): string

getMetadata

  • getMetadata(): Partial<Metadata>

getSource

  • getSource(): string

redo

  • redo(): void

setMetadata

  • setMetadata(metadata: Partial<Metadata>): void

setSource

  • setSource(value: string): void

toJSON

  • toJSON(): IBaseCell

transact

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

undo

  • undo(): void

updateSource

  • updateSource(start: number, end: number, value?: string): void

Generated using TypeDoc