Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions<T>

The options used to initialize a MimeDocumentFactory.

Type parameters

Hierarchy

Index

Properties

Optional canStartKernel

canStartKernel: boolean

Whether the widgets can start a kernel when opened.

Optional dataType

dataType: "string" | "json"

Preferred data type from the model.

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.

fileTypes

fileTypes: ReadonlyArray<string>

The file types the widget can view.

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 preferKernel

preferKernel: boolean

Whether the widgets prefer having a kernel started.

primaryFileType

primaryFileType: IFileType

The primary file type associated with the document.

Optional readOnly

readOnly: boolean

Whether the widget factory is read only.

Optional renderTimeout

renderTimeout: number

The render timeout.

rendermime

rendermime: IRenderMimeRegistry

The rendermime instance.

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

Generated using TypeDoc