| Namespaces | Members | Methods |
|---|---|---|
Definition of UI Namespaces driving menus and UI-ready utilities.
- Source:
Namespaces
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 |
UIElement | to append |
pluginId |
string | owner plugin ID |
selector |
string | jquery selector where to append, default 'body' |
- Source:
(static) addViewerHtml(html, pluginId, uniqueViewerId) → {boolean}
Add custom HTML to the viewer-dependent context - it will be contained within the viewer area.
This HTML IS NOT GUARANTEED TO BE PRESERVED when changing viewers.
Plugins must listen to change in viewer events to update the UI if necessary,
and should not rely on this HTML being persistent - when a viewer is gone, so is the HTML.
Parameters:
| Name | Type | Description |
|---|---|---|
html |
UIElement | |
pluginId |
string | |
uniqueViewerId |
OpenSeadragon.Viewer | string |
- Source:
Returns:
(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 |
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: