Show Tooltip
- PI Vision Widget -
Revision History
| Revision No. | Date | Author | Document ID | Description of changes |
|---|---|---|---|---|
| 9.0 | July 2025 | RS | EW_ShowTooltip_v9.0_en | -Compatibility PIVision 2024 -Added Get support-Added rest provider -Graphic restyle |
| 8.0 | August 2023 | FP | EW_ShowTooltip_v8.0_en | Compatibility PI Vision 2023 |
| 7.0 | June 2023 | MDC | EW_ShowTooltip_v7.0_en | First Version |
Document References
| Document | Description |
|---|---|
| PI Vision Installation and Administration Guide | PI Vision™ user manual from AVEVA |
Introduction
With the Show Tooltip widget the user is able to customize a tooltip with a totally user-configurable text.
The widget is a transparent zone where when you hover the mouse in it displays a configurable tooltip.
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 to 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 in a display it is necessary to select firstly the widget icon relative and the drag drag any attribute inside the display.
Figure 1 - Show Tooltip widget
After creating the widget, hovering over it shows a blank tooltip.
Figure 2 – Initialization Show Tooltip widget
In the widget configuration, the user can choose the text to display using, if necessary, also the html formatting (some examples below).
Figure 3 - Show Tooltip widget with html formatting
Figure 4 – Html formatting
Later by right clicking the widget the configuration panel will open.
Figure 5 - Context menu
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 6 - Language selection
Configurations
Figure 7 - Configurations
| Setting | Description |
|---|---|
| Tooltip text | The text the tooltip will show. |
| Position tooltip | The position in which the tooltip will appear. |
| Width tooltip | The width of the tooltip. |
| Tooltip border width | The width of the tooltip’s border. (0-10)px |
| Widget border width | The width of the back square’s border. (0-10)px |
| 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:
- Text size;
- Background color;
- Widget edge color;
- Text color;
- Tooltip edge color;
- Tooltip background color;
Figure 8 - 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 9 - 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 10 - 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-EWShowTooltip.js
- sym-EWShowTooltip-config.html
- sym-EWShowTooltip-template.html
and in the folder ..\PIPC\PIVision\Public the following folders:
- Images that contains the control icon:
- EWShowTooltip.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 11).
Save the file and restart the IIS.
Figure 11 - 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.