Script API - v1.26.30.25
    Preparing search index...

    Interface IDropdownPropertyItem

    A property item which supports Dropdown properties

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

    Hierarchy (View Summary)

    Index

    Properties

    enable id paneId typeName value visible

    Methods

    getEntryByIndex getEntryByValue setTitle setTooltip updateEntries

    Properties

    enable: boolean

    If the item is enabled in the UI.

    id: string

    Unique ID for the property item.

    paneId: string

    The parent pane id.

    typeName: PropertyItemType

    The type name of the target property.

    value: number

    Current selected entry value of the property item list.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Parameters

      • value: number

        Value of the dropdown entry in the list.

      Returns IDropdownPropertyItemEntry | undefined

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

    • Parameters

      Returns void

      Updates title of the property item.

    • Parameters

      • entries: IDropdownPropertyItemEntry[]

        New list of updated entries.

      • OptionalnewValue: number

        New value value to use for the dropdown.

      Returns void

      Update list of dropdown entries.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods