Functions and Variables

The following functions and variables are used in our template.

Display Options

canvasWidth / canvasHeight

These variables give the effective width and height available, if you'd like to build your content to fit the existing window.

clearedDisplay

This value is true if the display has been cleared and you need to re-build the content. This normally happens due to a page change or the window being resized.

Data

LoadData(query)

Loads data points from an AQL query.

Resulting data points can be read from the window.liveData variable.

The window.refreshContent function will be called once the data is loaded and available.

LoadLiveData(query)

Loads data points from an AQL query and subscribes to live data updates.

Resulting data points can be read from the window.liveData variable.

The window.refreshContent function will be called once the data is loaded and available, and whenever new live data arrives.

liveDataColumns

An array of the column names for your incoming data.

liveData

A dictionary containing the live data values. For example, the 'temperature' property of an asset named 'Machine' would be available at window.liveData['Machine.Temperature'].

Query Functions

ARDIQuery(query)

Returns the results of an AQL query as a JSON object.

ARDITable(query)

Returns the results of an AQL query as a JSON table.

Tooltip Functions

ShowTooltip(ob)

Displays a tooltip showing values taken from object 'ob'.

HideTooltip()

Hides a previously displayed tooltip.

General Functions

SetPageType(ext)

Sets the type/extension for the content.

Currently, this can be 'svg' or 'html'.

SetPageName(name)

Sets the name for the current page.

This is used when saving the file.