Widgets Ellipse
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.
-
Stroke Width - The width of the border around the widget. The border will only be visible if a gradient color theme is used.
-
Color Theme - Whether the coloring of the widget is solid or will use a gradient.
-
Device Name - 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.
-
Time Range - The time range to retrieve and display the metric data.
-
Threshold Type - Used to determine which threshold type comparison should be done. Options include:
-
Availability which checks to see if the metric data is available in the selected period.
-
Performance Utilization which does the following calculation, which is then used in the threshold comparison: (Metric Data/Metric Maximum) * 100.
-
Performance Value which selects the raw metric value and is used in the threshold comparison.
-
-
Warning Threshold - The threshold settings used to check if the metric is in violation.
-
If set to None, no thresholding will be done for the widget.
-
If set to [Manual], a customized threshold can be set to change the widget color and play a sound when the metric is in violation.
-
If set to a pre-configured threshold, the widget can change color and play a sound when the metric is in violation.
-
-
Warning Threshold Operator - If Warning Threshold is set to "[Manual]", the operator that will be used to check for metric violation. Used in conjunction with Warning Threshold Value field.
-
Warning Threshold Value - If Warning Threshold is set to "[Manual]", the value used to check for metric violation. Used in conjunction with Warning Threshold Operator field.
-
Warning Audible Alert - If a metric is in violation, the selected sound will be played.
-
Critical Threshold - The threshold settings used to check if the metric is in violation.
-
If set to None, no thresholding will be done for the widget.
-
If set to [Manual], a customized threshold can be set to change the widget color and play a sound when the metric is in violation.
-
If set to a pre-configured threshold, the widget can change color and play a sound when the metric is in violation.
-
-
Critical Threshold Operator - If Critical Threshold is set to "[Manual]", the operator that will be used to check for metric violation. Used in conjunction with Critical Threshold Value field.
-
Critical Threshold Value - If Critical Threshold is set to "[Manual]", the value used to check for metric violation. Used in conjunction with Critical Threshold Operator field.
-
Critical Audible Alert - If a metric is in violation, the selected sound will be played.
-
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/deviceswould 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 |
| <LinkType> | Drill-down link type: 'Diagram', 'DiagramBasic', 'DiagramDynamicDevice', 'ManualInternal', 'ManualExternal' |
| <LinkTarget> | Drill-down link target: 'SameTab', 'NewTab', 'NewWindow' |
| <LinkDiagramID> | Optional Drill-down diagram to open. Only applicable for 'Diagram', 'DiagramBasic', and 'DiagramDynamicDevice' link types |
| <LinkDeviceID> | Optional Drill-down dynamic device diagram to open. Only applicable for 'DiagramDynamicDevice' link type |
| <LinkURL> | Optional Drill-down URL to open. Only applicable for 'ManualInternal' and 'ManualExternal' link types |
| <X> | X point of widget relative to the diagram canvas |
| <Y> | Y point of widget relative to the diagram canvas |
| <Width> | Widgth of widget in pixels |
| <Height> | Height of widget in pixes |
| <ScaleX> | Scaled X |
| <ScaleY> | Scaled Y |
| <Rotate> | Widget rotation in degrees |
| <StrokeWidth> | Stroke width |
| <MenuID> | Associated context menu ID. 0 if no menu |
| <StrokeType> | Stroke type: 'Empty', Gradient', 'Color' |
| <StrokeGradient> | Optional stroke gradient clor in hex notation. Only present for 'Gradient' stroke type |
| <StrokeColor> | Optional stroke color in hex notation. Only present for 'Color' stroke type |
| <FillType> | Fill type: 'Empty', Gradient', 'Color' |
| <FillGradient> | Optional fill gradient color in hex notation. Only present for 'Gradient' fill type |
| <FillColor> | Optional fill color in hex notation. Only present for 'Color' fill type |
| <Theme> | Color theme |
| <DeviceID> | Device ID |
| <MetricTypeID> | Metric Type ID |
| <MetricID> | Metric ID |
| <Period> | Metric Period: Daily, Weekly, Monthly, Yearly |
| <ThresholdTypeID> | Threshold Type ID |
| <WarningThresholdID> | Warning Threshold ID. 0 if manual |
| <WarningManualThresholdOperator> | Optional Warning manual threshold operator |
| <WarningManualThresholdValue> | Optional Warning manual threshold value |
| <CriticalThresholdID> | Critical Threshold ID. 0 if manual |
| <CriticalManualThresholdOperator> | Optional Critical manual threshold operator |
| <CriticalManualThresholdValue> | Optional Critical manual threshold operator |