Gauge

Display a single numerical value within a specified range on a semi-circular indicator.

Public Variables (Properties)

[?]

Common variables and variable groups: Name, Visible, Breakpoints, Variable Storage, Container Properties, Styles, Preloader, Events, Component Bindings.

Basic Properties Group

The following properties can be found in the Basic Properties group.

Value

Indicate the current value of the gauge.

Variable Name:

value

Records:

1

Record Format:

Field Name

Field Type

Field Description

value

Float

Value

Scale

Configure the bounds of the gauge, fill color, and tick placement.

Variable Name:

scale

Records:

1

Record Format:

Field Name

Field Type

Field Description

defaultColor

Color

Indicate the fill color from the lowest bound to the Value.

lowerBound

Float

Lower bound of the gauge.

upperBound

Float

Upper bound of the gauge.

showAxisTickLabels

Boolean

Indicate whether tick labels should be displayed.

majorTickIncrement

Float

Increments at which to place major tick marks .

minorTickCount

Integer

Number of minor tick marks to place between major tick marks.

Ranges

Apply custom fill color to any number of ranges.

Variable Name:

ranges

Records:

0…Unlimited

Record Format:

Field Name

Field Type

Field Description

rangeUpperBound

Float

Upper bound to which to apply the indicated color as fill.

rangeColor

Color

Color to apply to the range.

Visualization Properties: Gauge

The following properties can be found in the Visualization group, in the Gauge subgroup

Inner Radius

Defines the inner radius of the gauge as a proportion of the outer radius, from 0 to 1. For example, a value of 0.5 will set the inner radius to be 50% of the radius of the outer radius.

Variable Name:

innerRadiusGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

innerRadiusGauge

Float

Inner Radius

Line Cap

Indicate whether the line caps on the gauge should be Square or Rounded.

Variable Name:

styleLineCapGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleLineCapGauge

String

Line Cap

Fill

Specifies the fill color of the gauge element.

Variable Name:

styleFillGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleFillGauge

Color

Fill

Fill Opacity

Defines the opacity level of the fill color for the gauge element.

Variable Name:

styleFillOpacityGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleFillOpacityGauge

Float

Fill Opacity

Border Color

Sets the color of the border around the gauge element.

Variable Name:

styleStrokeGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleStrokeGauge

Color

Border Color

Border Opacity

Controls the opacity of the border around the gauge element.

Variable Name:

styleStrokeOpacityGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleStrokeOpacityGauge

Float

Border Opacity

Border Width

Specifies the width of the border around the gauge element

Variable Name:

styleLineWidthGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleLineWidthGauge

Integer

Border Width

Border Dash Interval

Specifies the dash pattern of the border around the gauge element.

Variable Name:

styleLineDashGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleLineDashGauge

String

Line Dash

Shadow Color

Sets the color of the shadow cast by the gauge element.

Variable Name:

styleShadowColorGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowColorGauge

Color

Shadow Color

Shadow Blur

Determines the blurring effect applied to the shadow cast by the gauge element.

Variable Name:

styleShadowBlurGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowBlurGauge

Integer

Shadow Blur

Shadow Offset X

Controls the horizontal offset of the shadow cast by the gauge element.

Variable Name:

styleShadowOffsetXGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowOffsetXGauge

Integer

Shadow Offset X

Shadow Offset Y

Controls the vertical offset of the shadow cast by the gauge element.

Variable Name:

styleShadowOffsetYGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowOffsetYGauge

Integer

Shadow Offset Y

Cursor

Defines the cursor appearance when hovering over the gauge element

Variable Name:

styleCursorGauge

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleCursorGauge

String

Cursor

Visualization Properties: Content

The following properties can be found in the Visualization group, in the Content subgroup

Text

Specify custom text for the content of the gauge.

Variable Name:

customContentText

Records:

1

Record Format:

Field Name

Field Type

Field Description

customContentText

String

Text

Color

Specifies the color of the text content.

Variable Name:

styleColorContent

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleColorContent

Color

Color

Opacity

Defines the opacity level of the text content.

Variable Name:

styleOpacityContent

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleOpacityContent

Float

Opacity

Font Size

Sets the font size of the text content.

Variable Name:

styleFontSizeContent

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleFontSizeContent

Integer

Font Size

Visualization Properties: Pointer

The following properties can be found in the Visualization group, in the Pointer subgroup.

Shape

Choose the shape of the pointer, Default, Triangle, or Circle.

Variable Name:

shapePointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

shapePointer

String

Shape

Size

Indicates the size of the pointer as a proportion of the inner radius of the gauge, where a value of 1 indicates that the size of the pointer will be equal to the inner radius, 0.5 indicates a value equal to half the inner radius, and 0 indicates the pointer size will be zero.

Variable Name:

sizePointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

sizePointer

Float

Size

Radius

Radius value is a proportion of the gauge Inner Radius, where 1 indicates radius is equal to the inner radius, 0.5 indicates a value equal to half the inner radius, and 0 indicates the radius will be zero.

Radius value has a different effect, depending on pointer Shape:

  • If Shape is Default , indicates the length of the pointer.

  • If Shape is Triangle, indicates where the endpoint of the triangle will be located, between the radius and the gauge inner radius.

  • If Shape is Circle, indicates where the midpoint of the circle will be located, between the radius and the gauge inner radius.

Variable Name:

radiusPointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

radiusPointer

Float

Radius

Border Color

Sets the border color of the pointer.

Variable Name:

styleStrokePointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleStrokePointer

Color

Border Color

Border Opacity

Controls the opacity of the border of the pointer.

Variable Name:

styleStrokeOpacityPointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleStrokeOpacityPointer

Float

Border Opacity

Border Width

Determines the width of the border around the pointer.

Variable Name:

styleLineWidthPointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleLineWidthPointer

Integer

Border Width

Shadow Color

Sets the color of the shadow cast by the pointer.

Variable Name:

styleShadowColorPointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowColorPointer

Color

Shadow Color

Shadow Blur

Determines the blurring effect applied to the shadow cast by the pointer.

Variable Name:

styleShadowBlurPointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowBlurPointer

Integer

Shadow Blur

Shadow Offset X

Controls the horizontal offset of the shadow cast by the pointer.

Variable Name:

styleShadowOffsetXPointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowOffsetXPointer

Integer

Shadow Offset X

Shadow Offset Y

Controls the vertical offset of the shadow cast by the pointer.

Variable Name:

styleShadowOffsetYPointer

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowOffsetYPointer

Integer

Shadow Offset Y

Visualization Properties: Pin

The following properties can be found in the Visualization group, in the Pin subgroup.

Fill

Specifies the fill color of the pin.

Variable Name:

styleFillPin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleFillPin

Color

Fill

Fill Opacity

Defines the opacity level of the fill color for the pin.

Variable Name:

styleFillOpacityPin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleFillOpacityPin

Float

Fill Opacity

Radius

Sets the radius of the pin.

Variable Name:

styleRadiusPin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleRadiusPin

Integer

Radius

Border

Sets the border color of the pin.

Variable Name:

styleStrokePin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleStrokePin

Color

Border

Border Opacity

Controls the opacity of the border of the pin.

Variable Name:

styleStrokeOpacityPin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleStrokeOpacityPin

Float

Border Opacity

Border Width

Determines the width of the border around the pin.

Variable Name:

styleLineWidthPin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleLineWidthPin

Integer

Border Width

Shadow Color

Sets the color of the shadow cast by the pin.

Variable Name:

styleShadowColorPin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowColorPin

Color

Shadow Color

Shadow Blur

Determines the blurring effect applied to the shadow cast by the pin.

Variable Name:

styleShadowBlurPin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowBlurPin

Integer

Shadow Blur

Shadow Offset X

Controls the horizontal offset of the shadow cast by the pin.

Variable Name:

styleShadowOffsetXPin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowOffsetXPin

Integer

Shadow Offset X

Shadow Offset Y

Controls the vertical offset of the shadow cast by the pin.

Variable Name:

styleShadowOffsetYPin

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowOffsetYPin

Integer

Shadow Offset Y

Public Events

[?]

Common Events: Common Component Events

Was this page helpful?