Interface IRootPropertyPane

collapsed

Readonlyid

onPropertyPaneVisibilityUpdated

visible

addBlockList

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

• Parameters

  • Optionaloptions: IPropertyItemOptionsBlockList

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

  Remarks

  Adds a block list to the pane.

addBool

• addBool(
      value: IObservableProp<boolean>,
      options?: IBoolPropertyItemOptions,
  ): IBoolPropertyItem

• 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>

• 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

• 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(
      value: IObservableProp<RGBA>,
      options?: IColorPickerPropertyItemOptions,
  ): IColorPickerPropertyItem

• Parameters

  • value: IObservableProp<RGBA>
  • Optionaloptions: IColorPickerPropertyItemOptions

  Returns IColorPickerPropertyItem

  Remarks

  Adds a color picker item to the pane.

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.

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.

addDivider

• addDivider(): IPropertyItemBase

• Returns IPropertyItemBase

  Remarks

  Adds an divider item to the pane.

addDropdown

• addDropdown(
      value: IObservableProp<number>,
      options?: IDropdownPropertyItemOptions,
  ): IDropdownPropertyItem

• Parameters

  • value: IObservableProp<number>
  • Optionaloptions: IDropdownPropertyItemOptions

  Returns IDropdownPropertyItem

  Remarks

  Adds an Dropdown item to the pane.

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.

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.

addNumber

• addNumber(
      value: IObservableProp<number>,
      options?: INumberPropertyItemOptions,
  ): INumberPropertyItem

• Parameters

  • value: IObservableProp<number>
  • Optionaloptions: INumberPropertyItemOptions

  Returns INumberPropertyItem

  Remarks

  Adds a number item to the pane.

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.

addString

• addString(
      value: IObservableProp<string>,
      options?: IStringPropertyItemOptions,
  ): IStringPropertyItem

• Parameters

  • value: IObservableProp<string>
  • Optionaloptions: IStringPropertyItemOptions

  Returns IStringPropertyItem

  Remarks

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

addTable

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

• Parameters

  • Optionaloptions: IPropertyItemOptionsTable

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

  Remarks

  Adds a table to the pane.

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.

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.

addVector3

• addVector3(
      value: IObservableProp<Vector3>,
      options?: IVector3PropertyItemOptions,
  ): IVector3PropertyItem

• 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>

• 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

• Returns void

  Remarks

  Collapse the pane.

createSubPane

• createSubPane(options: ISubPanePropertyItemOptions): 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(): LocalizedString

• Returns LocalizedString

  Remarks

  Returns property pane title.

hide

• hide(): void

• Returns void

  Remarks

  Hide the pane.

removeSubPane

• removeSubPane(paneToRemove: IPropertyPane): boolean

• Parameters

  • paneToRemove: IPropertyPane

  Returns boolean

  Remarks

  Removes an existing sub pane.

setTitle

• setTitle(newTitle: LocalizedString): void

• Parameters

  • newTitle: 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.