Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL USER MANUAL VERSIONS

Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: published 8.0.16 change



Panel
titleGeneral

Component Palette Icon:




Panel
borderStylesolid
titleDescription

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 two intervals.



Panel
titleProperties


NameDescriptionProperty TypeScriptingCategory
Arc WidthThe width of the colored interval arcs.float.arcWidthAppearance
Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

Note

The border is unaffected by rotation.


Border.borderCommon
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.int.cursorCodeCommon
Dial BackgroundThe background color of the dial face. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.Color.dialBackgroundAppearance
Dial ShapeThe shape of the dial. This property determines how the dial face looks in the area not covered by the meter angle extent.int.dialTypeAppearance
Interval 1 BackgroundThe color to fill the wedge of this interval. See Color Selector.Color.interval1BackgroundIntervals
Interval 1 HighThe upper bound of this interval.double.interval1HighIntervals
Interval 1 LowThe lower bound of this interval.double.interval1LowIntervals
Interval 1 OutlineThe color to paint the arc of this interval. See Color Selector.Color.interval1OutlineIntervals
Interval 2 BackgroundThe color to fill the wedge of this interval. See Color Selector.Color.interval2BackgroundIntervals
Interval 2 HighThe upper bound of this interval.double.interval2HighIntervals
Interval 2 LowThe lower bound of this interval.double.interval2LowIntervals
Interval 2 OutlineThe color to paint the arc of this interval. See Color Selector.Color.interval2OutlineIntervals
Interval 3 BackgroundThe color to fill the wedge of this interval. See Color Selector.Color.interval3BackgroundIntervals
Interval 3 HighThe upper bound of this interval.double.interval3HighIntervals
Interval 3 LowThe lower bound of this interval.double.interval3LowIntervals
Interval 3 OutlineThe color to paint the arc of this interval. See Color Selector.Color.interval3OutlineIntervals
Interval 4 BackgroundThe color to fill the wedge of this interval. See Color Selector.Color.interval4BackgroundIntervals
Interval 4 HighThe upper bound of this interval.double.interval4HighIntervals
Interval 4 LowThe lower bound of this interval.double.interval4LowIntervals
Interval 4 OutlineThe color to paint the arc of this interval. See Color Selector.Color.interval4OutlineIntervals
Interval 5 BackgroundThe color to fill the wedge of this interval. See Color Selector.Color.interval5BackgroundIntervals
Interval 5 HighThe upper bound of this interval.double.interval5HighIntervals
Interval 5 LowThe lower bound of this interval.double.interval5LowIntervals
Interval 5 OutlineThe color to paint the arc of this interval. See Color Selector.Color.interval5OutlineIntervals
Meter AngleThe angle in degrees of the centerpoint of the meter (90 is straight up).int.meterAngleAppearance
Meter Angle ExtentThe extent, in degrees, of the entire meter.int.meterAngleExtentAppearance
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
Needle ColorThe color of the meter's needle. See Color Selector.Color.needleColorAppearance
Needle SizeThe size of the base of the needle.float.needleSizeAppearance
Needle Stroke ColorThe color of the needle's stroke. See Color Selector.Color.needleStrokeColorAppearance
Needle Stroke SizeThe size of the needle's stroke.float.needleStrokeSizeAppearance
Overall High BoundThe high bound for the whole meter.double.overallHighData
Overall Low BoundThe lower bound for the whole meter.double.overallLowData
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Reverse Range?If true, the meter will consider right to left needle movement as positive.boolean.reverseRangeData
Show Tick Labels?If true, value will be shown on interval-boundary ticks.boolean.ticksAppearance
StylesContains the component's styles.Dataset.stylesAppearance
Tick ColorThe color of tick marks.Color.tickColorAppearance
Tick FormatThe number format to use for the tick labels.String.tickLabelFormatAppearance
Tick Label ColorThe color of the tick labels. See Color Selector.Color.tickLabelColorAppearance
Tick Label FontThe font to use for the tick labels.Font.labelFontAppearance
Tick SizeThe distance between ticks.double.tickSizeAppearance
UnitsA string to describe the units for the current value label.String.unitsAppearance
ValueThe value to display in this meter. The needle and current value label will change to reflect this.double.valueData
Value ColorThe color of the meter's current value label. See Color Selector.Color.valueColorAppearance
Value FormatThe number format to use for the value label.String.valueLabelFormatAppearance
Value Label FontThe font to use for the current value label.Font.valueFontAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Deprecated Properties
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated




Panel
titleScripting


Panel
titleScripting Functions

This component does not have scripting functions associated with it.


Panel
titleExtension Functions


This component does not have extension functions associated with it.

8.0.16 - Remove the sentence above. Add the configureChart extension functions panel under Extension Functions.

Editor_notes
Expand
titleconfigureChart


New_in
Version8.0.16


  • Description

Provides an opportunity to perform further configuration via scripting.

  • Parameters

Component self- A reference to the component that is invoking this function.

JFreeChart chart- A JFreeChart object. Refer to the JFreeChart documentation for API details.

  • Return

Nothing

  • Scope

Client



Panel
titleEvent Handlers


Expand
titlemouse


Expand
titlemouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.



Expand
titlemouseEntered

This event fires when the mouse enters the space over the source component.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.



Expand
titlemouseExited

This event fires when the mouse leaves the space over the source component.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.



Expand
titlemousePressed

This event fires when a mouse button is pressed down on the source component.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.



Expand
titlemouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.




Expand
titlemouseMotion


Expand
titlemouseDragged

Fires when the mouse moves over a component after a button has been pushed.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.



Expand
titlemouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.




Expand
titlepropertyChange


Expand
titlepropertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.sourceThe component that fired this event
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyName

The name of the property that changed.

Note

Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.








Panel
titleExamples


Panel
titleUpdated fonts

Property NameValue
Dial Background0,0,128
Value35
Unitm/s
Value Label FontCaibri, Italic, 16
Tick Label FontCaibri, Italic, 12



Panel
titleChord Meter with modified value intervals

Property NameValue
Value35
Reverse Range?True
Units'None'
Arc Width10
Meter Angle Extent220
Meter Angle0
Dial ShapeChord
Interval 1 Low40
Interval 2 High60
Interval 2 Low0
Interval 3 High80
Interval 3 Low60
Interval 4 High100
Interval 3 Low81