Interface IWidgetFactoryOptions<T>

The options used to initialize a widget factory.

interface IWidgetFactoryOptions<T extends Widget = Widget> {
    autoStartDefault?: boolean;
    canStartKernel?: boolean;
    contentProviderId?: string;
    defaultFor?: readonly string[];
    defaultRendered?: readonly string[];
    fileTypes: readonly string[];
    label?: string;
    modelName?: string;
    name: string;
    preferKernel?: boolean;
    readOnly?: boolean;
    shutdownOnClose?: boolean;
    toolbarFactory?: (
        widget: T,
    ) =>
        | DocumentRegistry.IToolbarItem[]
        | IObservableList<DocumentRegistry.IToolbarItem>;
    translator?: IRenderMime.ITranslator;
}

Type Parameters

Hierarchy (View Summary)

Properties

autoStartDefault? canStartKernel? contentProviderId? defaultFor? defaultRendered? fileTypes label? modelName? name preferKernel? readOnly? shutdownOnClose? toolbarFactory? translator?

Properties

Optional ReadonlyautoStartDefault

autoStartDefault?: boolean

Whether to automatically start the preferred kernel

Optional ReadonlycanStartKernel

canStartKernel?: boolean

Whether the widgets can start a kernel when opened.

Optional Readonly ExperimentalcontentProviderId

contentProviderId?: string

Identifier of the content provider required for the widget (if any).

Optional ReadonlydefaultFor

defaultFor?: readonly string[]

The file types for which the factory should be the default.

Optional ReadonlydefaultRendered

defaultRendered?: readonly string[]

The file types for which the factory should be the default for rendering, if that is different than the default factory (which may be for editing) If undefined, then it will fall back on the default file type.

ReadonlyfileTypes

fileTypes: readonly string[]

The file types the widget can view.

Optional Readonlylabel

label?: string

The label of the widget to display in dialogs. If not given, name is used instead.

Optional ReadonlymodelName

modelName?: string

The name of the document model type.

Readonlyname

name: string

The name of the widget to display in dialogs.

Optional ReadonlypreferKernel

preferKernel?: boolean

Whether the widgets prefer having a kernel started.

Optional ReadonlyreadOnly

readOnly?: boolean

Whether the widget factory is read only.

Optional ReadonlyshutdownOnClose

shutdownOnClose?: boolean

Whether the kernel should be shutdown when the widget is closed.

Optional ReadonlytoolbarFactory

toolbarFactory?: (
    widget: T,
) =>
    | DocumentRegistry.IToolbarItem[]
    | IObservableList<DocumentRegistry.IToolbarItem>

A function producing toolbar widgets, overriding the default toolbar widgets.

Optional Readonlytranslator

translator?: IRenderMime.ITranslator

The application language translator.

Settings

Member Visibility

On This Page

Properties