Interface IOptions

An options object for main area widget subclasses providing their own default content.

Notes

This makes it easier to have a subclass that provides its own default content. This can go away once we upgrade to TypeScript 2.8 and have an easy way to make a single property optional, ala https://stackoverflow.com/a/46941824

interface IOptions {
    content?: CSVViewer;
    context: IContext<DocumentRegistry.IModel>;
    delimiter?: string;
    node?: HTMLElement;
    reveal?: Promise<any>;
    tag?: keyof HTMLElementTagNameMap;
    toolbar?: Toolbar<Widget>;
    translator?: ITranslator;
}

Hierarchy (view full)

Properties

content? context delimiter? node? reveal? tag? toolbar? translator?

Properties

Optional content

content?: CSVViewer

The child widget to wrap.

context

context: IContext<DocumentRegistry.IModel>

Optional delimiter

delimiter?: string

Data delimiter character

Optional node

node?: HTMLElement

The optional node to use for the widget.

If a node is provided, the widget will assume full ownership and control of the node, as if it had created the node itself.

The default is a new <div>.

Optional reveal

reveal?: Promise<any>

An optional promise for when the content is ready to be revealed.

Optional tag

tag?: keyof HTMLElementTagNameMap

The optional element tag, used for constructing the widget's node.

If a pre-constructed node is provided via the node arg, this value is ignored.

Optional toolbar

toolbar?: Toolbar<Widget>

The toolbar to use for the widget. Defaults to an empty toolbar.

Optional translator

translator?: ITranslator

The application language translator.

Settings

Member Visibility

Theme

On This Page

contentcontextdelimiternoderevealtagtoolbartranslator