pie-chart-model

Aggregation type for the pie chart.

Align the data labels on the left or right side of the chart instead of the default position around the chart.

Promise that resolves when the setup process is complete.

Note: This promise does not need to be awaited if the setup method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.

The background color of the chart.

Category field for the pie chart.

The chart ID.

The chart renderer.

Whether or not the chart subtitle is visible.

Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.

The chart sub type of the series.

Whether or not the chart title is visible.

Note: Even if the title is visible, it may not be displayed if the title text is empty.

The chart type.

Whether the chart should attempt to match the data source's colors.

true: Attempt to match the data source's colors. false: Use the colors defined in the config.

The current chart configuration object.

Setting for placing the data labels inside of the slices.

Offset for the data labels.

Data labels text symbol (font, color, style).

Whether data labels are visible.

Data store object that can be used to store any data needed for the chart.

Number of decimal places to display in the slice values.

The description text symbol. Contains styling information such as font, color, and symbol style.

Whether or not the chart description is visible.

Note: Even if the description is visible, it may not be displayed if the description text is empty.

Whether to display the category in the legend.

Whether to display the category on the data label. Note: If the setting is not found in the config, it will default to true.

Display category value on tooltip setting from the chart config.

Note: If the setting is not found in the config, it will default to true.

Whether to display the numeric value on the data label. Note: If the setting is not found in the config, it will default to true.

Display numeric value on tooltip setting from the chart config.

Note: If the setting is not found in the config, it will default to true.

Whether to display the percentage on the data label.

Note: If the setting is not found in the config, it will default to true.

Display percentage on tooltip setting from the chart config.

Note: If the setting is not found in the config, it will default to true.

Display type for the pie chart slices. Specifies whether to display the slices as a percentage, value, or both.

End angle of the pie chart.

Whether to fetch null values for them to be counted or displayed as categories on the chart.

Array of grouped slice ids for the pie chart.

Threshold below which slices will be grouped.

Inner radius size for the pie chart.

Character limit for the slice labels.

The chart model's layer.

Maximum legend height.

Legend position: top, bottom, left, or right.

Whether legend markers are rounded.

Legend item text symbol (font, color, style).

Legend title text symbol (font, color, style).

The legend title text.

Whether the legend title is visible.

Whether the legend title is visible.

The pie chart data mode.

category - The chart is using values from the category field to determine each slice. fields - The chart is using aggregated values from the numeric fields to determine each slice.

Numeric fields for the pie chart.

Optimize data labels overlapping setting for the pie chart.

List of category's values for custom sort.

Order of the slice array by returning an array of slice ids

Prefix of the percentages of the slices.

Suffix of the percentages of the slices.

The length of the series array.

Slice grouping configuration for the pie chart.

Array of slices for the pie chart.

The split-by values for the chart.

Start angle of the pie chart.

The subtitle text symbol. Contains styling information such as font, color, and symbol style.

The chart subtitle text.

Ticks symbol connecting slices to labels.

Visibility of the ticks.

The title text symbol. Contains styling information such as font, color, and symbol style.

The chart title text.

The maximum width in pixel for the legend value labels.

Prefix of the values of the slices.

Suffix of the values of the slice.

The version of the chart configuration.

Generate the proper chart title given the current config.

Gets the list of the category values for the chart.

Gets the data filter for the bar chart.

Gets the setting of the dataTooltipReverseColor property.

• If the seriesIndex is provided, the dataTooltipReverseColor for that series will be returned. Otherwise, the same property of the first series will be returned.
• If the dataTooltipReverseColor is not set on the series, the default value of false will be returned.

Gets the data tooltip value format for a series.

If the series index is out of bounds or the series list is empty, this function will return undefined.

Gets the visibility of the data tooltips.

• If the seriesIndex is provided, the visibility for that series will be returned. Otherwise, the visibility of the first series will be returned.
• If the visibility is not set on the series, the default value of true will be returned.

Gets the setting for the display of numerical value in the legend items.

Note: Only applicable to pie charts.

Gets the setting for the display of percentage in the legend items.

Note: Only applicable to pie charts.

Gets the maximum width in pixel for the legend item labels.

Note: Only applicable to pie charts.

Gets the original name of the slice based on the slice index.

Gets the series ID for a given series index. If the series index is out of bounds, this function will return undefined.

Gets the series index for a given series ID. If the series ID is not found, this function will return undefined.

Gets the visibility of a series.

Gets the color of the slice based on the slice index. If the index is out of bounds, this function will return undefined.

Gets the slice id for a given slice index. If the index is out of bounds, this function will return undefined.

Gets the slice index for a given slice id. If the sliceId is not found, this function will return undefined.

Gets the name of the slice based on the slice index. If the index is out of bounds, this function will return undefined.

Gets the length of the slices array.

Gets the sort order for the pie chart.

Checks if the current chart model is for the same chart as another chart model.

Moves the custom sort values in-place for the order by list in the config. Note: This method should be only used when the sort order is set to customSort.

Moves a series from one index in the series array to another.

Returns whether the series styling is able to be reset.

Resets the slices styling to the default styling.

Sets the data filter for the chart.

Sets the setting of the dataTooltipReverseColor property.

• If the seriesIndex is provided, the reverse color will be set for that series only. Otherwise, the reverse color will be set for all series.

Sets the data tooltip value format for a series.

Sets the visibility of the data tooltips.

• If the seriesIndex is provided, the visibility will be set for that series only. Otherwise, the visibility will be set for all series.

Sets the setting for the display of numerical value in the legend items.

Note: Only applicable to pie charts.

Sets the setting for the display of percentage in the legend items.

Note: Only applicable to pie charts.

Sets the maximum width in pixel for the legend item labels.

Note: Only applicable to pie charts.

Sets the visibility of a series.

Sets the color of the slice based on the slice index.

Sets name of the slice based on the slice index.

Sets the sort order for the pie chart.

Completes the async setup process for the chart model. Must be called before using the model.

Can be awaited to allow any pending async updates to complete.