Pie chart SDS
Generates a pie chart for a data set, with the option to add drill-down trees for
additional data sets. You must populate the data set by using a service.
Restriction
The Pie chart must be populated by using a service.
Note: If you encounter sizing problems when you display
the chart in a collapsible panel, use the following code on the On expand event
of the collapsible panel to adjust the chart size to the available space:
${CHART_CONTROL_ID}.refresh();
Configuration properties
Under Configuration, set or modify the appearance and behavior properties for the view.
- 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.
- Theme definitions
- Theme definitions specify the colors and styles for a view and determine its appearance. You can preview the look and feel of views in the theme editor. See Themes.
The appearance configuration properties for the Pie chart SDS view are shown in the following
table:
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 |
Data series custom color style | Customize the color style for the data series.
In the NameValuePair , Name is the datapoint label and
Value is the color specified as name, hexadecimal code, or RGB code. For example,
red , #ff0000 , rgb(255, 0, 0) . The property takes precedence over Data series color style. |
NameValuePair (List) |
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 |
Legend placement | The position of the legend for the chart. | String |
Border radius | The radius of the chart. | 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 Pie chart SDS view are shown in the following
table:
For information on drill-down
trees that you can use with your charts, see Drill-down trees.
Behavior configuration property | Description | Data type |
---|---|---|
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 |
Data service | A service that populates the data series. | Ajax service |
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. |
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 |
Show tooltip | When this option is enabled, hovering over data points in the chart with the mouse causes a tooltip to appear. The tooltip shows both the name of the point and its value. | Boolean |
Events
Set or modify the event handlers for the view in the Events properties. You can set events to be triggered programmatically or when a user interacts with the view. For information about how to define and code events, see User-defined events.The Pie chart SDS view 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)
Keyboard navigation
To navigate charts using the keyboard:
- Press
Tab
until the chart that you want is highlighted. - Press
Tab
to get focus inside the chart. - Use the right, left, up or down arrow keys to navigate within the chart. Note: To navigate the chart as described, you must use the JAWS screen reader.
Methods
For information about the methods for Pie SDS Chart, see the Pie chart SDS JavaScript API.
Additional resources
For information about how to create a coach or page, see Building coaches.
For information about standard properties
(General, Configuration,
Positioning, Visibility, and HTML
Attributes), see View properties.