Interface IDocumentWidgetFactoryOptions

The options used to initialize a document widget factory.

This interface is intended to be used by mime renderer extensions to define a document opener that uses its renderer factory.

interface IDocumentWidgetFactoryOptions {
    defaultFor?: readonly string[];
    defaultRendered?: readonly string[];
    fileTypes: readonly string[];
    label?: string;
    modelName?: string;
    name: string;
    primaryFileType: string;
    toolbarFactory?: (widget?: Widget) => IRenderMime.IToolbarItem[];
    translator?: IRenderMime.ITranslator;
}

Properties

defaultFor? defaultRendered? fileTypes label? modelName? name primaryFileType toolbarFactory? translator?

Properties

Optional ReadonlydefaultFor

defaultFor?: readonly string[]

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

Optional ReadonlydefaultRendered

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.

ReadonlyfileTypes

fileTypes: readonly string[]

The file types the widget can view.

Optional Readonlylabel

label?: string

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

Optional ReadonlymodelName

modelName?: string

The name of the document model type.

Readonlyname

name: string

The name of the widget to display in dialogs.

ReadonlyprimaryFileType

primaryFileType: string

The primary file type of the widget.

Optional ReadonlytoolbarFactory

toolbarFactory?: (widget?: Widget) => IRenderMime.IToolbarItem[]

A function returning a list of toolbar items to add to the toolbar.

Optional Readonlytranslator

translator?: IRenderMime.ITranslator

The application language translator.

Settings

Member Visibility

On This Page

Properties