Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions<T>

The options used to construct a NotebookWidgetFactory.

Type parameters

Hierarchy

  • IWidgetFactoryOptions<T>
    • IOptions

Index

Properties

Optional canStartKernel

canStartKernel: boolean

Whether the widgets can start a kernel when opened.

contentFactory

contentFactory: IContentFactory

A notebook panel content factory.

Optional defaultFor

defaultFor: ReadonlyArray<string>

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

Optional defaultRendered

defaultRendered: ReadonlyArray<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.

fileTypes

fileTypes: ReadonlyArray<string>

The file types the widget can view.

mimeTypeService

mimeTypeService: IEditorMimeTypeService

The service used to look up mime types.

Optional modelName

modelName: string

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

name

name: string

The name of the widget to display in dialogs.

Optional notebookConfig

notebookConfig: INotebookConfig

The notebook configuration.

Optional preferKernel

preferKernel: boolean

Whether the widgets prefer having a kernel started.

Optional readOnly

readOnly: boolean

Whether the widget factory is read only.

rendermime

rendermime: IRenderMimeRegistry

Optional shutdownOnClose

shutdownOnClose: boolean

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

Optional toolbarFactory

toolbarFactory: function

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

Type declaration

    • (widget: T): IToolbarItem[]
    • Parameters

      • widget: T

      Returns IToolbarItem[]

Generated using TypeDoc