Interface IPropertyPane

collapsed

onPropertyPaneVisibilityUpdated

addBlockList

• addBlockList(
      value: IObservableProp<string[]>,
      options?: IBlockListPropertyItemOptions,
  ): IBlockListPropertyItem

  Parameters

  • value: IObservableProp<string[]>
  • Optionaloptions: IBlockListPropertyItemOptions

  Returns IBlockListPropertyItem

  Remarks

  Adds a block list to the pane.

addBlockTable

• addBlockTable(options?: IBlockTablePropertyItemOptions): IBlockTablePropertyItem

  Parameters

  • Optionaloptions: IBlockTablePropertyItemOptions

  Returns IBlockTablePropertyItem

  Remarks

  Adds a block table to the pane.

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.

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.

addButtonPane

• addButtonPane(options?: IButtonPanePropertyItemOptions): IButtonPanePropertyItem

  Parameters

  • Optionaloptions: IButtonPanePropertyItemOptions

  Returns IButtonPanePropertyItem

  Remarks

  Adds a pane for grouped button layout.

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.

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.

addDataTable

• addDataTable(options?: IDataTablePropertyItemOptions): IDataTablePropertyItem

  Parameters

  • Optionaloptions: IDataTablePropertyItemOptions

  Returns IDataTablePropertyItem

  Remarks

  Adds a data table 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.

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.

addLink

• addLink(
      value: IObservableProp<string>,
      options?: ILinkPropertyItemOptions,
  ): ILinkPropertyItem

  Parameters

  • value: IObservableProp<string>
  • Optionaloptions: ILinkPropertyItemOptions

  Returns ILinkPropertyItem

  Remarks

  Adds a Link 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.

addProgressIndicator

• addProgressIndicator(
      options?: IProgressIndicatorPropertyItemOptions,
  ): IProgressIndicatorPropertyItem

  Parameters

  • Optionaloptions: IProgressIndicatorPropertyItemOptions

  Returns IProgressIndicatorPropertyItem

  Remarks

  Adds a Progress Indicator item to the pane.

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

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.

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.

getTitle

• getTitle(): LocalizedString

  Returns LocalizedString

  Remarks

  Returns pane title.

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 pane.