Multi Purpose Chart control

The Multi Purpose Chart displays data in a chart on a coach with the option to add drill down trees for presenting additional data sets. You can display either a single data series, or overlay the chart with multiple data series.

Restriction

The Multi Purpose Chart must be populated by using a service flow with appropriate Ajax access.

Configuration properties

Set or modify configuration properties for the control, such as appearance and behavior properties, in the Configuration properties tab.

Screen size: A configuration property that has the Screen Sizes icon beside the property name can have different values for each screen size. If you do not set a value, the screen size inherits the value of the next larger screen size as its default value. If you are using the Process Designer desktop editor, you are setting the value for the large screen size. The other screen sizes inherit this value.

Theme definitions: Theme definitions specify the colors and styles for a control and determine the appearance of the control. You can preview the look and feel of controls in the theme editor. See Themes.

The appearance configuration properties for the Multi Purpose Chart control are shown in the following table:

Table 1. Appearance configuration properties for the Multi Purpose Chart control
Appearance configuration property	Description	Data type
Background color style	The color style for the background color.	`String`
Data series color style	The color style for the data series.	`String`
Show value labels	Display data point values above each point in the chart.	`Boolean`
Show breadcrumbs	When this option is enabled, the title shows the current position of the tree that the user can drill down into (depending on the menu selection).	`Boolean`
Point size	The size of the dot that marks the value. Default: 2.5 pixels.	`Decimal`
XY Axis color style	The color style for the X and Y axes.	`String`
Gridlines style	The style for the horizontal gridlines.	`String`
Legend placement	The position of the legend for the chart.	`String`
X label rotation	The rotation in degrees for the X-axis label.	`Decimal`
Border radius	The radius of the chart. You can set this property for pie and donut charts.	`String`
Padding	The padding for the right, top, left, and bottom of the chart (in pixels).	`String`
Height	The height of the chart.	`Integer`

The behavior configuration properties for the Multi Purpose Chart control are shown in the following table:

Table 2. Behavior configuration properties for the Multi Purpose Chart control
Behavior configuration property	Description	Data type
Single data service	A service that populates the data series.	`Ajax service`
Single data series	The `seriesName` is the name for the data series and `dataPoints` is the list of data points to include in the data series.	`String` for the `seriesName` and `DataPoint[]` for the list of `dataPoints`.
Multi data service	A multi-data series service that populates the chart data.	`Ajax service`
Multi data series	A multi-data series to populate the chart. The `seriesName` is the name for the data series and `dataPoints` is the list of data points to include in the data series.	`String` for the `seriesName` and `DataPoint[]` for the list of `dataPoints`.
Show multi-data series	Overlay multiple data series.	`Boolean`
Chart data mode	Select whether to populate chart data from a service or from the configuration option. Note that trees users can drill down into are available only by populating through a service flow with appropriate Ajax access.	`String`
Enable menu	Enables the visibility of the menu. The menu is required if you have a tree that users can drill down into, or if you added menus.	`Boolean`
Number of Y axis ticks	The maximum number of ticks on the Y axis.	`Integer`
Y axis tick precision	The number of decimal places to display for Y-axis value labels. The default number of decimal places is 0.	`Integer`
Min Y axis value	The minimum value on the Y axis.	`Decimal`
Max Y axis value	The maximum value on the Y axis.	`Decimal`
Use X axis culling	Show only the number of X-axis data tick counts, which is determined by the value of the Max X tick count property.	`Boolean`
Max X tick count	The maximum number of ticks on the X axis.	`Integer`
Tooltip style	Display tooltips.	`String`

Events

Set or modify the event handlers for the control in the Events tab. You can set events to be triggered programmatically or when a user interacts with the control. For information about how to define and code events, see User-defined events. The Multi Purpose Chart control has the following types of event handlers:

On load: Activated when the chart is loaded, for example,
```
me.defocusSeries("Brand1")
```
On refreshed: Activated when the chart is refreshed, for example,
```
me.focusSeries("Brand1")
```
On click: Activated when the chart is clicked, for example,
```
me.transform("donut", ["Brand1","Brand2"])
```

On menu action: Activated when a menu action is detected, for example,

console.log("Running menu action '" + action.name + "' on " + me.getSelectedDataPoint().label + " with value of " + me.getSelectedDataPoint().value)

Methods

For information about the methods for the Multi Purpose Chart control, see the JavaScript documentation.

Additional resources

For information about how to create a coach, see Building coaches.
For information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see Coach view properties.