Class Menu

Use the Menu class to create a context menu. Menus can contain custom entries and hierarchy, or existing actions and tools.

Hierarchy (View Summary)

Deletable
- Menu
  - BarMenu
  - BarMenu

Index

Constructors

Properties

node plugin? structure closed_in_this_click? open

Methods

addAction delete deleteItem hide hover open removeAction show

Constructors

constructor

new Menu(
    id: string,
    template: any[] | ((context?: any) => any[]),
    options?: MenuOptions,
): Menu
Creates a new context menu
Parameters
- id: string
- template: any[] | ((context?: any) => any[])
- Optionaloptions: MenuOptions
Returns Menu
Overrides Deletable.constructor
- Defined in types/custom/menu.d.ts:35
new Menu(
template: any[] | ((context?: any) => any[]),
options?: MenuOptions,
): Menu
Parameters
- template: any[] | ((context?: any) => any[])
- Optionaloptions: MenuOptions
Returns Menu
Overrides Deletable.constructor
- Defined in types/custom/menu.d.ts:40

Properties

node

node: HTMLUListElement

`Optional`plugin

plugin?: string

The ID of the plugin that created the object

structure

structure: any[]

`Static` `Optional`closed_in_this_click

closed_in_this_click?: string

`Static`open

open: Menu

Methods

addAction

addAction(action: Action | CustomMenuItem, path?: string | number): void
Adds an action to the menu structure
Parameters
- action: Action | CustomMenuItem
  Action to add
- Optionalpath: string | number
  Path pointing to the location. Use the ID of each level of the menu, or index within a level, separated by a point. For example, export.0 places the action at the top position of the Export submenu.
Returns void
- Defined in types/custom/menu.d.ts:61

delete

delete(): void
Returns void
Inherited from Deletable.delete
- Defined in types/custom/misc.d.ts:8

deleteItem

deleteItem(rm_item: Action): void
Parameters
- rm_item: Action
Returns void
Deprecated
- Defined in types/custom/menu.d.ts:70

hide

hide(): this
Closes the menu if it's open

Returns this
- Defined in types/custom/menu.d.ts:55

hover

hover(node: HTMLElement, event: Event, expand?: boolean): void
Parameters
- node: HTMLElement
- event: Event
- Optionalexpand: boolean
Returns void
- Defined in types/custom/menu.d.ts:71

open

open(position: HTMLElement | MouseEvent | "mouse", context?: any): this
Opens the menu somewhere
Parameters
- position: HTMLElement | MouseEvent | "mouse"
  Position where to open the menu. Can be a mouse event, or a node that the menu is spawned below.
- Optionalcontext: any
  Context for the click events inside the menu
Returns this
- Defined in types/custom/menu.d.ts:47

removeAction

removeAction(path: string | Action): void
Parameters
- path: string | Action
  Path pointing to the location. Use the ID of each level of the menu, or index within a level, or item ID, separated by a point. For example, export.export_special_format removes the action "Export Special Format" from the Export submenu.
Returns void
- Defined in types/custom/menu.d.ts:66

show

show(position: HTMLElement | MouseEvent | "mouse", context?: any): this
Alias for .open()
Parameters
- position: HTMLElement | MouseEvent | "mouse"
- Optionalcontext: any
Returns this
- Defined in types/custom/menu.d.ts:51