Properties
dataStore
Type: any
Description: Data store object that can be used to store any data needed for the chart.
Default: {}
setupFinished
Type: Promise
Description: 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.
Default: ...
aggregationType
Type: Web
Description: Aggregation type for the pie chart.
alignDataLabels
Type: undefined | boolean
Description: Align data labels setting for the pie chart.
backgroundColor
Type: undefined | Color
Description: The background color of the chart.
category
Type: string
Description: Category field for the pie chart.
chartId
Type: undefined | string
Description: The chart ID.
chartRenderer
Type: any
Description: The chart renderer.
chartSubtitleVisibility
Type: boolean
Description: Whether or not the chart subtitle is visible.true: Chart subtitle is visible.false: Chart subtitle is hidden.
Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.
chartSubType
Type: Chart
Description: The chart sub type of the series.
chartTitleVisibility
Type: boolean
Description: Whether or not the chart title is visible.true: Chart title is visible.false: Chart title is hidden.
Note: Even if the title is visible, it may not be displayed if the title text is empty.
chartType
Type: Chart
Description: The chart type.
colorMatch
Type: boolean
Description: 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.
config
Type: Chart
Description: The current chart configuration object.
dataLabelsInside
Type: undefined | boolean
Description: Setting for placing the data labels inside of the slices.
dataLabelsOffset
Type: number
Description: Offset for the data labels.
dataLabelsSymbol
Type: undefined | Web
Description: Data labels text symbol (font, color, style).
dataLabelsVisibility
Type: boolean
Description: Whether data labels are visible.
true: visible, false: hidden.
decimalPlaces
Type: number
Description: Number of decimal places to display in the slice values.
descriptionSymbol
Type: undefined | Web
Description: The description text symbol. Contains styling information such as font, color, and symbol style.
descriptionText
Type: string
Description: The chart description text.
descriptionVisibility
Type: boolean
Description: Whether or not the chart description is visible.true: Description is visible.false: Description is hidden.
Note: Even if the description is visible, it may not be displayed if the description text is empty.
displayCategoryValueOnTooltip
Type: boolean
Description: Display category value on tooltip setting from the chart config.
displayNumericValueOnTooltip
Type: boolean
Description: Display numeric value on tooltip setting from the chart config.
displayPercentageOnTooltip
Type: boolean
Description: Display percentage on tooltip setting from the chart config.
displayType
Type: Pie
Description: Display type for the pie chart slices. Specifies whether to display the slices as a percentage, value, or both.
endAngle
Type: undefined | null | number
Description: End angle of the pie chart.
fetchNULLValues
Type: boolean
Description: Whether to fetch null values for them to be counted or displayed as categories on the chart.
groupedSliceIds
Type: string[]
Description: Array of grouped slice ids for the pie chart.
groupingThreshold
Type: number
Description: Threshold below which slices will be grouped.
innerRadiusSize
Type: number
Description: Inner radius size for the pie chart.
labelCharacterLimit
Type: null | number
Description: Character limit for the slice labels.
layer
Type: undefined | Supported
Description: The associated layer.
legendMaxHeight
Type: undefined | number
Description: Maximum legend height.
legendPosition
Type: Web
Description: Legend position: top, bottom, left, or right.
legendRoundMarker
Type: boolean
Description: Whether legend markers are rounded.
legendTextSymbol
Type: undefined | Web
Description: Legend item text symbol (font, color, style).
legendTitleSymbol
Type: undefined | Web
Description: Legend title text symbol (font, color, style).
legendTitleText
Type: string
Description: The legend title text.
legendTitleVisibility
Type: boolean
Description: Whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden.
legendVisibility
Type: boolean
Description: Whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden.
mode
Type: Pie
Description: The pie chart data mode (Category or Fields).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.
numericFields
Type: string | string[]
Description: Numeric fields for the pie chart.
optimizeDataLabelsOverlapping
Type: undefined | boolean
Description: Optimize data labels overlapping setting for the pie chart.
orderByList
Type: string[]
Description: No description.
orderOfSlices
Type: undefined | string[]
Description: Order of the slice array by returning an array of slice ids
percentagePrefix
Type: undefined | string
Description: Prefix of the percentages of the slices.
percentageSuffix
Type: undefined | string
Description: Suffix of the percentages of the slices.
seriesLength
Type: number
Description: The length of the series array.
sliceGrouping
Type: undefined | Web
Description: Slice grouping configuration for the pie chart.
slices
Type: undefined | Web
Description: Array of slices for the pie chart.
splitByValues
Type: string[]
Description: The split-by values for the chart.
startAngle
Type: undefined | null | number
Description: Start angle of the pie chart.
subtitleSymbol
Type: undefined | Web
Description: The subtitle text symbol. Contains styling information such as font, color, and symbol style.
subtitleText
Type: string
Description: The chart subtitle text.
ticksSymbol
Type: undefined | I
Description: Ticks symbol connecting slices to labels.
ticksVisibility
Type: boolean
Description: Visibility of the ticks.
titleSymbol
Type: undefined | Web
Description: The title text symbol. Contains styling information such as font, color, and symbol style.
titleText
Type: string
Description: The chart title text.
valuePrefix
Type: undefined | string
Description: Prefix of the values of the slices.
valueSuffix
Type: undefined | string
Description: Suffix of the values of the slice.
version
Type: undefined | string
Description: The version of the chart configuration.
Methods
generateChartTitle
Signature: generate
Description: Generate the proper chart title given the current config.
Returns: string
getCustomSortValues
Signature: get
Description: Gets the list of the category values for the chart.
Returns: Promise
Async: This method is async and must be awaited.
getDataFilters
Signature: get
Description: Gets the data filter for the bar chart.
Returns: undefined | Web
getDataTooltipReverseColor
Signature: get
Description: Gets the setting of the data property.
Parameters:
- Optional
series– The index of the series.Index : number
Returns: boolean
getDataTooltipValueFormat
Signature: get
Description: 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.
Parameters:
series– The index of the series to retrieve the value format for.Index : number
Returns: undefined | Number
getDataTooltipVisibility
Signature: get
Description: Gets the visibility of the data tooltips.
Parameters:
- Optional
series– The index of the series.Index : number
Returns: boolean
getDisplayNumericValue
Signature: get
Description: Gets the setting for the display of numerical value in the legend items.
Returns: boolean
getDisplayPercentage
Signature: get
Description: Gets the setting for the display of percentage in the legend items.
Returns: boolean
getLabelMaxWidth
Signature: get
Description: Gets the maximum width in pixel for the legend item labels.
Returns: number
getOriginalSliceName
Signature: get
Description: Gets the original name of the slice based on the slice index.
Parameters:
slice– No description.Index : number
Returns: undefined | null | string | number | Date
getSeriesId
Signature: get
Description: Gets the series ID for a given series index.
If the series index is out of bounds, this function will return undefined.
Parameters:
series– The index of the series.Index : number
Returns: undefined | string
getSeriesIndex
Signature: get
Description: Gets the series index for a given series ID.
If the series ID is not found, this function will return undefined.
Parameters:
series– No description.Id : string
Returns: undefined | number
getSeriesVisibility
Signature: get
Description: Gets the visibility of a series.
Parameters:
series– The series indexIndex : number
Returns: boolean
getSliceColor
Signature: get
Description: Gets the color of the slice based on the slice index. If the index is out of bounds, this function will return undefined.
Parameters:
slice– The index of the slice.Index : number
Returns: undefined | Color
getSliceId
Signature: get
Description: Gets the slice id for a given slice index. If the index is out of bounds, this function will return undefined.
Parameters:
slice– The index of the slice.Index : number
Returns: undefined | string
getSliceIndex
Signature: get
Description: Gets the slice index for a given slice id. If the slice is not found, this function will return undefined.
Parameters:
slice– The id of the slice.Id : string
Returns: undefined | number
getSliceName
Signature: get
Description: Gets the name of the slice based on the slice index. If the index is out of bounds, this function will return undefined.
Parameters:
slice– The index of the slice.Index : number
Returns: undefined | string
getSlicesLength
Signature: get
Description: Gets the length of the slices array.
Returns: number
getSortOrder
Signature: get
Description: Gets the sort order for the pie chart.
Returns: Pie
isSameChartAs
Signature: is
Description: Checks if the current chart model is for the same chart as another chart model.
Parameters:
other– The other chart model to compare to.Model : undefined | Chart Model
Returns: boolean
moveCustomSortValuesInOrderByList
Signature: move
Description: 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 custom.
Parameters:
from– The index to move the custom sort item from.Index : number to– The index to move the category item to.Index : number
Returns: void
moveSeries
Signature: move
Description: Moves a series from one index in the series array to another.
Parameters:
from– Index to move the series from.Index : number to– Index to move the series to.Index : number
Returns: void
resetAvailable
Signature: reset
Description: Returns whether the series styling is able to be reset.
Returns: boolean
resetSlices
Signature: reset
Description: Resets the slices styling to the default styling.
Returns: void
setDataFilters
Signature: set
Description: Shared method for all chart types.
Parameters:
new– No description.Data Filters : undefined | Web Chart Data Filters
Returns: Promise
Async: This method is async and must be awaited.
setDataTooltipReverseColor
Signature: set
Description: Sets the setting of the data property.
Parameters:
reverse– Indicator of whether to reverse the color.Color : boolean - Optional
series– The index of the series to set the reverse color.Index : number
Returns: void
setDataTooltipValueFormat
Signature: set
Description: Sets the data tooltip value format for a series.
Parameters:
series– The index of the series to set the value format for.Index : number value– The value format to set.Format : undefined | Number Format Options
Returns: void
setDataTooltipVisibility
Signature: set
Description: Sets the visibility of the data tooltips.
Parameters:
visibility– The visibility of the data tooltips.: boolean - Optional
series– The index of the series to set the visibility.Index : number
Returns: void
setDisplayNumericValue
Signature: set
Description: Sets the setting for the display of numerical value in the legend items.
Parameters:
display– The setting for the display of numerical value in the legend itemsNumeric Value : boolean
Returns: void
setDisplayPercentage
Signature: set
Description: Sets the setting for the display of percentage in the legend items.
Parameters:
display– The setting for the display of percentage in the legend itemsPercentage : boolean
Returns: void
setLabelMaxWidth
Signature: set
Description: Sets the maximum width in pixel for the legend item labels.
Parameters:
label– The maximum width in pixel for the legend item labelsMax Width : number
Returns: void
setSeriesVisibility
Signature: set
Description: Sets the visibility of a series.
Parameters:
props– No description.: Legend Item Visibility
Returns: void
setSliceColor
Signature: set
Description: Sets the color of the slice based on the slice index.
Parameters:
color– The color for the slice.: undefined | Color slice– The index of the slice.Index : number
Returns: void
setSliceName
Signature: set
Description: Sets name of the slice based on the slice index.
Parameters:
name– The name for the slice.: string slice– The index of the slice.Index : number
Returns: void
setSortOrder
Signature: set
Description: Sets the sort order for the pie chart.
Parameters:
sort– The sort order.Order : Pie Chart Data Sorting Kinds - Optional
order– No description.By List : string[]
Returns: void
setup
Signature: setup(params
Description: Completes the async setup process for the chart model. Must be called before using the model.
Parameters:
params– The parameters to be used to set up the chart model.: Model Params
Returns: Promise
Async: This method is async and must be awaited.