Sankey view

A Sankey view draws numeric parameters as bands between named nodes, for example energy flowing from a main meter to sub-meters, or material moving between process stages. Band thickness is proportional to each parameter’s value over the report window. Authors add it with Add Sankey under Setup → Reports; viewers open it on the report page.

Settings

Setting	Field	Values	Default
Compact	compact	On or off. Narrower nodes and tighter spacing.	Off
Height	height	Pixels, 40–4000, or empty (null). See Size.	Empty
Show titles	showTitles	On or off. Paints node labels and link values.	On
Show tooltips	showTooltips	On or off. Hover text on nodes and bands.	On
Interactive	interactive	On or off. Clicking a node or band filters the visible parameters.	On
Value aggregation	valueAggregation	Delta (delta), Sum (sum), Average (average), Latest (latest), First (first), Min (min), Max (max)	Delta

One Value aggregation applies to every link of the view.

Nodes

Under Nodes, Add node adds a node labeled Node. Each node has a Node label (label) and an id that is assigned automatically (node, node2, …) and cannot be edited. Move up and Move down reorder them; node order is the drawing order. An empty list is allowed.

Links

Under Links, Add link adds a band. Add link is available once there are at least two nodes, the report has a numeric parameter, and some From, To, and Parameter combination is still free: not used by another link and not closing a loop.

Setting	Field	Values	Default
From	fromNodeId	A node
To	toNodeId	A node other than From and other than any node that already leads to From
Parameter	parameterId	A numeric report parameter
Decimal places	decimalPlaces	0–12	2

Each combination of From, To, and Parameter can appear once. Links cannot form a loop: the To list leaves out nodes that would close one. If a loop was written through the API or hmi push, the editor shows an error on the card and the report cannot be saved until a link is removed, and the report page shows a message instead of the diagram.

Removing a report parameter used here asks for confirmation and removes the links that use it. The nodes and the view stay, even without links.

On the report page

Values

Each band shows its parameter aggregated over the window, up to the last completed minute before the window end or the current time, whichever is earlier. Delta is the latest value in the window minus the latest value in the preceding period of the same length; when that period has no readings, the first value in the window is used instead. A missing parameter or one with no value counts as 0.

When the window ends at the current time, values refresh as each minute completes.

Drawing

Bands and nodes are proportional to the values, scaled so the busiest column fills the height; a node is as tall as its flows. A value of 0 or less draws as a thin line. Bands use the parameter’s Default color at half opacity; zone colors are not used. Nodes are solid bars.

With Show titles on, each band shows its value with its Decimal places and units; a label that does not fit is left out, and the tooltip still has the value. Node labels sit to the right of the node, and in the last column to the left.

With Show tooltips on, hovering a band shows the parameter label and value; hovering a node shows its label and throughput (the larger of inflow and outflow, in the links’ units when they agree).

Size

The diagram fills the height of its layout cell, so it matches taller neighbors in the same row. It is never shorter than Height, or than 280 px (160 px with Compact) when Height is empty, and it grows with the number of nodes. Wide diagrams scroll sideways.

Filtering by click

With Interactive on, clicking a node or band shows only the parameters of the links that touch it, in every view of the report. Clicking the background, or Show all when only some parameters are visible, shows all report parameters again. Clicking works even when the report has Lock time range on.

Hidden parameters remove their bands, and nodes without visible bands are left out. When there is nothing to show, the view says No parameters to show.; if links exist but are all hidden, Show all stays available.

Related

• Report settings
• Report page
• Chart, table, time bars, histogram, calendar, hourly matrix, state duration
• Readings API: readings.aggregate (readings procedures)