接口 IDropdownPropertyItem实验性

A property item which supports Dropdown properties

interface IDropdownPropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    value: number;
    visible: boolean;
    getEntryByIndex(index: number): IDropdownPropertyItemEntry;
    getEntryByValue(value: number): IDropdownPropertyItemEntry;
    setTitle(title: LocalizedString): void;
    setTooltip(tooltip: LocalizedString): void;
    updateEntries(
        entries: IDropdownPropertyItemEntry[],
        newValue?: number,
    ): void;
}

层级 (查看层级一览)

属性

enable id paneId typeName value visible

方法

getEntryByIndex getEntryByValue setTitle setTooltip updateEntries

属性

实验性enable

enable: boolean

备注

If the item is enabled in the UI.

只读 实验性id

id: string

备注

Unique ID for the property item.

只读 实验性paneId

paneId: string

备注

The parent pane id.

只读 实验性typeName

typeName: PropertyItemType

备注

The type name of the target property.

只读 实验性value

value: number

备注

Current selected entry value of the property item list.

实验性visible

visible: boolean

备注

If the item should be visible in the UI.

方法

getEntryByIndex

  • getEntryByIndex(index: number): IDropdownPropertyItemEntry
  • 实验性

    参数

    • index: number

      Index of the dropdown entry in the list.

    返回 IDropdownPropertyItemEntry

    备注

    Find a dropdown entry at an index in the dropdown list.

getEntryByValue

  • getEntryByValue(value: number): IDropdownPropertyItemEntry
  • 实验性

    参数

    • value: number

      Value of the dropdown entry in the list.

    返回 IDropdownPropertyItemEntry

    备注

    Find a dropdown entry with a specific value associated with property item.

setTitle

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

    参数

    返回 void

    备注

    Updates title of the property item.

setTooltip

  • setTooltip(tooltip: LocalizedString): void
  • 实验性

    参数

    返回 void

    备注

    Updates tooltip of the property item.

updateEntries

  • updateEntries(entries: IDropdownPropertyItemEntry[], newValue?: number): void
  • 实验性

    参数

    返回 void

    备注

    Update list of dropdown entries.

显示设置

成员可见性

目录

属性
方法