Class BarMenu

Creates a new menu in the menu bar

Hierarchy (View Summary)

Menu
- BarMenu

Index

Constructors

Methods

addAction conditionMet delete deleteItem hide highlight hover onClose? onOpen? open removeAction show

Properties

children condition? highlight_action? id label name node options? structure type closed_in_this_click? open

Constructors

constructor

new BarMenu(
    id: string,
    structure: MenuItem[],
    options?: BarMenuOptions,
): BarMenu
Parameters
- id: string
- structure: MenuItem[]
- Optionaloptions: BarMenuOptions
Returns BarMenu
Overrides Menu.constructor
- Defined in types/custom/menu_bar.d.ts:14

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
Inherited from Menu.addAction
- Defined in types/generated/interface/menu.d.ts:112

conditionMet

conditionMet(): boolean
Returns boolean
Deprecated
Inherited from Menu.conditionMet
- Defined in types/generated/interface/menu.d.ts:106

delete

delete(): void
Returns void
Inherited from Menu.delete
- Defined in types/generated/interface/menu.d.ts:122

deleteItem

deleteItem(rm_item: Action): void
Parameters
- rm_item: Action
Returns void
Deprecated
Use removeAction instead
Inherited from Menu.deleteItem
- Defined in types/generated/interface/menu.d.ts:121

hide

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

Returns this
Inherited from Menu.hide
- Defined in types/generated/interface/menu.d.ts:102

highlight

highlight(action: Action): void
Visually highlights an action within the menu, until the user opens the menu
Parameters
- action: Action
Returns void
- Defined in types/custom/menu_bar.d.ts:24

hover

hover(node: HTMLElement, event?: Event, expand?: boolean): void
Parameters
- node: HTMLElement
- Optionalevent: Event
- Optionalexpand: boolean
Returns void
Inherited from Menu.hover
- Defined in types/generated/interface/menu.d.ts:81

`Optional`onClose

onClose?(): void
Returns void
Inherited from Menu.onClose
- Defined in types/generated/interface/menu.d.ts:72

`Optional`onOpen

onOpen?(position: MenuOpenPositionAnchor, context?: any): void
Parameters
- position: MenuOpenPositionAnchor
- Optionalcontext: any
Returns void
Inherited from Menu.onOpen
- Defined in types/generated/interface/menu.d.ts:71

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
Inherited from Menu.open
- Defined in types/generated/interface/menu.d.ts:94

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
Inherited from Menu.removeAction
- Defined in types/generated/interface/menu.d.ts:117

show

show(position?: MenuOpenPositionAnchor, context?: any): this
Alias for .open()
Parameters
- Optionalposition: MenuOpenPositionAnchor
- Optionalcontext: any
Returns this
Inherited from Menu.show
- Defined in types/generated/interface/menu.d.ts:98

Properties

children

children: []

`Optional`condition

condition?: ConditionResolvable

`Optional`highlight_action

highlight_action?: MenuItem

id

id: string

label

label: HTMLElement

name

name: string

node

node: HTMLUListElement

`Optional`options

options?: MenuOptions

structure

structure: MenuItem[]

type

type: "bar_menu"

`Static` `Optional`closed_in_this_click

closed_in_this_click?: string

`Static`open

open: Menu