Interface IPropertyPane

collapsed

Readonly id

onPropertyPaneVisibilityUpdated

Optional Readonly parentPaneId

title

visible

Optional width

addBlockList

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

• Parameters

  • Optional options: IPropertyItemOptionsBlockList

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

  Remarks

  Adds a block list to the pane.

addBlockPicker

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

• Type Parameters

  • T extends PropertyBag

  • Prop extends string

  Parameters

  • obj: T

  • property: Prop

  • Optional options: IPropertyItemOptionsDataPicker

  Returns IPropertyItem<T, Prop>

  Remarks

  Adds a BlockPicker item 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<T, Prop>(obj, property, options?): IPropertyItem<T, Prop>

• Type Parameters

  • T extends PropertyBag

  • Prop extends string

  Parameters

  • obj: T

  • property: Prop

  • Optional options: IPropertyItemOptionsColorPicker

  Returns IPropertyItem<T, Prop>

  Remarks

  Adds a color picker item to the pane.

addDivider

• addDivider(): IPropertyItemBase

• Returns IPropertyItemBase

  Remarks

  Adds an divider item to the pane.

addDropdown

• addDropdown<T, Prop>(obj, property, options?): IDropdownPropertyItem<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<T, Prop>

  Remarks

  Adds an DropDown item to the pane.

addEntityPicker

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

• Type Parameters

  • T extends PropertyBag

  • Prop extends string

  Parameters

  • obj: T

  • property: Prop

  • Optional options: IPropertyItemOptionsDataPicker

  Returns IPropertyItem<T, Prop>

  Remarks

  Adds an EntityPicker 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<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<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.

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.

createPropertyPane

• createPropertyPane(options): IPropertyPane

• Parameters

  • options: IPropertyPaneOptions

  Returns IPropertyPane

  Remarks

  Creates an internal sub panel that is presented inside a extender control.

expand

• expand(): void

• Returns void

  Remarks

  Expand the pane.

hide

• hide(): void

• Returns void

  Remarks

  Hide the pane.

removePropertyPane

• removePropertyPane(paneToRemove): boolean

• Parameters

  • paneToRemove: IPropertyPane

  Returns boolean

  Remarks

  Removes a child property pane from the parent pane.

show

• show(): void

• Returns void

  Remarks

  Show the pane and all of its property items.