Interface IToggleGroupPropertyItemOptions

Optional properties for Toggle Group property item

Hierarchy

Properties

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

Properties

Optional enable

enable?: boolean

Remarks

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

Optional entries

entries?: IToggleGroupPropertyItemEntry[]

Remarks

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

Optional hiddenEntryLabels

hiddenEntryLabels?: boolean

Remarks

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

Optional hiddenLabel

hiddenLabel?: boolean

Remarks

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

Optional onChange

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

Type declaration

    • (newValue, oldValue, items): void

    • Parameters

      Returns void

      Remarks

      This callback is called when UI control value is changed.

Optional title

title?: LocalizedString

Remarks

Localized title of the property item.

Optional tooltip

tooltip?: LocalizedString

Remarks

Tooltip description of the property item.

Optional visible

visible?: boolean

Remarks

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

Settings

Member Visibility

Theme

On This Page