Methods

Source code

close(closeParent)

Close menu.

Parameters:

Name	Type	Default	Description
closeParent	boolean	false	optional If true try to close parent menu if exists.

Source code

closeAllSubMenus()

Close all opened sub menus.

Source code

closeSubMenu(row)

Close sub menu at row index.

Parameters:

Name	Type	Description
row	number	Row index.

Source code

destroy()

Destroy instance.

Source code

executeCommand(event)

Execute menu command.

Parameters:

Name	Type	Description
event	Event	optional The mouse event object.

Source code

getSelectedItem(){object|null}

Returns currently selected menu item. Returns null if no item was selected.

Returns: {object|null}

Source code

hasSelectedItem(){boolean}

Checks if the menu has selected (highlighted) any item from the menu list.

Returns: {boolean}

Source code

isAllSubMenusClosed(){boolean}

Checks if all created and opened sub menus are closed.

Returns: {boolean}

Source code

isCommandPassive(commandDescriptor){boolean}

Checks if the passed command is passive or not. The command is passive when it's marked as
disabled, the descriptor object contains isCommand property set to false, command
is a separator, or the item is recognized as submenu. For passive items the menu is not
closed automatically after the user trigger the command through the UI.

Parameters:

Name	Type	Description
commandDescriptor	object	Selected menu item from the menu data source.

Returns: {boolean}

Source code

isOpened(){boolean}

Checks if menu was opened.

Returns: {boolean} Returns true if menu was opened.

Source code

isSubMenu(){boolean}

Check if menu is using as sub-menu.

Returns: {boolean}

Source code

onAfterSelection(r, c, r2, c2, preventScrolling)

On after selection listener.

Parameters:

Name	Type	Description
r	number	Selection start row index.
c	number	Selection start column index.
r2	number	Selection end row index.
c2	number	Selection end column index.
preventScrolling	object	Object with value property where its value change will be observed.

Source code

open()

Open menu.

Fires:

• Hooks#event:beforeContextMenuShow
• Hooks#event:afterContextMenuShow

Source code

openSubMenu(row){Menu|boolean}

Open sub menu at the provided row index.

Parameters:

Name	Type	Description
row	number	Row index.

Returns: {Menu|boolean} Returns created menu or false if no one menu was created.

Source code

selectFirstCell()

Select first cell in opened menu.

Source code

selectLastCell()

Select last cell in opened menu.

Source code

selectNextCell(row, col)

Select next cell in opened menu.

Parameters:

Name	Type	Description
row	number	Row index.
col	number	Column index.

Source code

selectPrevCell(row, col)

Select previous cell in opened menu.

Parameters:

Name	Type	Description
row	number	Row index.
col	number	Column index.

Source code

setMenuItems(menuItems)

Set array of objects which defines menu items.

Parameters:

Name	Type	Description
menuItems	Array	Menu items to display.

Source code

setOffset(area, offset)

Set offset menu position for specified area (above, below, left or right).

Parameters:

Name	Type	Default	Description
area	string		Specified area name (above, below, left or right).
offset	number	0	Offset value.

Source code

setPosition(coords)

Set menu position based on dom event or based on literal object.

Parameters:

Name	Type	Description
coords	Event | object	Event or literal Object with coordinates.

Source code

setPositionAboveCursor(cursor)

Set menu position above cursor object.

Parameters:

Name	Type	Description
cursor	Cursor	Cursor object.

Source code

setPositionBelowCursor(cursor)

Set menu position below cursor object.

Parameters:

Name	Type	Description
cursor	Cursor	Cursor object.

Source code

setPositionOnLeftOfCursor(cursor)

Set menu position on the left of cursor object.

Parameters:

Name	Type	Description
cursor	Cursor	Cursor object.

Source code

setPositionOnRightOfCursor(cursor)

Set menu position on the right of cursor object.

Parameters:

Name	Type	Description
cursor	Cursor	Cursor object.