@arcgis/charts-components 4.33.0-next.94 → 4.33.0-next.96

package/dist/model/mixins/utils/line-marker-styling.d.ts

@@ -0,0 +1,118 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { Color, RESTSimpleLineSymbolStyle, RESTSimpleMarkerSymbolStyle, WebChartLineChartSeries, WebChartRadarChartSeries } from '@arcgis/charts-spec';
+type LineChartSeries = WebChartLineChartSeries | WebChartRadarChartSeries;
+export declare const getLineStyle: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => RESTSimpleLineSymbolStyle | undefined;
+export declare const setLineStyle: (newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number, config: ChartConfig<LineChartSeries>) => void;
+export declare const getLineWidth: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => number | undefined;
+export declare const setLineWidth: (newWidth: number | undefined, seriesIndex: number, config: ChartConfig<LineChartSeries>) => void;
+export declare const getMarkerColor: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => Color | undefined;
+export declare const setMarkerColor: (newColor: Color | undefined, seriesIndex: number, config: ChartConfig<LineChartSeries>) => void;
+export declare const getMarkerStyle: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => RESTSimpleMarkerSymbolStyle | undefined;
+export declare const setMarkerStyle: (newStyle: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex: number, config: ChartConfig<LineChartSeries>) => void;
+export declare const getMarkerSize: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => number | undefined;
+export declare const setMarkerSize: (newSize: number | undefined, seriesIndex: number, config: ChartConfig<LineChartSeries>) => void;
+/**
+ * Specify whether line segments of the series should be smoothed.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<WebChartLineChartSeries>} config - The chart configuration.
+ *
+ * @default false
+ * @returns {boolean}
+ */
+export declare const isLineSmoothed: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => boolean;
+/**
+ * Specify whether line segments of the series should be smoothed.
+ * @param {boolean} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+ * @param {number} props.seriesIndex - The index of the series.
+ * @param {ChartConfig<WebChartLineChartSeries>} props.config - The chart configuration.
+ */
+export declare const setLineSmoothed: (props: {
+    smoothed: boolean;
+    seriesIndex: number;
+    config: ChartConfig<LineChartSeries>;
+}) => void;
+/**
+ * Specify whether the line series should show area.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<WebChartLineChartSeries>} config - The chart configuration.
+ *
+ * @default false
+ * @returns {boolean}
+ */
+export declare const isAreaVisible: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => boolean;
+/**
+ * Specify whether the line series should show area.
+ * @param {boolean} props.visible - `true` if the line series should show area, `false` otherwise.
+ * @param {number} props.seriesIndex - The index of the series.
+ * @param {ChartConfig<WebChartLineChartSeries>} props.config - The chart configuration.
+ */
+export declare const setAreaVisible: (props: {
+    visible: boolean;
+    seriesIndex: number;
+    config: ChartConfig<LineChartSeries>;
+}) => void;
+/**
+ * Indicate whether to show or hide the markers/bullets of the line series.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<WebChartLineChartSeries>} config - The chart configuration.
+ *
+ * @default true
+ * @returns {boolean}
+ */
+export declare const isMarkerVisible: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => boolean;
+/**
+ * Indicate whether to show or hide the markers/bullets of the line series.
+ * @param {boolean} props.visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+ * @param {number} props.seriesIndex - The index of the series.
+ * @param {ChartConfig<WebChartLineChartSeries>} props.config - The chart configuration.
+ */
+export declare const setMarkerVisible: (props: {
+    visible: boolean;
+    seriesIndex: number;
+    config: ChartConfig<LineChartSeries>;
+}) => void;
+/**
+ * Specify the color of the filled area for line chart.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<LineChartSeries>} config - The chart configuration.
+ *
+ * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+ *
+ * @returns {Color | undefined}
+ */
+export declare const getAreaColor: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => Color | undefined;
+/**
+ * Specify the color of the filled area for line chart.
+ * @param {Color | undefined} props.color - The color of the filled area for line chart.
+ * @param {number} props.seriesIndex - The index of the series.
+ * @param {ChartConfig<WebChartLineChartSeries>} props.config - The chart configuration.
+ *
+ * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+ */
+export declare const setAreaColor: (props: {
+    color: Color | undefined;
+    seriesIndex: number;
+    config: ChartConfig<LineChartSeries>;
+}) => void;
+/**
+ * Specify whether to connect the lines when there's a gap in the data.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<LineChartSeries>} config - The chart configuration.
+ *
+ * @returns {boolean | undefined}
+ */
+export declare const getConnectLines: (seriesIndex: number, config: ChartConfig<LineChartSeries>) => boolean | undefined;
+/**
+ * Specify whether to connect the lines when there's a gap in the data.
+ * @param {boolean | undefined} props.connect - Whether to connect the gap in the data
+ * @param {number} props.seriesIndex - The index of the series.
+ * @param {ChartConfig<LineChartSeries>} props.config - The chart configuration.
+ *
+ * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
+ */
+export declare const setConnectLines: (props: {
+    connect: boolean | undefined;
+    seriesIndex: number;
+    config: ChartConfig<LineChartSeries>;
+}) => void;
+export {};

package/dist/model/mixins/utils/temporal-binning.d.ts

@@ -0,0 +1,73 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { WebChartFixedDateBinningUnits, WebChartNullPolicyTypes, WebChartTimeAggregationTypes, WebChartTemporalBinningTypes } from '@arcgis/charts-spec';
+/**
+ * Gets the date binning type.
+ * @param config The chart configuration.
+ */
+export declare const getTemporalBinningType: (config: ChartConfig) => WebChartTemporalBinningTypes | undefined;
+/**
+ * Gets the time interval size.
+ * @param config The chart configuration.
+ */
+export declare const getTemporalBinningSize: (config: ChartConfig) => number | undefined;
+/**
+ * Gets the time interval units.
+ * @param config The chart configuration.
+ */
+export declare const getTemporalBinningUnit: (config: ChartConfig) => WebChartFixedDateBinningUnits | undefined;
+/**
+ * Gets the time aggregation type.
+ * @param config The chart configuration.
+ */
+export declare const getTimeAggregationType: (config: ChartConfig) => WebChartTimeAggregationTypes | undefined;
+/**
+ * Gets whether to trim incomplete time interval.
+ * @param config The chart configuration.
+ */
+export declare const getTrimIncompleteTimeInterval: (config: ChartConfig) => boolean | undefined;
+/**
+ * Gets the null policy.
+ * @param config The chart configuration.
+ */
+export declare const getNullPolicy: (config: ChartConfig) => WebChartNullPolicyTypes | undefined;
+/**
+ * Sets the temporal binning type.
+ * @param type The new value for the date binning type.
+ * @param config The chart configuration.
+ */
+export declare const setTemporalBinningType: (type: WebChartTemporalBinningTypes, config: ChartConfig) => void;
+/**
+ * Sets the time interval size by updating the config accordingly.
+ * @param newBinCount The new value for the interval size.
+ * @param config The chart configuration.
+ */
+export declare const setTemporalBinningSize: (newBinCount: number | undefined, config: ChartConfig) => void;
+/**
+ * Sets the null policy by updating the config accordingly.
+ * @param newNullPolicy The new value for the null policy.
+ * @param config The chart configuration.
+ */
+export declare const setNullPolicy: (newNullPolicy: WebChartNullPolicyTypes | undefined, config: ChartConfig) => void;
+/**
+ * Sets the time interval units by updating the config accordingly.
+ * @param newUnit The new value for the interval units.
+ * @param config The chart configuration.
+ */
+export declare const setTemporalBinningUnit: (newUnit: WebChartFixedDateBinningUnits | undefined, config: ChartConfig) => void;
+/**
+ * Sets the time aggregation type by updating the config accordingly.
+ * @param newTimeAggregationType The new value for the aggregation type.
+ * @param config The chart configuration.
+ */
+export declare const setTimeAggregationType: (newTimeAggregationType: WebChartTimeAggregationTypes | undefined, config: ChartConfig) => void;
+/**
+ * Sets whether to trim incomplete time interval by updating the config accordingly.
+ * @param newTrimIncompleteTimeInterval The new value for the trim incomplete time interval property.
+ * @param config The chart configuration.
+ */
+export declare const setTrimIncompleteTimeInterval: (newTrimIncompleteTimeInterval: boolean | undefined, config: ChartConfig) => void;
+/**
+ * Resets the time interval by setting its size to 0.
+ * @param config The chart configuration.
+ */
+export declare const resetTimeInterval: (config: ChartConfig) => void;

package/dist/model/mixins/utils/tooltips.d.ts

@@ -0,0 +1,37 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+/**
+ * Gets the visibility of the data tooltips.
+ * @param config The chart configuration object
+ * @param seriesIndex The index of the series.
+ * @returns {boolean}
+ * @remarks
+ * a. If the seriesIndex is provided, the visibility for that series will be returned. Otherwise, the visibility of the first series will be returned.
+ * b. If the visibility is not set on the series, the default value of `true` will be returned.
+ */
+export declare const getDataTooltipVisibility: (config: ChartConfig, seriesIndex?: number) => boolean;
+/**
+ * Sets the visibility of the data tooltips.
+ * @param config The chart configuration object
+ * @param visibility The visibility of the data tooltips.
+ * @param seriesIndex The index of the series.
+ * @remarks If the seriesIndex is provided, the visibility will be set for that series only. Otherwise, the visibility will be set for all series.
+ */
+export declare const setDataTooltipVisibility: (config: ChartConfig, visibility: boolean, seriesIndex?: number) => void;
+/**
+ * Gets the setting of the `dataTooltipReverseColor` property.
+ * @param config The chart configuration object
+ * @param seriesIndex The index of the series.
+ * @returns {boolean}
+ * @remarks
+ * a. If the seriesIndex is provided, the dataTooltipReverseColor for that series will be returned. Otherwise, the same property of the first series will be returned.
+ * b. If the dataTooltipReverseColor is not set on the series, the default value of `false` will be returned.
+ */
+export declare const getDataTooltipReverseColor: (config: ChartConfig, seriesIndex?: number) => boolean;
+/**
+ *
+ * @param config The chart configuration object
+ * @param reverseColor Indicator of whether to reverse the color.
+ * @param seriesIndex The index of the series to set the reverse color.
+ * @remarks 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.
+ */
+export declare const setDataTooltipReverseColor: (config: ChartConfig, reverseColor: boolean, seriesIndex?: number) => void;

package/dist/model/pie-chart-model/pie-chart-legend-model.d.ts

@@ -0,0 +1,47 @@
+import { ModelWithLegend } from '../mixins/model-with-legend';
+export declare abstract class PieChartLegendModel extends ModelWithLegend {
+    /**
+     * Gets the setting for the display of numerical value in the legend items.
+     * @returns {boolean}
+     * @remarks
+     * This setting is only applicable to pie charts.
+     */
+    getDisplayNumericValue(): boolean;
+    /**
+     * Sets the setting for the display of numerical value in the legend items.
+     * @param displayNumericValue The setting for the display of numerical value in the legend items
+     * @remarks
+     * This setting is only applicable to pie charts.
+     */
+    setDisplayNumericValue(displayNumericValue: boolean): void;
+    /**
+     * Gets the setting for the display of percentage in the legend items.
+     * @returns {boolean}
+     * @remarks
+     * This setting is only applicable to pie charts.
+     */
+    getDisplayPercentage(): boolean;
+    /**
+     * Sets the setting for the display of percentage in the legend items.
+     * @param displayPercentage The setting for the display of percentage in the legend items
+     * @remarks
+     * This setting is only applicable to pie charts.
+     */
+    setDisplayPercentage(displayPercentage: boolean): void;
+    /**
+     * Gets the maximum width in pixel for the legend item labels.
+     * @returns {number}
+     * @remarks
+     * This setting is only applicable to pie charts.
+     */
+    getLabelMaxWidth(): number;
+    /**
+     * Sets the maximum width in pixel for the legend item labels.
+     * @param labelMaxWidth The maximum width in pixel for the legend item labels
+     * @remarks
+     * This setting is only applicable to pie charts.
+     */
+    setLabelMaxWidth(labelMaxWidth: number): void;
+}
+export interface PieChartLegendModel extends ModelWithLegend {
+}

package/dist/model/pie-chart-model/pie-chart-model.d.ts

@@ -0,0 +1,400 @@
+import { WebChart, WebChartPieChartSlice, WebChartPieChartGroupSlice, WebChartPieChartSeries, Color, ISimpleLineSymbol, RESTStatisticType } from '@arcgis/charts-spec';
+import { ChartTypes, ChartConfig } from '@arcgis/charts-shared-utils';
+import { PieChartSlicesDisplay, LayerInfo, PieChartDataSortingKinds, PieChartDataModes } from '../interfaces/common';
+import { ChartModel } from '../chart-model/customElement.js';
+import { ModelWithColorMatch, ModelWithDataLabels, ModelWithTooltips } from '../mixins';
+import { PieChartLegendModel } from './pie-chart-legend-model';
+import { ModelParams } from '../interfaces/chart-interfaces';
+export declare class PieChartModel extends ChartModel {
+    /**
+     * Current configuration used for the pie chart
+     */
+    protected _config: ChartConfig<WebChartPieChartSeries, WebChart>;
+    protected _chartType: ChartTypes;
+    /**
+     * Protected property to hold the pie chart data mode (Category or Fields)
+     *
+     * `category` - The chart will use values from the category field to determine each slice.
+     *
+     * `fields` - The chart will use aggregated values from the numeric fields to determine each slice.
+     *
+     * @category Protected
+     */
+    protected _mode: PieChartDataModes;
+    protected layerInfo: LayerInfo;
+    /**
+     * Array of hidden grouped slice ids
+     * @category Private
+     */
+    private _groupedSliceIds;
+    setup(params: ModelParams<ChartConfig<WebChartPieChartSeries>>): Promise<void>;
+    /**
+     * Gets the category field for the pie chart.
+     * @returns {string}
+     */
+    getCategory(): string;
+    /**
+     * Sets the category field for the pie chart.
+     * @param {string} category The category field.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setCategory(category: string): Promise<void>;
+    /**
+     * Gets the numeric fields for the pie chart.
+     * @returns {string[]}
+     */
+    getNumericFields(): string[];
+    /**
+     * Sets the numeric field or numeric fields array for the pie chart.
+     * @param {string[]} numericFields The numeric field or numeric fields array.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setNumericFields(numericFields: string[] | string): Promise<void>;
+    /**
+     * Gets the aggregation type for the pie chart.
+     * @returns {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | "no_aggregation"}
+     */
+    getAggregationType(): RESTStatisticType;
+    /**
+     * Sets the aggregation type for the pie chart.
+     * @param {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | "no_aggregation"} aggregationType The aggregation type. Must be one of the values allowed by `RESTStatisticType`.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setAggregationType(aggregationType: RESTStatisticType): Promise<void>;
+    /**
+     * Gets the sort order for the pie chart.
+     * @returns {PieChartDataSortingKinds}
+     */
+    getSortOrder(): PieChartDataSortingKinds;
+    /**
+     * Sets the sort order for the pie chart.
+     * @param {PieChartDataSortingKinds} sortOrder The sort order.
+     */
+    setSortOrder(sortOrder: PieChartDataSortingKinds, orderByList?: string[]): void;
+    getOrderByList(): string[];
+    /**
+     * Sets the list of category's values for custom sort
+     * @param {string[]} orderByList The list of category's values
+     */
+    setOrderByList(orderByList: string[]): void;
+    /**
+     * 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}
+     */
+    getMode(): PieChartDataModes;
+    /**
+     * 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.
+     *
+     * @param {PieChartDataModes} mode The mode.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setMode(mode: PieChartDataModes): void;
+    /**
+     * Gets the list of the category values for the chart.
+     * @returns {string[]}
+     */
+    getCustomSortValues(): Promise<string[]>;
+    /**
+     * 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`.
+     * @param {number} fromIndex The index to move the custom sort item from.
+     * @param {number} toIndex The index to move the category item to.
+     */
+    moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
+    /**
+     * Gets the symbol for the ticks connecting the slices to the labels.
+     * @returns {ISimpleLineSymbol | undefined}
+     */
+    getTicksSymbol(): ISimpleLineSymbol | undefined;
+    /**
+     * Sets the symbol for the ticks connecting the slices to the labels.
+     * @param {ISimpleLineSymbol | undefined} lineSymbol The ticks symbol.
+     */
+    setTicksSymbol(lineSymbol: ISimpleLineSymbol | undefined): void;
+    /**
+     * Gets the array of slices for the pie chart.
+     * @returns {WebChartPieChartSlice[] | undefined}
+     */
+    getSlices(): WebChartPieChartSlice[] | undefined;
+    /**
+     * Sets the array of slices for the pie chart.
+     * @param {WebChartPieChartSlice[] | undefined} slices The slices array.
+     */
+    setSlices(slices: WebChartPieChartSlice[] | undefined): void;
+    /**
+     * Gets the array of grouped slice ids for the pie chart.
+     * @returns {string[]}
+     */
+    getGroupedSliceIds(): string[];
+    /**
+     * Sets the array of grouped slice ids for the pie chart.
+     * @param {string[]} groupedSliceIds The grouped slice ids array.
+     */
+    setGroupedSliceIds(groupedSliceIds: string[]): void;
+    /**
+     * Gets the slice grouping configuration for the pie chart.
+     * @returns {WebChartPieChartGroupSlice | undefined}
+     */
+    getSliceGrouping(): WebChartPieChartGroupSlice | undefined;
+    /**
+     * Sets the slice grouping configuration for the pie chart.
+     * @param {WebChartPieChartGroupSlice | undefined} sliceGrouping The slice grouping configuration.
+     */
+    setSliceGrouping(sliceGrouping: WebChartPieChartGroupSlice | undefined): void;
+    /**
+     * Gets the inner radius size for the pie chart.
+     * @returns {number}
+     */
+    getInnerRadiusSize(): number;
+    /**
+     * Sets the inner radius size for the pie chart.
+     * @param {number} size The inner radius size.
+     */
+    setInnerRadiusSize(size: number): void;
+    /**
+     * Gets the threshold below which slices will be grouped.
+     * @returns {number}
+     */
+    getGroupingThreshold(): number;
+    /**
+     * Sets the threshold below which slices will be grouped.
+     * @param {number} threshold The grouping threshold.
+     */
+    setGroupingThreshold(threshold: number): void;
+    /**
+     * Gets the character limit for the slice labels.
+     * @returns {number | null}
+     */
+    getLabelCharacterLimit(): number | null;
+    /**
+     * Sets the character limit for the slice labels.
+     * @param {number | null} limit The label character limit.
+     */
+    setLabelCharacterLimit(limit: number | null): void;
+    /**
+     * Gets the number of decimal places to display in the slice values.
+     * @returns {number}
+     */
+    getDecimalPlaces(): number;
+    /**
+     * Sets the number of decimal places to display in the slice values.
+     * @param {number} decimalPlaces The decimal places.
+     */
+    setDecimalPlaces(decimalPlaces: number): void;
+    /**
+     * Gets the display type for the pie chart slices. Specifies whether to display the slices as a percentage, value, or both.
+     * @returns {PieChartSlicesDisplay}
+     */
+    getDisplayType(): PieChartSlicesDisplay;
+    /**
+     * Sets the display type for the pie chart slices. Specifies whether to display the slices as a percentage, value, or both.
+     * @param {PieChartSlicesDisplay} displayType The display type.
+     */
+    setDisplayType(displayType: PieChartSlicesDisplay): void;
+    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    /**
+     * Gets the original name of the slice based on the slice index.
+     * @returns {Date | number | string | null | undefined}
+     */
+    getOriginalSliceName(sliceIndex: number): Date | number | string | null | undefined;
+    /**
+     * Gets the name of the slice based on the slice index. If the index is out of bounds, this function will return `undefined`.
+     * @param {number} sliceIndex The index of the slice.
+     * @returns {string | undefined}
+     */
+    getSliceName(sliceIndex: number): string | undefined;
+    /**
+     * Sets name of the slice based on the slice index.
+     * @param {string} name The name for the slice.
+     * @param {number} sliceIndex The index of the slice.
+     */
+    setSliceName(name: string, sliceIndex: number): void;
+    /**
+     * Gets the color of the slice based on the slice index. If the index is out of bounds, this function will return `undefined`.
+     * @param {number} sliceIndex The index of the slice.
+     * @returns {Color | undefined}
+     */
+    getSliceColor(sliceIndex: number): Color | undefined;
+    /**
+     * Sets the color of the slice based on the slice index.
+     * @param {Color | undefined} color The color for the slice.
+     * @param {number} sliceIndex The index of the slice.
+     */
+    setSliceColor(color: Color | undefined, sliceIndex: number): void;
+    /**
+     * Gets the order of the slice array by returning an array of slice ids
+     * @returns {string[] | undefined}
+     */
+    getOrderOfSlices(): string[] | undefined;
+    /**
+     * Sets the order of the slices array by providing an array of slice ids.
+     * @param {string[]} order The order of the slices.
+     */
+    setOrderOfSlices(order: string[]): void;
+    /**
+     * Moves a series from one index in the series array to another.
+     * @param {number} fromIndex Index to move the series from.
+     * @param {number} toIndex Index to move the series to.
+     */
+    moveSeries(fromIndex: number, toIndex: number): void;
+    /**
+     * Gets the slice id for a given slice index. If the index is out of bounds, this function will return `undefined`.
+     * @param {number} sliceIndex The index of the slice.
+     * @returns {string | undefined}
+     */
+    getSliceId(sliceIndex: number): string | undefined;
+    /**
+     * Gets the slice index for a given slice id. If the `sliceId` is not found, this function will return `undefined`.
+     * @param {string} sliceId The id of the slice.
+     * @returns {number | undefined}
+     */
+    getSliceIndex(sliceId: string): number | undefined;
+    /**
+     * Gets the length of the slices array.
+     * @returns {number}
+     */
+    getSlicesLength(): number;
+    /**
+     * Resets the slices styling to the default styling.
+     */
+    resetSlices(): void;
+    /**
+     * Returns whether the series styling is able to be reset.
+     * @returns {boolean}
+     */
+    resetAvailable(): boolean;
+    /**
+     * Gets the visibility of the ticks.
+     * @returns {boolean}
+     */
+    getTicksVisibility(): boolean;
+    /**
+     * Sets the visibility of the ticks.
+     * @param visibility The visibility setting for the ticks.
+     */
+    setTicksVisibility(visibility: boolean): void;
+    /**
+     * Gets the start angle of the pie chart.
+     * @returns {number | null | undefined}
+     */
+    getStartAngle(): number | null | undefined;
+    /**
+     * Sets the start angle for the pie chart.
+     * @param angle The start angle for the pie chart.
+     */
+    setStartAngle(angle: number): void;
+    /**
+     * Gets the end angle of the pie chart.
+     * @returns {number | null | undefined}
+     */
+    getEndAngle(): number | null | undefined;
+    /**
+     * Sets the end angle for the pie chart.
+     * @param angle The end angle for the pie chart.
+     */
+    setEndAngle(angle: number): void;
+    /**
+     * Gets the display numeric value on tooltip setting from the chart config.
+     * @returns {boolean}
+     * @remarks If the setting is not found in the config, it will default to `true`.
+     */
+    getDisplayNumericValueOnTooltip(): boolean;
+    /**
+     * Sets the display numeric value on tooltip setting in the chart config.
+     * @param display The boolean value to set the displayNumericValueOnTooltip to
+     */
+    setDisplayNumericValueOnTooltip(display: boolean): void;
+    /**
+     * Gets the display percentage on tooltip setting from the chart config.
+     * @returns {boolean}
+     * @remarks If the setting is not found in the config, it will default to `true`.
+     */
+    getDisplayPercentageOnTooltip(): boolean;
+    /**
+     * Sets the display percentage on tooltip setting in the chart config.
+     * @param display The boolean value to set the displayPercentageOnTooltip to
+     */
+    setDisplayPercentageOnTooltip(display: boolean): void;
+    /**
+     * Gets the prefix of the values of the slices.
+     * @returns {string | undefined}
+     */
+    getValuePrefix(): string | undefined;
+    /**
+     * Sets the prefix for the values of the slices.
+     * @param prefix The prefix for the values of the slices.
+     */
+    setValuePrefix(prefix: string): void;
+    /**
+     * Gets the suffix of the values of the slice.
+     * @returns {string | undefined}
+     */
+    getValueSuffix(): string | undefined;
+    /**
+     * Sets the suffix for the values of the slices.
+     * @param suffix The suffix for the values of the slices.
+     */
+    setValueSuffix(suffix: string): void;
+    /**
+     * Gets the prefix of the percentages of the slices.
+     * @returns {string | undefined}
+     */
+    getPercentagePrefix(): string | undefined;
+    /**
+     * Sets the prefix for the percentages of the slices.
+     * @param prefix The prefix for the percentages of the slices.
+     */
+    setPercentagePrefix(prefix: string): void;
+    /**
+     * Gets the suffix of the percentages of the slices.
+     * @returns {string | undefined}
+     */
+    getPercentageSuffix(): string | undefined;
+    /**
+     * Sets the suffix for the percentages of the slices.
+     * @param suffix The suffix for the percentages of the slices.
+     */
+    setPercentageSuffix(suffix: string): void;
+    /**
+     * Gets the offset for the data labels.
+     * @returns {string | undefined}
+     */
+    getDataLabelsOffset(): number;
+    /**
+     * Sets the offset for the data labels.
+     * @param offset The offset for the data labels.
+     */
+    setDataLabelsOffset(offset: number): void;
+    /**
+     * Gets the align data labels setting for the pie chart.
+     * @returns {boolean | undefined}
+     */
+    getAlignDataLabels(): boolean | undefined;
+    /**
+     * Sets the align data labels setting for the pie chart.
+     * @param align The align data labels setting for the pie chart.
+     */
+    setAlignDataLabels(align: boolean): void;
+    /**
+     * Gets the optimize data labels overlapping setting for the pie chart.
+     * @returns {boolean | undefined}
+     */
+    getOptimizeDataLabelsOverlapping(): boolean | undefined;
+    /**
+     * Sets the optimize data labels overlapping setting for the pie chart.
+     * @param optimize The optimize data labels overlapping setting for the pie chart.
+     */
+    setOptimizeDataLabelsOverlapping(optimize: boolean): void;
+}
+export interface PieChartModel extends PieChartLegendModel, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels {
+}