Top  | Previous | Next

Meter
Meters have<br> customizable segments 

Meters have
customizable segments 
A few gradient and<br> transparent circles<br> can give your meter<br> some shine

A few gradient and
transparent circles
can give your meter
some shine
Meters can be<br> many shapes

Meters can be
many shapes

Description

A meter display shows a value on a needle-gauge. The gauge's range can be broken up into five intervals. The intervals can have their own edge and background colors.

 

How the meter looks is affected by its appearance properties. You can modify colors, thicknesses, start and extend angles, needle size, etc to get the meter that you want. For example, the meter on the far right of the example has a Meter Angle Extent of 90°, a Meter Angle of 45°, a reversed range, and 2 intervals.

Properties

Appearance

Units

A string to describe the units for the current value label.

Scripting name

units

Data type

String

Dial Background

The background color of the dial face.

Scripting name

dialBackground

Data type

Color

Needle Color

The color of the meter's needle.

Scripting name

needleColor

Data type

Color

Needle Size

The size of the base of the needle.

Scripting name

needleSize

Data type

float

Needle Stroke Color

The color of the needle's stroke.

Scripting name

needleStrokeColor

Data type

Color

Needle Stroke Size

The size of the needle's stroke.

Scripting name

needleStrokeSize

Data type

float

Value Color

The color of the meter's current value label.

Scripting name

valueColor

Data type

Color

Tick Label Color

The color of the tick labels

Scripting name

tickLabelColor

Data type

Color

Tick Color

The color of tick marks.

Scripting name

tickColor

Data type

Color

Tick Size

The distance between ticks.

Scripting name

tickSize

Data type

double

Show Tick Labels?

If true, value will be shown on interval-boundary ticks.

Scripting name

ticks

Data type

boolean

Value Label Font

The font to use for the current value label.

Scripting name

valueFont

Data type

Font

Tick Label Font

The font to use for the tick labels.

Scripting name

labelFont

Data type

Font

Value Format

The number format to use for the value label.

Scripting name

valueLabelFormat

Data type

String

Tick Format

The number format to use for the tick labels.

Scripting name

tickLabelFormat

Data type

String

Arc Width

The width of the colored interval arcs

Scripting name

arcWidth

Data type

float

Meter Angle Extent

The extent, in degrees, of the entire meter.

Scripting name

meterAngleExtent

Data type

int

Meter Angle

The angle in degrees of the centerpoint of the meter (90 is straight up).

Scripting name

meterAngle

Data type

int

Dial Shape

The shape of the dial. This property determines how the dial face looks in the area not covered by the meter angle extent.

Scripting name

dialType

Data type

int

Values

1

Chord

0

Circle

2

Pie

Styles

Contains the component's styles

Scripting name

styles

Data type

Dataset

Flags

bindable | expert

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

Visible

If disabled, the component will be hidden.

Scripting name

visible

Data type

boolean

Flags

bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name

border

Data type

Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name

toolTipText

Data type

String

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Values

0

Default

1

Crosshair

2

Text

3

Wait

12

Hand

13

Move

4

SW Resize

5

SE Resize

6

NW Resize

7

NE Resize

8

N Resize

9

S Resize

10

W Resize

11

E Resize

Data

Value

The value to display in this meter. The needle and current value label will change to reflect this.

Scripting name

value

Data type

double

Flags

bindable

Overall Low Bound

The lower bound for the whole meter

Scripting name

overallLow

Data type

double

Flags

bindable

Overall High Bound

The high bound for the whole meter

Scripting name

overallHigh

Data type

double

Flags

bindable

Reverse Range?

If true, the meter will consider right to left needle movement as positive.

Scripting name

reverseRange

Data type

boolean

Data Quality

The data quality code for any tag bindings on this component.

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

Intervals

Interval 1 Low

The lower bound of this interval.

Scripting name

interval1Low

Data type

double

Interval 1 High

The upper bound of this interval.

Scripting name

interval1High

Data type

double

Interval 1 Outline

The color to paint the arc of this interval.

Scripting name

interval1Outline

Data type

Color

Interval 1 Background

The color to fill the wedge of this interval.

Scripting name

interval1Background

Data type

Color

Interval 2 Low

The lower bound of this interval.

Scripting name

interval2Low

Data type

double

Interval 2 High

The upper bound of this interval.

Scripting name

interval2High

Data type

double

Interval 2 Outline

The color to paint the arc of this interval.

Scripting name

interval2Outline

Data type

Color

Interval 2 Background

The color to fill the wedge of this interval.

Scripting name

interval2Background

Data type

Color

Interval 3 Low

The lower bound of this interval.

Scripting name

interval3Low

Data type

double

Interval 3 High

The upper bound of this interval.

Scripting name

interval3High

Data type

double

Interval 3 Outline

The color to paint the arc of this interval.

Scripting name

interval3Outline

Data type

Color

Interval 3 Background

The color to fill the wedge of this interval.

Scripting name

interval3Background

Data type

Color

Interval 4 Low

The lower bound of this interval.

Scripting name

interval4Low

Data type

double

Interval 4 High

The upper bound of this interval.

Scripting name

interval4High

Data type

double

Interval 4 Outline

The color to paint the arc of this interval.

Scripting name

interval4Outline

Data type

Color

Interval 4 Background

The color to fill the wedge of this interval.

Scripting name

interval4Background

Data type

Color

Interval 5 Low

The lower bound of this interval.

Scripting name

interval5Low

Data type

double

Interval 5 High

The upper bound of this interval.

Scripting name

interval5High

Data type

double

Interval 5 Outline

The color to paint the arc of this interval.

Scripting name

interval5Outline

Data type

Color

Interval 5 Background

The color to fill the wedge of this interval.

Scripting name

interval5Background

Data type

Color

Scripting

Events

The following event sets are fired by this component. See Component Event Handlers to learn more.

•mouse
•mouseMotion
•propertyChange

 

Scripting Functions

This component has no special scripting functions.