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

    A property item which supports Menu properties

    export interface IMenuPropertyItem extends IPropertyItemBase {
    addEntry(props: IMenuCreationParams, action?: RegisteredAction<NoArgsAction>): IMenu;
    getEntries(): IMenu[];
    getMenu(menuId: string): IMenu | undefined;
    removeEntry(menuId: string): void;
    setTitle(title: LocalizedString | undefined): void;
    setTooltip(tooltip: BasicTooltipContent | undefined): void;
    }
    interface IMenuPropertyItem {
        enable: boolean;
        id: string;
        paneId: string;
        typeName: PropertyItemType;
        visible: boolean;
        addEntry(
            props: IMenuCreationParams,
            action?: RegisteredAction<NoArgsAction>,
        ): IMenu;
        getEntries(): IMenu[];
        getMenu(menuId: string): IMenu | undefined;
        removeEntry(menuId: string): void;
        setTitle(title: LocalizedString | undefined): void;
        setTooltip(tooltip: BasicTooltipContent | undefined): void;
    }

    Hierarchy (View Summary)

    Index

    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.

    The type name of the target property.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Returns IMenu[]

      All first level menu entries

    • Parameters

      • menuId: string

        Identifier of the menu.

      Returns IMenu | undefined

      Find the menu item recursively if it exists

    • Parameters

      • menuId: string

        Menu id to remove

      Returns void

      Removed the menu item entry if the id is found

    • Parameters

      Returns void

      Updates title of the property item.