Namespace: USER_INTERFACE

USER_INTERFACE

Namespaces Members Methods
Definition of UI Namespaces driving menus and UI-ready utilities.
Source:

Namespaces

AdvancedMenu
Errors
MainMenu
Status
Tools
Tutorials

Members

(static) Dialogs

Dialog System
Source:
See:

(static) DropDown

DropDown Handler
Source:
See:

(static) Loading

UI Fullscreen Loading
Source:

Methods

(static) addHtml(html, pluginId, selector)

Add custom HTML to the DOM selector
Parameters:
Name Type Description
html string to append
pluginId string owner plugin ID
selector string jquery selector where to append, default 'body'
Source:

(static) focusMenu(menuName, menuId)

Highlight element in DOM ensuring given menus are open it is contained in
Parameters:
Name Type Description
menuName menu type it is contained in, the name of the menu as in USER_INTERFACE
menuId string | Array.<string> id of the menu to focus, applicable for menus that can switch between different contents, AdvancedMenu can specify both string (menuId to open) or array ([menuId, submenuId])
Source:

(static) highlight(menuName, menuId, id, timeout, animated)

Highlight element in DOM ensuring given menus are open it is contained in
Parameters:
Name Type Description
menuName menu type it is contained in, the name of the menu as in USER_INTERFACE
menuId string | Array.<string> id of the menu to focus, applicable for menus that can switch between different contents, AdvancedMenu can specify both string (menuId to open) or array ([menuId, submenuId])
id element ID to highlight
timeout highlight timeout in ms, default 2000
animated default true
Source:

(static) highlightElementId(id, timeout, animated)

Run highlight animation on element
Parameters:
Name Type Description
id id of the element in DOM
timeout highlight timeout in ms, default 2000
animated default true
Source: