接口 IRootPropertyPane

collapsed

只读id

onPropertyPaneVisibilityUpdated

visible

addBlockList

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

  参数

  • 可选options: IPropertyItemOptionsBlockList

  返回 IBlockListPropertyItem<{ EMPTY: undefined }, "EMPTY">

  备注

  Adds a block list to the pane.

addBlockTable

• addBlockTable(options?: IBlockTablePropertyItemOptions): IBlockTablePropertyItem

  参数

  • 可选options: IBlockTablePropertyItemOptions

  返回 IBlockTablePropertyItem

  备注

  Adds a block table to the pane.

addBool

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

  参数

  • value: IObservableProp<boolean>
  • 可选options: IBoolPropertyItemOptions

  返回 IBoolPropertyItem

  备注

  Adds a togglable boolean item to the pane.

addBool_deprecated

• addBool_deprecated<T extends PropertyBag, Prop extends string>(
      obj: T,
      property: Prop,
      options?: IPropertyItemOptionsBool,
  ): IPropertyItem<T, Prop>

  类型参数

  • T extends PropertyBag
  • Prop extends string

  参数

  • obj: T
  • property: Prop
  • 可选options: IPropertyItemOptionsBool

  返回 IPropertyItem<T, Prop>

  备注

  Adds a boolean item to the pane.

addButton

• addButton(
      action: ButtonPropertyItemSupportedActionTypes,
      options?: IButtonPropertyItemOptions,
  ): IButtonPropertyItem

  参数

  • action: ButtonPropertyItemSupportedActionTypes
  • 可选options: IButtonPropertyItemOptions

  返回 IButtonPropertyItem

  备注

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

addButtonPane

• addButtonPane(options?: IButtonPanePropertyItemOptions): IButtonPanePropertyItem

  参数

  • 可选options: IButtonPanePropertyItemOptions

  返回 IButtonPanePropertyItem

  备注

  Adds a pane for grouped button layout.

addColorPicker

• addColorPicker(
      value: IObservableProp<RGBA>,
      options?: IColorPickerPropertyItemOptions,
  ): IColorPickerPropertyItem

  参数

  • value: IObservableProp<RGBA>
  • 可选options: IColorPickerPropertyItemOptions

  返回 IColorPickerPropertyItem

  备注

  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>

  类型参数

  • T extends PropertyBag
  • Prop extends string

  参数

  • obj: T
  • property: Prop
  • 可选options: IPropertyItemOptionsColorPicker_deprecated

  返回 IPropertyItem<T, Prop>

  备注

  Adds a color picker item to the pane.

addComboBox

• addComboBox(
      value: IObservableProp<string>,
      options?: IComboBoxPropertyItemOptions,
  ): IComboBoxPropertyItem

  参数

  • value: IObservableProp<string>
  • 可选options: IComboBoxPropertyItemOptions

  返回 IComboBoxPropertyItem

  备注

  Adds a combo box item to the pane.

addDivider

• addDivider(): IPropertyItemBase

  返回 IPropertyItemBase

  备注

  Adds an divider item to the pane.

addDropdown

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

  参数

  • value: IObservableProp<number>
  • 可选options: IDropdownPropertyItemOptions

  返回 IDropdownPropertyItem

  备注

  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>

  类型参数

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

  参数

  • obj: T
  • property: Prop
  • 可选options: IPropertyItemOptionsDropdown

  返回 IDropdownPropertyItem_deprecated<T, Prop>

  备注

  Adds an DropDown item to the pane.

addImage

• addImage(
      value: IObservableProp<string | ImageResourceData>,
      options?: IImagePropertyItemOptions,
  ): IImagePropertyItem

  参数

  • value: IObservableProp<string | ImageResourceData>
  • 可选options: IImagePropertyItemOptions

  返回 IImagePropertyItem

  备注

  Adds an image item to the pane.

addLink

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

  参数

  • value: IObservableProp<string>
  • 可选options: ILinkPropertyItemOptions

  返回 ILinkPropertyItem

  备注

  Adds a Link item to the pane.

addNumber

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

  参数

  • value: IObservableProp<number>
  • 可选options: INumberPropertyItemOptions

  返回 INumberPropertyItem

  备注

  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>

  类型参数

  • T extends PropertyBag
  • Prop extends string

  参数

  • obj: T
  • property: Prop
  • 可选options: IPropertyItemOptionsNumber

  返回 IPropertyItem<T, Prop>

  备注

  Adds a number item to the pane.

addProgressIndicator

• addProgressIndicator(
      options?: IProgressIndicatorPropertyItemOptions,
  ): IProgressIndicatorPropertyItem

  参数

  • 可选options: IProgressIndicatorPropertyItemOptions

  返回 IProgressIndicatorPropertyItem

  备注

  Adds a Progress Indicator item to the pane.

addString

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

  参数

  • value: IObservableProp<string>
  • 可选options: IStringPropertyItemOptions

  返回 IStringPropertyItem

  备注

  Adds an editable string item to the pane

addString_deprecated

• addString_deprecated<T extends PropertyBag, Prop extends string>(
      obj: T,
      property: Prop,
      options?: IPropertyItemOptions,
  ): IPropertyItem<T, Prop>

  类型参数

  • T extends PropertyBag
  • Prop extends string

  参数

  • obj: T
  • property: Prop
  • 可选options: IPropertyItemOptions

  返回 IPropertyItem<T, Prop>

  备注

  Adds a string item to the pane

addTable

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

  参数

  • 可选options: IPropertyItemOptionsTable

  返回 ITablePropertyItem<{ EMPTY: undefined }, "EMPTY">

  备注

  Adds a table to the pane.

addText

• addText(
      value: IObservableProp<LocalizedString>,
      options?: ITextPropertyItemOptions,
  ): ITextPropertyItem

  参数

  • value: IObservableProp<LocalizedString>
  • 可选options: ITextPropertyItemOptions

  返回 ITextPropertyItem

  备注

  Adds a multiline Text item to the pane.

addToggleGroup

• addToggleGroup(
      value: IObservableProp<number>,
      options?: IToggleGroupPropertyItemOptions,
  ): IToggleGroupPropertyItem

  参数

  • value: IObservableProp<number>
  • 可选options: IToggleGroupPropertyItemOptions

  返回 IToggleGroupPropertyItem

  备注

  Adds a toggle button group to the pane.

addVector3

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

  参数

  • value: IObservableProp<Vector3>
  • 可选options: IVector3PropertyItemOptions

  返回 IVector3PropertyItem

  备注

  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>

  类型参数

  • T extends PropertyBag
  • Prop extends string

  参数

  • obj: T
  • property: Prop
  • 可选options: IPropertyItemOptionsVector3

  返回 IVector3PropertyItem_deprecated<T, Prop>

  备注

  Adds a Vec3 item to the pane.

collapse

• collapse(): void

  返回 void

  备注

  Collapse the pane.

createSubPane

• createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem

  参数

  • options: ISubPanePropertyItemOptions

  返回 ISubPanePropertyItem

  备注

  Creates an sub pane that can store property items.

getTitle

• getTitle(): LocalizedString

  返回 LocalizedString

  备注

  Returns pane title.

hide

• hide(): void

  返回 void

  备注

  Hide the pane.

removeSubPane

• removeSubPane(paneToRemove: IPropertyPane): boolean

  参数

  • paneToRemove: IPropertyPane

  返回 boolean

  备注

  Removes an existing sub pane.

setTitle

• setTitle(newTitle: LocalizedString): void

  参数

  • newTitle: LocalizedString

    New title

  返回 void

  备注

  Updates title of pane.

show

• show(): void

  返回 void

  备注

  Show the pane and all of its items.