Pie Chart
Description
This document describes a list of attributes available to configure pie charts. A pie chart is a type of data visualization that displays data in the form of a circle. The circle is divided into segments, each representing a different category or value. The size of each segment is proportional to the value it represents.
Config Details
Preset Configuration
The preset configuration area is a common configuration for all visualizations. In this section the basic preset information can be filled such as the title and description for the wrapper configuration and the name and description for the preset itself.
| Ref No | Name | Description | Value | Recommended | Required |
|---|---|---|---|---|---|
| 1 | Preset | Defines which preset is currently selected. | Select option | - | Yes |
| 2 | Title | Defines the title of the wrapper configuration area. | No | ||
| 3 | Description | Defines the description of the wrapper configuration area. | Text Input | - | No |
| 4 | View Name | Defines the name for the view. The same name will be used for the preset. | Text Input | - | No |
| 5 | View Description | Defines the description for the view. | Text Input | - | No |
| 6 | Is Primary | Whether the preset is the default. | True, False | - | Yes |
Component Configuration
| Ref No | Name | Description | Value | Recommended | Required |
|---|---|---|---|---|---|
| 1 | Color Field | Defines the data field that will be used to determine the color category in the chart (the color of each slice in the chart). | Text input | - | Yes |
| 2 | Angle Field | Defines the data value field that will be shown in the chart (the value of each slice in the chart). | Text input | - | Yes |
| 3 | Multi | This option creates multiple instances of the chart based on a selected dimension, displaying separate charts for each value within that dimension. For example, if a time or period dimension is chosen, it will generate one chart for each time period, showing data breakdowns for the selected metric or category. This allows for easy comparison across multiple dimensions. Each value can be followed by the sorting order (separated by an empty space). The sorting order can be asc (ascending order) or desc (descending order) - e.g. "business_unit desc". If no sorting order is specified then it will be sorted in ascending order by default. | Array of text inputs | - | No |
| 4 | Category Field | This option is used when the data within the main series is further divided by an additional dimension. It identifies the dimension responsible for this sub-division, effectively acting as a second-level series. The Category Field is particularly useful for visualizing details that split the data but does not directly alter the chart's structure. For example, if the chart is grouped by "Business Unit" but further split by "Sales Region" or a combination like "Sales Region, Segment" the Category Field helps identify and differentiate these splits within the series. It can be an array of multiple values. | Array of text inputs | - | No |
| 5 | Sort By | Defines the data field that will be used to sort the data. It can be an array of multiple values. Each value can be followed by the sorting order (separated by an empty space). The sorting order can be asc (ascending order) or desc (descending order) - e.g. "business_unit desc". If no sorting order is specified then it will be sorted in ascending order by default. | Array of text inputs | - | No |
| 6 | Aggregate By | Defines the data field(s) that will be used to aggregate the data when the data has multiple dimension fields. It can be an array of multiple values. | Array of text inputs | - | No |
| 7 | Aggregate Metric | Defines the data value field that will be used when the data is being aggregated. | Text input | - | No |
| 8 | Aggregate Operation | Defines the type of operation used in the aggregation. | Sum, Average, Count, Standard Deviation | - | No |
| 9 | Show X Axis | Whether to render the X axis reference line and values. | True, False | - | No |
| 10 | Show Y Axis | Whether to render the Y axis reference line and values. | True, False | - | No |
| 11 | Show Label | Whether to render the value label. | True, False | - | No |
| 12 | Adjust Position | Whether to automatically adjust the chart data label position. | True, False | - | No |
| 13 | Hide Overlap | Whether to prevent label overlapping. | True, False | - | No |
| 14 | Adjust Color | Whether to automatically define label text color based on color contrast with the background color. | True, False | - | No |
| 15 | Limit In Shape | Whether the label should only be shown if the chart element is wide enough. | True, False | - | No |
| 16 | Show Legend | Whether the chart legend should be rendered. | True, False | - | No |
| 17 | Position | Defines the position of the legend. | Top, Bottom, Left, Right | - | No |
| 18 | Layout | Defines the legend orientation in the chart. | Horizontal, Vertical | - | No |
| 19 | Value Mask | Defines the mask to be applied to the metric field's value. If no value is specified then the NumberThousand mask will be applied by default. | NumberThousand, ThousandNoDigits, NumberFormatted, NumberOneDigit, NumberNoDigits, NumberTwoDigits, CurrencyThousand, CurrencyFormatted, CurrencyOneDigit, CurrencyTwoDigits, PercentileTwoDigits, PercentileNoDigits, PercentileOneDigit | - | No |
| 20 | Filter Data | Filters the data to only show positive or negative values or all values. If no value is specified then all values will be shown by default. | All, Positive, Negative | - | No |
| 21 | Chart Theme | Defines the visual theme and style applied to the chart. If no value is specified then the Standard theme will be applied by default. | Standard, Divergent, Single Hue | - | No |