...
Optional. If specified, then a toolTip with the specified text is displayed for this component.
linkPropertiesToData
replaceTags
If specified, then the tags in the text Optional. Contains options to link properties of this component to actual data values. For example the height of the component can be changed depending on the data values of a specified variable.
useThresholdWarningLevelColors
Optional. If specified, then the data for the specified variable within the specified relative view period is used to determine threshold crossings. For crossed thresholds, warningLevels are activated. The color of the most severe activated warningLevel is used as the fill and/or stroke color for the component, as specified.
useThresholdWarningLevelSymbols
Optional. If specified, then the data for the specified variable within the specified relative view period is used to determine threshold crossings. For crossed thresholds, warningLevels are activated. The symbolId property of the most severe activated warningLevel is used to load a graphic from the <defs/> section of a SVG document. This is very similar to how the ThresholdWarningLevelColors works, but can be applied only to <use/> elements in an SVG file as these elements support embedding an elemen from the <defs/> section of the SVG document using a xlink:href attribute.
replaceTags
If specified, then the tags in the text of this component are replaced using data from the specified variable. See #tags.
Left Single Click Action and Left Double Click Action Configuration Options
...
are replaced using data from the specified variable. See #tags.
Left Single Click Action and Left Double Click Action Configuration Options
Click action configuration elements
switchToScadaPanel
Within this schematic status display the view will switch to the specified panel, specified by scadaPanelId. To specify a panel in a different scadaDisplay, also specify the scadaDisplayInstanceDescriptor.
scadaPanelId
The id of the scadaPanel to switch to. The scadaPanel to switch to must be present in this config file.
openDisplay
Open another Delft-FEWS display.
spatialDisplay
Opens the Spatial Display with specified title and gridPlotId. The slider in the Spatial Display is set to the slider time that was active in the Schematic Status Display.
timeSeriesDisplay
Open the timeSeriesDisplay using the specified options. The period that is shown in the display is the smallest period that completely includes the relative view periods of all shown variables. The option to directly open a display from the DisplayGroups is available from version 2012.01.
timeSeriesEditor
Open the timeSeriesEditor using the specified options. The data of the specified variables can be edited in the display. The period that is shown in the display is the smallest period that completely includes the relative view periods of all shown variables.
taskRunDialog
Opens the TaskRunDialog from the DisplayConfigurations with the specified config filename.
thresholdEventsDisplay
Opens the system wide threshold events table viewer with the specified title and icon.
(note, if the threshold events table is defined as explorer task in explorer.xml config, please specify the same title and icon here for consistent behaviour)
title
Title of the display window.
variable
One or more variables to define the data that is shown in the display.
showGraph
Optional. If true then a graph is shown in the opened display. If false, then the graph is not shown.
showTable
Optional. If true then a table is shown in the opened display. If false, then the table is not shown.
runWorkflow
Run a predefined workflow.
- workflowId (required): The workflow descriptor id of the workflow to run. This id should refer to a workflow that is defined in the WorkflowDescriptors configuration file. The current system time is used as the time zero (T0) for the workflow run.
- localrun (optional, default=false, available since 2022.0): if set to true, the workflow will be run locally instead on the server. The result of the local run will only be saved on the server if autoSaveToServerAfterLocalRun is set to true.
- autoSaveToServerAfterLocalRun (optional, default=false, available since 2022.01). It can only be set to true if localRun is also true. If autoSaveToServerAfterLocalRun is configured as true, the locally un workflow will be saved on the server.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<runWorkflow>
<workflowId>ID</workflowId>
<localRun>true</localRun>
<autoSaveToServerAfterLocalRun>true</autoSaveToServerAfterLocalRun>
</runWorkflow> |
OpenPdfFile
Opens in a PDF viewer the specified file at the specified bookmark. Note: not all PDF viewer support focus at the specifiek bookmark.
OpenURL
Opens the specified URL.
enumerateValues
Steps through the possible values of a variable, of which the parameter has to be linked to an enumeration in the parameters configuration file. Every time the display element is clicked the next value (code) of the enumeration is assigned to all time steps in the defined timeSeriesSet and overrulingRelativeViewPeriod for the specified variable.
enterValue
Pops up a dialiog where the user can input a new value for the specified variable, the new value is assigned to all time steps in the defined timeSeriesSet and overrulingRelativeViewPeriod for the specified variable. Optional min and max attributes can be provided to limit the range (minimum, maximum) of values that can be entered.
Link Properties To Data Configuration Options
Link properties to data configuration elements
There are several options available:
Link Height To Data Configuration Options
Link height to data configuration elements
Optional. If specified, then for this component the height attribute is linked to the data values for the specified variable. This option can only be used for svg objects of type "rect". The data limits refer to the range of the timeseries. The height limits refer to the height of the object within the svg file for the unit (e.g. pixels or mm) defined in the document properties. If the data value is less than dataLowerLimit, then the height is set to heightLowerLimit. If the data value is greater than dataUpperLimit, then the height is set to heightUpperLimit. If the data value is between dataLowerLimit and dataUpperLimit, then the height will be linearly interpolated between heightLowerLimit and heightUpperLimit. If no data is available, then this component is made invisible.
Note: it is required that dataUpperLimit is greater than dataLowerLimit. However it is possible to define heightUpperLimit less than heightLowerLimit to control the direction of the change of the height.
variable
The data for this variable is used to determine the height for this component.
dataLowerLimit
If the data value is less than or equal to dataLowerLimit, then the height will be equal to heightLowerLimit.
dataUpperLimit
If the data value is greater than or equal to dataUpperLimit, then the height will be equal to heightUpperLimit.
heightLowerLimit
The height that corresponds to the dataLowerLimit value.
heightUpperLimit
The height that corresponds to the dataUpperLimit value.
anchorPoint
The anchor point describes which part of the component should remain at the same position when the height is changed. Can be "bottom", "top" or "center".
Link Width To Data Configuration Options
Link width to data configuration elements
Since 2016.01. Optional. If specified, then for this component the width attribute is linked to the data values for the specified variable. This option can only be used for svg objects of type "rect". The data limits refer to the range of the timeseries. The width limits refer to the width of the object within the svg file for the unit (e.g. pixels or mm) defined in the document properties. If the data value is less than dataLowerLimit, then the width is set to widthLowerLimit. If the data value is greater than dataUpperLimit, then the width is set to widthUpperLimit
switchToScadaPanel
Within this schematic status display the view will switch to the specified panel, specified by scadaPanelId. To specify a panel in a different scadaDisplay, also specify the scadaDisplayInstanceDescriptor.
scadaPanelId
The id of the scadaPanel to switch to. The scadaPanel to switch to must be present in this config file.
openDisplay
Open another Delft-FEWS display.
spatialDisplay
Opens the Spatial Display with specified title and gridPlotId. The slider in the Spatial Display is set to the slider time that was active in the Schematic Status Display.
timeSeriesDisplay
Open the timeSeriesDisplay using the specified options. The period that is shown in the display is the smallest period that completely includes the relative view periods of all shown variables. The option to directly open a display from the DisplayGroups is available from version 2012.01.
timeSeriesEditor
Open the timeSeriesEditor using the specified options. The data of the specified variables can be edited in the display. The period that is shown in the display is the smallest period that completely includes the relative view periods of all shown variables.
taskRunDialog
Opens the TaskRunDialog from the DisplayConfigurations with the specified config filename.
thresholdEventsDisplay
Opens the system wide threshold events table viewer with the specified title and icon.
(note, if the threshold events table is defined as explorer task in explorer.xml config, please specify the same title and icon here for consistent behaviour)
title
Title of the display window.
variable
One or more variables to define the data that is shown in the display.
showGraph
Optional. If true then a graph is shown in the opened display. If false, then the graph is not shown.
showTable
Optional. If true then a table is shown in the opened display. If false, then the table is not shown.
runWorkflow
Run a predefined workflow.
- workflowId (required): The workflow descriptor id of the workflow to run. This id should refer to a workflow that is defined in the WorkflowDescriptors configuration file. The current system time is used as the time zero (T0) for the workflow run.
- localrun (optional, default=false, available since 2022.0): if set to true, the workflow will be run locally instead on the server. The result of the local run will only be saved on the server if autoSaveToServerAfterLocalRun is set to true.
- autoSaveToServerAfterLocalRun (optional, default=false, available since 2022.01). It can only be set to true if localRun is also true. If autoSaveToServerAfterLocalRun is configured as true, the locally un workflow will be saved on the server.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<runWorkflow>
<workflowId>ID</workflowId>
<localRun>true</localRun>
<autoSaveToServerAfterLocalRun>true</autoSaveToServerAfterLocalRun>
</runWorkflow> |
OpenPdfFile
Opens in a PDF viewer the specified file at the specified bookmark. Note: not all PDF viewer support focus at the specifiek bookmark.
OpenURL
Opens the specified URL.
enumerateValues
Steps through the possible values of a variable, of which the parameter has to be linked to an enumeration in the parameters configuration file. Every time the display element is clicked the next value (code) of the enumeration is assigned to all time steps in the defined timeSeriesSet and overrulingRelativeViewPeriod for the specified variable.
enterValue
Pops up a dialiog where the user can input a new value for the specified variable, the new value is assigned to all time steps in the defined timeSeriesSet and overrulingRelativeViewPeriod for the specified variable. Optional min and max attributes can be provided to limit the range (minimum, maximum) of values that can be entered.
Link Properties To Data Configuration Options
Link properties to data configuration elements
There are several options available:
Link Height To Data Configuration Options
Link height to data configuration elements
Optional. If specified, then for this component the height attribute is linked to the data values for the specified variable. This option can only be used for svg objects of type "rect". The data limits refer to the range of the timeseries. The height limits refer to the height of the object within the svg file for the unit (e.g. pixels or mm) defined in the document properties. If the data value is less than dataLowerLimit, then the height is set to heightLowerLimit. If the data value is greater than dataUpperLimit, then the height is set to heightUpperLimit. If the data value is between dataLowerLimit and dataUpperLimit, then the height will width will be linearly interpolated between heightLowerLimit widthLowerLimit and heightUpperLimit widthUpperLimit. If no data is available, then this component is made invisible.
Note: it is required that dataUpperLimit is greater than dataLowerLimit. However it is possible to define heightUpperLimit widthUpperLimit less than heightLowerLimit widthLowerLimit to control the direction of the change of the height width.
variable
The data for this variable is used to determine the height for this component.
dataLowerLimit
If the data value is less than or equal to dataLowerLimit, then the height will be equal to heightLowerLimit.
dataUpperLimit
If the data value is greater than or equal to dataUpperLimit, then the height will be equal to heightUpperLimit.
...
widthLowerLimit
The height that width that corresponds to the dataLowerLimit value.
...
widthUpperLimit
The height that width that corresponds to the dataUpperLimit value.
anchorPoint
The anchor point describes which part of the component should remain at the same position when the height is changed. Can be "bottomleft", "topright" or "center".
Link
...
Rotation To Data Configuration Options
Link width rotation to data configuration elements
Since 2016.01. Optional. If specified, then for this component the width attribute rotation is linked to the data values for the specified variable. The rotation that is derived from the data values is always relative to the rotation angle that is specified for this component in the svg file. This option can only be used for svg objects of type "path", "rect". The data limits refer to the range of the timeseries. The width limits refer to the width of the object within the svg file for the unit (e.g. pixels or mm) defined in the document properties. , "circle", "ellipse", "line", "polyline", "polygon" or "text". If the data value is less than dataLowerLimit, then the width is rotation is set to widthLowerLimitrotationLowerLimit. If the data value is greater than dataUpperLimit, then the width is rotation is set to widthUpperLimitrotationUpperLimit. If the data value is between dataLowerLimit and dataUpperLimit, then the width will rotation will be linearly interpolated between widthLowerLimit rotationLowerLimit and widthUpperLimitrotationUpperLimit. If no data is available, then this component is made invisible. If the data value is flagged as "varying direction" (e.g. varying wind direction), then the rotation will increase linearly in time (animation). In this case the rotation will increase from rotationLowerLimit to rotationUpperLimit and then start from rotationLowerLimit again.
Note: it is required that dataUpperLimit is greater than dataLowerLimit. However it is possible to define rotationUpperLimit less than rotationLowerLimit Note: it is required that dataUpperLimit is greater than dataLowerLimit. However it is possible to define widthUpperLimit less than widthLowerLimit to control the direction of the change of the widthrotation. If rotationUpperLimit is greater than rotationLowerLimit, then increasing data values result in clockwise rotation.
variable
The data for this variable is used to determine the height rotation for this component.
dataLowerLimit
If the data value is less than or equal to dataLowerLimit, then the height rotation will be equal to heightLowerLimitrotationLowerLimit.
dataUpperLimit
If the data value is greater than or equal to dataUpperLimit, then the height rotation will be equal to heightUpperLimitrotationUpperLimit.
...
rotationLowerLimit
The width that rotation (in degrees) that corresponds to the dataLowerLimit value.
widthUpperLimit
This rotation is always relative to the rotation angle that is specified for this component in the svg file.
rotationUpperLimit
The rotation (in degrees) that The width that corresponds to the dataUpperLimit value. This rotation is always relative to the rotation angle that is specified for this component in the svg file.
...
anchorPointX
The anchor point describes which part of the component should remain at the same position when the height is changed. Can be "left", "right" or "center".
Link Rotation To Data Configuration Options
Link rotation to data configuration elements
Optional. If specified, then for this component the rotation is linked to the data values for the specified variable. The rotation that is derived from the data values is always relative to the rotation angle that is specified for this component in the svg file. This option can only be used for svg objects of type "path", "rect", "circle", "ellipse", "line", "polyline", "polygon" or "text". If the data value is less than dataLowerLimit, then the rotation is set to rotationLowerLimit. If the data value is greater than dataUpperLimit, then the rotation is set to rotationUpperLimit. If the data value is between dataLowerLimit and dataUpperLimit, then the rotation will be linearly interpolated between rotationLowerLimit and rotationUpperLimit. If no data is available, then this component is made invisible. If the data value is flagged as "varying direction" (e.g. varying wind direction), then the rotation will increase linearly in time (animation). In this case the rotation will increase from rotationLowerLimit to rotationUpperLimit and then start from rotationLowerLimit again.
Note: it is required that dataUpperLimit is greater than dataLowerLimit. However it is possible to define rotationUpperLimit less than rotationLowerLimit to control the direction of the rotation. If rotationUpperLimit is greater than rotationLowerLimit, then increasing data values result in clockwise rotation.
variable
The data for this variable is used to determine the rotation for this component.
dataLowerLimit
If the data value is less than or equal to dataLowerLimit, then the rotation will be equal to rotationLowerLimit.
dataUpperLimit
If the data value is greater than or equal to dataUpperLimit, then the rotation will be equal to rotationUpperLimit.
rotationLowerLimit
The rotation (in degrees) that corresponds to the dataLowerLimit value. This rotation is always relative to the rotation angle that is specified for this component in the svg file.
rotationUpperLimit
The rotation (in degrees) that corresponds to the dataUpperLimit value. This rotation is always relative to the rotation angle that is specified for this component in the svg file.
anchorPointX
The x coordinate of the anchor point. The rotation will be around the anchor point. This x coordinate has to be specified in the user space coordinate system of the svg object for this component in the svg file. The user space coordinate system is determined by all transforms that are specified in the parent svg objects of the svg object for this component. All transforms that are specified in the svg object itself are not part of the user space coordinate system and thus should be taken into account in the coordinates that are specified here. E.g. to rotate a "rect" svg object with attributes width="200" height="200" x="500" y="300" transform="translate(50 0)" around its center, use anchorPoint coordinates (x, y) = (650, 400). See also Determining the rotation anchor point for an SVG object in user space coordinates.
anchorPointY
The y coordinate of the anchor point. The rotation will be around the anchor point. This y coordinate has to be specified in the user space coordinate system of the svg object for this component in the svg file. The user space coordinate system is determined by all transforms that are specified in the parent svg objects of the svg object for this component. All transforms that are specified in the svg object itself are not part of the user space coordinate system and thus should be taken into account in the coordinates that are specified here. E.g. to rotate a "rect" svg object with attributes width="200" height="200" x="500" y="300" transform="translate(50 0)" around its center, use anchorPoint coordinates (x, y) = (650, 400). See also Determining the rotation anchor point for an SVG object in user space coordinates.
Use Threshold Warning Level Colors Configuration Options
Use threshold warning level colors configuration elements
variable
The data for this variable is used to determine threshold crossings. For crossed thresholds, warningLevels are activated. The color of the most severe activated warningLevel is used as the fill and/or stroke color for the component, as specified below.
thresholdGroupId
Optional. If specified, then only thresholds in the specified thresholdGroup are used in the determination of threshold crossings and warningLevels for the specified variable. If not specified, then thresholds in all thresholdGroups are used.
thresholdReference
Specify which data is used for determining threshold crossings. Either choose the first or last reliable or doubtful value within the relative view period, or choose all reliable or doubtful values within the relative view period. Can be "first_value", "last_value" or "relative_view_period".
colorType
Specify which color type (fill and/or stroke) should be changed to use warningLevel colors. Color types that are not specified here are not changed. Can be "fill", "stroke" or "fill_and_stroke".
...
x coordinate of the anchor point. The rotation will be around the anchor point. This x coordinate has to be specified in the user space coordinate system of the svg object for this component in the svg file. The user space coordinate system is determined by all transforms that are specified in the parent svg objects of the svg object for this component. All transforms that are specified in the svg object itself are not part of the user space coordinate system and thus should be taken into account in the coordinates that are specified here. E.g. to rotate a "rect" svg object with attributes width="200" height="200" x="500" y="300" transform="translate(50 0)" around its center, use anchorPoint coordinates (x, y) = (650, 400). See also Determining the rotation anchor point for an SVG object in user space coordinates.
anchorPointY
The y coordinate of the anchor point. The rotation will be around the anchor point. This y coordinate has to be specified in the user space coordinate system of the svg object for this component in the svg file. The user space coordinate system is determined by all transforms that are specified in the parent svg objects of the svg object for this component. All transforms that are specified in the svg object itself are not part of the user space coordinate system and thus should be taken into account in the coordinates that are specified here. E.g. to rotate a "rect" svg object with attributes width="200" height="200" x="500" y="300" transform="translate(50 0)" around its center, use anchorPoint coordinates (x, y) = (650, 400). See also Determining the rotation anchor point for an SVG object in user space coordinates.
Use Threshold Warning Level Colors Configuration Options (useThresholdWarningLevelColors)
Optional. If specified, then the data for the specified variable within the specified relative view period is used to determine threshold crossings. For crossed thresholds, warningLevels are activated. The color of the most severe activated warningLevel is used as the fill and/or stroke color for the component, as specified.
Use threshold warning level colors configuration elements
variable
The data for this variable is used to determine threshold crossings. For crossed thresholds, warningLevels are activated. The color of the most severe activated warningLevel is used as the fill and/or stroke color for the component, as specified below.
thresholdGroupId
Optional. If specified, then only thresholds in the specified thresholdGroup are used in the determination of threshold crossings and warningLevels for the specified variable. If not specified, then thresholds in all thresholdGroups are used.
thresholdReference
Specify which data is used for determining threshold crossings. Either choose the first or last reliable or doubtful value within the relative view period, or choose all reliable or doubtful values within the relative view period. Can be "first_value", "last_value" or "relative_view_period".
colorType
Specify which color type (fill and/or stroke) should be changed to use warningLevel colors. Color types that are not specified here are not changed. Can be "fill", "stroke" or "fill_and_stroke".
Use Threshold Warning Level Symbols Configuration Options (useThresholdWarningLevelSymbols)
Optional. If specified, then the data for the specified variable within the specified relative view period is used to determine threshold crossings. For crossed thresholds, warningLevels are activated. The symbolId property of the most severe activated warningLevel is used to load a graphic from the <defs/> section of a SVG document. This is very similar to how the ThresholdWarningLevelColors works, but can be applied only to <use/> elements in an SVG file as these elements support embedding an elemen from the <defs/> section of the SVG document using a xlink:href attribute.
| Expand |
|---|
...
the same time. A tested approach is:
|
Tooltip Configuration Options
...