Widgets Text
Form Fields
-
X - The starting X coordinate for the widget.
-
Y - The starting Y coordinate for the widget.
-
Rotation - The rotation of the widget.
-
Text - The text that will be displayed. The following strings can be used in this field, and they will be replaced will live data from the database. The values will be determined using the event filter settings that are configured below.
-
$AvgSeverity - The average severity of the selected events.
-
$MaxSeverity - The maximum severity of the selected events.
-
$Count - The number of events that are returned by the event filter.
-
$SumOfCount - The sum of the "Count" field of the events that are returned by the event filter.
-
-
Fill Type - The coloring type of the text.
-
Fill Color - If "Fill Type" is set to "Color", this will be the color of the text.
-
Fill Gradient - If "Fill Type" is set to "Gradient", this will be the gradient color of the text.
-
Font Name - The font used when displaying the text.
-
Font Size - The size of the text.
-
Text Alignment - The alignment of the text within the widget space.
-
Bold/Italic/Underline - Check boxes for the bold, italic and underline formatting options.
-
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.
-
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/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 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> | X point of widget relative to the diagram canvas |
| <Y> | Y point of widget relative to the diagram canvas |
| <Rotate> | Widget rotation in degrees |
| <Text> | Display text |
| <FillType> | Fill type: 'Gradient', 'Color' |
| <FillGradient> | Fill gradient color in hex notation. Only present for 'Gradient' fill type |
| <FillColor> | Fill color in hex notation. Only present for 'Color' fill type |
| <FontName> | Font family name |
| <FontSize> | Font size |
| <TextAlignment> | Text anchor |
| <FontBold> | Enable bolded text |
| <FontItalic> | Enable italicized text |
| <FontUnderline> | Enable underlined text |
| <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' |
| <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 |