Interface IOptions

An options object for initializing a base cell widget.

interface IOptions {
    contentFactory: Cell.IContentFactory;
    editorConfig?: Record<string, any>;
    editorExtensions?: Extension[];
    inputHistoryScope?: "global" | "session";
    layout?: PanelLayout;
    maxNumberOutputs?: number;
    model: IMarkdownCellModel;
    placeholder?: boolean;
    rendermime: IRenderMimeRegistry;
    showEditorForReadOnlyMarkdown?: boolean;
    translator?: ITranslator;
}

Hierarchy (view full)

Properties

contentFactory editorConfig? editorExtensions? inputHistoryScope? layout? maxNumberOutputs? model placeholder? rendermime showEditorForReadOnlyMarkdown? translator?

Properties

contentFactory

contentFactory: Cell.IContentFactory

The factory object for customizable cell children.

Optional editorConfig

editorConfig?: Record<string, any>

The configuration options for the text editor widget.

Optional editorExtensions

editorExtensions?: Extension[]

Editor extensions to be added.

Optional inputHistoryScope

inputHistoryScope?: "global" | "session"

Whether to split stdin line history by kernel session or keep globally accessible.

Optional layout

layout?: PanelLayout

Cell widget layout.

Optional maxNumberOutputs

maxNumberOutputs?: number

The maximum number of output items to display in cell output.

model

model: IMarkdownCellModel

The model used by the cell.

Optional placeholder

placeholder?: boolean

Whether this cell is a placeholder for future rendering.

rendermime

rendermime: IRenderMimeRegistry

The mime renderer for the cell widget.

Optional showEditorForReadOnlyMarkdown

showEditorForReadOnlyMarkdown?: boolean

Show editor for read-only Markdown cells.

Optional translator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

Theme

On This Page

contentFactoryeditorConfigeditorExtensionsinputHistoryScopelayoutmaxNumberOutputsmodelplaceholderrendermimeshowEditorForReadOnlyMarkdowntranslator