Skip to end of metadata
Go to start of metadata
General

Component Palette Icon:


 

 

Description

A component that displays an indication of actual versus target values. It provides a visual indication to users that is easy to comprehend with a quick glance. These values can be unit count, OEE or any values residing in SQLTags.

Properties
NameScriptingCategoryProperty TypeDescription
Target ValuetargetValueDatadoubleThe target value.
Actual ValueactualValueDatadoubleThe actual value.
Target LabeltargetLabelDataStringThe label for the target value.
Actual LabelactualLabelDataStringThe label for the actual value.
Target Series ColortargetSeriesColorAppearanceColorThe color of the target series.
Actual Series ColoractualSeriesColorAppearanceColorThe color of the actual series.
Chart TitletitleAppearanceStringAn optional title that will appear at the top of the chart.
Value Axis LabelvalueLabelAxesStringThe label for the value axis.
Category Axis LabelcategoryLabelAxesFontThe label for the category axis.
Value Axis Auto-RangevalAxisAutoRangeAxesbooleanIf true, the value axis range will be determined automatically. If false, the specified upper and lower bounds will be used.
Value Axis Lower BoundvalAxisLowerBoundAxesdoubleThe lower bound of the value axis. Used only when auto-range is false.
Value Axis Upper BoundvalAxisUpperBoundAxesdoubleThe upper bound of the value axis. Used only when auto-range is false.
Title FonttitleFontAxesFontThe font for the chart's title.
Legend FontlegendFontAxesFontThe font for the legend items.
Bar Label FontbarLabelFontAxesFontThe font for the bar labels.
Bar Label OffsetbarLabelOffsetAxesdoubleThe offset between the bar and the bar label.
Value Axis Label FontvalAxisLabelFontAxesFontThe font for the value axis label.
Category Axis Label FontcatAxisLabelFontAxesFontThe font for the category axis label.
Value Axis Tick FontvalAxisTickFontAxesFontThe font for the value axis' ticks.
Category Axis Tick FontcatAxisTickFontAxesFontThe font for the category axis' ticks.
Bar Label ColorbarLabelColorAxesColorThe color for the bar labels.
Value Axis Label ColorvalAxisLabelColorAxesColorThe color for the value axis label.
Category Axis Label ColorcatAxisLabelColorAxesColorThe color for the category axis label.
Value Axis Tick ColorvalAxisTickColorAxesColorThe color for the value axis' ticks.
Value Axis Fixed WidthvalAxisFixedWidthAxesdoubleIf greater than zero, use as the value axis width.
Category Axis Tick ColorcatAxisTickColorAxesColorThe color for the category axis' ticks.
Value Axis Upper MarginvalAxisUpperMarginAxesdoubleThe upper margin, as a percentage, of the value axis. Only used when auto-range is true.
Category Axis Upper MargincatAxisUpperMarginAxesdoubleThe upper margin, as a percentage, of the category axis.
Category Axis Lower MargincatAxisLowerMarginAxesdoubleThe lower margin, as a percentage, of the category axis.
Chart BackgroundchartBackgroundAppearanceColorThe backgroud color // for the chart.
Plot BackgroundplotBackgroundAppearanceColorThe backgroud color for the plot.
Legend?legendAppearancebooleanIf True, then the legend items are described when user hovers the mouse.
Tooltips?tooltipsBehaviorbooleanIf True, then the target values are displayed when user hovers the mouse.
Labels?labelsAppearancebooleanAlways display labels?
Gradient bars?gradientAppearancebooleanIf true, bars will be painted with a gradient 'shine'.
Shadows?shadowsAppearancebooleanIf true, bars will have a drop-shadow beneath them.
Foreground TransparencyforegroundAlphaAppearancefloatThe transparency of the pie.
VerticalverticalAppearancebooleanSets the orientation of the chart to vertical.
Item MarginitemMarginAppearancedoubleThe margin between bars in a category as a fraction.
Scripting
Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

This component does not have extension functions associated with it. 

Event Handlers
 mouse
 mouseClicked

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.

PropertyDescription
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 Ctrl 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.
 mouseEntered

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

PropertyDescription
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 Ctrl 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.
 mouseExited

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

PropertyDescription
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 Ctrl 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.
 mousePressed

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

PropertyDescription
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 Ctrl 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.
 mouseReleased

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

PropertyDescription
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 Ctrl 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.
 mouseMotion
 mouseDragged

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

 

PropertyDescription
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 Ctrl 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.
 mouseMoved

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

PropertyDescription
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 Ctrl 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.
 propertyChange
 propertyChange

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

PropertyDescription
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.
propertyNameThe 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.
Customizers

This component does not have any custom properties.

Examples

Component Performance Indicator

Performance Indicator

This is similar to a bar chart except that it only has 2 series or bars. Also, the values reside in SQLTags instead of having to setup values in an Ignition Dataset.
  • No labels