@jupyterlab/cells

method getEditorOptions

protected getEditorOptions: () => InputArea.IOptions['editorOptions'];

• Get the editor options at initialization.

  Returns

  Editor options

method handleEvent

handleEvent: (event: Event) => void;

• Handle the DOM events for the widget.

  Parameter event

  The DOM event sent to the widget.

  #### Notes This method implements the DOM EventListener interface and is called in response to events on the notebook panel's node. It should not be called directly by user code.

method onAfterAttach

protected onAfterAttach: (msg: Message) => void;

• Handle after-attach messages for the widget.

method onBeforeDetach

protected onBeforeDetach: (msg: Message) => void;

• A message handler invoked on a 'before-detach' message

method updateCellSourceWithAttachment

protected abstract updateCellSourceWithAttachment: (
    attachmentName: string,
    URI?: string
) => void;

• Modify the cell source to include a reference to the attachment.

constructor

constructor(options: AttachmentsCellModel.IOptions<ISharedCell>);

• Construct a new cell with optional attachments.

property attachments

readonly attachments: IAttachmentsModel;

• Get the attachments of the model.

method dispose

dispose: () => void;

• Dispose of the resources held by the model.

method toJSON

toJSON: () => nbformat.IRawCell | nbformat.IMarkdownCell;

• Serialize the model to JSON.

constructor

constructor(options: Cell.IOptions<T>);

• Construct a new base cell widget.

property contentFactory

readonly contentFactory: Cell.IContentFactory;

• The content factory used by the widget.

property displayChanged

readonly displayChanged: ISignal<this, void>;

• Signal to indicate that widget has changed visibly (in size, in type, etc)

property editor

readonly editor: any;

• Get the CodeEditor used by the cell.

property editorConfig

readonly editorConfig: Record<string, any>;

• Editor configuration

property editorWidget

readonly editorWidget: any;

• Get the CodeEditorWrapper used by the cell.

property headings

readonly headings: Cell.IHeading[];

• Cell headings

  Deprecated

  Use the asynchronous getHeadings method instead. This getter only returns the last cached value.

property inputArea

readonly inputArea: InputArea;

• Get the input area for the cell.

property inputHidden

inputHidden: boolean;

• The view state of input being hidden.

property inViewport

inViewport: boolean;

• Whether the cell is in viewport or not.

  #### Notes This property is managed by the windowed container which holds the cell. When a cell is not in a windowed container, it always returns false, but this may change in the future major version.

property inViewportChanged

readonly inViewportChanged: ISignal<Cell<ICellModel>, boolean>;

• Will emit true just after the node is attached to the DOM Will emit false just before the node is detached of the DOM

property model

readonly model: ICellModel;

• Get the model used by the cell.

property placeholder

placeholder: boolean;

• Whether the cell is a placeholder not yet fully rendered or not.

property prompt

protected prompt: string;

property promptNode

readonly promptNode: HTMLElement;

• Get the prompt node used by the cell.

property readOnly

readOnly: boolean;

• The read only state of the cell.

property ready

readonly ready: Promise<void>;

• A promise that resolves when the widget renders for the first time.

property scrollRequested

readonly scrollRequested: ISignal<Cell<ICellModel>, Cell.IScrollRequest>;

• Signal emitted when cell requests scrolling to its element.

property syncCollapse

syncCollapse: boolean;

• Whether to sync the collapse state to the cell model.

property syncEditable

syncEditable: boolean;

• Whether to sync the editable state to the cell model.

property translator

protected translator: ITranslator;

method clone

clone: () => Cell<T>;

• Clone the cell, using the same model.

method dispose

dispose: () => void;

• Dispose of the resources held by the widget.

method getEditorOptions

protected getEditorOptions: () => InputArea.IOptions['editorOptions'];

• Get the editor options at initialization.

  Returns

  Editor options

method getHeadings

getHeadings: () => Promise<Cell.IHeading[]>;

• Async Cell headings

method handleInputHidden

protected handleInputHidden: (value: boolean) => void;

• Handle the input being hidden.

  #### Notes This is called by the inputHidden setter so that subclasses can perform actions upon the input being hidden without accessing private state.

method initializeDOM

protected initializeDOM: () => void;

• Create children widgets.

method initializeState

initializeState: () => this;

• Initialize view state from model.

  #### Notes Should be called after construction. For convenience, returns this, so it can be chained in the construction, like new Foo().initializeState();

method isPlaceholder

isPlaceholder: () => boolean;

• Whether the cell is a placeholder that defer rendering

  #### Notes You can wait for the promise Cell.ready to wait for the cell to be rendered.

method loadCollapseState

loadCollapseState: () => void;

• Revert view collapse state from model.

method loadEditableState

loadEditableState: () => void;

• Load view editable state from model.

method onActivateRequest

protected onActivateRequest: (msg: Message) => void;

• Handle 'activate-request' messages.

method onAfterAttach

protected onAfterAttach: (msg: Message) => void;

• Handle after-attach messages.

method onBeforeAttach

protected onBeforeAttach: (msg: Message) => void;

• Handle before-attach messages.

method onContentChanged

protected onContentChanged: () => void;

method onMetadataChanged

protected onMetadataChanged: (model: CellModel, args: IMapChange) => void;

• Handle changes in the metadata.

method onResize

protected onResize: (msg: Widget.ResizeMessage) => void;

• Handle resize messages.

method onUpdateRequest

protected onUpdateRequest: (msg: Message) => void;

• Handle update-request messages.

method saveCollapseState

saveCollapseState: () => void;

• Save view collapse state to model

method saveEditableState

saveEditableState: () => void;

• Save view editable state to model

method setPrompt

setPrompt: (value: string) => void;

• Set the prompt for the widget.

  Deprecated

  - set the executionState on the model instead.

method updateEditorConfig

updateEditorConfig: (v: Record<string, any>) => void;

• Update the editor configuration with the partial provided dictionary.

  Parameter v

  Partial editor configuration

constructor

constructor();

• Construct a new cell footer.

constructor

constructor();

• Construct a new cell header.

constructor

constructor(options?: CellModel.IOptions<ISharedCell>);

property contentChanged

readonly contentChanged: Signal<this, void>;

• A signal emitted when the state of the model changes.

property id

readonly id: string;

• The id for the cell.

property metadata

readonly metadata: Omit<nbformat.IBaseCellMetadata, 'trusted'>;

• The metadata associated with the cell.

property metadataChanged

readonly metadataChanged: ISignal<ICellModel, IMapChange>;

• Signal emitted when cell metadata changes.

property sharedModel

readonly sharedModel: ISharedCell;

property stateChanged

readonly stateChanged: Signal<
    this,
    IChangedArgs<
        any,
        any,
        'trusted' | 'isDirty' | 'executionCount' | 'executionState'
    >
>;

• A signal emitted when a model state changes.

property trusted

trusted: boolean;

• The trusted state of the model.

property type

readonly type: nbformat.CellType;

• The type of cell.

method deleteMetadata

deleteMetadata: (key: string) => any;

• Delete a metadata

  Parameter key

  Metadata key

method dispose

dispose: () => void;

• Dispose of the resources held by the model.

method getMetadata

getMetadata: (key: string) => any;

• Get a metadata

  ### Notes This returns a copy of the key value.

  Parameter key

  Metadata key

method onGenericChange

protected onGenericChange: () => void;

• Handle a change to the observable value.

method onTrustedChanged

onTrustedChanged: (
    trusted: CellModel,
    args: ObservableValue.IChangedArgs
) => void;

• Handle a change to the trusted state.

  The default implementation is a no-op.

method setMetadata

setMetadata: (key: string, value: any) => void;

• Set a metadata

  Parameter key

  Metadata key

  Parameter value

  Metadata value

method toJSON

toJSON: () => nbformat.ICell;

• Serialize the model to JSON.

constructor

constructor(cell: Cell<ICellModel>);

property cell

protected cell: Cell<ICellModel>;

property editor

readonly editor: any;

• Text editor

property model

readonly model: ICellModel;

• Editor content model

constructor

constructor(options: CodeCell.IOptions);

• Construct a code cell widget.

property headings

readonly headings: Cell.IHeading[];

property maxNumberOutputs

protected maxNumberOutputs: number;

• Maximum number of outputs to display.

property outputArea

readonly outputArea: OutputArea;

• Get the output area for the cell.

property outputHidden

outputHidden: boolean;

• The view state of output being collapsed.

property outputsScrolled

outputsScrolled: boolean;

• Whether the output is in a scrolled state?

property syncScrolled

syncScrolled: boolean;

• Whether to sync the scrolled state to the cell model.

method clone

clone: () => CodeCell;

• Clone the cell, using the same model.

method cloneOutputArea

cloneOutputArea: () => OutputArea;

• Clone the OutputArea alone, returning a simplified output area, using the same model.

method dispose

dispose: () => void;

• Dispose of the resources used by the widget.

method getHeadings

getHeadings: () => Promise<Cell.IHeading[]>;

method getOutputPlaceholderText

protected getOutputPlaceholderText: () => string | undefined;

method handleInputHidden

protected handleInputHidden: (value: boolean) => void;

• Handle the input being hidden.

  #### Notes This method is called by the case cell implementation and is subclasses here so the code cell can watch to see when input is hidden without accessing private state.

method initializeDOM

protected initializeDOM: () => void;

• Create children widgets.

method initializeState

initializeState: () => this;

• Initialize view state from model.

  #### Notes Should be called after construction. For convenience, returns this, so it can be chained in the construction, like new Foo().initializeState();

method loadCollapseState

loadCollapseState: () => void;

• Revert view collapse state from model.

  We consider the collapsed metadata key as the source of truth for outputs being hidden.

method loadScrolledState

loadScrolledState: () => void;

• Revert view collapse state from model.

method onMetadataChanged

protected onMetadataChanged: (model: CellModel, args: IMapChange) => void;

• Handle changes in the metadata.

method onOutputChanged

protected onOutputChanged: () => void;

• Callback on output changes

method onStateChanged

protected onStateChanged: (model: ICellModel, args: IChangedArgs<any>) => void;

• Handle changes in the model.

method saveCollapseState

saveCollapseState: () => void;

• Save view collapse state to model

method saveScrolledState

saveScrolledState: () => void;

• Save view collapse state to model

method updatePromptOverlayIcon

updatePromptOverlayIcon: () => void;

• Update the Prompt Overlay Icon

method onAfterDetach

protected onAfterDetach: (msg: Message) => void;

• A message handler invoked on an 'after-detach' message.

  #### Notes The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.

  This may be reimplemented by subclasses as needed.

method onBeforeAttach

protected onBeforeAttach: (msg: Message) => void;

• A message handler invoked on a 'before-attach' message.

  #### Notes The default implementation of this method forwards the message to all widgets. It assumes all widget nodes are attached to the parent widget node.

  This may be reimplemented by subclasses as needed.

constructor

constructor(options?: CodeCellModel.IOptions);

• Construct a new code cell with optional original cell content.

property executionCount

executionCount: nbformat.ExecutionCount;

• The execution count of the cell.

property executionState

executionState: IExecutionState;

• The execution state of the cell.

property isDirty

isDirty: boolean;

• Whether the cell is dirty or not.

  A cell is dirty if it is output is not empty and does not result of the input code execution.

property outputs

readonly outputs: IOutputAreaModel;

• The cell outputs.

property sharedModel

readonly sharedModel: ISharedCodeCell;

property type

readonly type: string;

• The type of the cell.

method clearExecution

clearExecution: () => void;

method dispose

dispose: () => void;

• Dispose of the resources held by the model.

method onOutputsChange

protected onOutputsChange: (
    sender: IOutputAreaModel,
    event: IOutputAreaModel.ChangedArgs
) => void;

• Handle a change to the cell outputs modelDB and reflect it in the shared model.

method onTrustedChanged

onTrustedChanged: (
    trusted: CellModel,
    args: ObservableValue.IChangedArgs
) => void;

• Handle a change to the trusted state.

method toJSON

toJSON: () => nbformat.ICodeCell;

• Serialize the model to JSON.

constructor

constructor();

• Construct a new collapser.

property collapsed

readonly collapsed: boolean;

• Is the input/output of the parent collapsed.

method handleClick

protected abstract handleClick: (e: React.MouseEvent<HTMLDivElement>) => void;

• Handle the click event.

method render

protected render: () => React.ReactElement<any>;

• Render the collapser with the virtual DOM.

constructor

constructor(options: InputArea.IOptions);

• Construct an input area widget.

property contentFactory

readonly contentFactory: InputArea.IContentFactory;

• The content factory used by the widget.

property editor

readonly editor: CodeEditor.IEditor;

• Get the CodeEditor used by the cell.

property editorWidget

readonly editorWidget: CodeEditorWrapper;

• Get the CodeEditorWrapper used by the cell.

property model

readonly model: ICellModel;

• The model used by the widget.

property promptNode

readonly promptNode: HTMLElement;

• Get the prompt node used by the cell.

property renderedInput

readonly renderedInput: Widget;

• Get the rendered input area widget, if any.

method dispose

dispose: () => void;

• Dispose of the resources held by the widget.

method renderInput

renderInput: (widget: Widget) => void;

• Render an input instead of the text editor.

method setPrompt

setPrompt: (value: string) => void;

• Set the prompt of the input area.

method showEditor

showEditor: () => void;

• Show the text editor.

constructor

constructor();

• Construct a new input collapser.

property collapsed

readonly collapsed: boolean;

• Is the cell's input collapsed?

method handleClick

protected handleClick: (e: React.MouseEvent<HTMLDivElement>) => void;

• Handle a click event for the user to collapse the cell's input.

constructor

constructor(options: IPlaceholderOptions);

• Construct a new input placeholder.

constructor

constructor();

property executionCount

executionCount: string;

• The execution count for the prompt.

constructor

constructor(options: MarkdownCell.IOptions);

• Construct a Markdown cell widget.

property headingCollapsed

headingCollapsed: boolean;

• Whether the heading is collapsed or not.

property headingCollapsedChanged

readonly headingCollapsedChanged: ISignal<MarkdownCell, boolean>;

• Signal emitted when the cell collapsed state changes.

property headingInfo

readonly headingInfo: { text: string; level: number };

• Text that represents the highest heading (i.e. lowest level) if cell is a heading. Returns empty string if not a heading.

property headings

readonly headings: Cell.IHeading[];

property headingsResolved

readonly headingsResolved: boolean;

property numberChildNodes

numberChildNodes: number;

• Number of collapsed sub cells.

property rendered

rendered: boolean;

• Whether the cell is rendered.

property renderedChanged

readonly renderedChanged: ISignal<MarkdownCell, boolean>;

• Signal emitted when the markdown cell rendered state changes

property renderer

readonly renderer: IRenderMime.IRenderer;

• Renderer

property showEditorForReadOnly

showEditorForReadOnly: boolean;

method clone

clone: () => MarkdownCell;

• Clone the cell, using the same model.

method dispose

dispose: () => void;

• Dispose of the resources held by the widget.

method getHeadings

getHeadings: () => Promise<Cell.IHeading[]>;

• Parses and returns the list of Markdown headings in the cell.

  Returns

  A promise that resolves to an array of cell headings.

  Remarks

  This method caches the result after the first call to avoid redundant parsing.

method initializeDOM

protected initializeDOM: () => void;

• Create children widgets.

method maybeCreateCollapseButton

protected maybeCreateCollapseButton: () => void;

method maybeCreateOrUpdateExpandButton

protected maybeCreateOrUpdateExpandButton: () => void;

• Create, update or remove the hidden cells button. Note that the actual visibility is controlled in Static Notebook by toggling jp-mod-showHiddenCellsButton class.

method onContentChanged

protected onContentChanged: () => void;

• Callback on content changed

method onUpdateRequest

protected onUpdateRequest: (msg: Message) => void;

method renderCollapseButtons

protected renderCollapseButtons: (widget?: Widget) => void;

• Render the collapse button for heading cells, and for collapsed heading cells render the "expand hidden cells" button.

method renderInput

protected renderInput: (widget: Widget) => void;

• Render an input instead of the text editor.

method showEditor

protected showEditor: () => void;

• Show the text editor instead of rendered input.

method updateCellSourceWithAttachment

protected updateCellSourceWithAttachment: (
    attachmentName: string,
    URI?: string
) => void;

• Modify the cell source to include a reference to the attachment.

constructor

constructor(
    options?: Omit<
        AttachmentsCellModel.IOptions<ISharedMarkdownCell>,
        'cell_type'
    >
);

• Construct a markdown cell model from optional shared model.

property type

readonly type: string;

• The type of the cell.

method toJSON

toJSON: () => nbformat.IMarkdownCell;

• Serialize the model to JSON.

constructor

constructor();

• Construct a new output collapser.

property collapsed

readonly collapsed: boolean;

• Is the cell's output collapsed?

method handleClick

protected handleClick: (e: React.MouseEvent<HTMLDivElement>) => void;

• Handle a click event for the user to collapse the cell's output.

constructor

constructor(options: IPlaceholderOptions);

• Construct a new output placeholder.

constructor

constructor(options: IPlaceholderOptions);

• Construct a new placeholder.

property text

text: string;

method onAfterAttach

protected onAfterAttach: (msg: Message) => void;

method onBeforeDetach

protected onBeforeDetach: (msg: Message) => void;

constructor

constructor(options: RawCell.IOptions);

• Construct a raw cell widget.

method clone

clone: () => RawCell;

• Clone the cell, using the same model.

constructor

constructor(
    options?: Omit<AttachmentsCellModel.IOptions<ISharedRawCell>, 'cell_type'>
);

• Construct a raw cell model from optional shared model.

property type

readonly type: string;

• The type of the cell.

method toJSON

toJSON: () => nbformat.IRawCell;

• Serialize the model to JSON.

property attachments

readonly attachments: IAttachmentsModel;

• The cell attachments

property contentChanged

readonly contentChanged: ISignal<ICellModel, void>;

• A signal emitted when the content of the model changes.

property id

readonly id: string;

• A unique identifier for the cell.

property metadata

readonly metadata: Omit<nbformat.IBaseCellMetadata, 'trusted'>;

• The metadata associated with the cell.

  ### Notes This is a copy of the metadata. Changing a part of it won't affect the model. As this returns a copy of all metadata, it is advised to use getMetadata to speed up the process of getting a single key.

property metadataChanged

readonly metadataChanged: ISignal<ICellModel, IMapChange>;

• Signal emitted when cell metadata changes.

property sharedModel

readonly sharedModel: ISharedCell;

• The cell shared model.

property stateChanged

readonly stateChanged: ISignal<ICellModel, IChangedArgs<boolean, boolean, any>>;

• A signal emitted when a model state changes.

property trusted

trusted: boolean;

• Whether the cell is trusted.

property type

readonly type: nbformat.CellType;

• The type of the cell.

method deleteMetadata

deleteMetadata: (key: string) => void;

• Delete a metadata.

  Parameter key

  Metadata key

method getMetadata

getMetadata: (key: string) => any;

• Get a metadata

  ### Notes This returns a copy of the key value.

  Parameter key

  Metadata key

method setMetadata

setMetadata: (key: string, value: any) => void;

• Set a metadata

  Parameter key

  Metadata key

  Parameter value

  Metadata value

method toJSON

toJSON: () => nbformat.ICell;

• Serialize the model to JSON.

property executionCount

executionCount: nbformat.ExecutionCount;

• The code cell's prompt number. Will be null if the cell has not been run.

property executionState

executionState: IExecutionState;

• The code cell's state.

property isDirty

readonly isDirty: boolean;

• Whether the code cell has been edited since the last run.

property outputs

readonly outputs: IOutputAreaModel;

• The cell outputs.

property sharedModel

readonly sharedModel: ISharedCodeCell;

• The code cell shared model

property type

readonly type: 'code';

• The type of the cell.

  #### Notes This is a read-only property.

method clearExecution

clearExecution: () => void;

• Clear execution, outputs, and related metadata

method toJSON

toJSON: () => nbformat.ICodeCell;

• Serialize the model to JSON.

property executionCount

executionCount: string | null;

• The execution count of the prompt.

property type

readonly type: 'markdown';

• The type of the cell.

method toJSON

toJSON: () => nbformat.IMarkdownCell;

• Serialize the model to JSON.

property callback

callback: (e: MouseEvent) => void;

• Ellipsis button callback

property promptClass

promptClass?: string;

• Prompt element CSS class

property text

text?: string;

• Text to include with the placeholder

property translator

translator?: ITranslator;

• Translator object

property type

readonly type: 'raw';

• The type of the cell.

method toJSON

toJSON: () => nbformat.IRawCell;

• Serialize the model to JSON.

variable defaultContentFactory

const defaultContentFactory: ContentFactory;

• The shared ContentFactory instance.