For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-editor/interfaces/IButtonPanePropertyItem.md.

Interface: IButtonPanePropertyItem experimental

Beta

A property item pane which supports multiple buttons

Extends

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

addButton()

addButton(action, options?): IButtonPropertyItem

Beta

Parameters

action

ButtonPropertyItemSupportedActionTypes

options?

IButtonPropertyItemOptions

Returns

IButtonPropertyItem

Remarks

Adds a button to the pane and binds the specified action to the button interaction.


hide()

hide(): void

Beta

Returns

void

Remarks

Hide the pane.

Inherited from

IPane.hide


show()

show(): void

Beta

Returns

void

Remarks

Show the pane and all of its items.

Inherited from

IPane.show