Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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

Table of Contents
excludeContents

...

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.

The ButtonSetting element has two more attributes namely: permission and selected. If permission is set, the button is shown to the current user if the user has the permission to view the button. If selected is set, then the button is shown as selected when FEWS is running. The default for selected is true.

Code Block
titleExample config for the buttonSettings in TimeSeriesDisplayConfig.xml
<buttonSettings>
		...
		<moveBackHalfViewPeriod visible="false"/>
		<moveForwardHalfViewPeriod visible="false"/>
		<moveForwardOneViewPeriod/>
		<showAllData/>
		<switchReferenceLevel/>
		<setViewPeriod/>
		<copyTimeSeries visible="false"/>
		<pasteTimeSeries visible="false"/>
		...
</buttonSettings>

...

Code Block
titleAll Available Button Visibility Settings
 <buttonSettings>
		<showDisplayGroups/>
		<showTable/>
		<showValidationColumn/>
		<showValidationStepsColumn/>
		<showUsersColumn/>
		<showCommentsColumn/>
		<showUnitsColumn/>
		<showLocationNamesInTableHeader/>
		<showLocationIdsInTableHeader/>
		<showModuleInstanceInTableHeader/>
		<showForecastTimesInTableHeader/>
		<showColumnStatistics/>
		<showThresholdCrossings/>
		<twentyFourHourOptions/>
		<groupTableByTimeSeries/>
		<reverseTimeSeriesOrder/>
		<showTwentyFourHour/>
		<showChart/>
		<toggleGraphSplitting/>
		<toggleGraphEqualScale/>
		<toggleGraphGroupByRun/>
		<scaleToShowUnreliableData/>
		<showDataLabels/>
		<switchFilterAndShortcuts/>
		<hideUnreliableData/>
		<stackPlot/>
		<legendDisplayOptions/>
		<hideFooter/>
		<thresholdDisplayOptions/>
		<useColorMap/>
		<toggleValidationInChart/>
		<toggleUsersInChart/>
		<toggleCommentsInChart/>
		<toggleProductInfoInChart/>
		<toggleLongitudinalProfileMarkers/>
		<showStatistics/>
		<showLookupTable/>
		<rotateChartAndTable/>
		<zoomIn/>
		<zoomOut/>
		<zoomToDefault/>
		<selectPreviousZoomLevel/>
		<selectNextZoomLevel/>
		<moveToFistDataPoint visible="true"/>
		<moveBackOneViewPeriod/>
		<moveBackHalfViewPeriod/>
		<moveForwardHalfViewPeriod/>
		<moveForwardOneViewPeriod/>
		<moveToLastDataPoint/>
		<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>

...

Menu-item in the showGraph drop-down menu with icon  and label "hide Hide unreliables".

Using this button hides unreliable data. 

legendDisplayOptions

stackPlot

Menu-item Controls visibility of several menu-items 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 Image Added and label "Show legend at vertical axis"
  • icon 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 this button shows comments (on a time series) in the graph.

...

toggleProductInfoInChart

Menu-item in the showGraph drop-down menu with icon Image Added and label "Longitudinal profile characteristicsProduct Info".

Using this button shows the product info (of the time series) in the graph.

Since 2019.02.

toggleLongitudinalProfileMarkers

Menu-item in the showGraph drop-down menu with label "Longitudinal profile characteristics".

Using this button shows longitudinal profile longitudinal profile markers.

showStatistics

Button with icon: 

...

Drop-down button with icon: 

Button to control Using this button toggles a panel showing the lookup tables table / rating curvescurve. 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.

...

showThresholdWarningLevels

printChart

saveChartAsPicture

showLongTermScroller

searchAndSelectForecasts

setTimeSeriesVisibility

setTimeSeriesResampling

hideEmptyTimeSeries

showValidationRules

showTimeSeriesLister

Drop-down button with icon Image AddedImage Added or Image Added 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: Image Added

Using this button prints the chart.

saveChartAsPicture

Button with icon: Image Added

Using this button saves the chart in an image format of the operators choosing.

showLongTermScroller

Button with icon: Image Added

Using this button shows the long term scroller panel.

searchAndSelectForecasts

Drop-down button with icon: Image Added

Using this button allows selection of what forecast run(s) should be displayed.

setTimeSeriesVisibility

Button with icon Image Added or Image Added (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: Image Added

Using this button allows selection of what time steps should be used to resample the displayed timeseries.

hideEmptyTimeSeries

Button with icon: Image Added

Use this button to hide empty time series from graph and table.

showValidationRules

Button with icon: Image Added

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: Image Added

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

showHistoricalAnalysis

Button with icon: Image Added

Use this button to show a panel that lists the time series available in the Archive

Note: this button appears on the middle part of the toolbar