#Interface: IButtonPropertyItem experimental

Beta

A property item which supports 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

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

IPropertyItemBase.visible

#Methods

#replaceAction()

replaceAction(action): void

Beta

#Parameters

#action

RegisteredAction<NoArgsAction>

New action to replace the existing with.

#Returns

void

#Remarks

Replace action assigned to the button.

---

#setIcon()

setIcon(icon): void

Beta

#Parameters

#icon

string | undefined

New button icon.

#Returns

void

#Remarks

Updates icon of the button.

---

#setTitle()

setTitle(title): void

Beta

#Parameters

#title

LocalizedString | undefined

New button title.

#Returns

void

#Remarks

Updates title of the button.

---

#setTooltip()

setTooltip(tooltip): void

Beta

#Parameters

#tooltip

BasicTooltipContent | undefined

New button tooltip.

#Returns

void

#Remarks

Updates tooltip description of the button.