Interface IPropertyPane

collapsed

Readonly id

onPropertyPaneVisibilityUpdated

visible

addBlockList

• addBlockList(options?): IBlockListPropertyItem<{
      EMPTY: undefined;
  }, "EMPTY">

• Parameters

  • Optional options: IPropertyItemOptionsBlockList

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

  Remarks

  Adds a block list to the pane.

addBool

• addBool(value, options?): IBoolPropertyItem

• Parameters

  • value: IObservableProp<boolean>

  • Optional options: IBoolPropertyItemOptions

  Returns IBoolPropertyItem

  Remarks

addBool_deprecated

• addBool_deprecated<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>

• Type Parameters

  • T extends PropertyBag

  • Prop extends string

  Parameters

  • obj: T

  • property: Prop

  • Optional options: IPropertyItemOptionsBool

  Returns IPropertyItem<T, Prop>

  Remarks

  Adds a boolean item to the pane.

addButton

• addButton(action, options?): IButtonPropertyItem

• Parameters

  • action: RegisteredAction<NoArgsAction> | (() => void)

  • Optional options: IButtonPropertyItemOptions

  Returns IButtonPropertyItem

  Remarks

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

addColorPicker

• addColorPicker(value, options?): IColorPickerPropertyItem

• Parameters

  • value: IObservableProp<RGBA>

  • Optional options: IColorPickerPropertyItemOptions

  Returns IColorPickerPropertyItem

  Remarks

  Adds a color picker item to the pane.

addColorPicker_deprecated

• addColorPicker_deprecated<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>

• Type Parameters

  • T extends PropertyBag

  • Prop extends string

  Parameters

  • obj: T

  • property: Prop

  • Optional options: IPropertyItemOptionsColorPicker_deprecated

  Returns IPropertyItem<T, Prop>

  Remarks

  Adds a color picker item to the pane.

addComboBox

• addComboBox(value, options?): IComboBoxPropertyItem

• Parameters

  • value: IObservableProp<string>

  • Optional options: IComboBoxPropertyItemOptions

  Returns IComboBoxPropertyItem

  Remarks

  Adds a combo box item to the pane.

addDivider

• addDivider(): IPropertyItemBase

• Returns IPropertyItemBase

  Remarks

  Adds an divider item to the pane.

addDropdown

• addDropdown(value, options?): IDropdownPropertyItem

• Parameters

  • value: IObservableProp<number>

  • Optional options: IDropdownPropertyItemOptions

  Returns IDropdownPropertyItem

  Remarks

  Adds an Dropdown item to the pane.

addDropdown_deprecated

• addDropdown_deprecated<T, Prop>(obj, property, options?): IDropdownPropertyItem_deprecated<T, Prop>

• Type Parameters

  • T extends Omit<PropertyBag, Prop> & {
        [key in string]: number
    }

  • Prop extends string

  Parameters

  • obj: T

  • property: Prop

  • Optional options: IPropertyItemOptionsDropdown

  Returns IDropdownPropertyItem_deprecated<T, Prop>

  Remarks

  Adds an DropDown item to the pane.

addImage

• addImage(value, options?): IImagePropertyItem

• Parameters

  • value: IObservableProp<string | ImageResourceData>

  • Optional options: IImagePropertyItemOptions

  Returns IImagePropertyItem

  Remarks

  Adds an image item to the pane.

addNumber

• addNumber(value, options?): INumberPropertyItem

• Parameters

  • value: IObservableProp<number>

  • Optional options: INumberPropertyItemOptions

  Returns INumberPropertyItem

  Remarks

  Adds a number item to the pane.

addNumber_deprecated

• addNumber_deprecated<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>

• Type Parameters

  • T extends PropertyBag

  • Prop extends string

  Parameters

  • obj: T

  • property: Prop

  • Optional options: IPropertyItemOptionsNumber

  Returns IPropertyItem<T, Prop>

  Remarks

  Adds a number item to the pane.

addString

• addString(value, options?): IStringPropertyItem

• Parameters

  • value: IObservableProp<string>

  • Optional options: IStringPropertyItemOptions

  Returns IStringPropertyItem

  Remarks

addString_deprecated

• addString_deprecated<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>

• Type Parameters

  • T extends PropertyBag

  • Prop extends string

  Parameters

  • obj: T

  • property: Prop

  • Optional options: IPropertyItemOptions

  Returns IPropertyItem<T, Prop>

  Remarks

  Adds a string item to the pane

addTable

• addTable(options?): ITablePropertyItem<{
      EMPTY: undefined;
  }, "EMPTY">

• Parameters

  • Optional options: IPropertyItemOptionsTable

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

  Remarks

  Adds a table to the pane.

addText

• addText(value, options?): ITextPropertyItem

• Parameters

  • value: IObservableProp<LocalizedString>

  • Optional options: ITextPropertyItemOptions

  Returns ITextPropertyItem

  Remarks

  Adds a multiline Text item to the pane.

addToggleGroup

• addToggleGroup(value, options?): IToggleGroupPropertyItem

• Parameters

  • value: IObservableProp<number>

  • Optional options: IToggleGroupPropertyItemOptions

  Returns IToggleGroupPropertyItem

  Remarks

  Adds a toggle button group to the pane.

addVector3

• addVector3(value, options?): IVector3PropertyItem

• Parameters

  • value: IObservableProp<Vector3>

  • Optional options: IVector3PropertyItemOptions

  Returns IVector3PropertyItem

  Remarks

  Adds a Vec3 item to the pane.

addVector3_deprecated

• addVector3_deprecated<T, Prop>(obj, property, options?): IVector3PropertyItem_deprecated<T, Prop>

• Type Parameters

  • T extends PropertyBag

  • Prop extends string

  Parameters

  • obj: T

  • property: Prop

  • Optional options: IPropertyItemOptionsVector3

  Returns IVector3PropertyItem_deprecated<T, Prop>

  Remarks

  Adds a Vec3 item to the pane.

collapse

• collapse(): void

• Returns void

  Remarks

  Collapse the pane.

createSubPane

• createSubPane(options): ISubPanePropertyItem

• Parameters

  • options: ISubPanePropertyItemOptions

  Returns ISubPanePropertyItem

  Remarks

  Creates an sub pane that can store property items.

expand

• expand(): void

• Returns void

  Remarks

  Expand the pane.

getTitle

• getTitle(): undefined | LocalizedString

• Returns undefined | LocalizedString

  Remarks

  Returns property pane title.

hide

• hide(): void

• Returns void

  Remarks

  Hide the pane.

removeSubPane

• removeSubPane(paneToRemove): boolean

• Parameters

  • paneToRemove: IPropertyPane

  Returns boolean

  Remarks

  Removes an existing sub pane.

setTitle

• setTitle(newTitle): void

• Parameters

  • newTitle: undefined | LocalizedString

    New title

  Returns void

  Remarks

  Updates title of property pane.

show

• show(): void

• Returns void

  Remarks

  Show the pane and all of its property items.