Interface IToggleGroupPropertyItemOptions

Optional properties for Toggle Group property item

interface IToggleGroupPropertyItemOptions {
    enable?: boolean;
    entries?: IToggleGroupPropertyItemEntry[];
    hiddenEntryLabels?: boolean;
    hiddenLabel?: boolean;
    onChange?: (
        newValue: number,
        oldValue: number,
        items: IToggleGroupPropertyItemEntry[],
    ) => void;
    title?: LocalizedString;
    tooltip?: LocalizedString;
    visible?: boolean;
}

Hierarchy (View Summary)

Properties

enable? entries? hiddenEntryLabels? hiddenLabel? onChange? title? tooltip? visible?

Properties

Optionalenable

enable?: boolean

Remarks

Initial enabled state of property item. If undefined, it will default to true.

Optionalentries

entries?: IToggleGroupPropertyItemEntry[]

Remarks

List of toggle button entries associated with the property item. If undefined, list will be empty.

OptionalhiddenEntryLabels

hiddenEntryLabels?: boolean

Remarks

If true toggle buttons will be displayed vertically with their labels. If undefined, labels will be hidden.

OptionalhiddenLabel

hiddenLabel?: boolean

Remarks

If true label text will be hidden. It will be visible by default.

OptionalonChange

onChange?: (
    newValue: number,
    oldValue: number,
    items: IToggleGroupPropertyItemEntry[],
) => void

Remarks

This callback is called when UI control value is changed.

Optionaltitle

title?: LocalizedString

Remarks

Localized title of the property item.

Optionaltooltip

tooltip?: LocalizedString

Remarks

Tooltip description of the property item.

Optionalvisible

visible?: boolean

Remarks

Initial visibility state of property item. If undefined, it will default to true.

Settings

Member Visibility

On This Page

Properties