Interface ISharedNotebook

Implements an API for nbformat.INotebookContent

Hierarchy

Implemented by

Properties

cells changed disableDocumentWideUndoRedo? disposed isDisposed metadata metadataChanged nbformat nbformat_minor state version

Methods

addCell canRedo canUndo clearUndoHistory deleteCell deleteCellRange deleteMetadata dispose fromJSON getCell getMetadata getState insertCell insertCells moveCell moveCells redo setMetadata setState toJSON transact undo updateMetadata

Properties

Readonly cells

cells: ISharedCell[]

The list of shared cells in the notebook.

Readonly changed

changed: ISignal<ISharedNotebook, NotebookChange>

The changed signal.

Optional Readonly disableDocumentWideUndoRedo

disableDocumentWideUndoRedo?: boolean

Wether the undo/redo logic should be considered on the full document across all cells.

Readonly disposed

disposed: ISignal<ISharedNotebook, void>

A signal emitted when the object is disposed.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

metadata

metadata: INotebookMetadata

Notebook metadata.

Readonly metadataChanged

metadataChanged: ISignal<ISharedNotebook, IMapChange<any>>

Signal triggered when a metadata changes.

Readonly nbformat

nbformat: number

The major version number of the nbformat.

Readonly nbformat_minor

nbformat_minor: number

The minor version number of the nbformat.

Readonly state

state: JSONObject

Document state

Readonly version

version: string

Document version

Methods

addCell

canRedo

canUndo

clearUndoHistory

deleteCell

  • Remove a cell.

    Parameters

    • index: number

    Returns void

deleteCellRange

  • Remove a range of cells.

    Parameters

    • from: number
    • to: number

    Returns void

deleteMetadata

  • Delete a metadata notebook.

    Parameters

    • key: string

      The key to delete

    Returns void

dispose

  • 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

fromJSON

  • Override the notebook with a JSON-serialized document.

    Parameters

    • value: INotebookContent

      The notebook

    Returns void

getCell

getMetadata

  • Returns all metadata associated with the notebook.

    Returns

    Notebook's metadata.

    Returns INotebookMetadata

  • Returns a metadata associated with the notebook.

    Returns

    Notebook's metadata.

    Parameters

    • key: string

      Key to get from the metadata

    Returns undefined | PartialJSONValue

getState

  • Get the value for a state attribute

    Parameters

    • key: string

      Key to get

    Returns undefined | JSONValue

insertCell

  • Insert a shared cell into a specific position.

    Returns

    The inserted cell.

    Parameters

    • index: number

      Cell's position.

    • cell: Cell

      Cell to insert.

    Returns ISharedCell

insertCells

  • Insert a list of shared cells into a specific position.

    Returns

    The inserted cells.

    Parameters

    • index: number

      Position to insert the cells.

    • cells: Cell[]

      Array of shared cells to insert.

    Returns ISharedCell[]

moveCell

  • Move a cell.

    Parameters

    • fromIndex: number
    • toIndex: number

    Returns void

moveCells

  • Move cells.

    Parameters

    • fromIndex: number
    • toIndex: number
    • Optional n: number

    Returns void

redo

setMetadata

  • Sets all metadata associated with the notebook.

    Parameters

    • metadata: INotebookMetadata

      All Notebook's metadata.

    Returns void

  • Sets a metadata associated with the notebook.

    Parameters

    • metadata: string

      The key to set.

    • value: PartialJSONValue

      New metadata value

    Returns void

setState

  • Set the value of a state attribute

    Parameters

    • key: string

      Key to set

    • value: JSONValue

      New attribute value

    Returns void

toJSON

  • Serialize the model to JSON.

    Returns INotebookContent

transact

  • Perform a transaction. While the function f is called, all changes to the shared document are bundled into a single event.

    Parameters

    • f: (() => void)

      Transaction to execute

        • (): void

        • Returns void

    • Optional undoable: boolean

      Whether to track the change in the action history or not (default true)

    Returns void

undo

updateMetadata

  • Updates the metadata associated with the notebook.

    Parameters

    • value: Partial<INotebookMetadata>

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc