Class Notifications

A common framework for displaying notifications to the client. Submitted notifications are added to a queue, and up to 3 notifications are displayed at once. Each notification is displayed for 5 seconds at which point further notifications are pulled from the queue.

Example: Displaying Notification Messages

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");

Hierarchy (view full)

Properties

queue active options _element position _dragDrop _tabs _searchFilters _minimized _scrollPositions appId _state _priorState #id RENDER_STATES

Accessors

id element template popOut rendered closing title defaultOptions

Methods

initialize _renderInner _render notify info warn error remove clear getData render activateListeners activateTab bringToTop close minimize maximize setPosition _callHooks _saveScrollPositions _restoreScrollPositions _renderOuter _getHeaderButtons _activateCoreListeners _onChangeTab _onSearchFilter _canDragStart _canDragDrop _onDragStart _onDragOver _onDrop _waitForImages fetch

Properties

queue

queue: object[]

Submitted notifications which are queued for display

active

active: object[]

Notifications which are currently displayed

options

options: object

The options provided to this application upon initialization

_element

_element: jQuery

An internal reference to the HTML element this application renders

position

position: object

Track the current position and dimensions of the Application UI

_dragDrop

_dragDrop: DragDrop[]

DragDrop workflow handlers which are active for this Application

_tabs

_tabs: Tabs[]

Tab navigation handlers which are active for this Application

_searchFilters

_searchFilters: SearchFilter[]

SearchFilter handlers which are active for this Application

_minimized

_minimized: boolean

Track whether the Application is currently minimized

_scrollPositions

_scrollPositions: object

Track the most recent scroll positions for any vertically scrolling containers

appId

appId: number

The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT

Protected _state

_state: number

The current render state of the Application

See

Protected _priorState

_priorState: number

The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.

See

Private #id

#id: number = 1

An incrementing counter for the notification IDs.

Static RENDER_STATES

RENDER_STATES: Readonly<{
    ERROR: -3;
    CLOSING: -2;
    CLOSED: -1;
    NONE: 0;
    RENDERING: 1;
    RENDERED: 2;
}> = ...

The sequence of rendering states that track the Application life-cycle.

Type declaration

  • ERROR: -3
  • CLOSING: -2
  • CLOSED: -1
  • NONE: 0
  • RENDERING: 1
  • RENDERED: 2

Accessors

id

  • get id(): string

  • Return the CSS application ID which uniquely references this UI element

    Returns string

element

  • get element(): jQuery

  • Return the active application element, if it currently exists in the DOM

    Returns jQuery

template

  • get template(): string

  • The path to the HTML template file which should be used to render the inner content of the app

    Returns string

popOut

  • get popOut(): boolean

  • 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

    Returns boolean

rendered

  • get rendered(): boolean

  • Return a flag for whether the Application instance is currently rendered

    Returns boolean

closing

  • get closing(): boolean

  • Whether the Application is currently closing.

    Returns boolean

title

  • get title(): string

  • An Application window should define its own title definition logic which may be dynamic depending on its data

    Returns string

Static defaultOptions

  • get defaultOptions(): object

  • Returns object

Methods

initialize

  • initialize(): void

  • Initialize the Notifications system by displaying any system-generated messages which were passed from the server.

    Returns void

_renderInner

  • _renderInner(...args): Promise<any>

  • Parameters

    • Rest ...args: any[]

    Returns Promise<any>

_render

  • _render(...args): Promise<void>

  • Parameters

    • Rest ...args: any[]

    Returns Promise<void>

notify

  • notify(message, type?, options?): number

  • Push a new notification into the queue

    Parameters

    • message: string

      The content of the notification message

    • type: string = "info"

      The type of notification, "info", "warning", and "error" are supported

    • Optional options: NotifyOptions = {}

      Additional options which affect the notification

    Returns number

    The ID of the notification (positive integer)

info

  • info(message, options): number

  • Display a notification with the "info" type

    Parameters

    • message: string

      The content of the notification message

    • options: NotifyOptions

      Notification options passed to the notify function

    Returns number

    The ID of the notification (positive integer)

warn

  • warn(message, options): number

  • Display a notification with the "warning" type

    Parameters

    • message: string

      The content of the notification message

    • options: NotifyOptions

      Notification options passed to the notify function

    Returns number

    The ID of the notification (positive integer)

error

  • error(message, options): number

  • Display a notification with the "error" type

    Parameters

    • message: string

      The content of the notification message

    • options: NotifyOptions

      Notification options passed to the notify function

    Returns number

    The ID of the notification (positive integer)

remove

  • remove(id): void

  • Remove the notification linked to the ID.

    Parameters

    • id: number

      The ID of the notification

    Returns void

clear

  • clear(): void

  • Clear all notifications.

    Returns void

getData

  • getData(options?): object | Promise<object>

  • 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

    Parameters

    • options: object = {}

    Returns object | Promise<object>

render

  • render(force?, options?): Application

  • 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

    • 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: {
          left: number;
          top: number;
          width: number;
          height: number;
          scale: number;
          focus: boolean;
          renderContext: string;
          renderData: object;
      } = {}

      Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.

      • left: number

        The left positioning attribute

      • top: number

        The top positioning attribute

      • width: number

        The rendered width

      • height: number

        The rendered height

      • scale: number

        The rendered transformation scale

      • focus: boolean

        Apply focus to the application, maximizing it and bringing it to the top of the vertical stack.

      • renderContext: string

        A context-providing string which suggests what event triggered the render

      • renderData: object

        The data change which motivated the render request

    Returns Application

    The rendered Application instance

activateListeners

  • activateListeners(html): void

  • After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.

    Parameters

    • html: JQuery

    Returns void

activateTab

  • activateTab(tabName, options?): void

  • Change the currently active tab

    Parameters

    • tabName: string

      The target tab name to switch to

    • options: {
          group: string;
          triggerCallback: boolean;
      } = {}

      Options which configure changing the tab

      • group: string

        A specific named tab group, useful if multiple sets of tabs are present

      • triggerCallback: boolean

        Whether to trigger tab-change callback functions

    Returns void

bringToTop

  • bringToTop(): void

  • Bring the application to the top of the rendering stack

    Returns void

close

  • close(options?): Promise<void>

  • 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

    Parameters

    • Optional options: object = {}

      Options which affect how the Application is closed

    Returns Promise<void>

    A Promise which resolves once the application is closed

    Fires

    closeApplication

minimize

  • minimize(): Promise<void>

  • 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 Promise<void>

    A Promise which resolves once the minimization action has completed

maximize

  • maximize(): Promise<void>

  • 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 Promise<void>

    A Promise which resolves once the maximization action has completed

setPosition

  • setPosition(position?): void | {
        left: number;
        top: number;
        width: number;
        height: number;
        scale: number;
    }

  • Set the application position and store its new location. Returns the updated position object for the application containing the new values.

    Parameters

    • position: {
          left: number;
          top: number;
          width: number;
          height: string | number;
          scale: number;
      } = {}

      Positional data

      • left: number

        The left offset position in pixels

      • top: number

        The top offset position in pixels

      • width: number

        The application width in pixels

      • height: string | number

        The application height in pixels

      • scale: number

        The application scale as a numeric factor where 1.0 is default

    Returns void | {
        left: number;
        top: number;
        width: number;
        height: number;
        scale: number;
    }

Protected _callHooks

  • _callHooks(hookName, ...hookArgs): void
  • Protected Internal

    Call all hooks for all applications in the inheritance chain.

    Parameters

    • hookName: string | ((className) => string)

      The hook being triggered, which formatted with the Application class name

    • Rest ...hookArgs: any[]

      The arguments passed to the hook calls

    Returns void

Protected _saveScrollPositions

  • _saveScrollPositions(html): void
  • Protected

    Persist the scroll positions of containers within the app before re-rendering the content

    Parameters

    • html: jQuery

      The HTML object being traversed

    Returns void

Protected _restoreScrollPositions

  • _restoreScrollPositions(html): void
  • Protected

    Restore the scroll positions of containers within the app after re-rendering the content

    Parameters

    • html: jQuery

      The HTML object being traversed

    Returns void

Protected _renderOuter

  • _renderOuter(): Promise<jQuery>
  • Protected

    Render the outer application wrapper

    Returns Promise<jQuery>

    A promise resolving to the constructed jQuery object

Protected _getHeaderButtons

  • _getHeaderButtons(): ApplicationHeaderButton[]
  • Protected

    Specify the set of config buttons which should appear in the Application header. Buttons should be returned as an Array of objects. The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.

    Returns ApplicationHeaderButton[]

    Fires

    getApplicationHeaderButtons

Protected _activateCoreListeners

  • _activateCoreListeners(html): void
  • Protected

    Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.

    Parameters

    • html: jQuery

    Returns void

Protected _onChangeTab

  • _onChangeTab(event, tabs, active): void
  • Protected

    Handle changes to the active tab in a configured Tabs controller

    Parameters

    • event: MouseEvent

      A left click event

    • tabs: Tabs

      The Tabs controller

    • active: string

      The new active tab name

    Returns void

Protected _onSearchFilter

  • _onSearchFilter(event, query, rgx, html): void
  • Protected

    Handle changes to search filtering controllers which are bound to the Application

    Parameters

    • event: KeyboardEvent

      The key-up event from keyboard input

    • query: string

      The raw string input to the search field

    • rgx: RegExp

      The regular expression to test against

    • html: HTMLElement

      The HTML element which should be filtered

    Returns void

Protected _canDragStart

  • _canDragStart(selector): boolean
  • Protected

    Define whether a user is able to begin a dragstart workflow for a given drag selector

    Parameters

    • selector: string

      The candidate HTML selector for dragging

    Returns boolean

    Can the current user drag this selector?

Protected _canDragDrop

  • _canDragDrop(selector): boolean
  • Protected

    Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector

    Parameters

    • selector: string

      The candidate HTML selector for the drop target

    Returns boolean

    Can the current user drop on this selector?

Protected _onDragStart

  • _onDragStart(event): void
  • Protected

    Callback actions which occur at the beginning of a drag start workflow.

    Parameters

    • event: DragEvent

      The originating DragEvent

    Returns void

Protected _onDragOver

  • _onDragOver(event): void
  • Protected

    Callback actions which occur when a dragged element is over a drop target.

    Parameters

    • event: DragEvent

      The originating DragEvent

    Returns void

Protected _onDrop

  • _onDrop(event): void
  • Protected

    Callback actions which occur when a dragged element is dropped on a target.

    Parameters

    • event: DragEvent

      The originating DragEvent

    Returns void

Protected _waitForImages

  • _waitForImages(): Promise<void>
  • Protected

    Wait for any images present in the Application to load.

    Returns Promise<void>

    A Promise that resolves when all images have loaded.

Private fetch

  • fetch(): void
  • Private

    Retrieve a pending notification from the queue and display it

    Returns void

Settings

Member Visibility

Theme

On This Page

queueactiveoptions_elementposition_dragDrop_tabs_searchFilters_minimized_scrollPositionsappId_state_priorState#idRENDER_STATESidelementtemplatepopOutrenderedclosingtitledefaultOptionsinitialize_renderInner_rendernotifyinfowarnerrorremovecleargetDatarenderactivateListenersactivateTabbringToTopcloseminimizemaximizesetPosition_callHooks_saveScrollPositions_restoreScrollPositions_renderOuter_getHeaderButtons_activateCoreListeners_onChangeTab_onSearchFilter_canDragStart_canDragDrop_onDragStart_onDragOver_onDrop_waitForImagesfetch