Interface IBoolPropertyItemOptions

Optional properties for Bool property item

interface IBoolPropertyItemOptions {
    enable?: boolean;
    hiddenLabel?: boolean;
    onChange?: (newValue: boolean, oldValue: boolean) => void;
    title?: LocalizedString;
    tooltip?: LocalizedString;
    variant?: BoolPropertyItemVariant;
    visible?: boolean;
}

Hierarchy (View Summary)

Properties

enable? hiddenLabel? onChange? title? tooltip? variant? visible?

Properties

Optionalenable

enable?: boolean

Remarks

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

OptionalhiddenLabel

hiddenLabel?: boolean

Remarks

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

OptionalonChange

onChange?: (newValue: boolean, oldValue: boolean) => void

Remarks

This callback is called when UI control value is changed.

Optionaltitle

title?: LocalizedString

Remarks

Localized title of the text item.

Optionaltooltip

tooltip?: LocalizedString

Remarks

Tooltip description of the property item

Optionalvariant

variant?: BoolPropertyItemVariant

Remarks

Determines how we display bool as a UI element. If undefined, it will default to Checkbox.

Optionalvisible

visible?: boolean

Remarks

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

Settings

Member Visibility

On This Page

Properties