Interface IOptions<T>

The options used to initialize a MimeDocumentFactory.

interface IOptions<T> {
    autoStartDefault?: boolean;
    canStartKernel?: boolean;
    dataType?: "string" | "json";
    defaultFor?: readonly string[];
    defaultRendered?: readonly string[];
    factory?: IRenderMime.IRendererFactory;
    fileTypes: readonly string[];
    label?: string;
    modelName?: string;
    name: string;
    preferKernel?: boolean;
    primaryFileType: undefined | DocumentRegistry.IFileType;
    readOnly?: boolean;
    renderTimeout?: number;
    rendermime: IRenderMimeRegistry;
    shutdownOnClose?: boolean;
    toolbarFactory?: ((widget) => DocumentRegistry.IToolbarItem[] | IObservableList<DocumentRegistry.IToolbarItem>);
    translator?: IRenderMime.ITranslator;
}

Type Parameters

Hierarchy (view full)

Properties

autoStartDefault? canStartKernel? dataType? defaultFor? defaultRendered? factory? fileTypes label? modelName? name preferKernel? primaryFileType readOnly? renderTimeout? 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.

Optional dataType

dataType?: "string" | "json"

Preferred data type from the model.

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 factory

factory?: IRenderMime.IRendererFactory

Optional renderer to use (overriding the renderer in the registry)

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.

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

preferKernel?: boolean

Whether the widgets prefer having a kernel started.

primaryFileType

primaryFileType: undefined | DocumentRegistry.IFileType

The primary file type associated with the document.

Optional Readonly readOnly

readOnly?: boolean

Whether the widget factory is read only.

Optional renderTimeout

renderTimeout?: number

The render timeout.

rendermime

rendermime: IRenderMimeRegistry

The rendermime instance.

Optional Readonly shutdownOnClose

shutdownOnClose?: boolean

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

Optional Readonly toolbarFactory

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

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

Type declaration

Optional Readonly translator

translator?: IRenderMime.ITranslator

The application language translator.

Settings

Member Visibility

Theme

On This Page

autoStartDefaultcanStartKerneldataTypedefaultFordefaultRenderedfactoryfileTypeslabelmodelNamenamepreferKernelprimaryFileTypereadOnlyrenderTimeoutrendermimeshutdownOnClosetoolbarFactorytranslator