Interface IDropdownPropertyItem

A property item which supports Dropdown properties

Hierarchy

IPropertyItemBase
- IDropdownPropertyItem

Index

Properties

enable id paneId typeName value visible

Methods

getEntryByIndex getEntryByValue setTitle setTooltip updateEntries

Properties

enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly` id

id: string

Remarks

Unique ID for the property item.

`Readonly` paneId

paneId: string

Remarks

The parent pane id.

`Readonly` typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

`Readonly` value

value: number

Remarks

Current selected entry value of the property item list.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

getEntryByIndex

getEntryByIndex(index): IDropdownPropertyItemEntry
Parameters
- index: number
  
  Index of the dropdown entry in the list.
Returns IDropdownPropertyItemEntry

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

getEntryByValue

getEntryByValue(value): IDropdownPropertyItemEntry
Parameters
- value: number
  
  Value of the dropdown entry in the list.
Returns IDropdownPropertyItemEntry

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

setTitle

setTitle(title): void
Parameters
- title: LocalizedString
  
  New title.
Returns void

Remarks
Updates title of the property item.

setTooltip

setTooltip(tooltip): void
Parameters
- tooltip: LocalizedString
  
  New tooltip.
Returns void

Remarks
Updates tooltip of the property item.

updateEntries

updateEntries(entries, newValue?): void
Parameters
- entries: IDropdownPropertyItemEntry[]
  
  New list of updated entries.
- Optional newValue: number
  
  New value value to use for the dropdown.
  
  Optional
Returns void

Remarks
Update list of dropdown entries.