Interface IPropertyPane`Beta`

Property pane present dynamic content. It can be associated with an object and presented with different kind of controls.

interface IPropertyPane {
    collapsed: boolean;
    id: string;
    onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
    parentPaneId?: string;
    title: string;
    visible: boolean;
    width?: number;
    addBlockList(
        options?: IPropertyItemOptionsBlockList,
    ): IBlockListPropertyItem<{ EMPTY: undefined }, "EMPTY">;
    addBlockPicker<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsDataPicker,
    ): IPropertyItem<T, Prop>;
    addBool(
        value: IObservableProp<boolean>,
        options?: IBoolPropertyItemOptions,
    ): IBoolPropertyItem;
    addBool_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsBool,
    ): IPropertyItem<T, Prop>;
    addButton(
        action: RegisteredAction<NoArgsAction> | () => void,
        options?: IButtonPropertyItemOptions,
    ): IButtonPropertyItem;
    addColorPicker<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsColorPicker,
    ): IPropertyItem<T, Prop>;
    addDivider(): IPropertyItemBase;
    addDropdown<
        T extends Omit<PropertyBag, Prop> & { [key in string]: number },
        Prop extends string,
    >(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsDropdown,
    ): IDropdownPropertyItem<T, Prop>;
    addEntityPicker<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsDataPicker,
    ): IPropertyItem<T, Prop>;
    addImage(
        value: IObservableProp<string | ImageResourceData>,
        options?: IImagePropertyItemOptions,
    ): IImagePropertyItem;
    addNumber<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsNumber,
    ): IPropertyItem<T, Prop>;
    addString<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptions,
    ): IPropertyItem<T, Prop>;
    addTable(
        options?: IPropertyItemOptionsTable,
    ): ITablePropertyItem<{ EMPTY: undefined }, "EMPTY">;
    addText(
        value: IObservableProp<LocalizedString>,
        options?: ITextPropertyItemOptions,
    ): ITextPropertyItem;
    addVector3(
        value: IObservableProp<Vector3>,
        options?: IVector3PropertyItemOptions,
    ): IVector3PropertyItem;
    addVector3_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsVector3,
    ): IVector3PropertyItem_deprecated<T, Prop>;
    collapse(): void;
    createPropertyPane(options: IPropertyPaneOptions): IPropertyPane;
    expand(): void;
    hide(): void;
    removePropertyPane(paneToRemove: IPropertyPane): boolean;
    show(): void;
}

Properties

`Beta`collapsed

collapsed: boolean

Remarks

Pane state for being expanded or collapsed.

`Readonly` `Beta`id

id: string

Remarks

Unique ID for the property pane.

`Beta`onPropertyPaneVisibilityUpdated

onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

Remarks

Provides visibility change events

`Optional` `Readonly` `Beta`parentPaneId

parentPaneId?: string

Remarks

In case of sub pane this is the id of the parent pane.

`Beta`title

title: string

Remarks

Localized title of the property pane

`Beta`visible

visible: boolean

Remarks

Check visibility of the pane

`Optional` `Beta`width

width?: number

Remarks

Width of the panel in rem.

Methods

addBlockList

addBlockList(
options?: IPropertyItemOptionsBlockList,
): IBlockListPropertyItem<{ EMPTY: undefined }, "EMPTY">
Beta
Parameters
- Optionaloptions: IPropertyItemOptionsBlockList
Returns IBlockListPropertyItem<{ EMPTY: undefined }, "EMPTY">
Remarks
Adds a block list to the pane.

addBlockPicker

addBlockPicker<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsDataPicker,
): IPropertyItem<T, Prop>
Beta
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optionaloptions: IPropertyItemOptionsDataPicker
Returns IPropertyItem<T, Prop>
Remarks
Adds a BlockPicker item to the pane.

addBool

addBool(
value: IObservableProp<boolean>,
options?: IBoolPropertyItemOptions,
): IBoolPropertyItem
Beta
Parameters
- value: IObservableProp<boolean>
- Optionaloptions: IBoolPropertyItemOptions
Returns IBoolPropertyItem
Remarks

addBool_deprecated

addBool_deprecated<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsBool,
): IPropertyItem<T, Prop>
Beta
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optionaloptions: IPropertyItemOptionsBool
Returns IPropertyItem<T, Prop>
Remarks
Adds a boolean item to the pane.

addButton

addButton(
action: RegisteredAction<NoArgsAction> | () => void,
options?: IButtonPropertyItemOptions,
): IButtonPropertyItem
Beta
Parameters
- action: RegisteredAction<NoArgsAction> | () => void
- Optionaloptions: IButtonPropertyItemOptions
Returns IButtonPropertyItem
Remarks
Adds a button to the pane and binds the specified action to the button activate.

addColorPicker

addColorPicker<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsColorPicker,
): IPropertyItem<T, Prop>
Beta
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optionaloptions: IPropertyItemOptionsColorPicker
Returns IPropertyItem<T, Prop>
Remarks
Adds a color picker item to the pane.

addDivider

addDivider(): IPropertyItemBase
Beta
Returns IPropertyItemBase
Remarks
Adds an divider item to the pane.

addDropdown

addDropdown<
    T extends Omit<PropertyBag, Prop> & { [key in string]: number },
    Prop extends string,
>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsDropdown,
): IDropdownPropertyItem<T, Prop>
Beta
Type Parameters
- T extends Omit<PropertyBag, Prop> & { [key in string]: number }
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optionaloptions: IPropertyItemOptionsDropdown
Returns IDropdownPropertyItem<T, Prop>
Remarks
Adds an DropDown item to the pane.

addEntityPicker

addEntityPicker<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsDataPicker,
): IPropertyItem<T, Prop>
Beta
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optionaloptions: IPropertyItemOptionsDataPicker
Returns IPropertyItem<T, Prop>
Remarks
Adds an EntityPicker item to the pane.

addImage

addImage(
value: IObservableProp<string | ImageResourceData>,
options?: IImagePropertyItemOptions,
): IImagePropertyItem
Beta
Parameters
- value: IObservableProp<string | ImageResourceData>
- Optionaloptions: IImagePropertyItemOptions
Returns IImagePropertyItem
Remarks
Adds an image item to the pane.

addNumber

addNumber<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsNumber,
): IPropertyItem<T, Prop>
Beta
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optionaloptions: IPropertyItemOptionsNumber
Returns IPropertyItem<T, Prop>
Remarks
Adds a number item to the pane.

addString

addString<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptions,
): IPropertyItem<T, Prop>
Beta
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optionaloptions: IPropertyItemOptions
Returns IPropertyItem<T, Prop>
Remarks
Adds a string item to the pane

addTable

addTable(
options?: IPropertyItemOptionsTable,
): ITablePropertyItem<{ EMPTY: undefined }, "EMPTY">
Beta
Parameters
- Optionaloptions: IPropertyItemOptionsTable
Returns ITablePropertyItem<{ EMPTY: undefined }, "EMPTY">
Remarks
Adds a table to the pane.

addText

addText(
value: IObservableProp<LocalizedString>,
options?: ITextPropertyItemOptions,
): ITextPropertyItem
Beta
Parameters
- value: IObservableProp<LocalizedString>
- Optionaloptions: ITextPropertyItemOptions
Returns ITextPropertyItem
Remarks
Adds a multiline Text item to the pane.

addVector3

addVector3(
value: IObservableProp<Vector3>,
options?: IVector3PropertyItemOptions,
): IVector3PropertyItem
Beta
Parameters
- value: IObservableProp<Vector3>
- Optionaloptions: IVector3PropertyItemOptions
Returns IVector3PropertyItem
Remarks
Adds a Vec3 item to the pane.

addVector3_deprecated

addVector3_deprecated<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsVector3,
): IVector3PropertyItem_deprecated<T, Prop>
Beta
Type Parameters
- T extends PropertyBag
- Prop extends string
Parameters
- obj: T
- property: Prop
- Optionaloptions: IPropertyItemOptionsVector3
Returns IVector3PropertyItem_deprecated<T, Prop>
Remarks
Adds a Vec3 item to the pane.

collapse

collapse(): void
Beta
Returns void
Remarks
Collapse the pane.

createPropertyPane

createPropertyPane(options: IPropertyPaneOptions): IPropertyPane
Beta
Parameters
- options: IPropertyPaneOptions
Returns IPropertyPane
Remarks
Creates an internal sub panel that is presented inside a extender control.

expand

expand(): void
Beta
Returns void
Remarks
Expand the pane.

hide

hide(): void
Beta
Returns void
Remarks
Hide the pane.

removePropertyPane

removePropertyPane(paneToRemove: IPropertyPane): boolean
Beta
Parameters
- paneToRemove: IPropertyPane
Returns boolean
Remarks
Removes a child property pane from the parent pane.

show

show(): void
Beta
Returns void
Remarks
Show the pane and all of its property items.

Interface IPropertyPaneBeta

Index

Properties

Methods

Properties

Betacollapsed

Remarks

Readonly Betaid

Remarks

BetaonPropertyPaneVisibilityUpdated

Remarks

Optional Readonly BetaparentPaneId

Remarks

Betatitle

Remarks

Betavisible

Remarks

Optional Betawidth

Remarks

Methods

addBlockList

Parameters

Returns IBlockListPropertyItem<{ EMPTY: undefined }, "EMPTY">

Remarks

addBlockPicker

Type Parameters

Parameters

Returns IPropertyItem<T, Prop>

Remarks

addBool

Parameters

Returns IBoolPropertyItem

Remarks

addBool_deprecated

Type Parameters

Parameters

Returns IPropertyItem<T, Prop>

Remarks

addButton

Parameters

Returns IButtonPropertyItem

Remarks

addColorPicker

Type Parameters

Parameters

Returns IPropertyItem<T, Prop>

Remarks

addDivider

Returns IPropertyItemBase

Remarks

addDropdown

Type Parameters

Parameters

Returns IDropdownPropertyItem<T, Prop>

Remarks

addEntityPicker

Type Parameters

Parameters

Returns IPropertyItem<T, Prop>

Remarks

addImage

Parameters

Returns IImagePropertyItem

Remarks

addNumber

Type Parameters

Parameters

Returns IPropertyItem<T, Prop>

Remarks

addString

Type Parameters

Parameters

Returns IPropertyItem<T, Prop>

Remarks

addTable

Parameters

Returns ITablePropertyItem<{ EMPTY: undefined }, "EMPTY">

Remarks

addText

Parameters

Interface IPropertyPane`Beta`

`Beta`collapsed

`Readonly` `Beta`id

`Beta`onPropertyPaneVisibilityUpdated

`Optional` `Readonly` `Beta`parentPaneId

`Beta`title

`Beta`visible

`Optional` `Beta`width