You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

All buttons and some 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.

Example 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>

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. 

All 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/>
		<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. 

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: 

Using this button shows the validation column in the time series table.

showValidationStepsColumn

Menu-item in the showTable drop-down menu with icon: 

Using this button shows the validation steps column in the time series table.

showUsersColumn

Menu-item in the showTable drop-down menu with icon: 

Using this button shows the users column in the time series table.

showCommentsColumn

Menu-item in the showTable drop-down menu with icon: 

Using this button shows the comments column in the time series table.

showUnitsColumn

Menu-item in the showTable drop-down menu with label "Units" in the English version.

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" in the English version.

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" in the English version.

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" in the English version.

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" in the English version.

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" in the English version.

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" in the English version.

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" in the English version.

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" in the English version.

Using this button groups table by time series.

reverseTimeSeriesOrder

Menu-item in the showTable drop-down menu with label "Time order reversed" in the English version.

Using this button reverses the time order in the columns.

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

 

  • No labels