Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

  • IDocumentWidgetFactoryOptions

Index

Properties

Optional Readonly defaultFor

defaultFor: ReadonlyArray<string>

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

Optional Readonly 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.

Readonly fileTypes

fileTypes: ReadonlyArray<string>

The file types the widget can view.

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.

Readonly primaryFileType

primaryFileType: string

The primary file type of the widget.

Optional Readonly toolbarFactory

toolbarFactory: (widget?: IRenderer) => IToolbarItem[]

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

Type declaration

Generated using TypeDoc