Interface IFactory

The interface for a notebook widget factory.

interface IFactory {
    autoStartDefault: boolean;
    canStartKernel?: boolean;
    defaultFor?: readonly string[];
    defaultRendered?: readonly string[];
    editorConfig: IEditorConfig;
    fileTypes: readonly string[];
    isDisposed: boolean;
    label?: string;
    modelName?: string;
    name: string;
    notebookConfig: INotebookConfig;
    preferKernel?: boolean;
    readOnly?: boolean;
    shutdownOnClose: boolean;
    toolbarFactory?: ((widget) => IObservableList<DocumentRegistry.IToolbarItem> | DocumentRegistry.IToolbarItem[]);
    translator?: IRenderMime.ITranslator;
    widgetCreated: ISignal<IWidgetFactory<NotebookPanel, INotebookModel>, NotebookPanel>;
    createNew(context, source?): NotebookPanel;
    dispose(): void;
}

Hierarchy (view full)

Properties

autoStartDefault canStartKernel? defaultFor? defaultRendered? editorConfig fileTypes isDisposed label? modelName? name notebookConfig preferKernel? readOnly? shutdownOnClose toolbarFactory? translator? widgetCreated

Methods

createNew dispose

Properties

autoStartDefault

autoStartDefault: boolean

Whether to automatically start the preferred kernel.

Optional Readonly canStartKernel

canStartKernel?: boolean

Whether the widgets can start a kernel when opened.

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.

editorConfig

editorConfig: IEditorConfig

A configuration object for cell editor settings.

Readonly fileTypes

fileTypes: readonly string[]

The file types the widget can view.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Optional Readonly label

label?: string

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

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.

notebookConfig

notebookConfig: INotebookConfig

A configuration object for notebook settings.

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.

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 Readonly translator

translator?: IRenderMime.ITranslator

The application language translator.

widgetCreated

widgetCreated: ISignal<IWidgetFactory<NotebookPanel, INotebookModel>, NotebookPanel>

A signal emitted when a new widget is created.

Methods

createNew

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

Settings

Member Visibility

Theme

On This Page

autoStartDefaultcanStartKerneldefaultFordefaultRenderededitorConfigfileTypesisDisposedlabelmodelNamenamenotebookConfigpreferKernelreadOnlyshutdownOnClosetoolbarFactorytranslatorwidgetCreatedcreateNewdispose