Interface IToggleGroupPropertyItem

A property item which supports toggle button properties

interface IToggleGroupPropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    value: number;
    visible: boolean;
    getEntryByIndex(index: number): IToggleGroupPropertyItemEntry;
    getEntryByValue(value: number): IToggleGroupPropertyItemEntry;
    setTitle(title: LocalizedString): void;
    setTooltip(tooltip: LocalizedString): void;
    updateEntries(
        entries: IToggleGroupPropertyItemEntry[],
        newValue?: number,
    ): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- IToggleGroupPropertyItem

Index

Properties

enable id paneId typeName value visible

Methods

getEntryByIndex getEntryByValue setTitle setTooltip updateEntries

Properties

enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly`id

id: string

Remarks

Unique ID for the property item.

`Readonly`paneId

paneId: string

Remarks

The parent pane id.

`Readonly`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

`Readonly`value

value: number

Remarks

Current selected entry value.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

getEntryByIndex

getEntryByIndex(index: number): IToggleGroupPropertyItemEntry
Parameters
- index: number
  Index of the toggle entry in the list.
Returns IToggleGroupPropertyItemEntry
Remarks
Find a toggle entry at an index in the group.

getEntryByValue

getEntryByValue(value: number): IToggleGroupPropertyItemEntry
Parameters
- value: number
  Value of the toggle entry in the group.
Returns IToggleGroupPropertyItemEntry
Remarks
Find a toggle entry with a specific value associated with property item.

setTitle

setTitle(title: LocalizedString): void
Parameters
- title: LocalizedString
  New title.
Returns void
Remarks
Updates title of the property item.

setTooltip

setTooltip(tooltip: LocalizedString): void
Parameters
- tooltip: LocalizedString
  New tooltip.
Returns void
Remarks
Updates tooltip of the property item.

updateEntries

updateEntries(entries: IToggleGroupPropertyItemEntry[], newValue?: number): void
Parameters
- entries: IToggleGroupPropertyItemEntry[]
  New list of updated entries.
- OptionalnewValue: number
  New value value to use for the selected toggle button.
Returns void
Remarks
Update list of toggle group entries.