Interface IOptions<T>

The options used to construct a NotebookWidgetFactory.

interface IOptions<T> {
    autoStartDefault?: boolean;
    canStartKernel?: boolean;
    contentFactory: NotebookPanel.IContentFactory;
    defaultFor?: readonly string[];
    defaultRendered?: readonly string[];
    editorConfig?: IEditorConfig;
    fileTypes: readonly string[];
    label?: string;
    mimeTypeService: IEditorMimeTypeService;
    modelName?: string;
    name: string;
    notebookConfig?: INotebookConfig;
    preferKernel?: boolean;
    readOnly?: boolean;
    rendermime: IRenderMimeRegistry;
    shutdownOnClose?: boolean;
    toolbarFactory?: ((widget) => IObservableList<DocumentRegistry.IToolbarItem> | DocumentRegistry.IToolbarItem[]);
    translator?: ITranslator;
}

Type Parameters

Hierarchy (view full)

Properties

autoStartDefault? canStartKernel? contentFactory defaultFor? defaultRendered? editorConfig? fileTypes label? mimeTypeService modelName? name notebookConfig? preferKernel? readOnly? rendermime shutdownOnClose? toolbarFactory? translator?

Properties

Optional Readonly autoStartDefault

autoStartDefault?: boolean

Whether to automatically start the preferred kernel

Optional Readonly canStartKernel

canStartKernel?: boolean

Whether the widgets can start a kernel when opened.

contentFactory

contentFactory: NotebookPanel.IContentFactory

A notebook panel content factory.

Optional Readonly defaultFor

defaultFor?: readonly string[]

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

Optional Readonly defaultRendered

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.

Optional editorConfig

editorConfig?: IEditorConfig

The notebook cell editor configuration.

Readonly fileTypes

fileTypes: readonly string[]

The file types the widget can view.

Optional Readonly label

label?: string

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

mimeTypeService

mimeTypeService: IEditorMimeTypeService

The service used to look up mime types.

Optional Readonly modelName

modelName?: string

The name of the document model type.

Readonly name

name: string

The name of the widget to display in dialogs.

Optional notebookConfig

notebookConfig?: INotebookConfig

The notebook configuration.

Optional Readonly preferKernel

preferKernel?: boolean

Whether the widgets prefer having a kernel started.

Optional Readonly readOnly

readOnly?: boolean

Whether the widget factory is read only.

rendermime

rendermime: IRenderMimeRegistry

Optional Readonly shutdownOnClose

shutdownOnClose?: boolean

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

Optional Readonly toolbarFactory

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

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

Type declaration

Optional translator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

Theme

On This Page

autoStartDefaultcanStartKernelcontentFactorydefaultFordefaultRenderededitorConfigfileTypeslabelmimeTypeServicemodelNamenamenotebookConfigpreferKernelreadOnlyrendermimeshutdownOnClosetoolbarFactorytranslator