Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions<T>

An options object for initializing a title.

Type parameters

  • T

Hierarchy

  • IOptions

Index

Properties

Optional caption

caption: undefined | string

The caption for the title.

Optional className

className: undefined | string

The extra class name for the title.

Optional closable

closable: undefined | false | true

The closable state for the title.

Optional dataset

dataset: Dataset

The dataset for the title.

Optional icon

icon: VirtualElement.IRenderer | string

The icon renderer for the title.

DEPRECATED: if set to a string value, the .icon field will function as an alias for the .iconClass field, for backwards compatibility

Optional iconClass

iconClass: undefined | string

The icon class name for the title.

Optional iconLabel

iconLabel: undefined | string

The icon label for the title.

Optional iconRenderer

iconRenderer: VirtualElement.IRenderer
deprecated

Use icon instead.

Optional label

label: undefined | string

The label for the title.

Optional mnemonic

mnemonic: undefined | number

The mnemonic index for the title.

owner

owner: T

The object which owns the title.

Generated using TypeDoc