Interface IRootPropertyPane

A root pane that can store property items.

interface IRootPropertyPane {
    collapsed: boolean;
    id: string;
    onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
    visible: boolean;
    addBlockList(
        value: IObservableProp<string[]>,
        options?: IBlockListPropertyItemOptions,
    ): IBlockListPropertyItem;
    addBlockTable(
        options?: IBlockTablePropertyItemOptions,
    ): IBlockTablePropertyItem;
    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: ButtonPropertyItemSupportedActionTypes,
        options?: IButtonPropertyItemOptions,
    ): IButtonPropertyItem;
    addButtonPane(
        options?: IButtonPanePropertyItemOptions,
    ): IButtonPanePropertyItem;
    addColorPicker(
        value: IObservableProp<RGBA>,
        options?: IColorPickerPropertyItemOptions,
    ): IColorPickerPropertyItem;
    addColorPicker_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsColorPicker_deprecated,
    ): IPropertyItem<T, Prop>;
    addComboBox(
        value: IObservableProp<string>,
        options?: IComboBoxPropertyItemOptions,
    ): IComboBoxPropertyItem;
    addDataTable(
        options?: IDataTablePropertyItemOptions,
    ): IDataTablePropertyItem;
    addDivider(): IPropertyItemBase;
    addDropdown(
        value: IObservableProp<number>,
        options?: IDropdownPropertyItemOptions,
    ): IDropdownPropertyItem;
    addDropdown_deprecated<
        T extends Omit<PropertyBag, Prop> & { [key in string]: number },
        Prop extends string,
    >(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsDropdown,
    ): IDropdownPropertyItem_deprecated<T, Prop>;
    addImage(
        value: IObservableProp<string | ImageResourceData>,
        options?: IImagePropertyItemOptions,
    ): IImagePropertyItem;
    addLink(
        value: IObservableProp<string>,
        options?: ILinkPropertyItemOptions,
    ): ILinkPropertyItem;
    addNumber(
        value: IObservableProp<number>,
        options?: INumberPropertyItemOptions,
    ): INumberPropertyItem;
    addNumber_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsNumber,
    ): IPropertyItem<T, Prop>;
    addProgressIndicator(
        options?: IProgressIndicatorPropertyItemOptions,
    ): IProgressIndicatorPropertyItem;
    addString(
        value: IObservableProp<string>,
        options?: IStringPropertyItemOptions,
    ): IStringPropertyItem;
    addString_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptions,
    ): IPropertyItem<T, Prop>;
    addText(
        value: IObservableProp<LocalizedString>,
        options?: ITextPropertyItemOptions,
    ): ITextPropertyItem;
    addToggleGroup(
        value: IObservableProp<number>,
        options?: IToggleGroupPropertyItemOptions,
    ): IToggleGroupPropertyItem;
    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;
    createModalOverlayPane(
        options?: IModalOverlayPaneOptions,
    ): IModalOverlayPane;
    createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
    getActiveModalOverlayId(): string;
    getTitle(): LocalizedString;
    hide(): void;
    isHeaderActionVisible(): boolean;
    removeSubPane(paneToRemove: IPropertyPane): boolean;
    setActiveModalOverlay(id: string): void;
    setHeaderActionVisibility(visible: boolean): void;
    setTitle(newTitle: LocalizedString): void;
    show(): void;
}

Hierarchy (View Summary)

IPropertyPane
- IRootPropertyPane

Properties

collapsed

collapsed: boolean

Remarks

Pane state for being expanded or collapsed.

`Readonly`id

id: string

Remarks

Unique identifier for the pane.

onPropertyPaneVisibilityUpdated

onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

Remarks

Provides visibility change events

visible

visible: boolean

Remarks

Check visibility of the pane

Methods

addBlockList

addBlockList(
value: IObservableProp<string[]>,
options?: IBlockListPropertyItemOptions,
): IBlockListPropertyItem
Parameters
- value: IObservableProp<string[]>
- Optionaloptions: IBlockListPropertyItemOptions
Returns IBlockListPropertyItem
Remarks
Adds a block list to the pane.

Inherited from IPropertyPane.addBlockList

addBlockTable

addBlockTable(options?: IBlockTablePropertyItemOptions): IBlockTablePropertyItem
Parameters
- Optionaloptions: IBlockTablePropertyItemOptions
Returns IBlockTablePropertyItem
Remarks
Adds a block table to the pane.

Inherited from IPropertyPane.addBlockTable

addBool

addBool(
value: IObservableProp<boolean>,
options?: IBoolPropertyItemOptions,
): IBoolPropertyItem
Parameters
- value: IObservableProp<boolean>
- Optionaloptions: IBoolPropertyItemOptions
Returns IBoolPropertyItem
Remarks
Adds a togglable boolean item to the pane.

Inherited from IPropertyPane.addBool

addBool_deprecated

addBool_deprecated<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsBool,
): IPropertyItem<T, Prop>
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.

Inherited from IPropertyPane.addBool_deprecated

addButton

addButton(
action: ButtonPropertyItemSupportedActionTypes,
options?: IButtonPropertyItemOptions,
): IButtonPropertyItem
Parameters
- action: ButtonPropertyItemSupportedActionTypes
- Optionaloptions: IButtonPropertyItemOptions
Returns IButtonPropertyItem
Remarks
Adds a button to the pane and binds the specified action to the button interaction.

Inherited from IPropertyPane.addButton

addButtonPane

addButtonPane(options?: IButtonPanePropertyItemOptions): IButtonPanePropertyItem
Parameters
- Optionaloptions: IButtonPanePropertyItemOptions
Returns IButtonPanePropertyItem
Remarks
Adds a pane for grouped button layout.

Inherited from IPropertyPane.addButtonPane

addColorPicker

addColorPicker(
value: IObservableProp<RGBA>,
options?: IColorPickerPropertyItemOptions,
): IColorPickerPropertyItem
Parameters
- value: IObservableProp<RGBA>
- Optionaloptions: IColorPickerPropertyItemOptions
Returns IColorPickerPropertyItem
Remarks
Adds a color picker item to the pane.

Inherited from IPropertyPane.addColorPicker

addColorPicker_deprecated

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

Inherited from IPropertyPane.addColorPicker_deprecated

addComboBox

addComboBox(
value: IObservableProp<string>,
options?: IComboBoxPropertyItemOptions,
): IComboBoxPropertyItem
Parameters
- value: IObservableProp<string>
- Optionaloptions: IComboBoxPropertyItemOptions
Returns IComboBoxPropertyItem
Remarks
Adds a combo box item to the pane.

Inherited from IPropertyPane.addComboBox

addDataTable

addDataTable(options?: IDataTablePropertyItemOptions): IDataTablePropertyItem
Parameters
- Optionaloptions: IDataTablePropertyItemOptions
Returns IDataTablePropertyItem
Remarks
Adds a data table to the pane.

Inherited from IPropertyPane.addDataTable

addDivider

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

Inherited from IPropertyPane.addDivider

addDropdown

addDropdown(
value: IObservableProp<number>,
options?: IDropdownPropertyItemOptions,
): IDropdownPropertyItem
Parameters
- value: IObservableProp<number>
- Optionaloptions: IDropdownPropertyItemOptions
Returns IDropdownPropertyItem
Remarks
Adds an Dropdown item to the pane.

Inherited from IPropertyPane.addDropdown

addDropdown_deprecated

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

Inherited from IPropertyPane.addDropdown_deprecated

addImage

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

Inherited from IPropertyPane.addImage

addLink

addLink(
value: IObservableProp<string>,
options?: ILinkPropertyItemOptions,
): ILinkPropertyItem
Parameters
- value: IObservableProp<string>
- Optionaloptions: ILinkPropertyItemOptions
Returns ILinkPropertyItem
Remarks
Adds a Link item to the pane.

Inherited from IPropertyPane.addLink

addNumber

addNumber(
value: IObservableProp<number>,
options?: INumberPropertyItemOptions,
): INumberPropertyItem
Parameters
- value: IObservableProp<number>
- Optionaloptions: INumberPropertyItemOptions
Returns INumberPropertyItem
Remarks
Adds a number item to the pane.

Inherited from IPropertyPane.addNumber

addNumber_deprecated

addNumber_deprecated<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsNumber,
): IPropertyItem<T, Prop>
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.

Inherited from IPropertyPane.addNumber_deprecated

addProgressIndicator

addProgressIndicator(
options?: IProgressIndicatorPropertyItemOptions,
): IProgressIndicatorPropertyItem
Parameters
- Optionaloptions: IProgressIndicatorPropertyItemOptions
Returns IProgressIndicatorPropertyItem
Remarks
Adds a Progress Indicator item to the pane.

Inherited from IPropertyPane.addProgressIndicator

addString

addString(
value: IObservableProp<string>,
options?: IStringPropertyItemOptions,
): IStringPropertyItem
Parameters
- value: IObservableProp<string>
- Optionaloptions: IStringPropertyItemOptions
Returns IStringPropertyItem
Remarks
Adds an editable string item to the pane

Inherited from IPropertyPane.addString

addString_deprecated

addString_deprecated<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptions,
): IPropertyItem<T, Prop>
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

Inherited from IPropertyPane.addString_deprecated

addText

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

Inherited from IPropertyPane.addText

addToggleGroup

addToggleGroup(
value: IObservableProp<number>,
options?: IToggleGroupPropertyItemOptions,
): IToggleGroupPropertyItem
Parameters
- value: IObservableProp<number>
- Optionaloptions: IToggleGroupPropertyItemOptions
Returns IToggleGroupPropertyItem
Remarks
Adds a toggle button group to the pane.

Inherited from IPropertyPane.addToggleGroup

addVector3

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

Inherited from IPropertyPane.addVector3

addVector3_deprecated

addVector3_deprecated<T extends PropertyBag, Prop extends string>(
    obj: T,
    property: Prop,
    options?: IPropertyItemOptionsVector3,
): IVector3PropertyItem_deprecated<T, Prop>
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.

Inherited from IPropertyPane.addVector3_deprecated

collapse

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

Inherited from IPropertyPane.collapse

createModalOverlayPane

createModalOverlayPane(options?: IModalOverlayPaneOptions): IModalOverlayPane
Parameters
- Optionaloptions: IModalOverlayPaneOptions
  Creation parameters for modal overlay pane.
Returns IModalOverlayPane
Remarks
Register a modal overlay to the root pane. It will be hidden by default, when shown it will display over the root pane content. Only one modal overlay can be shown at a time.

createSubPane

createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem
Parameters
- options: ISubPanePropertyItemOptions
Returns ISubPanePropertyItem
Remarks
Creates an sub pane that can store property items.

Inherited from IPropertyPane.createSubPane

getActiveModalOverlayId

getActiveModalOverlayId(): string
Returns string
Unique identifier of the active modal overlay

Remarks

getTitle

getTitle(): LocalizedString
Returns LocalizedString
Remarks
Returns pane title.

Inherited from IPropertyPane.getTitle

hide

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

Inherited from IPropertyPane.hide

isHeaderActionVisible

isHeaderActionVisible(): boolean
Returns boolean
Current visibility state of header action

Remarks

removeSubPane

removeSubPane(paneToRemove: IPropertyPane): boolean
Parameters
- paneToRemove: IPropertyPane
Returns boolean
Remarks
Removes an existing sub pane.

Inherited from IPropertyPane.removeSubPane

setActiveModalOverlay

setActiveModalOverlay(id: string): void
Parameters
- id: string
  Unique id for modal overlay pane.
Returns void
Remarks
Sets registered modal overlay as active, if not found it will hide the current.

setHeaderActionVisibility

setHeaderActionVisibility(visible: boolean): void
Parameters
- visible: boolean
  New visibility state of the action button.
Returns void
Remarks
If a header action exists, updates visibility of the button.

setTitle

setTitle(newTitle: LocalizedString): void
Parameters
- newTitle: LocalizedString
  New title
Returns void
Remarks
Updates title of pane.

Inherited from IPropertyPane.setTitle

show

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

Inherited from IPropertyPane.show

Interface IRootPropertyPane

Hierarchy (View Summary)

Index

Properties

Methods

Properties

collapsed

Remarks

Readonlyid

Remarks

onPropertyPaneVisibilityUpdated

Remarks

visible

Remarks

Methods

addBlockList

Parameters

Returns IBlockListPropertyItem

Remarks

addBlockTable

Parameters

Returns IBlockTablePropertyItem

Remarks

addBool

Parameters

Returns IBoolPropertyItem

Remarks

addBool_deprecated

Type Parameters

Parameters

Returns IPropertyItem<T, Prop>

Remarks

addButton

Parameters

Returns IButtonPropertyItem

Remarks

addButtonPane

Parameters

Returns IButtonPanePropertyItem

Remarks

addColorPicker

Parameters

Returns IColorPickerPropertyItem

Remarks

addColorPicker_deprecated

Type Parameters

Parameters

Returns IPropertyItem<T, Prop>

Remarks

addComboBox

Parameters

Returns IComboBoxPropertyItem

Remarks

addDataTable

Parameters

Returns IDataTablePropertyItem

Remarks

addDivider

Returns IPropertyItemBase

Remarks

addDropdown

Parameters

Returns IDropdownPropertyItem

Remarks

addDropdown_deprecated

Type Parameters

Parameters

Returns IDropdownPropertyItem_deprecated<T, Prop>

Remarks

addImage

Parameters

Returns IImagePropertyItem

Remarks

addLink

Parameters

Returns ILinkPropertyItem

Remarks

addNumber

Parameters

Returns INumberPropertyItem

`Readonly`id