Interface IMenuPropertyItem

A property item which supports Menu properties

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;
    removeEntry(menuId: string): void;
    setTitle(title: LocalizedString): void;
    setTooltip(tooltip: BasicTooltipContent): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- IMenuPropertyItem

Index

Properties

enable id paneId typeName visible

Methods

addEntry getEntries getMenu removeEntry setTitle setTooltip

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.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

addEntry

addEntry(
props: IMenuCreationParams,
action?: RegisteredAction<NoArgsAction>,
): IMenu
Parameters
- props: IMenuCreationParams
  Menu creation parameters
- Optionalaction: RegisteredAction<NoArgsAction>
  Optional action to trigger on menu click
Returns IMenu
Remarks
Adds a new menu item entry to property item

getEntries

getEntries(): IMenu[]
Returns IMenu[]
All first level menu entries

Remarks

getMenu

getMenu(menuId: string): IMenu
Parameters
- menuId: string
  Identifier of the menu.
Returns IMenu
Remarks
Find the menu item recursively if it exists

removeEntry

removeEntry(menuId: string): void
Parameters
- menuId: string
  Menu id to remove
Returns void
Remarks
Removed the menu item entry if the id is found

setTitle

setTitle(title: LocalizedString): void
Parameters
- title: LocalizedString
  New title.
Returns void
Remarks
Updates title of the property item.

setTooltip

setTooltip(tooltip: BasicTooltipContent): void
Parameters
- tooltip: BasicTooltipContent
  New tooltip.
Returns void
Remarks
Updates tooltip description of property item.