#Interface: ISubPaneHeaderButtonItem experimental

Beta

A curated, icon-only button in a sub pane header.

#Extends

• ISubPaneHeaderItem

#Properties

#enable

enable: boolean

Beta

#Remarks

If the item is enabled in the UI.

#Inherited from

ISubPaneHeaderItem.enable

---

#id

readonly id: string

Beta

#Remarks

Unique ID for the property item.

#Inherited from

ISubPaneHeaderItem.id

---

#paneId

readonly paneId: string

Beta

#Remarks

The parent pane id.

#Inherited from

ISubPaneHeaderItem.paneId

---

#typeName

readonly typeName: PropertyItemType

Beta

#Remarks

The type name of the target property.

#Inherited from

ISubPaneHeaderItem.typeName

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

ISubPaneHeaderItem.visible

#Methods

#replaceAction()

replaceAction(action): void

Beta

#Parameters

#action

RegisteredAction<NoArgsAction>

New action.

#Returns

void

#Remarks

Replaces the action assigned to the button.

---

#setIcon()

setIcon(icon): void

Beta

#Parameters

#icon

string

New icon.

#Returns

void

#Remarks

Updates the icon of the button.

---

#setTooltip()

setTooltip(tooltip): void

Beta

#Parameters

#tooltip

BasicTooltipContent | undefined

New tooltip.

#Returns

void

#Remarks

Updates the tooltip of the header item.

#Inherited from

ISubPaneHeaderItem.setTooltip