Interface ISharedMarkdownCell

Implements an API for nbformat.IMarkdownCell.

Hierarchy

Implemented by

Properties

attachments? cell_type changed disposed id isDisposed isStandalone metadata metadataChanged notebook source

Methods

canRedo canUndo clearUndoHistory deleteMetadata dispose getAttachments getId getMetadata getSource redo setAttachments setMetadata setSource toJSON transact undo updateSource

Properties

Optional attachments

attachments?: IAttachments

Cell attachments

cell_type

cell_type: "markdown"

String identifying the type of cell.

Readonly changed

changed: ISignal<ISharedMarkdownCell, CellChange>

The changed signal.

Readonly disposed

disposed: ISignal<ISharedMarkdownCell, void>

A signal emitted when the object is disposed.

Readonly id

id: string

Cell id.

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.

metadata

metadata: Partial<IBaseCellMetadata>

Cell metadata.

Notes

You should prefer to access and modify the specific key of interest.

Readonly metadataChanged

metadataChanged: ISignal<ISharedMarkdownCell, IMapChange<any>>

Signal triggered when the cell metadata changes.

Readonly notebook

notebook: null | ISharedNotebook

The notebook that this cell belongs to.

source

source: string

Text

Methods

canRedo

canUndo

clearUndoHistory

deleteMetadata

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

getAttachments

getId

getMetadata

getSource

redo

setAttachments

setMetadata

setSource

toJSON

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)

    • Optional origin: any

    Returns void

undo

updateSource

  • Replace content from start to end with value.

    Parameters

    • start: number
    • end: number
    • Optional value: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc