Widgets Line
Form Fields
-
X1 - The starting X coordinate for the widget.
-
Y1 - The starting Y coordinate for the widget.
-
X2 - The ending X coordinate for the widget.
-
Y2 - The ending Y coordinate for the widget.
-
Stroke Width - The width of the widget.
-
Color Theme - Whether the coloring of the widget is solid or will use a gradient.
-
Start Point Type - The starting point type of the widget.
-
Start Point Size - If an "Start Point Type" is selected, this will be the size of the start point type.
-
End Point Type - The ending point type of the widget.
-
End Point Size - If an "End Point Type" is selected, this will be the size of the end point type.
-
Filter Type - Various filter types can be selected so the widget shows only relevant information. Options include using a pre-defined event filter, displaying events for a particular device, displaying events for devices using a particular Meta Tag and Meta Data, or a transient event list.
-
Filter Group - If Filter Type is set to "Event Filter", the Filter Groups can be traversed so restriction filter(s) are applied to the search query.
-
Filter Name - If Filter Type is set to "Event Filter", this will be the event filter used to select events to determine the widget coloring.
-
Device Name - If Filter Type is set to "Device", this will be the device used to select events to determine the widget coloring.
-
Meta Type - If Filter Type is set to "Meta Tag", devices with the selected Meta Type and Meta Tag will be used to select events to determine the widget coloring.
-
Meta Tag - If Filter Type is set to "Meta Tag", devices with the selected Meta Type and Meta Tag will be used to select events to determine the widget coloring.
-
Where - If Filter Type is set to "Transient Event List", this should contain a valid SQL "WHERE" clause that will be run to select the events to determine the widget coloring.
-
Display - If the user clicks on the widget, the selected display will be used to show the specific event fields in the event list.
-
Audible Alert - If the widget filter evaluates to true, the selected audio file will be played through the browser.
-
Link Type - The various actions that can occur when the widget is clicked on. Options include doing nothing, going back one page, linking to an event list, linking to internal or external web sites, 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 an event list, web sites or another Diagram, the link can be opened in the current Unified Assurance 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> | Starting X point of widget relative to the diagram canvas |
<Y> | Starting Y point of widget relative to the diagram canvas |
<X2> | Ending X point of widget relative to the diagram canvas |
<Y2> | Ending Y point of widget relative to the diagram canvas |
<ScaleX> | Scaled X |
<ScaleY> | Scaled Y |
<StrokeWidth> | Stroke width |
<Theme> | Color theme |
<StartPointType> | Start point type: 'Triangle', Arrow', 'Circle', or 'None' |
<StartPointSize> | Start point size: 'Small', 'Medium', 'Large' |
<EndPointType> | End point type: 'Triangle', Arrow', 'Circle', or 'None' |
<EndPointSize> | Start point size: 'Small', 'Medium', 'Large' |
<FilterType> | Filter type: 'FilterID', 'DeviceID', 'MetaTag', or 'TEL' (Transient Event List) |
<FilterGroupID> | Filter Group ID. Only available for 'FilterID' filter type |
<FilterID> | Filter ID. Only available for 'FilterID' filter type |
<FilterDeviceID> | Device ID. Only available for 'DeviceID' filter type |
<FilterMetaType> | Meta Type. Only available for 'MetaTag' filter type |
<FilterMetaTag> | Meta Tag. Only available for 'MetaTag' filter type |
<FilterTEL> | Custom where clause. Only available for 'TEL' filter type |
<DisplayID> | Event Display ID |
<LinkType> | Drill-down link type: 'Diagram', 'DiagramBasic', 'DiagramDynamicDevice', 'ManualInternal', 'ManualExternal' |
<LinkTarget> | Drill-down link target: 'SameTab', 'NewTab', 'NewWindow' |
<LinkURL> | Drill-down URL to open. Only applicable for 'ManualInternal' and 'ManualExternal' link types |
<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 |
<MenuID> | Associated context menu ID. 0 if no menu |