Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICellModel

The definition of a model object for a cell.

Hierarchy

  • IDisposable

Implemented by

Index

Properties

contentChanged

contentChanged: ISignal<ICellModel, void>

A signal emitted when the content of the model changes.

isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This is a read-only property which is always safe to access.

metadataChanged

metadataChanged: ISignal<ICellModel, IChangedArgs<any>>

A signal emitted when a metadata field changes.

source

source: string

The input content of the cell.

stateChanged

stateChanged: ISignal<ICellModel, IChangedArgs<any>>

A signal emitted when a model state changes.

type

type: CellType

The type of the cell.

Notes

This is a read-only property.

Methods

dispose

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

    Notes

    It is generally unsafe to use the object after it has been disposed.

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

    Returns void

getMetadata

  • Get a metadata cursor for the cell.

    Notes

    Metadata associated with the nbformat spec are set directly on the model. This method is used to interact with a namespaced set of metadata on the cell.

    Parameters

    • name: string

    Returns IMetadataCursor

listMetadata

  • listMetadata(): string[]
  • List the metadata namespace keys for the notebook.

    Notes

    Metadata associated with the nbformat are not included.

    Returns string[]

toJSON

  • toJSON(): any

Generated using TypeDoc