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 Pie Chart Component Component Ignition Pie 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.
Plot BackgroundplotBackgroundAppearanceColorThe backgroud color for all plots, unless they override it.
Section ColorssectionColorsAppearanceColor[]The colors to use for the pie wedge fills.
Outline ColorsoutlineColorsAppearanceColor[]The colors to use for the pie wedge outlines.
Outline StrokeoutlineStrokeAppearancefloatThe width for the section outline stroke.
Legend?legendAppearancebooleanShould there be an item legend below the chart?
Tooltips?tooltipsBehaviorbooleanShould tooltips be displayed when the mouse hovers over sections?
Labels?labelsAppearancebooleanShould labels be displayed near sections?
Label FormatlabelFormatAppearanceStringFormatting String. '{0}' is the wedge name, '{1}' is the value, '{2}' is the percent.
Tooltip FormattooltipFormatAppearanceStringFormatting String. '{0}' is the wedge name, '{1}' is the value, '{2}' is the percent.
Legend FontlegendFontAppearanceFontThe font for legend items, if there is a legend.
Label FontlabelFontAppearanceFontThe font for labels items, if there are labels.
Starting AnglestartAngleAppearanceintThe start angle to draw the pie wedges.
Enforce Circularity?circularAppearancebooleanIf true, the pie cannot be an oval, even if the overall chart is.
3D?threeDimensionalAppearancebooleanDeprecated. Use Style property instead.
Foreground TransparencyforegroundAlphaAppearancedoubleThe transparency of the pie.
3D Depth FactordepthFactorAppearanceFloat8The depth of a 3D pie as a factor of the chart height.
Selection Highlight ColorselectionHighlightColorAppearanceColorThe color of the selection highlight.
Selection Highlight WidthselectionHighlightWidthAppearancefloatThe line width of the selection highlight.
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.
Customizers

This component does not have any custom properties.

Examples

When the user clicks on a segment of the pie 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 pie 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 Pie Chart

Production Pie Chart

 

 

 

  • No labels