LEDGauge Class Properties
These properties are used by the LEDGauge class. The properties are described in alphabetic order.
Description
Use this property to specify a style class name suffix as a String value.
Then, in Application Designer, create custom style class definitions by append this style class name suffix to style class names. These custom style class definitions will override delivered style class definitions found in any of the PSCHARTSTYLE* sub style sheets.
For example, if the value of this property is set to MY_OVRD, then create the PSCHARTTITLE_MY_OVRD custom style class to override the PSCHARTTITLE style class.
This property is read-write.
Description
Use this property to specify an Integer value (0 or greater) indicating how long (in milliseconds) the gauge animation should last.
If this property is not specified, it defaults to the value of the GAnimationDuration property of the PT_CHART_GAUGE style class, which is 500 milliseconds.
This property is read-write.
Description
Use this property to specify the animation type for the gauge or chart. You can specify either an integer or constant value for this property.
If this property is not specified, it defaults to the value of the GAnimationDefType property of the PT_CHART_GAUGE style class, which is TransitionToLeft.
The values are:
|
Numeric Value |
Constant Value |
|---|---|
|
0 |
%Animation_None |
|
1 |
%Animation_Auto Note: The automatic animation is determined by the charting engine and varies by chart type. |
|
2 |
%Animation_AlphaFade |
|
3 |
%Animation_ConveyorFromRight |
|
4 |
%Animation_ConveyorFromLeft |
|
5 |
%Animation_CubeToLeft |
|
6 |
%Animation_CubeToRight |
|
7 |
%Animation_FlipRight |
|
8 |
%Animation_FlipLeft |
|
9 |
%Animation_SlideToLeft |
|
10 |
%Animation_SlideToRight |
|
11 |
%Animation_TransitionToLeft |
|
12 |
%Animation_TransitionToRight |
|
13 |
%Animation_Zoom |
This property is read-write.
Description
Use this property to specify a Float value indicating the height of the chart as a proportion of its width.
If the aspect ratio is not defined, a default value of 1 is used on fluid pages.
Note: AspectRatio is ignored on classic pages; instead, the height is determined by the height of the chart page control defined in Application Designer or by the Height and Width properties.
This property is read-write.
Example
&lGauge.AspectRatio = 0.8;Description
Use this property to specify the text of the bottom label as a String value.
This property is read-write.
Description
Use this property to specify the position of the bottom label. You can specify either an Integer or constant value for this property.
The values are:
|
Numeric Value |
Constant Value |
Description |
|---|---|---|
|
1 |
%BelowGauge |
Display the bottom label below the gauge. Note: %BelowGauge is the default value. |
|
2 |
%InsideGauge |
Display the bottom label inside the gauge. |
|
5 |
%Label_None |
Do not display a bottom label for the gauge. |
This property is read-write.
Description
Use this property to specify an Integer indicating the number of decimal places to display for the metric label. The default value: 0.
This property is read-write.
Description
Use this property to specify a valid URL as a String value. If IsDrillable is true, then the user is redirected to this URL after clicking on (or touching) the gauge.
This property is read-write.
Description
On a classic page, use this property to specify a Number value indicating the height of the gauge in pixels.
Note: On a fluid page, the combination of the AspectRatio, Height, and Width properties are used to determine the size of the gauge.
This property is read-write.
Description
Use this property to specify a Boolean value indicating whether the gauge is interactive—that is, whether the user can click on (or touch) the gauge to trigger an action. The default value is False.
The source of interactivity on a gauge can come from one of two places:
A URL set in the gauge's GaugeURL property.
FieldChange PeopleCode on the record field that holds the gauge area (that is, the Application Designer chart control).
If both a URL is set in the GaugeURL property and FieldChange PeopleCode exists on the record field of the gauge control, the URL will take precedence over the PeopleCode.
This property is read-write.
Description
Use this property to specify where the legend should appear, in relationship to the gauge. You can specify either an Integer or constant value for this property.
The legend will only appear if you have used the SetThreshold method and you have set this property to something other than %ChartLegend_None.
The values are:
|
Numeric Value |
Constant Value |
Description |
|---|---|---|
|
0 |
%ChartLegend_Left |
Display the legend to the left of the gauge. |
|
1 |
%ChartLegend_Right |
Display the legend to the right of the gauge. |
|
2 |
%ChartLegend_Top |
Display the legend above the gauge. |
|
3 |
%ChartLegend_Bottom |
Display the legend beneath the gauge. |
|
5 |
%ChartLegend_None |
Don’t display a legend. Note: %ChartLegend_None is the default value. |
This property is read-write.
Description
Use this property to specify the label position for the gauge’s metric value. You can specify either an Integer or constant value for this property.
The values are:
|
Numeric Value |
Constant Value |
Description* |
|---|---|---|
|
1 |
%BelowGauge |
Display the label for the metric below the gauge. |
|
2 |
%InsideGauge |
Display the label for the metric inside the gauge. |
|
5 |
%Label_None |
Don’t display a label for the metric. Note: %Label_None is the default value. |
|
6 |
%WithBottomGauge |
Display the metric label together with the bottom label. |
* The positions described are when the Type property is set to %GaugeType_Dial_Standard. For other dial gauge types, the positions can vary from the ones described.
This property is read-write.
Description
Use this property to specify the label type for the gauge’s metric value. You can specify either an Integer or constant value for this property.
The values are:
|
Numeric Value |
Constant Value |
Description |
|---|---|---|
|
1 |
%Number |
Display the metric as a number. |
|
2 |
%Percent |
Display the metric as a percentage, which is calculated as follows: |
This property is read-write.
Description
Use this property to specify the text of the top label as a String value.
This property is read-write.
Description
Use this property to specify the position of the top label. You can specify either an Integer or constant value for this property.
The values are:
|
Numeric Value |
Constant Value |
Description |
|---|---|---|
|
0 |
%AboveGauge |
Display the top label above the gauge. Note: %AboveGauge is the default value. |
|
2 |
%InsideGauge |
Display the top label inside the gauge. |
|
5 |
%Label_None |
Do not display a top label for the gauge. |
This property is read-write.
Description
Use this property to specify the visual representation of the gauge. You can specify either an Integer or constant value for this property.
The values are:
|
Numeric Value |
Constant Value |
Description |
|---|---|---|
|
26 |
%GaugeType_LED_Dot |
Display an LED gauge as a dot: 
Note: %GaugeType_LED_Dot is the default value. |
|
27 |
%GaugeType_LED_Arrow |
Display an LED gauge as an arrow: 
|
|
28 |
%GaugeType_LED_Triangle |
Display an LED gauge as a triangle: 
|
|
29 |
%GaugeType_LED_Rectangle |
Display an LED gauge as a rectangle: 
|
|
30 |
%GaugeType_LED_Square |
Display an LED gauge as a square: 
|
This property is read-write.
Example
In the following example, the status meter gauge is displayed horizontally.
&cLEDGauge.Type = %GaugeType_StatusMeter_Horiz;Description
On a classic page, use this property to specify a Number value indicating the width of the gauge in pixels.
Note: On a fluid page, the combination of the AspectRatio, Height, and Width properties are used to determine the size of the gauge.
This property is read-write.