Widgets Pie
Form Fields
-
X - The starting X coordinate for the widget.
-
Y - The starting Y coordinate for the widget.
-
Width - The overall width of the widget.
-
Height - The overall height of the widget.
-
Rotation - The rotation of the widget.
-
Color Theme - Whether the coloring of the widget is solid or will use a gradient.
-
Device - The device that has the metric to be displayed.
-
Metric Type - After selecting a device, a list of available metric types will be displayed.
-
Metric Instance - After selecting a device and metric type, a list of available metric instances will be displayed.
-
Data Type - The type of data that the widget will display.
-
Last Availability will show the last availability value for the metric.
-
Average Availability will show the average availability for the metric in the time range selected.
-
Minimum will show the minimum value for the metric in the time range selected.
-
Maximum will show the maximum value for the metric in the time range selected.
-
Summation will show the sum of all values for the metric in the time range selected.
-
Last will show the last value polled for the metric in the time range selected.
-
Average will show the average of all values for the metric in the time range selected.
-
-
Time Range - The time range to retrieve and display the metric data.
-
Link Type - The various actions that can occur when the widget is clicked on. Options include doing nothing, going back one page, linking to internal or external web sites, linking to a metric graph, linking to the metric details, or linking to another diagram.
-
Manual (internal) - the Link URL should be a link to any OCUA UI page (this would use a virtual path, e.g.
/#device/devices
would open the Configuration -> Device Catalog -> Devices page). -
Manual (external) - the Link URL is a valid physical path on the presentation server (e.g. /tools/myScript.php), or to an external site (e.g. https://www.example.com).
-
-
Link Target - If Link Type is set to link to web sites, the metric graph, the metric details, or another diagram, the new page can be opened in the current tab, a new browser tab, or a new browser window.
-
Link URL - If Link Type is set to link to web sites, this will be the URL of the site.
-
Diagram - If Link Type is set to link to a diagram, this will be the diagram to be opened.
-
Device - If Link Type is set to link to a Dynamic Device diagram, this will be the device that will be used within the diagram.
-
Context Menu - This will be the diagram menu available when context-clicking on the widget.
Widget Properties
Token | Description |
---|---|
<WidgetID> | SVG Widget identifier |
<X> | X point of widget relative to the diagram canvas |
<Y> | Y point of widget relative to the diagram canvas |
<Width> | Width of widget in pixels |
<Height> | Height of widget in pixels |
<ScaleX> | Scaled X |
<ScaleY> | Scaled Y |
<Rotate> | Widget rotation in degrees |
<Theme> | Color theme |
<DeviceID> | Device ID |
<MetricTypeID> | Metric Type ID |
<MetricID> | Metric ID |
<Period> | Metric Period: Daily, Weekly, Monthly, Yearly |
<LinkType> | Drill-down link type: 'Diagram', 'DiagramBasic', 'DiagramDynamicDevice', 'ManualInternal', 'ManualExternal' |
<LinkTarget> | Drill-down link target: 'SameTab', 'NewTab', 'NewWindow' |
<LinkDiagramID> | Drill-down diagram to open. Only applicable for 'Diagram', 'DiagramBasic', and 'DiagramDynamicDevice' link types |
<LinkDeviceID> | Drill-down dynamic device diagram to open. Only applicable for 'DiagramDynamicDevice' link type |
<LinkURL> | Drill-down URL to open. Only applicable for 'ManualInternal' and 'ManualExternal' link types |
<MenuID> | Associated context menu ID. 0 if no menu |