Interface IOptions

An options object for initializing a base cell widget.

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

Hierarchy (View Summary)

Properties

contentFactory editorConfig? editorExtensions? inputHistoryScope? layout? maxNumberOutputs? model placeholder? showInputPlaceholder? translator?

Properties

contentFactory

contentFactory: Cell.IContentFactory

The factory object for customizable cell children.

OptionaleditorConfig

editorConfig?: Record<string, any>

The configuration options for the text editor widget.

OptionaleditorExtensions

editorExtensions?: Extension[]

Editor extensions to be added.

OptionalinputHistoryScope

inputHistoryScope?: "session" | "global"

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

Optionallayout

layout?: PanelLayout

Cell widget layout.

OptionalmaxNumberOutputs

maxNumberOutputs?: number

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

model

model: IRawCellModel

The model used by the cell.

Optionalplaceholder

placeholder?: boolean

Whether this cell is a placeholder for future rendering.

OptionalshowInputPlaceholder

showInputPlaceholder?: boolean

Show placeholder text for standard input

Optionaltranslator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

On This Page

Properties