Constructor
new Notifications()
- Source:
Example
ui.notifications.info("This is an info message");
ui.notifications.warn("This is a warning message");
ui.notifications.error("This is an error message");
ui.notifications.info("This is a 4th message which will not be shown until the first info message is done");Extends
Members
(static) defaultOptions
- Source:
_element :jQuery
- Source:
- Overrides:
An internal reference to the HTML element this application renders
Type:
- jQuery
_scrollPositions :Object|null
- Source:
- Overrides:
Track the most recent scroll positions for any vertically scrolling containers
Type:
- Object | null
active :Array
- Source:
Notifications which are currently displayed
Type:
appId :Number
- Source:
- Overrides:
The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
Type:
element :jQuery|HTMLElement
- Source:
- Overrides:
Return the active application element, if it currently exists in the DOM
Type:
- jQuery | HTMLElement
id
- Source:
- Overrides:
Return the CSS application ID which uniquely references this UI element
options :Object
- Source:
- Overrides:
The options provided to this application upon initialization
Type:
- Object
popOut :boolean
- Source:
- Overrides:
Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered
Type:
- boolean
position :Object
- Source:
- Overrides:
Track the current position and dimensions of the Application UI
Type:
- Object
queue :Array
- Source:
Submitted notifications which are queued for display
Type:
rendered :boolean
- Source:
- Overrides:
Return a flag for whether the Application instance is currently rendered
Type:
- boolean
template :string
- Source:
- Overrides:
The path to the HTML template file which should be used to render the inner content of the app
Type:
- string
title :string
- Source:
- Overrides:
An Application window should define its own title definition logic which may be dynamic depending on its data
Type:
- string
Methods
activateListeners(html)
- Source:
- Overrides:
Once the HTML for an Application has been rendered, activate event listeners which provide interactivity for the application
Parameters:
| Name | Type | Description |
|---|---|---|
html |
jQuery | HTMLElement |
(async) close() → {Promise}
- Source:
- Overrides:
Close the application and un-register references to it within UI mappings This function returns a Promise which resolves once the window closing animation concludes
Returns:
- Type
- Promise
error(message)
- Source:
Display a notification with the "error" type
Parameters:
| Name | Type | Description |
|---|---|---|
message |
String | The content of the notification message |
getData() → {Object|Promise}
- Source:
- Overrides:
An application should define the data object used to render its template. This function may either return an Object directly, or a Promise which resolves to an Object If undefined, the default implementation will return an empty object allowing only for rendering of static HTML
Returns:
- Type
- Object | Promise
info(message)
- Source:
Display a notification with the "info" type
Parameters:
| Name | Type | Description |
|---|---|---|
message |
String | The content of the notification message |
(async) maximize() → {Promise}
- Source:
- Overrides:
Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized
Returns:
A Promise which resolves to true once the maximization action has completed
- Type
- Promise
(async) minimize() → {Promise}
- Source:
- Overrides:
Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized
Returns:
A Promise which resolves to true once the minimization action has completed
- Type
- Promise
notify(message, type)
- Source:
Push a new notification into the queue
Parameters:
| Name | Type | Description |
|---|---|---|
message |
String | The content of the notification message |
type |
String | The type of notification, currently "info", "warning", and "error" are supported |
render(force, options)
- Source:
- Overrides:
Render the Application by evaluating it's HTML template against the object of data provided by the getData method If the Application is rendered as a pop-out window, wrap the contained HTML in an outer frame with window controls
Parameters:
| Name | Type | Default | Description | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
force |
Boolean |
false
|
Add the rendered application to the DOM if it is not already present. If false, the Application will only be re-rendered if it is already present. |
|||||||||||||||||||||||||||
options |
Object | Additional rendering options which are applied to customize the way that the Application is rendered in the DOM. Properties
|
setPosition(left, top, width, height, scale) → {Object}
- Source:
- Overrides:
Set the application position and store it's new location.
Parameters:
| Name | Type | Description |
|---|---|---|
left |
number | null | The left offset position in pixels |
top |
number | null | The top offset position in pixels |
width |
number | null | The application width in pixels |
height |
number | string | null | The application height in pixels |
scale |
number | null | The application scale as a numeric factor where 1.0 is default |
Returns:
The updated position object for the application containing the new values
- Type
- Object
warn(message)
- Source:
Display a notification with the "warning" type
Parameters:
| Name | Type | Description |
|---|---|---|
message |
String | The content of the notification message |