#Interface: IMenuPropertyItem experimental

Beta

A property item which supports Menu properties

#Extends

• IPropertyItemBase

#Properties

#enable

enable: boolean

Beta

#Remarks

If the item is enabled in the UI.

#Inherited from

IPropertyItemBase.enable

---

#id

readonly id: string

Beta

#Remarks

Unique ID for the property item.

#Inherited from

IPropertyItemBase.id

---

#paneId

readonly paneId: string

Beta

#Remarks

The parent pane id.

#Inherited from

IPropertyItemBase.paneId

---

#typeName

readonly typeName: PropertyItemType

Beta

#Remarks

The type name of the target property.

#Inherited from

IPropertyItemBase.typeName

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

IPropertyItemBase.visible

#Methods

#addEntry()

addEntry(props, action?): IMenu

Beta

#Parameters

#props

IMenuCreationParams

Menu creation parameters

#action?

RegisteredAction<NoArgsAction>

Optional action to trigger on menu click

#Returns

IMenu

#Remarks

Adds a new menu item entry to property item

---

#getEntries()

getEntries(): IMenu[]

Beta

#Returns

IMenu[]

All first level menu entries

#Remarks

---

#getMenu()

getMenu(menuId): IMenu | undefined

Beta

#Parameters

#menuId

string

Identifier of the menu.

#Returns

IMenu | undefined

#Remarks

Find the menu item recursively if it exists

---

#removeEntry()

removeEntry(menuId): void

Beta

#Parameters

#menuId

string

Menu id to remove

#Returns

void

#Remarks

Removed the menu item entry if the id is found

---

#setTitle()

setTitle(title): void

Beta

#Parameters

#title

LocalizedString | undefined

New title.

#Returns

void

#Remarks

Updates title of the property item.

---

#setTooltip()

setTooltip(tooltip): void

Beta

#Parameters

#tooltip

BasicTooltipContent | undefined

New tooltip.

#Returns

void

#Remarks

Updates tooltip description of property item.