Class BasePlaceableHUD<ActiveHUDObject, ActiveHUDDocument, ActiveHUDLayer>Interface

_element

options

position

_dragDrop

_tabs

_searchFilters

_minimized

_scrollPositions

appId

Static RENDER_STATES

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

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: any;
    } = {}

    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: any

      The data change which motivated the render request

  Returns Application

  The rendered Application instance

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: any = {}

    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