Show TOC

 ValueComparisonLocate this document in the navigation structure

Definition

The UI element ValueComparison(IWDValueComparison) can be used to compare the graphic display of several values. You can use the properties boxValue, markerValue and barValue to visualize the relation of up to three comparison values. In addition, you can set two threshold values and thus define three differently colored areas.

 

Use

Typically, the ValueComparison element is used within a table. You can visualize the comparison of up to three values on a row-by-row basis.

WDJ_UIE_VALUECOMP

The ValueComparison-Element in its representation in a table column is always justified to the left.

 

Description of UI Element Properties
  • barValue

    Specifies the width of the bar.

  • boxValue

    Specifies the width of the box.

  • colorAboveThreshold

    Specifies the color of the bar above the upper threshold value.

  • colorBelowThreshold

    Specifies the color of the bar below the lower threshold value.

  • colorBetweenThresholds

    Specifies the color between the threshold values.colorAboveThreshold, colorBelowThreshold and colorBetweenThresholds are of enumeration type WDBarColor and can accept the following values:

    • critical
    • negative
    • neutral1
    • neutral2
    • neutral3
    • positive
  • lowerThresholdValue

    Specifies the lower threshold value.

  • markerType

    Specifies the type of the marker  line. markerType is of enumeration type WDMarkerType and can accept two different values:

    • critical for a critical value and
    • neutral for a neutral value.
  • markerValue

    Specifies the position of the marker line.

  • maxValue

    Defines a maximum value, which is needed if you want to display several ValueComparisonelements, for example, in a table. The maxValue property allows you to define a common maximum value which allows the comparison between the different ValueComparisonelements.

  • text

    Specifies the text of the ValueComparisonelement.

  • upperThresholdValue

    Specifies the upper threshold value.

  • width

    Specifies the width of the ValueComparison element in pixels.

Properties Overview

Name

Interface

Type

Initial Value

Bindable

barValue

IWDValueComparison

double

-1

bindable

boxValue

IWDValueComparison

double

-1

bindable

colorAboveThreshold

IWDValueComparison

WDBarColor

negative

bindable

colorBelowThreshold

IWDValueComparison

WDBarColor

neutral1

bindable

colorBetweenThresholds

IWDValueComparison

WDBarColor

critical

bindable

enabled

IWDUIElement

boolean

true

bindable

lowerThresholdValue

IWDValueComparison

double

-1

bindable

markerType

IWDValueComparison

WDMarkerType

neutral

bindable

markerValue

IWDValueComparison

double

-1

bindable

maxValue

IWDValueComparison

double

-1

bindable

text

IWDValueComparison

String

 

bindable

tooltip

IWDUIElement

String

 

bindable

upperThresholdValue

IWDValueComparison

double

-1

bindable

visible

IWDUIElement

WDVisibility

visible

bindable

width

IWDValueComparison

int

0

bindable