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/> <stackPlot/> <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.
stackPlot
Menu-item in the showGraph drop-down menu with label "stack plot".
Using this button toggles the graph(s) between a stack plot and a normal plot
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
Button with icon:
Using this button shows the basic statistics panel.
showLookupTable
Drop-down button with icon:
Using this button toggles a panel showing the lookup table / rating curve. This button is automatically made invisible when no lookup table config file is available, nor a rating curve stage / discharche parameter are configured (in Parameters.xml). The button will also automatically be disabled (still visible but not clickable) if the current data selection does not contain a lookup table / rating curve.
rotateChartAndTable
Button with icon:
Using this button toggles splitter (splitting the table and chart panel) orientation between vertical and horizontal.
zoomIn
Drop-down button with icon:
Using this button zooms in on the timeseries, reducing the view period length.
zoomOut
Button with icon:
Using this button zooms out on the timeseries, increasing the view period length.
zoomToDefault
Button with icon:
Using this button restores initial zoom (used when opening the TSD).
selectPreviousZoomLevel
Button with icon:
Using this button returns to the previous zoom level.
selectNextZoomLevel
Button with icon:
Using this button forwards to the next zoom level.
moveBackOneViewPeriod
Button with icon:
Using this button moves the view period backward with the entire length of the current view period.
moveBackHalfViewPeriod
Button with icon:
Using this button moves the view period backward with the half of the length of the current view period.
moveForwardHalfViewPeriod
Button with icon:
Using this button moves the view period forward with the half of the length of the current view period.
moveForwardOneViewPeriod
Button with icon:
Using this button moves the view period forward with the entire length of the current view period.
showAllData
Button with icon:
Using this button zooms to show the entire time series.
switchReferenceLevel
Regular or drop-down button with icon:
Using this button changes the values (i.e. water level) reference level to a global or local level.
setViewPeriod
Drop-down button with icon:
Using this button sets the view period; the section of a timeseries that is shown in the chart and table panel.
copyTimeSeries
Button with icon:
Using this button copies the selected timeseries.
pasteTimeSeries
Drop-down button with icon:
Using this button pastes the copied timeseries.
lockSelection
Button with icon:
Using this button locks the selected timeseries and view period. If unlocked, the timeseries and view period can (context dependent) be changed from outside the TSD.
runWorkflow
Button with icon:
Using this button saves changes to the timeseries and runs the workflow.
undoTimeSeriesChanges
Button with icon:
Using this button reverses modifications done to the timeseries.
saveTimeSeriesChanges
Button with icon:
Using this button saves changes to the timeseries.
setTimeSeriesEditableByClicking
Drop-down button with icon: or depending on which graphical edit mode is currently selected.
Using this button enables editing timeSeries by clicking on them.
Clicking the arrow symbol next to the button icon will open a drop-down menu:
useGraphicalEditorMovePointMode
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Adjust the shape of the time series by dragging a selected point".
Using these buttons switches to the mode where points can be freely moved.
useSetToMissingBetweenSelectedPointsMode
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Set the value between selected points to missing".
Using these buttons switches to the mode where missings are added in between points.
useInterpolateBetweenSelectedPointsMode
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Linear interpolate between selected points".
Using these buttons switches to the mode where points are interpolated between existing points.
useGraphicalEditorQuadraticInterpolationMode
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Quadratic interpolate between selected points".
Using these buttons switches to the mode where points are interpolated between existing points quadratically
useGraphicalEditorVerticalMoveMode
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Move the time series vertically".
Using these buttons switches to the mode where points can only be moved vertical (in value).
useNoGraphicalEditMode
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "No graphical edit mode selected".
Using these buttons disables editing.
selectPoints
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Select points".
Using this button selects a predetermained point selection.
deselectPoints
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "De-select points".
Using this button deselects all points.
selectOrDeselectPoint
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Select time step".
Using this button toggles selection of the point under the cursor.
openManualEditor
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Open editor".
Using this button show a pop-up in which numerical adjustments can be made.
moveHighLightedTimeStepToLeft
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Go to the previous selected time step".
Using this button highlights the first point to the left which is selected.
moveHighLightedTimeStepToRight
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Go to the next selected time step".
Using this button highlights the first point to the right which is selected.
moveTimeCursorToLeft
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Go to the previous time step".
Using this button highlights the first point to the left of the current point.
moveTimeCursorToRight
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Go to the next time step".
Using this button highlights the first point to the right of the current point.
increaseValue
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Increase value".
Using this button increases the currently selected point.
decreaseValue
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Decrease value".
Using this button decreases the currently selected point.
undoEdit
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Undo modifications made in the chart/table".
Using this button reverts the last change.
cancelEdit
Menu-item in the setTimeSeriesEditableByClicking drop-down menu with icon and label "Cancel edit".
Using this button reverts all changes.
showThresholdWarningLevels
Drop-down button with icon or depending on which drop-down menu item is selected.
Using this button shows the threshold level icons in the display group (shortcut) panel.
printChart
Button with icon:
Using this button prints the chart.
saveChartAsPicture
Button with icon:
Using this button saves the chart in an image format of the operators choosing.
showLongTermScroller
Button with icon:
Using this button shows the long term scroller panel.
searchAndSelectForecasts
Drop-down button with icon:
Using this button allows selection of what forecast run(s) should be displayed.
setTimeSeriesVisibility
Button with icon or (depends on if a time series has been made invisible).
Use this button to show a panel which allows selection of what timeseries should be displayed.
setTimeSeriesResampling
Button with icon:
Using this button allows selection of what time steps should be used to resample the displayed timeseries.
hideEmptyTimeSeries
Button with icon:
Use this button to hide empty time series from graph and table.
showValidationRules
Button with icon:
Use this button to show a panel that lists the validation rules for the selected time series on the selected time step.
Note: this button appears on the left part of the toolbar, in the first section. It is located between the showStatistics and showLookupTable buttons
showTimeSeriesLister
Button with icon:
Use this button to show a panel that lists the time series as they are in the database.
Note: this button appears on the left part of the toolbar, in the first section. It is located between the showChart and showStatistics buttons