What | buttonSettings element in TimeSeriesDisplayConfig.xml |
---|---|
Config group | SystemConfigFiles |
Required | no |
Description | Configuration element for button (and menu-item) visibility |
schema location | http://fews.wldelft.nl/schemas/version1.0/timeSeriesDisplay.xsd |
Contents
Overview
Most buttons and menu-items of drop-down menu buttons in the TimeSeries Dialog can individually be set to be shown or hidden with use of the buttonsSettings element in the TimeSeriesDisplayConfig.xml.
The buttonSettings element contains a sub-element for each of the buttons / menu items that can be hidden. To show or hide a button, the sub-element must be given a "visible" attribute, which can be set to true or false. An example configuration is shown below. Some of the sub-elements are mandatory. For these elements if you do not wish to change the default visibility of the button, simply leave the element empty.
Some buttons and menu-times are automatically hidden by FEWS when they are not relevant. For example, the menu item that controls whether the table shows threshold crossings (showThresholdCrossings) is only visible if at least one threshold value set is configured. This may result in buttons or menu-items remaining invisible, even though they are configured as visible="true" in the buttonSettings.
<buttonSettings> ... <moveBackHalfViewPeriod visible="false"/> <moveForwardHalfViewPeriod visible="false"/> <moveForwardOneViewPeriod/> <showAllData/> <switchReferenceLevel/> <setViewPeriod/> <copyTimeSeries visible="false"/> <pasteTimeSeries visible="false"/> ... </buttonSettings>
Configuration Aid: All Available ButtonSettings Elements
The code block below contains all of the currently available button settings elements, in the correct order. It can be copied and pasted into a TimeSeriesDisplayConfig.xml, after which you can find the element you wish to show / hide and add the visible attribute to those elements. Including the emtpy elements (without the visible attribute) will have no effect.
<buttonSettings> <showDisplayGroups/> <showTable/> <showValidationColumn/> <showValidationStepsColumn/> <showUsersColumn/> <showCommentsColumn/> <showUnitsColumn/> <showLocationNamesInTableHeader/> <showLocationIdsInTableHeader/> <showModuleInstanceInTableHeader/> <showForecastTimesInTableHeader/> <showColumnStatistics/> <showThresholdCrossings/> <twentyFourHourOptions/> <groupTableByTimeSeries/> <reverseTimeSeriesOrder/> <showTwentyFourHour/> <showChart/> <toggleGraphSplitting/> <toggleGraphEqualScale/> <scaleToShowUnreliableData/> <showDataLabels/> <switchFilterAndShortcuts/> <hideUnreliableData/> <legendDisplayOptions/> <hideFooter/> <thresholdDisplayOptions/> <useColorMap/> <toggleValidationInChart/> <toggleUsersInChart/> <toggleCommentsInChart/> <toggleLongitudinalProfileMarkers/> <showStatistics/> <showLookupTable/> <rotateChartAndTable/> <zoomIn/> <zoomOut/> <zoomToDefault/> <selectPreviousZoomLevel/> <selectNextZoomLevel/> <moveBackOneViewPeriod/> <moveBackHalfViewPeriod/> <moveForwardHalfViewPeriod/> <moveForwardOneViewPeriod/> <showAllData/> <switchReferenceLevel/> <setViewPeriod/> <copyTimeSeries/> <pasteTimeSeries/> <lockSelection/> <runWorkflow/> <undoTimeSeriesChanges/> <saveTimeSeriesChanges/> <setTimeSeriesEditableByClicking/> <useGraphicalEditorMovePointMode/> <useSetToMissingBetweenSelectedPointsMode/> <useInterpolateBetweenSelectedPointsMode/> <useGraphicalEditorQuadraticInterpolationMode/> <useGraphicalEditorVerticalMoveMode/> <useNoGraphicalEditMode/> <selectPoints/> <deselectPoints/> <selectOrDeselectPoint/> <openManualEditor/> <moveHighLightedTimeStepToLeft/> <moveHighLightedTimeStepToRight/> <moveTimeCursorToLeft/> <moveTimeCursorToRight/> <increaseValue/> <decreaseValue/> <undoEdit/> <cancelEdit/> <showThresholdWarningLevels/> <printChart/> <saveChartAsPicture/> <showLongTermScroller/> <searchAndSelectForecasts/> <setTimeSeriesVisibility/> <setTimeSeriesResampling/> <hideEmptyTimeSeries/> <showValidationRules/> <showTimeSeriesLister/> </buttonSettings>
List of Configurable Buttons
This section lists each of the available button visiblity settings, in the order in which they appear in the xml, explaining which button or menu-item is controlled by that setting. The labels mentioned for the menu-times are the labels in the English version, in localized versions these labels may differ.
showDisplayGroups
Button with icon:
Using this button shows the display group panel (aka shortcuts).
showTable
Drop-down button with icon:
Using this button shows the table view panel.
Clicking the arrow symbol next to the button icon will open a drop-down menu:
showValidationColumn
Menu-item in the showTable drop-down menu with icon and label "Validation".
Using this button shows the validation column in the time series table.
showValidationStepsColumn
Menu-item in the showTable drop-down menu with icon and label "Validation Steps".
Using this button shows the validation steps column in the time series table.
showUsersColumn
Menu-item in the showTable drop-down menu with icon and label "Users".
Using this button shows the users column in the time series table.
showCommentsColumn
Menu-item in the showTable drop-down menu with icon and label "Comments".
Using this button shows the comments column in the time series table.
showUnitsColumn
Menu-item in the showTable drop-down menu with label "Units".
Using this button shows the units column in the time series table.
showLocationNamesInTableHeader
Menu-item in the showTable drop-down menu with label "Location Names".
Using this button displays the location name(s) of each times series in the column header.
showLocationIdsInTableHeader
Menu-item in the showTable drop-down menu with label "Location Ids".
Using this button displays the location id(s) of each times series in the column header.
showModuleInstanceInTableHeader
Menu-item in the showTable drop-down menu with label "Modules".
Using this button displays the module instance of each times series in the column header.
showForecastTimesInTableHeader
Menu-item in the showTable drop-down menu with label "Forecast Times".
Using this button displays the forecast time of each times series in the column header.
showColumnStatistics
Menu-item in the showTable drop-down menu with label "Column Statistics".
Using this button displays statistics, such as average value, in the column header.
showThresholdCrossings
Menu-item in the showTable drop-down menu with label "Threshold Crossing".
Using this button show the threshold crossings.
twentyFourHourOptions
Controls the visibility of several menu-items in the showTable drop-down menu, the items have labels "Normal", "Days", "Weeks", "Months" and "Years".
Using these buttons switches between different durations over which the TwentyFourHour display is aggregated.
groupTableByTimeSeries
Menu-item in the showTable drop-down menu with label "Group columns by time series".
Using this button groups table by time series.
reverseTimeSeriesOrder
Menu-item in the showTable drop-down menu with label "Time order reversed".
Using this button reverses the time order in the columns.
showTwentyFourHour
Button with icon:
Using this button toggles the layout of the table between the normal view (one column per time series) and the 24N view (per day and per timeseries there is a column with each row being a time in that day).
showChart
Drop-down button with icon:
Using this button shows the chart view panel (aka graph view).
Clicking the arrow symbol next to the button icon will open a drop-down menu:
toggleGraphSplitting
Menu-item in the showGraph drop-down menu with icon and label "Toggle graph".
Using this button toggles between each timeseries having it's own subplot or being grouped by unit.
toggleGraphEqualScale
Menu-item in the showGraph drop-down menu with icon and label "Toggle graph with equal scaling".
Using this button toggles between each timeseries having it's own subplot or being grouped by unit, subplots of the same unit will be given equal scaling on the y-axis.
scaleToShowUnreliableData
Menu-item in the showGraph drop-down menu with icon and label "Scale to show unreliable data".
Using this button scales the chart to show unreliable data.
showDataLabels
Menu-item in the showGraph drop-down menu with icon and label "Show data labels".
Using this button shows data labels.
switchFilterAndShortcuts
Menu-item in the showGraph drop-down menu with icon and label "Toggle Filter and Shortcuts".
Using this button switches between filter/data viewer and display group panel/shortcuts.
hideUnreliableData
Menu-item in the showGraph drop-down menu with icon and label "hide unreliables".
Using this button hides unreliable data.
legendDisplayOptions
Controls visibility of several menu-items in the showGraph drop-down menu:
- icon and label "Show legend at vertical axis"
- icon and label "Show legend inside graph"
- icon and label "Show legend at horizontal axis"
- icon and label "Hide legend"
Using these buttons enable toggling between different locations for the legend.
hideFooter
Menu-item in the showGraph drop-down menu with icon and label "Hide footer".
Using this button toggles between showing and hiding the footer in the graph.
thresholdDisplayOptions
Controls visibility of several menu-items in the showGraph drop-down menu:
- icon and label "No thresholds"
- icon and label "Scale to show relevant thresholds"
- icon and label "Scale to show all thresholds"
Using these buttons enable toggling between different display options for thresholds.
useColorMap
Controls visibility of several menu-items in the showGraph drop-down menu:
- icon and label "Use Color Map"
- no icon and label "Rescale Classification"
Using these buttons enables color mapping.
toggleValidationInChart
Menu-item in the showGraph drop-down menu with icon and label "Validation".
Using this button shows validation data (on a time series) in the graph.
toggleUsersInChart
Menu-item in the showGraph drop-down menu with icon and label "Users".
Using this button shows user data (on a time series) in the graph.
toggleCommentsInChart
Menu-item in the showGraph drop-down menu with icon and label "Comments".
Using this button shows comments (on a time series) in the graph.
toggleLongitudinalProfileMarkers
Menu-item in the showGraph drop-down menu with label "Longitudinal profile characteristics".
Using this button shows longitudinal profile markers.
showStatistics
showLookupTable
rotateChartAndTable
zoomIn
zoomOut
zoomToDefault
selectPreviousZoomLevel
selectNextZoomLevel
moveBackOneViewPeriod
moveBackHalfViewPeriod
moveForwardHalfViewPeriod
moveForwardOneViewPeriod
showAllData
switchReferenceLevel
setViewPeriod
copyTimeSeries
pasteTimeSeries
lockSelection
runWorkflow
undoTimeSeriesChanges
saveTimeSeriesChanges
setTimeSeriesEditableByClicking
useGraphicalEditorMovePointMode
useSetToMissingBetweenSelectedPointsMode
useInterpolateBetweenSelectedPointsMode
useGraphicalEditorQuadraticInterpolationMode
useGraphicalEditorVerticalMoveMode
useNoGraphicalEditMode
selectPoints
deselectPoints
selectOrDeselectPoint
openManualEditor
moveHighLightedTimeStepToLeft
moveHighLightedTimeStepToRight
moveTimeCursorToLeft
moveTimeCursorToRight
increaseValue
decreaseValue
undoEdit
cancelEdit
showThresholdWarningLevels
printChart
saveChartAsPicture
showLongTermScroller
searchAndSelectForecasts
setTimeSeriesVisibility
setTimeSeriesResampling
hideEmptyTimeSeries
showValidationRules
showTimeSeriesLister