#Interface: IToggleGroupPropertyItem experimental

Beta

A property item which supports toggle button properties

#Extends

• IPropertyItemBase

#Properties

#enable

enable: boolean

Beta

#Remarks

If the item is enabled in the UI.

#Inherited from

IPropertyItemBase.enable

---

#id

readonly id: string

Beta

#Remarks

Unique ID for the property item.

#Inherited from

IPropertyItemBase.id

---

#paneId

readonly paneId: string

Beta

#Remarks

The parent pane id.

#Inherited from

IPropertyItemBase.paneId

---

#typeName

readonly typeName: PropertyItemType

Beta

#Remarks

The type name of the target property.

#Inherited from

IPropertyItemBase.typeName

---

#value

readonly value: number

Beta

#Remarks

Current selected entry value.

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

IPropertyItemBase.visible

#Methods

#getEntryByIndex()

getEntryByIndex(index): IToggleGroupPropertyItemEntry | undefined

Beta

#Parameters

#index

number

Index of the toggle entry in the list.

#Returns

IToggleGroupPropertyItemEntry | undefined

#Remarks

Find a toggle entry at an index in the group.

---

#getEntryByValue()

getEntryByValue(value): IToggleGroupPropertyItemEntry | undefined

Beta

#Parameters

#value

number

Value of the toggle entry in the group.

#Returns

IToggleGroupPropertyItemEntry | undefined

#Remarks

Find a toggle entry with a specific value associated with property item.

---

#setTitle()

setTitle(title): void

Beta

#Parameters

#title

LocalizedString | undefined

New title.

#Returns

void

#Remarks

Updates title of the property item.

---

#setTooltip()

setTooltip(tooltip): void

Beta

#Parameters

#tooltip

BasicTooltipContent | undefined

New tooltip.

#Returns

void

#Remarks

Updates tooltip of the property item.

---

#updateEntries()

updateEntries(entries, newValue?): void

Beta

#Parameters

#entries

IToggleGroupPropertyItemEntry[]

New list of updated entries.

#newValue?

number

New value value to use for the selected toggle button.

#Returns

void

#Remarks

Update list of toggle group entries.