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

Skip to end of metadata
Go to start of metadata



General

Component Palette Icon:



Description

The Pie Chart component displays a familiar-looking pie chart. A Pie Chart displays a list of named items, each of which has a value that is part of a total. The total is the sum of the value of each item. The key to the Pie Chart component is the  Data  property, which contains the items that will be displayed as pie wedges. Typically, this dataset will be bound to a SQL Query Binding in Vision to pull dynamic data out of an external database.

Extract Order  

Similar to other charts, the pie chart can actually accept data in two formats. You can tell the pie chart which format to use via its  Extract Order  property. The two extract orders are  By Column oBy Row. The following table shows the two styles for the data that created the pie chart in the screenshot.


By Column

By Row

Label

Value

Grapefruit

7

Apples

15

Bananas

56

Kiwis

19

Grapefruit

Apples

Bananas

Kiwis

7

15

56

19

Labels  

In addition to the color-coded legend, the pie chart can annotate each wedge with a label. The format of the label is controlled via the  Label Format  property.

For example, the format string used in the screenshot is " {0} = {2} ({3}) " This is a pattern string that uses the following placeholders:

 

  • {0}  - the item label
  • {1}  - the item value
  • {2}  - the item percentage
Properties
NameDescriptionProperty TypeScriptingCategory
3D Depth FactorThe depth of a 3D pie as a factor of the chart height.double.depthFactorAppearance
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.

The border is unaffected by rotation.

Border.borderCommon
Chart TitleAn optional title that will appear at the top of the chart.String.titleAppearance
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
DataThe data driving the chart.Dataset.dataData
Enforce Circularity?If true, the pie cannot be an oval, even if the overall chart is.boolean.circularAppearance
Extract OrderControls whether or not a pie plot views columns as pies, or rows.int.extractOrderData
Foreground TransparencyThe transparency of the pie (useful for 3D pies). Valid values are between 0 (0% opacity) and 1 (100% opacity).double.foregroundAlphaAppearance
Label FontThe font for labels items, if there are labels.Font.labelFontAppearance
Label FormatFormatting String. '{0}' is the wedge name, '{1}' is the value, '{2}' is the percent.String.labelFormatAppearance
Labels?Should labels be displayed near sections?boolean.labelsAppearance
Legend FontThe font for legend items, if there is a legend.Font.legendFontAppearance
Legend?Should there be an item legend below the chart?boolean.legendAppearance
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
Outline ColorsThe colors to use for the pie wedge outlines. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.Color[].outlineColorsAppearance
Outline Visible

The following feature is new in Ignition version 8.0.16
Click here to check out the other new features

 Whether to display an outline around the pie chart.

boolean.outlineVisibleAppearance
Outline StrokeThe width for the section outline stroke.float.outlineStrokeAppearance
Plot BackgroundThe background color for all plots, unless they override it. See Color Selector.Color.plotBackgroundAppearance
Plot Insets

The following feature is new in Ignition version 8.0.16
Click here to check out the other new features

 The padding to use around the actual plot rendering area.

int.plotInsetsAppearance
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
RotationDraw the wedges clockwise or counter-clockwise from the starting angle?int.rotationAppearance
Section ColorsThe colors to use for the pie wedge fills. See Color Selector.Color[].sectionColorsAppearance
Selected WedgeThe currently selected wedge. (Read only. Usable in bindings and scripting.)String.selectedDataUncategorized
Selection Enabled?If true, the user will be able to select wedges on the chart. The selected wedge will be highlighted, and the "selectedData" property will reflect it.boolean.selectionEnabledBehavior
Selection Highlight ColorThe color of the selection highlight. See Color Selector.Color.selectionHighlightColorAppearance
Selection Highlight WidthThe line width of the selection highlight.float.selectionHighlightWidthAppearance
Starting AngleThe start angle to draw the pie wedges.int.startAngleAppearance
StyleStyle of pie chart, standard, 3D, or ring.int.styleAppearance
Title FontThe font for the chart's title.Font.titleFontAppearance
Tooltip FormatFormatting String. '{0}' is the wedge name, '{1}' is the value, '{2}' is the percent.String.tooltipFormatAppearance
Tooltips?Should tooltips be displayed when the mouse hovers over sections?boolean.tooltipsBehavior
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
Scripting
 configureChart

The following feature is new in Ignition version 8.0.16
Click here to check out the other new features

  • Description

Provides an opportunity to perform further chart 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

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.

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

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

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

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

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

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

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

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.

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

Examples
Code Snippet
#The following code will print named and value of the selected wedge to the console.
#Alternatively, this can be used to write to a custom property of a table that is used to create the 'Where' clause of a SQL query that populates a table.

selectedWedge = event.source.selectedData
print selectedWedge
  • No labels