Class: Menu

dg.Menu

Menu (either top menu or popup menu). Top menu sample: https://public.datagrok.ai/js/samples/ui/menu Popup menu sample: https://public.datagrok.ai/js/samples/ui/popup-menu

Example

DG.Menu.popup()
  .item('Show info', () => grok.shell.info('Info'))
  .separator()
  .items(['First', 'Second'], (s) => grok.shell.info(s))
  .show();

Constructors

constructor

• new Menu(dart)

Parameters

Name	Type
dart	any

Defined in

src/widgets.ts:881

Properties

_check

• _check: HTMLDivElement

Defined in

src/widgets.ts:879

---

dart

• dart: any

Defined in

src/widgets.ts:878

Accessors

onContextMenuItemClick

• get onContextMenuItemClick(): Observable<any>

Returns

Observable<any>

Defined in

src/widgets.ts:961

---

root

• get root(): HTMLElement

Returns

HTMLElement

Defined in

src/widgets.ts:894

Methods

bind

▸ bind(element): Menu

Binds the menu to the specified options.element

Parameters

Name	Type
element	HTMLElement

Returns

Menu

Defined in

src/widgets.ts:953

---

clear

▸ clear(): void

Removes all child menu items.

Returns

void

Defined in

src/widgets.ts:913

---

click

▸ click(): void

Executes the onClick function for that menu item. Only works for items, not groups.

Returns

void

Defined in

src/widgets.ts:903

---

endGroup

▸ endGroup(): Menu

Ends a group of menu items and returns to the higher menu level.

Returns

Menu

Defined in

src/widgets.ts:924

---

find

▸ find(text): Menu

Finds a child menu item with the specified text.

Parameters

Name	Type
text	string

Returns

Menu

Defined in

src/widgets.ts:897

---

group

▸ group(text, order?): Menu

Returns an existing menu group or adds a new group with the specified text.

Parameters

Name	Type	Default value
text	string	undefined
order	null | number	null

Returns

Menu

Defined in

src/widgets.ts:918

---

item

▸ item(text, onClick, order?, options?): Menu

Adds a menu group with the specified text and handler.

Parameters

Name	Type	Default value
text	string	undefined
onClick	() => void	undefined
order	null | number	null
options	null | IMenuItemOptions	null

Returns

Menu

Defined in

src/widgets.ts:929

---

items

▸ items<T>(items, onClick, options?): Menu

For each item in items, adds a menu group with the specified text and handler.

Type parameters

Name	Type
T	any

Parameters

Name	Type	Default value
items	T[]	undefined
onClick	(item: T) => void	undefined
options	null | IMenuItemsOptions<T>	null

Returns

Menu

Defined in

src/widgets.ts:934

---

remove

▸ remove(text): void

Removes a child menu item with the specified text.

Parameters

Name	Type
text	string

Returns

void

Defined in

src/widgets.ts:908

---

separator

▸ separator(): Menu

Adds a separator line.

Returns

Menu

Defined in

src/widgets.ts:942

---

show

▸ show(options?): Menu

Shows the menu.

Parameters

Name	Type
options?	IShowMenuOptions

Returns

Menu

Defined in

src/widgets.ts:948

---

toString

▸ toString(): string

Returns

string

Defined in

src/widgets.ts:965

---

create

▸ Static create(): Menu

Returns

Menu

Defined in

src/widgets.ts:885

---

popup

▸ Static popup(): Menu

Creates a popup menu.

Returns

Menu

Defined in

src/widgets.ts:890