Class Menu

constructor

• new Menu(
      template: MenuItem[] | ((context?: any) => MenuItem[]),
      options?: MenuOptions,
  ): Menu

  Creates a new context menu

  Parameters

  • template: MenuItem[] | ((context?: any) => MenuItem[])
  • Optionaloptions: MenuOptions

  Returns Menu

• new Menu(
      id: string,
      template: MenuItem[] | ((context?: any) => MenuItem[]),
      options?: MenuOptions,
  ): Menu

  Parameters

  • id: string
  • template: MenuItem[] | ((context?: any) => MenuItem[])
  • Optionaloptions: MenuOptions

  Returns Menu

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

conditionMet

• conditionMet(): boolean

  Returns boolean

  Deprecated

delete

• delete(): void

  Returns void

deleteItem

• deleteItem(rm_item: Action): void

  Parameters

  • rm_item: Action

  Returns void

  Deprecated

  Use removeAction instead

hide

• hide(): this

  Closes the menu if it's open

  Returns this

hover

• hover(node: HTMLElement, event?: Event, expand?: boolean): void

  Parameters

  • node: HTMLElement
  • Optionalevent: Event
  • Optionalexpand: boolean

  Returns void

OptionalonClose

• onClose?(): void

  Returns void

OptionalonOpen

• onOpen?(position: MenuOpenPositionAnchor, context?: any): void

  Parameters

  • position: MenuOpenPositionAnchor
  • Optionalcontext: any

  Returns void

open

• open(position?: MenuOpenPositionAnchor, context?: any): this

  Opens the menu somewhere

  Parameters

  • Optionalposition: MenuOpenPositionAnchor

    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

  Remove an action or menu item from the menu

  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?: MenuOpenPositionAnchor, context?: any): this

  Alias for .open()

  Parameters

  • Optionalposition: MenuOpenPositionAnchor
  • Optionalcontext: any

  Returns this

children

Optionalcondition

Optionalhighlight_action

id

node

Optionaloptions

structure

type

Static Optionalclosed_in_this_click

Staticopen