Skip to end of metadata
Go to start of metadata

 

Description

A component that displays a pie chart with drill down capabilities. This extends from the Bar Chart Component Component Ignition Bar Chart Icon that comes with Ignition.

Properties
NameScriptingCategoryProperty TypeDescription
DatadataDataDataSetThe data driving the chart.
Drill Down OptionsdrillDownOptionsDataDataSetDataset with drill down options.
Previous Drill Down EnabledpreviousDrillDownEnabledDataBooleanIf true, show previous in drill down menu.
Chart TitletitleAppearanceStringAn optional title that will appear at the top of the chart.
Value Axis LabelvalueLabelAxesStringThe label for the value axis.
Value Axis Label formatvalueLabelFormatAxesStringThe label format for the value axis.
Category Axis LabelcategoryLabelAxesStringThe 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 BoundvalAxisLowerBoundAxesFloat8The lower bound of the value axis. Used only when auto-range is false.
Value Axis Upper BoundvalAxisUpperBoundAxesFloat8The 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 OffsetbarLabelOffsetAxesFloat8The 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.
Category Axis Tick ColorcatAxisTickColorAxesColorThe color for the category axis' ticks.
Value Axis Upper MarginvalAxisUpperMarginAxesFloat8The upper margin, as a percentage, of the value axis. Only used when auto-range is true.
Category Axis Upper MargincatAxisUpperMarginAxesFloat8The upper margin, as a percentage, of the category axis.
Category Axis Lower MargincatAxisLowerMarginAxesFloat8The lower margin, as a percentage, of the category axis.
Chart BackgroundchartBackgroundAppearanceColorThe backgroud color // for the chart.
Plot BackgroundplotBackgroundAppearanceColorThe backgroud color for the plot.
Series ColorsseriesColorsAppearanceColorThe sequence of colors used for series in the bar chart.
Legend?legendAppearanceBooleanShould there be an item legend below the chart?
Tooltips?tooltipsBehaviorBooleanShould tooltips be displayed when the mouse hovers over sections?
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 TransparencyforegroundAlphaAppearanceFloat4The transparency of the pie.
Category MargincategoryMarginAppearanceFloat8The marign between categories as a fraction of the total space.
Item MarginitemMarginAppearanceFloat8The margin between bars in a category as a fraction.
Category Date FormatcategoryDateFormatDataStringFormat the category if it is a date.
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
 drillDown
 drillDown

Is fired when drill down menu item is selected. Excludes the "Back" menu item.

PropertyDescription
sourceThe component that fired this event.
drillDownNameText of selected drill down option menu item.
categoryValue of first column for the selected row.
 back
PropertyDescription
sourceThe component that fired this event.
drillDownNameText of selected drill down option menu item.
categoryValue of first column for the selected row.
 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

When the user clicks on a bar of the bar chart, the drill down menu will appear. When an item in the drill down menu is clicked on, the drillDown event is fired. Script in the drillDown event is responsible for updating the Data property to change the results shown in the bar chart. The drill down menu information is set through the Drill Down Options property. The Drill Down Options can be populated from the Analysis Controller, Analysis Selector, SQL Query, scripting or it can be manually defined in the designer.

 

Component Bar Chart

Production Bar Chart

 

 

 

 

  • No labels