Interface IButtonPanePropertyItem`Beta`

A property item pane which supports multiple buttons

interface IButtonPanePropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    visible: boolean;
    addButton(
        action: ButtonPropertyItemSupportedActionTypes,
        options?: IButtonPropertyItemOptions,
    ): IButtonPropertyItem;
    hide(): void;
    show(): void;
}

Hierarchy (View Summary)

IPropertyItemBase
IPane
- IButtonPanePropertyItem

Index

Properties

enable id paneId typeName visible

Methods

addButton hide show

Properties

`Beta`enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly` `Beta`id

id: string

Remarks

Unique ID for the property item.

`Readonly` `Beta`paneId

paneId: string

Remarks

The parent pane id.

`Readonly` `Beta`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

`Beta`visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

addButton

addButton(
action: ButtonPropertyItemSupportedActionTypes,
options?: IButtonPropertyItemOptions,
): IButtonPropertyItem
Beta
Parameters
- action: ButtonPropertyItemSupportedActionTypes
- Optionaloptions: IButtonPropertyItemOptions
Returns IButtonPropertyItem
Remarks
Adds a button to the pane and binds the specified action to the button interaction.
- Defined in tmp/package/index.d.ts:4970

hide

hide(): void
Beta
Returns void
Remarks
Hide the pane.
Inherited from IPane.hide
- Defined in tmp/package/index.d.ts:5901

show

show(): void
Beta
Returns void
Remarks
Show the pane and all of its items.
Inherited from IPane.show
- Defined in tmp/package/index.d.ts:5907