Sankey
- PI Vision Widget -
Revision History
| Revision No. | Date | Author | Document ID | Description of changes |
|---|---|---|---|---|
| 9.3 | December 2025 | RS | EW_Sankey_v9.3_en.doc | The Widget correctly parses the numeric values shown on PI Vision |
| 9.2 | November 2025 | RS | EW_Sankey_v9.2_en.doc | - Bug fixing: Link between nodes shows properly. Scale factor calculated programmatically. Fixed widget resize. Tooltip shows UOM if present. Asset switch will not change the colors of the attributes. |
| 9.1 | October 2025 | RS | EW_Sankey_v9.1_en.doc | -Added “add to collection” functionality |
| 9.0 | June 2025 | RS | EW_Sankey_v9.0_en.doc | -Compatibility PIVision 2024 -Added Get support-Added rest provider -Graphic restyle |
| 8.0 | August 2023 | MM | EW_Sankey_v8.0_en.doc | Compatibility with PI Vision 2023 |
| 7.1 | September 2022 | MDC | EW_Sankey_v7.1_en.doc | French browser management |
| 7.0 | August 2022 | AM | EW_Sankey_v7.0_en.doc | Compatibility with PI Vision 2022 |
| 6.0 | October 2021 | MDC | EW_Sankey_v6.0_en.doc | Compatibility with PI Vision 2021 |
| 4.0 | October 2020 | BA | EW_Sankey_v4.0_en.doc | Compatibility with PI Vision 2020 |
| 1.4.1 | August 2020 | BA | EW_Sankey_v1.4.1_en.doc | Review |
| 1.4 | February 2020 | PC | EW_Sankey_v1.4.doc | Ability to save the position of the nodes; Ability to set the color of the flows; Number of decimals in configuration; |
| 1.3 | December 2019 | AF | EW_Sankey_v1.3.doc | Support for EWClasses and EWDictionary libraries; Expiry support |
| 1.2 | March 2019 | GI | EW_Sankey_v1.2.doc | Review |
| 1.2 | November 2018 | AF | EWSankey_v.1.2.docx | Data source modified |
| 1.1 | February 2018 | GT | EWSankey_v.1.1.docx | Adaptation of the doc according to some improvements |
| 1.0 | January 2018 | GT | EWSankery_v.1.0.docx | First review |
Document References
| Document | Description |
|---|---|
| PI Vision Installation and Administration Guide | PI Vision™ user manual from AVEVA |
Introduction
Sankey widget allows to represent aggregate and/or totalized data in an AF table though a particular flow diagram type where size of arrows is proportional to the amount of flow.
The PI Vision of AVEVA is available from 2017 and allows viewing real-time data from PI Data Archive and data organized in assets from the AVEVA Asset Framework (PI-AF). In order to achieve PI Vision displays, simply access https://webServer/PIVision (indicating the correct name of the webserver machine).
The most recent versions of most HTML5 compatible browsers are supported on computers, tablets and phones running Android and iOS.
In PI Vision the configuration of the elements is quite intuitive and is characterized by a simple drag-and-drop of the control into the display.
Definitions, Acronyms And Abbreviations
Acronyms and definitions that are used in the current manual are listed below.
| Term | Definition |
|---|
Operating Principles And Use
To insert the widget, select the corresponding icon and navigate to the asset to be displayed and drag all the attributes involved by the Sankey in the display area.
Figure 1 - PI Vision Menu
Then by selecting the contextual menu you can access the specific configuration of the widget.
Figure 2 - Contextual Menu
Functionality and use
The widget is quite intuitive and allows to visualize graphically flows and quantities related to them.
Information are contained into the attributes belonging to the dragged element and involves details concerning:
- Source#Destination, string attribute (the separator between these two fields is “#”)
- Enlivened quantity
The figure below shows an example of an AF database for the widget in question.
Figure 3 - AF Database Example
Figure 4 - Sankey Widget
It is possible to improve the diagram visibility by moving vertical coloured bars. Tooltips over arrows help the user understand and identify flows and quantities.
Customization and configuration
The widget configuration allows to change the appearance in terms of colours, text size and language visualization.
Language
The section Language allows users to choose the language with which the user visualizes labels and configuration parameters.
Figure 5 - Language selection
Configurations
It is possible to configure a set of Settings, as shown below. The table shows the descriptions for each parameter.
Figure 6 - Configurations
| Setting | Description |
|---|---|
| Node Padding | Increase/Decrease the vertical space between nodes |
| Node width | Increase/Decrease the thickness of nodes |
| Number of decimals | Useful for configuring the number of decimals visible in the tooltip |
| Save position | Necessary to memorize the position of the nodes after moving them |
| Use color attribute | It allows to choose whether to set the color of the nodes from the attribute |
| Color attribute | It’s the name of the sub-attribute used to define the color |
| REST Provider | Allows the user to select between default or custom protocol for api requests. |
Table 1 - Configurations description
Appearance Settings
In the Appearance settings section it is possible to change the value and color of:
- Title;
- Title color;
- Title size;
- Label size;
- Background color;
- Text color;
Figure 7 - Appearance settings
Colors selection
To configure the different colors simply select the color drop-down menu and choose the gradation on the first horizontal scrollbar, the possible point of the color palette and indicate with the second horizontal scrollbar the eventual transparency level. To confirm, select the button
.
Figure 8 - Choice of color
Contacts
Get Support button (read Get Support documentation)
Link to e-matica.com (click on the icon)
Link to widget online documentation (click on link)
Figure 9 - Contacts
Installation
Following are the installation requirements and procedure.
Requirements
In order to install the product, minimum requirements are listed in the table below:
| Software | Version | Note |
|---|---|---|
| PI Vision | 2024 (*) | Requirements are linked to the PI Vision correct functioning |
Table 2 - Installation prerequisites
(*)This widget is also compatible with PI Vision 2023, 2022, 2021, 2020 and 2019.
We suggest using Google Chrome for full compatibility with the widget.
Installation procedure
The installation procedure involves the copy of different folders and files in the predefined PI Vision path.
In particular it is necessary to copy the following filed in the folder ..\PIPC\PIVision\Scripts\app\editor\symbols\ext:
- sym-EWSankey.js
- sym-EWSankey-config.html
- sym-EWSankey-template.html
and in the folder ..\PIPC\PIVision\Public the following folders:
- Images that contains the control icon:
- EWSankey.png
- Libs with the libraries used:
- EWClasses.js
Then, open the web.config file inside the PIVision folder (..\PIPC\PIVision) and check that debug is set to "true" (Figure 12).
Save the file and restart the IIS.
Figure 12 - web.config
Notes And References
For more information about Vision PI refer to documentation on AVEVA © portal.
For information about the web service to refer to the specific documentation.