Downtime timeline

About 3 min read

TwDowntimeTimeline · Category: Charts

Settings

These settings are in the properties panel on the right while the widget is selected, mostly in the Downtime Timeline Settings section. The default value is the value the widget has when it is first added to a page.

Machines

Setting	Type	Default	Description
Machines seriesConfigJson	Series configuration	[]	Pick tags with a run/stop log; each tag becomes one row. Without a name the log description is shown. Templates apply their tag prefix.
Downtime reasons reasonOverlay	Checkbox	Off	Shows the entered reasons under the stops in their category color; authorized users click a stop to enter its reason. The edition and the machine must have downtime reasons turned on.

Time range

Setting	Type	Default	Description
Time source timeSource	Custom editor	local	Local: the widget uses its own range. Page time: follows the page time picker; without a selection it falls back to its own range.
Range type rangeMode	Selection	relative	Rolling window that ends now, or a calendar period (day, week, month, quarter, year). Options: calendar Calendar, relative Relative
Calendar period calendarPeriod	Selection	day	Period used when the range type is calendar. Options: day Day, week Week, month Month, quarter Quarter, year Year
Window length (minutes) timeRangeMinutes	Number	1440	Length of the rolling window in minutes. The server also limits the longest range.
Calendar offset calendarOffset	Number	0	0 is the current period, -1 the previous one. Future periods are not allowed.

Display

Setting	Type	Default	Description
Maximum segments maxSegments	Number	2000	Most state segments returned by one request (1–5000). Beyond it the newest segments are kept, older ones are cut off and a notice is shown; when the cap is at least the number of machines, each machine keeps at least its last state.
Auto refresh (s) autoRefreshSeconds	Number	60	While the range includes now the timeline reloads at this interval. 0 turns it off; at least 30 seconds.
Show legend showLegend	Checkbox	On	Shows a text legend of the running, stopped and unknown colors.

Other settings

Setting	Type	Default	Description
Enable Flashing enableFlashing	Checkbox	Off	Makes the widget blink (an opacity pulse every second). Usually bound to an alarm condition.
Log Button logButton	Checkbox	Off	At runtime shows a chart icon when hovering the widget; clicking it adds the Tags bound to the widget to the log Tag list.

Bindings

In the Bindings (Rules) section of the properties panel, a Tag can be bound to the following properties of this widget with a Direct binding. The binding types (Direct, IntRange, FloatRange, Boolean, Bit) are the same for all widgets; they are described on the Widget Reference page.

title, visible, authorization, x, y, width, height, rotation, class, foregroundColor, backgroundColor, borderColor, borderStyle, borderWidth, borderRadius, borderTopLeftRadius, borderTopRightRadius, enableFlashing, logButton, downtimeSchemaVersion, seriesConfigJson, timeSource, rangeMode, calendarPeriod, calendarOffset, timeRangeMinutes, maxSegments, autoRefreshSeconds, showLegend, reasonOverlay

Common sections

While this widget is selected, the properties panel also shows these common sections: General, Layout, Appearance, Bindings (Rules). These sections are described on the Page Editor page.