接口 IPropertyPane实验性

Property pane present dynamic content. It can be associated with an object and presented with different kind of controls.

interface IPropertyPane {
    collapsed: boolean;
    id: string;
    onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
    visible: boolean;
    addBlockList(
        options?: IPropertyItemOptionsBlockList,
    ): IBlockListPropertyItem<{ EMPTY: undefined }, "EMPTY">;
    addBlockTable(
        options?: IBlockTablePropertyItemOptions,
    ): IBlockTablePropertyItem;
    addBool(
        value: IObservableProp<boolean>,
        options?: IBoolPropertyItemOptions,
    ): IBoolPropertyItem;
    addBool_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsBool,
    ): IPropertyItem<T, Prop>;
    addButton(
        action: RegisteredAction<NoArgsAction> | () => void,
        options?: IButtonPropertyItemOptions,
    ): IButtonPropertyItem;
    addColorPicker(
        value: IObservableProp<RGBA>,
        options?: IColorPickerPropertyItemOptions,
    ): IColorPickerPropertyItem;
    addColorPicker_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsColorPicker_deprecated,
    ): IPropertyItem<T, Prop>;
    addComboBox(
        value: IObservableProp<string>,
        options?: IComboBoxPropertyItemOptions,
    ): IComboBoxPropertyItem;
    addDivider(): IPropertyItemBase;
    addDropdown(
        value: IObservableProp<number>,
        options?: IDropdownPropertyItemOptions,
    ): IDropdownPropertyItem;
    addDropdown_deprecated<
        T extends Omit<PropertyBag, Prop> & { [key in string]: number },
        Prop extends string,
    >(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsDropdown,
    ): IDropdownPropertyItem_deprecated<T, Prop>;
    addImage(
        value: IObservableProp<string | ImageResourceData>,
        options?: IImagePropertyItemOptions,
    ): IImagePropertyItem;
    addLink(
        value: IObservableProp<string>,
        options?: ILinkPropertyItemOptions,
    ): ILinkPropertyItem;
    addNumber(
        value: IObservableProp<number>,
        options?: INumberPropertyItemOptions,
    ): INumberPropertyItem;
    addNumber_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsNumber,
    ): IPropertyItem<T, Prop>;
    addProgressIndicator(
        options?: IProgressIndicatorPropertyItemOptions,
    ): IProgressIndicatorPropertyItem;
    addString(
        value: IObservableProp<string>,
        options?: IStringPropertyItemOptions,
    ): IStringPropertyItem;
    addString_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptions,
    ): IPropertyItem<T, Prop>;
    addTable(
        options?: IPropertyItemOptionsTable,
    ): ITablePropertyItem<{ EMPTY: undefined }, "EMPTY">;
    addText(
        value: IObservableProp<LocalizedString>,
        options?: ITextPropertyItemOptions,
    ): ITextPropertyItem;
    addToggleGroup(
        value: IObservableProp<number>,
        options?: IToggleGroupPropertyItemOptions,
    ): IToggleGroupPropertyItem;
    addVector3(
        value: IObservableProp<Vector3>,
        options?: IVector3PropertyItemOptions,
    ): IVector3PropertyItem;
    addVector3_deprecated<T extends PropertyBag, Prop extends string>(
        obj: T,
        property: Prop,
        options?: IPropertyItemOptionsVector3,
    ): IVector3PropertyItem_deprecated<T, Prop>;
    collapse(): void;
    createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
    expand(): void;
    getTitle(): LocalizedString;
    hide(): void;
    removeSubPane(paneToRemove: IPropertyPane): boolean;
    setTitle(newTitle: LocalizedString): void;
    show(): void;
}

层级 (查看层级一览)

属性

collapsed id onPropertyPaneVisibilityUpdated visible

方法

addBlockList addBlockTable addBool addBool_deprecated addButton addColorPicker addColorPicker_deprecated addComboBox addDivider addDropdown addDropdown_deprecated addImage addLink addNumber addNumber_deprecated addProgressIndicator addString addString_deprecated addTable addText addToggleGroup addVector3 addVector3_deprecated collapse createSubPane expand getTitle hide removeSubPane setTitle show

属性

实验性collapsed

collapsed: boolean

备注

Pane state for being expanded or collapsed.

只读 实验性id

id: string

备注

Unique ID for the property pane.

实验性onPropertyPaneVisibilityUpdated

onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

备注

Provides visibility change events

实验性visible

visible: boolean

备注

Check visibility of the pane

方法

addBlockList

addBlockTable

addBool

addBool_deprecated

addButton

addColorPicker

addColorPicker_deprecated

addComboBox

addDivider

addDropdown

addDropdown_deprecated

addImage

addLink

addNumber

addNumber_deprecated

addProgressIndicator

addString

addString_deprecated

addTable

addText

addToggleGroup

addVector3

addVector3_deprecated

collapse

  • collapse(): void
  • 实验性

    返回 void

    备注

    Collapse the pane.

createSubPane

expand

  • expand(): void
  • 实验性

    返回 void

    备注

    Expand the pane.

getTitle

hide

  • hide(): void
  • 实验性

    返回 void

    备注

    Hide the pane.

removeSubPane

  • removeSubPane(paneToRemove: IPropertyPane): boolean
  • 实验性

    参数

    返回 boolean

    备注

    Removes an existing sub pane.

setTitle

  • setTitle(newTitle: LocalizedString): void
  • 实验性

    参数

    返回 void

    备注

    Updates title of property pane.

show

  • show(): void
  • 实验性

    返回 void

    备注

    Show the pane and all of its property items.

显示设置

成员可见性

目录

属性
方法