Skip to content

Component Library

A component is a ready-made interface element with behaviour of its own, sitting in the animation designer’s palette. You place it on a screen, bind it to a variable, and it redraws itself on every data tick. Gauges, tanks, LEDs, toggles, displays and charts are built-in examples.

This screen manages the components installed into the space.

The Component Library screen

ColumnDescription
NameComponent name
VersionThe component’s own version
API VersionThe component interface version it targets
PrefixThe prefix the component uses for its element names
CapabilitiesWhat the component asks to be allowed to do
EnabledWhether it appears in the palette

Install uploads a new component package; Reload refreshes the list.

The Prefix keeps components from different sources from overwriting each other’s names: every package is registered under its own prefix.

The Enabled flag lets you take a component out of service without deleting it. When you want a component gone from the palette, disabling it first and watching what breaks is safer than deleting it out from under the screens that use it.

Both put your own content on screen, but they work differently:

ComponentCustom HTML
How it rendersInline in the animation, as SVGInside a separate, sandboxed iframe
FrameworkNone — plain JSWhatever library you like
Where its data comes fromA server-side expressionAn API bridge injected into the page
Where it is usedPlaced from the designer paletteAs a custom menu or dashboard page

Put briefly: write a component when you need a readout to sit inside a SCADA screen, and Custom HTML when you are building a page in its own right.

Components are distributed as packages; the package manifest declares the component’s parameters and data bindings. Authoring is outside the scope of this screen — this page covers managing the ones already installed.