The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT
The options provided to this application upon initialization
Track the current position and dimensions of the Application UI
Return the active application element, if it currently exists in the DOM
Return the CSS application ID which uniquely references this UI element
Get the currently viewed page.
Set the currently viewed page.
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
Return a flag for whether the Application instance is currently rendered
The path to the HTML template file which should be used to render the inner content of the app
Returns the localized name of the window title.
Register a callback to occur when an event fires. See individual events for descriptions and use Api.DEBUG.EVENTS to log and analyze events.
Like on but only fires on the next occurrence.
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
Finish the download and return the byte array for the file.
A promise that resolves to Uint8Array of file bytes once that download is finished. You can pass this to a viewer to open it, or do something else with it.
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
A Promise which resolves to true once the maximization action has completed
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
A Promise which resolves to true once the minimization action has completed
Open a PDF
A URL or byte array to open.
The initial page to open to
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
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.
Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.
Set the application position and store it's new location
Generated using TypeDoc
The base viewer class from which all other types of viewers inherit.
StaticViewer
FillableViewer
ActorViewer