• Public
  • Public/Protected
  • All

The options used to construct a NotebookWidgetFactory.

Type parameters




Optional Readonly canStartKernel

canStartKernel: boolean

Whether the widgets can start a kernel when opened.


contentFactory: 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.


mimeTypeService: IEditorMimeTypeService

The service used to look up mime types.

Optional Readonly modelName

modelName: string

The registered name of the model type used to create the widgets.

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.


Optional sessionDialogs

sessionDialogs: ISessionContextDialogs

The session context dialogs.

Optional Readonly shutdownOnClose

shutdownOnClose: boolean

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

Optional Readonly toolbarFactory

toolbarFactory: (widget: T) => IToolbarItem[] | IObservableList<IToolbarItem>

Type declaration

Optional translator

translator: ITranslator

The application language translator.

Generated using TypeDoc