Interface IPropertyPane

collapsed

onPropertyPaneVisibilityUpdated

addBlockList

• addBlockList(value, options?): IBlockListPropertyItem

• Parameters

  • value: IObservableProp<string[]>

  • Optional options: IBlockListPropertyItemOptions

  Returns IBlockListPropertyItem

  Remarks

  Adds a block list to the pane.

addBlockTable

• addBlockTable(options?): IBlockTablePropertyItem

• Parameters

  • Optional options: IBlockTablePropertyItemOptions

  Returns IBlockTablePropertyItem

  Remarks

  Adds a block table to the pane.

addBool

• addBool(value, options?): IBoolPropertyItem

• Parameters

  • value: IObservableProp<boolean>

  • Optional options: IBoolPropertyItemOptions

  Returns IBoolPropertyItem

  Remarks

  Adds a togglable boolean item to the pane.

addButton

• addButton(action, options?): IButtonPropertyItem

• Parameters

  • action: ButtonPropertyItemSupportedActionTypes

  • Optional options: IButtonPropertyItemOptions

  Returns IButtonPropertyItem

  Remarks

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

addButtonPane

• addButtonPane(options?): IButtonPanePropertyItem

• Parameters

  • Optional options: IButtonPanePropertyItemOptions

  Returns IButtonPanePropertyItem

  Remarks

  Adds a pane for grouped button layout.

addColorPicker

• addColorPicker(value, options?): IColorPickerPropertyItem

• Parameters

  • value: IObservableProp<RGBA>

  • Optional options: IColorPickerPropertyItemOptions

  Returns IColorPickerPropertyItem

  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.

addDataTable

• addDataTable(options?): IDataTablePropertyItem

• Parameters

  • Optional options: 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, options?): IDropdownPropertyItem

• Parameters

  • value: IObservableProp<number>

  • Optional options: IDropdownPropertyItemOptions

  Returns IDropdownPropertyItem

  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.

addLink

• addLink(value, options?): ILinkPropertyItem

• Parameters

  • value: IObservableProp<string>

  • Optional options: ILinkPropertyItemOptions

  Returns ILinkPropertyItem

  Remarks

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

addProgressIndicator

• addProgressIndicator(options?): IProgressIndicatorPropertyItem

• Parameters

  • Optional options: IProgressIndicatorPropertyItemOptions

  Returns IProgressIndicatorPropertyItem

  Remarks

  Adds a Progress Indicator item to the pane.

addString

• addString(value, options?): IStringPropertyItem

• Parameters

  • value: IObservableProp<string>

  • Optional options: IStringPropertyItemOptions

  Returns IStringPropertyItem

  Remarks

  Adds an editable string item 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.

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.

getTitle

• getTitle(): undefined | LocalizedString

• Returns undefined | LocalizedString

  Remarks

  Returns pane title.

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