Pie Chart Model

NameDescription
emitConfigUpdate

Signature: emitConfigUpdate(functionCalled: string): void
Description: Emits a config update event.
Parameters:

  • functionCalled: string - No description.
Returns: void

generateDefaultConfig

Signature: generateDefaultConfig(): Promise
Description: A function that generates the default config object when creating a new chart.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

getAggregationType

Signature: getAggregationType(): WebChartStatisticType
Description: Gets the aggregation type for the pie chart.
Returns: WebChartStatisticType

getAlignDataLabels

Signature: getAlignDataLabels(): undefined | boolean
Description: Gets the align data labels setting for the pie chart.
Returns: undefined | boolean

getBackgroundColor

Signature: getBackgroundColor(): undefined | Color
Description: Gets the background color of the chart.
Returns: undefined | Color

getCategory

Signature: getCategory(): string
Description: Gets the category field for the pie chart.
Returns: string

getChartId

Signature: getChartId(): undefined | string
Description: Gets the chart id.
Returns: undefined | string

getChartRenderer

Signature: getChartRenderer(): any
Description: Gets the chart renderer.
Returns: any

getChartSubtitleVisibility

Signature: getChartSubtitleVisibility(): boolean
Description: Gets whether or not the chart subtitle is visible.true: Chart subtitle is visible.false: Chart subtitle is hidden.
Returns: boolean

getChartSubType

Signature: getChartSubType(): ChartSubType
Description: Gets the chart sub type of the series.
Returns: ChartSubType

getChartTitleVisibility

Signature: getChartTitleVisibility(): boolean
Description: Gets whether or not the chart title is visible.true: Chart title is visible.false: Chart title is hidden.
Returns: boolean

getChartType

Signature: getChartType(): ChartTypes
Description: Gets the chart type.
Returns: ChartTypes

getColorMatch

Signature: getColorMatch(): boolean
Description: Gets 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.
Returns: boolean

getConfig

Signature: getConfig(): ChartConfig
Description: Gets the current chart configuration object.
Returns: ChartConfig

getCustomSortValues

Signature: getCustomSortValues(): Promise
Description: Gets the list of the category values for the chart.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

getDataLabelsInside

Signature: getDataLabelsInside(): undefined | boolean
Description: Gets the setting for placing the data labels inside of the slices.
Returns: undefined | boolean

getDataLabelsOffset

Signature: getDataLabelsOffset(): number
Description: Gets the offset for the data labels.
Returns: number

getDataLabelsSymbol

Signature: getDataLabelsSymbol(): undefined | WebChartTextSymbol
Description: Gets the data labels text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getDataLabelsVisibility

Signature: getDataLabelsVisibility(): boolean
Description: Gets whether the data labels are visible.true: Data labels are visible.false: Data labels are hidden.
Returns: boolean

getDataTooltipReverseColor

Signature: getDataTooltipReverseColor(seriesIndex: number): boolean
Description: Gets the setting of the dataTooltipReverseColor property.
Parameters:

  • Optional seriesIndex: number - The index of the series.
Returns: boolean

getDataTooltipVisibility

Signature: getDataTooltipVisibility(seriesIndex: number): boolean
Description: Gets the visibility of the data tooltips.
Parameters:

  • Optional seriesIndex: number - The index of the series.
Returns: boolean

getDecimalPlaces

Signature: getDecimalPlaces(): number
Description: Gets the number of decimal places to display in the slice values.
Returns: number

getDescriptionSymbol

Signature: getDescriptionSymbol(): undefined | WebChartTextSymbol
Description: Gets the description text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getDescriptionText

Signature: getDescriptionText(): string
Description: Gets the chart description text.
Returns: string

getDescriptionVisibility

Signature: getDescriptionVisibility(): boolean
Description: Gets whether or not the chart description is visible.true: Description is visible.false: Description is hidden.
Returns: boolean

getDisplayCategoryValueOnTooltip

Signature: getDisplayCategoryValueOnTooltip(): boolean
Description: Gets the display category value on tooltip setting from the chart config.
Returns: boolean

getDisplayNumericValue

Signature: getDisplayNumericValue(): boolean
Description: Gets the setting for the display of numerical value in the legend items.
Returns: boolean

getDisplayNumericValueOnTooltip

Signature: getDisplayNumericValueOnTooltip(): boolean
Description: Gets the display numeric value on tooltip setting from the chart config.
Returns: boolean

getDisplayPercentage

Signature: getDisplayPercentage(): boolean
Description: Gets the setting for the display of percentage in the legend items.
Returns: boolean

getDisplayPercentageOnTooltip

Signature: getDisplayPercentageOnTooltip(): boolean
Description: Gets the display percentage on tooltip setting from the chart config.
Returns: boolean

getDisplayType

Signature: getDisplayType(): PieChartSlicesDisplay
Description: Gets the display type for the pie chart slices. Specifies whether to display the slices as a percentage, value, or both.
Returns: PieChartSlicesDisplay

getEndAngle

Signature: getEndAngle(): undefined | null | number
Description: Gets the end angle of the pie chart.
Returns: undefined | null | number

getFetchNULLValues

Signature: getFetchNULLValues(): boolean
Description: Gets whether to fetch null values for them to be counted or displayed as categories on the chart.
Returns: boolean

getGroupedSliceIds

Signature: getGroupedSliceIds(): string[]
Description: Gets the array of grouped slice ids for the pie chart.
Returns: string[]

getGroupingThreshold

Signature: getGroupingThreshold(): number
Description: Gets the threshold below which slices will be grouped.
Returns: number

getInnerRadiusSize

Signature: getInnerRadiusSize(): number
Description: Gets the inner radius size for the pie chart.
Returns: number

getLabelCharacterLimit

Signature: getLabelCharacterLimit(): null | number
Description: Gets the character limit for the slice labels.
Returns: null | number

getLabelMaxWidth

Signature: getLabelMaxWidth(): number
Description: Gets the maximum width in pixel for the legend item labels.
Returns: number

getLayer

Signature: getLayer(): undefined | SupportedLayer
Description: Gets the associated layer.
Returns: undefined | SupportedLayer

getLegendMaxHeight

Signature: getLegendMaxHeight(): undefined | number
Description: Gets the maximum height of the legend.
Returns: undefined | number

getLegendPosition

Signature: getLegendPosition(): WebChartLegendPositions
Description: Gets the legend position: top, bottom, left, or right.
Returns: WebChartLegendPositions

getLegendRoundMarker

Signature: getLegendRoundMarker(): boolean
Description: Gets the indicator for whether the legend markers should be rounded.
Returns: boolean

getLegendTextSymbol

Signature: getLegendTextSymbol(): undefined | WebChartTextSymbol
Description: Gets the legend text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getLegendTitleSymbol

Signature: getLegendTitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the legend title symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getLegendTitleText

Signature: getLegendTitleText(): string
Description: Gets the legend title text.
Returns: string

getLegendTitleVisibility

Signature: getLegendTitleVisibility(): boolean
Description: Gets whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden.
Returns: boolean

getLegendVisibility

Signature: getLegendVisibility(): boolean
Description: Gets whether the legend title is visible.true: Legend title is visible.false: Legend title is hidden.
Returns: boolean

getMode

Signature: getMode(): PieChartDataModes
Description: Gets 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.
Returns: PieChartDataModes

getNumericFields

Signature: getNumericFields(): string[]
Description: Gets the numeric fields for the pie chart.
Returns: string[]

getOptimizeDataLabelsOverlapping

Signature: getOptimizeDataLabelsOverlapping(): undefined | boolean
Description: Gets the optimize data labels overlapping setting for the pie chart.
Returns: undefined | boolean

getOrderByList

Signature: getOrderByList(): string[]
Description: No description.
Returns: string[]

getOrderOfSlices

Signature: getOrderOfSlices(): undefined | string[]
Description: Gets the order of the slice array by returning an array of slice ids
Returns: undefined | string[]

getOriginalSliceName

Signature: getOriginalSliceName(sliceIndex: number): undefined | null | string | number | Date
Description: Gets the original name of the slice based on the slice index.
Parameters:

  • sliceIndex: number - No description.
Returns: undefined | null | string | number | Date

getPercentagePrefix

Signature: getPercentagePrefix(): undefined | string
Description: Gets the prefix of the percentages of the slices.
Returns: undefined | string

getPercentageSuffix

Signature: getPercentageSuffix(): undefined | string
Description: Gets the suffix of the percentages of the slices.
Returns: undefined | string

getSeriesId

Signature: getSeriesId(seriesIndex: number): undefined | string
Description: Gets the series ID for a given series index.If the series index is out of bounds, this function will return undefined.
Parameters:

  • seriesIndex: number - The index of the series.
Returns: undefined | string

getSeriesIndex

Signature: getSeriesIndex(seriesId: string): undefined | number
Description: Gets the series index for a given series ID.If the series ID is not found, this function will return undefined.
Parameters:

  • seriesId: string - No description.
Returns: undefined | number

getSeriesLength

Signature: getSeriesLength(): number
Description: Gets the length of the series array.
Returns: number

getSeriesVisibility

Signature: getSeriesVisibility(seriesIndex: number): boolean
Description: Gets the visibility of a series.
Parameters:

  • seriesIndex: number - The series index
Returns: boolean

getSliceColor

Signature: getSliceColor(sliceIndex: number): undefined | Color
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:

  • sliceIndex: number - The index of the slice.
Returns: undefined | Color

getSliceGrouping

Signature: getSliceGrouping(): undefined | WebChartPieChartGroupSlice
Description: Gets the slice grouping configuration for the pie chart.
Returns: undefined | WebChartPieChartGroupSlice

getSliceId

Signature: getSliceId(sliceIndex: number): undefined | string
Description: Gets the slice id for a given slice index. If the index is out of bounds, this function will return undefined.
Parameters:

  • sliceIndex: number - The index of the slice.
Returns: undefined | string

getSliceIndex

Signature: getSliceIndex(sliceId: string): undefined | number
Description: Gets the slice index for a given slice id. If the sliceId is not found, this function will return undefined.
Parameters:

  • sliceId: string - The id of the slice.
Returns: undefined | number

getSliceName

Signature: getSliceName(sliceIndex: number): undefined | string
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:

  • sliceIndex: number - The index of the slice.
Returns: undefined | string

getSlices

Signature: getSlices(): undefined | WebChartPieChartSlice[]
Description: Gets the array of slices for the pie chart.
Returns: undefined | WebChartPieChartSlice[]

getSlicesLength

Signature: getSlicesLength(): number
Description: Gets the length of the slices array.
Returns: number

getSortOrder

Signature: getSortOrder(): PieChartDataSortingKinds
Description: Gets the sort order for the pie chart.
Returns: PieChartDataSortingKinds

getSplitByValues

Signature: getSplitByValues(): string[]
Description: Gets the split-by values for the chart.
Returns: string[]

getStartAngle

Signature: getStartAngle(): undefined | null | number
Description: Gets the start angle of the pie chart.
Returns: undefined | null | number

getSubtitleSymbol

Signature: getSubtitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getSubtitleText

Signature: getSubtitleText(): string
Description: Gets the chart subtitle text.
Returns: string

getTicksSymbol

Signature: getTicksSymbol(): undefined | ISimpleLineSymbol
Description: Gets the symbol for the ticks connecting the slices to the labels.
Returns: undefined | ISimpleLineSymbol

getTicksVisibility

Signature: getTicksVisibility(): boolean
Description: Gets the visibility of the ticks.
Returns: boolean

getTitleSymbol

Signature: getTitleSymbol(): undefined | WebChartTextSymbol
Description: Gets the title text symbol. Contains styling information such as font, color, and symbol style.
Returns: undefined | WebChartTextSymbol

getTitleText

Signature: getTitleText(): string
Description: Gets the chart title text.
Returns: string

getValuePrefix

Signature: getValuePrefix(): undefined | string
Description: Gets the prefix of the values of the slices.
Returns: undefined | string

getValueSuffix

Signature: getValueSuffix(): undefined | string
Description: Gets the suffix of the values of the slice.
Returns: undefined | string

getVersion

Signature: getVersion(): string
Description: Gets the version of the chart configuration.
Returns: string

isSameChartAs

Signature: isSameChartAs(otherModel: undefined | ChartModel): boolean
Description: Checks if the current chart model is for the same chart as another chart model.
Parameters:

  • otherModel: undefined | ChartModel - The other chart model to compare to.
Returns: boolean

loadConfigFromLayer

Signature: loadConfigFromLayer(params: ModelParams): Promise
Description: A function that loads the config based on the provided props.
Parameters:

  • params: ModelParams - No description.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

moveCustomSortValuesInOrderByList

Signature: moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void
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 customSort.
Parameters:

  • fromIndex: number - The index to move the custom sort item from.
  • toIndex: number - The index to move the category item to.
Returns: void

moveSeries

Signature: moveSeries(fromIndex: number, toIndex: number): void
Description: Moves a series from one index in the series array to another.
Parameters:

  • fromIndex: number - Index to move the series from.
  • toIndex: number - Index to move the series to.
Returns: void

resetAvailable

Signature: resetAvailable(): boolean
Description: Returns whether the series styling is able to be reset.
Returns: boolean

resetSlices

Signature: resetSlices(): void
Description: Resets the slices styling to the default styling.
Returns: void

setAggregationType

Signature: setAggregationType(aggregationType: WebChartStatisticType): Promise
Description: Sets the aggregation type for the pie chart.
Parameters:

  • aggregationType: WebChartStatisticType - The aggregation type. Must be one of the values allowed by WebChartStatisticType.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setAlignDataLabels

Signature: setAlignDataLabels(align: boolean): void
Description: Sets the align data labels setting for the pie chart.
Parameters:

  • align: boolean - The align data labels setting for the pie chart.
Returns: void

setBackgroundColor

Signature: setBackgroundColor(backgroundColor: undefined | Color): void
Description: Sets the background color of the chart.
Parameters:

  • backgroundColor: undefined | Color - The background color.
Returns: void

setCategory

Signature: setCategory(category: string): Promise
Description: Sets the category field for the pie chart.
Parameters:

  • category: string - The category field.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setChartId

Signature: setChartId(id: string): void
Description: Sets the chart id.
Parameters:

  • id: string - No description.
Returns: void

setChartRenderer

Signature: setChartRenderer(renderer: any): void
Description: Sets the chart renderer.
Parameters:

  • renderer: any - The chart renderer to set.
Returns: void

setChartSubtitleVisibility

Signature: setChartSubtitleVisibility(visibility: boolean): void
Description: Sets whether or not the chart subtitle is visible.true: Show chart subtitle.false: Hide chart subtitle.
Parameters:

  • visibility: boolean - The visibility state of the chart subtitle.Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.
Returns: void

setChartTitleVisibility

Signature: setChartTitleVisibility(visibility: boolean): void
Description: Sets whether or not the chart title is visible.true: Show chart title.false: Hide chart title.
Parameters:

  • visibility: boolean - The visibility state of the chart title.Note: Even if the title is visible, it may not be displayed if the title text is empty.
Returns: void

setColorMatch

Signature: setColorMatch(newColorMatch: boolean): void
Description: Sets 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.
Parameters:

  • newColorMatch: boolean - No description.
Returns: void

setConfig

Signature: setConfig(config: ChartConfig): void
Description: Sets the chart configuration object.
Parameters:

  • config: ChartConfig - The configuration object.
Returns: void

setDataLabelsInside

Signature: setDataLabelsInside(inside: boolean): void
Description: Sets the setting for placing the data labels inside of the slices.
Parameters:

  • inside: boolean - Whether to place the data labels inside of the slices
Returns: void

setDataLabelsOffset

Signature: setDataLabelsOffset(offset: number): void
Description: Sets the offset for the data labels.
Parameters:

  • offset: number - The offset for the data labels.
Returns: void

setDataLabelsSymbol

Signature: setDataLabelsSymbol(newDataLabelsSymbol: undefined | WebChartTextSymbol): void
Description: Sets the data labels text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • newDataLabelsSymbol: undefined | WebChartTextSymbol - No description.
Returns: void

setDataLabelsVisibility

Signature: setDataLabelsVisibility(newDataLabelsVisibility: boolean): void
Description: Sets the visibility of the data labels.true: Show data labels.false: Hide data labels.
Parameters:

  • newDataLabelsVisibility: boolean - No description.
Returns: void

setDataTooltipReverseColor

Signature: setDataTooltipReverseColor(reverseColor: boolean, seriesIndex: number): void
Description: Sets the setting of the dataTooltipReverseColor property.
Parameters:

  • reverseColor: boolean - Indicator of whether to reverse the color.
  • Optional seriesIndex: number - The index of the series to set the reverse color.
Returns: void

setDataTooltipVisibility

Signature: setDataTooltipVisibility(visibility: boolean, seriesIndex: number): void
Description: Sets the visibility of the data tooltips.
Parameters:

  • visibility: boolean - The visibility of the data tooltips.
  • Optional seriesIndex: number - The index of the series to set the visibility.
Returns: void

setDecimalPlaces

Signature: setDecimalPlaces(decimalPlaces: number): void
Description: Sets the number of decimal places to display in the slice values.
Parameters:

  • decimalPlaces: number - The decimal places.
Returns: void

setDescriptionSymbol

Signature: setDescriptionSymbol(descriptionSymbol: undefined | WebChartTextSymbol): void
Description: Sets the description text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • descriptionSymbol: undefined | WebChartTextSymbol - The description symbol.
Returns: void

setDescriptionText

Signature: setDescriptionText(description: string): void
Description: Sets the chart description text.
Parameters:

  • description: string - The description text.
Returns: void

setDescriptionVisibility

Signature: setDescriptionVisibility(visibility: boolean): void
Description: Sets whether or not the chart description is visible.true: Show description.false: Hide description.
Parameters:

  • visibility: boolean - The visibility state of the description.Note: Even if the description is visible, it may not be displayed if the description text is empty.
Returns: void

setDisplayCategoryOnTooltip

Signature: setDisplayCategoryOnTooltip(display: boolean): void
Description: Sets the display category value on tooltip setting in the chart config.
Parameters:

  • display: boolean - The boolean value to set the displayCategoryOnTooltip to
Returns: void

setDisplayNumericValue

Signature: setDisplayNumericValue(displayNumericValue: boolean): void
Description: Sets the setting for the display of numerical value in the legend items.
Parameters:

  • displayNumericValue: boolean - The setting for the display of numerical value in the legend items
Returns: void

setDisplayNumericValueOnTooltip

Signature: setDisplayNumericValueOnTooltip(display: boolean): void
Description: Sets the display numeric value on tooltip setting in the chart config.
Parameters:

  • display: boolean - The boolean value to set the displayNumericValueOnTooltip to
Returns: void

setDisplayPercentage

Signature: setDisplayPercentage(displayPercentage: boolean): void
Description: Sets the setting for the display of percentage in the legend items.
Parameters:

  • displayPercentage: boolean - The setting for the display of percentage in the legend items
Returns: void

setDisplayPercentageOnTooltip

Signature: setDisplayPercentageOnTooltip(display: boolean): void
Description: Sets the display percentage on tooltip setting in the chart config.
Parameters:

  • display: boolean - The boolean value to set the displayPercentageOnTooltip to
Returns: void

setDisplayType

Signature: setDisplayType(displayType: PieChartSlicesDisplay): void
Description: Sets the display type for the pie chart slices. Specifies whether to display the slices as a percentage, value, or both.
Parameters:

  • displayType: PieChartSlicesDisplay - The display type.
Returns: void

setEndAngle

Signature: setEndAngle(angle: number): void
Description: Sets the end angle for the pie chart.
Parameters:

  • angle: number - The end angle for the pie chart.
Returns: void

setFetchNULLValues

Signature: setFetchNULLValues(fetchNULLValues: boolean): void
Description: Sets whether to fetch null values for them to be counted or displayed as categories on the chart.
Parameters:

  • fetchNULLValues: boolean - Whether to fetch null values.
Returns: void

setGroupedSliceIds

Signature: setGroupedSliceIds(groupedSliceIds: string[]): void
Description: Sets the array of grouped slice ids for the pie chart.
Parameters:

  • groupedSliceIds: string[] - The grouped slice ids array.
Returns: void

setGroupingThreshold

Signature: setGroupingThreshold(threshold: number): void
Description: Sets the threshold below which slices will be grouped.
Parameters:

  • threshold: number - The grouping threshold.
Returns: void

setInnerRadiusSize

Signature: setInnerRadiusSize(size: number): void
Description: Sets the inner radius size for the pie chart.
Parameters:

  • size: number - The inner radius size.
Returns: void

setLabelCharacterLimit

Signature: setLabelCharacterLimit(limit: null | number): void
Description: Sets the character limit for the slice labels.
Parameters:

  • limit: null | number - The label character limit.
Returns: void

setLabelMaxWidth

Signature: setLabelMaxWidth(labelMaxWidth: number): void
Description: Sets the maximum width in pixel for the legend item labels.
Parameters:

  • labelMaxWidth: number - The maximum width in pixel for the legend item labels
Returns: void

setLegendMaxHeight

Signature: setLegendMaxHeight(maxHeight: number): void
Description: Sets the maximum height of the legend. If not set, the legend will occupy the same height as the series container or pie chart.
Parameters:

  • maxHeight: number - the maximum height for the legend
Returns: void

setLegendPosition

Signature: setLegendPosition(legendPosition: WebChartLegendPositions): void
Description: Sets the legend position; where the chart legend should be displayed, top, bottom, left, or right.
Parameters:

  • legendPosition: WebChartLegendPositions - No description.
Returns: void

setLegendRoundMarker

Signature: setLegendRoundMarker(roundMarker: boolean): void
Description: Sets the indicator for whether the legend markers should be rounded.
Parameters:

  • roundMarker: boolean - the round marker indicator
Returns: void

setLegendTextSymbol

Signature: setLegendTextSymbol(legendText: undefined | WebChartTextSymbol): void
Description: Sets the legend text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • legendText: undefined | WebChartTextSymbol - No description.
Returns: void

setLegendTitleSymbol

Signature: setLegendTitleSymbol(legendTitle: undefined | WebChartTextSymbol): void
Description: Sets the legend title symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • legendTitle: undefined | WebChartTextSymbol - No description.
Returns: void

setLegendTitleText

Signature: setLegendTitleText(legendTitleText: string): void
Description: Sets the legend title text.
Parameters:

  • legendTitleText: string - No description.
Returns: void

setLegendTitleVisibility

Signature: setLegendTitleVisibility(showLegendTitle: boolean): void
Description: Sets whether the legend title is visible.true: Show legend title.false: Hide legend title.
Parameters:

  • showLegendTitle: boolean - No description.
Returns: void

setLegendVisibility

Signature: setLegendVisibility(legendVisibility: boolean): void
Description: Sets whether the legend title is visible.true: Show legend title.false: Hide legend title.
Parameters:

  • legendVisibility: boolean - No description.
Returns: void

setMode

Signature: setMode(mode: PieChartDataModes): void
Description: Sets the pie chart data mode (Category or Fields).category - The chart should use values from the category field to determine each slice.fields - The chart should use aggregated values from the numeric fields to determine each slice.
Parameters:

  • mode: PieChartDataModes - The mode.
Returns: void

setNumericFields

Signature: setNumericFields(numericFields: string | string[]): Promise
Description: Sets the numeric field or numeric fields array for the pie chart.
Parameters:

  • numericFields: string | string[] - The numeric field or numeric fields array.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setOptimizeDataLabelsOverlapping

Signature: setOptimizeDataLabelsOverlapping(optimize: boolean): void
Description: Sets the optimize data labels overlapping setting for the pie chart.
Parameters:

  • optimize: boolean - The optimize data labels overlapping setting for the pie chart.
Returns: void

setOrderByList

Signature: setOrderByList(orderByList: string[]): void
Description: Sets the list of category's values for custom sort
Parameters:

  • orderByList: string[] - The list of category's values
Returns: void

setOrderOfSlices

Signature: setOrderOfSlices(order: string[]): void
Description: Sets the order of the slices array by providing an array of slice ids.
Parameters:

  • order: string[] - The order of the slices.
Returns: void

setPercentagePrefix

Signature: setPercentagePrefix(prefix: string): void
Description: Sets the prefix for the percentages of the slices.
Parameters:

  • prefix: string - The prefix for the percentages of the slices.
Returns: void

setPercentageSuffix

Signature: setPercentageSuffix(suffix: string): void
Description: Sets the suffix for the percentages of the slices.
Parameters:

  • suffix: string - The suffix for the percentages of the slices.
Returns: void

setSeriesVisibility

Signature: setSeriesVisibility(props: LegendItemVisibility): void
Description: Sets the visibility of a series.
Parameters:

  • props: LegendItemVisibility - No description.
Returns: void

setSliceColor

Signature: setSliceColor(color: undefined | Color, sliceIndex: number): void
Description: Sets the color of the slice based on the slice index.
Parameters:

  • color: undefined | Color - The color for the slice.
  • sliceIndex: number - The index of the slice.
Returns: void

setSliceGrouping

Signature: setSliceGrouping(sliceGrouping: undefined | WebChartPieChartGroupSlice): void
Description: Sets the slice grouping configuration for the pie chart.
Parameters:

  • sliceGrouping: undefined | WebChartPieChartGroupSlice - The slice grouping configuration.
Returns: void

setSliceName

Signature: setSliceName(name: string, sliceIndex: number): void
Description: Sets name of the slice based on the slice index.
Parameters:

  • name: string - The name for the slice.
  • sliceIndex: number - The index of the slice.
Returns: void

setSlices

Signature: setSlices(slices: undefined | WebChartPieChartSlice[]): void
Description: Sets the array of slices for the pie chart.
Parameters:

  • slices: undefined | WebChartPieChartSlice[] - The slices array.
Returns: void

setSortOrder

Signature: setSortOrder(sortOrder: PieChartDataSortingKinds, orderByList: string[]): void
Description: Sets the sort order for the pie chart.
Parameters:

  • sortOrder: PieChartDataSortingKinds - The sort order.
  • Optional orderByList: string[] - No description.
Returns: void

setStartAngle

Signature: setStartAngle(angle: number): void
Description: Sets the start angle for the pie chart.
Parameters:

  • angle: number - The start angle for the pie chart.
Returns: void

setSubtitleSymbol

Signature: setSubtitleSymbol(subtitleSymbol: undefined | WebChartTextSymbol): void
Description: Sets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • subtitleSymbol: undefined | WebChartTextSymbol - The title symbol.
Returns: void

setSubtitleText

Signature: setSubtitleText(subtitle: string): void
Description: Sets the chart subtitle text.
Parameters:

  • subtitle: string - The subtitle text.
Returns: void

setTicksSymbol

Signature: setTicksSymbol(lineSymbol: undefined | ISimpleLineSymbol): void
Description: Sets the symbol for the ticks connecting the slices to the labels.
Parameters:

  • lineSymbol: undefined | ISimpleLineSymbol - The ticks symbol.
Returns: void

setTicksVisibility

Signature: setTicksVisibility(visibility: boolean): void
Description: Sets the visibility of the ticks.
Parameters:

  • visibility: boolean - The visibility setting for the ticks.
Returns: void

setTitleSymbol

Signature: setTitleSymbol(titleSymbol: undefined | WebChartTextSymbol): void
Description: Sets the title text symbol. Contains styling information such as font, color, and symbol style.
Parameters:

  • titleSymbol: undefined | WebChartTextSymbol - The title symbol.
Returns: void

setTitleText

Signature: setTitleText(title: string): void
Description: Sets the chart title text.
Parameters:

  • title: string - The title text.
Returns: void

setup

Signature: setup(params: ModelParams): Promise
Description: Completes the async setup process for the chart model. Must be called before using the model.
Parameters:

  • params: ModelParams - The parameters to be used to set up the chart model.
Returns: Promise
Async: This method is async and must be awaited for the changes to take effect.

setValuePrefix

Signature: setValuePrefix(prefix: string): void
Description: Sets the prefix for the values of the slices.
Parameters:

  • prefix: string - The prefix for the values of the slices.
Returns: void

setValueSuffix

Signature: setValueSuffix(suffix: string): void
Description: Sets the suffix for the values of the slices.
Parameters:

  • suffix: string - The suffix for the values of the slices.
Returns: void

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.