Class BarMenu

Optionalplugin

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

delete

• delete(): void

  Returns void

hide

• hide(): this

  Closes the menu if it's open

  Returns this

open

• open(position: HTMLElement | MouseEvent, context?: any): this

  Opens the menu somewhere

  Parameters

  • position: HTMLElement | MouseEvent

    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

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

show

• show(position: HTMLElement | MouseEvent, context?: any): this

  Alias for .open()

  Parameters

  • position: HTMLElement | MouseEvent
  • Optionalcontext: any

  Returns this