@arcgis/charts-components 4.33.0-next.136 → 4.33.0-next.138

package/dist/loader.js

@@ -2,10 +2,10 @@ import { r as e } from "./chunks/runtime.js";
 import { makeDefineCustomElements as t } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.33/esri/copyright.txt for details.
-v4.33.0-next.136 */
+v4.33.0-next.138 */
 const o = t(e, {
   "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,autoDisposeChart,chartLimits:,chartWillRender:,componentVersion,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableConfiguration,enableResponsiveFeatures,errorPolicy,featureIndex,filterByExtent,filterBySelection,gaugeInnerLabelFormatter:,guideTooltipFormatter:,hideEmptySeries,hideLicenseWatermark,hideLoaderAnimation,ignoreSmoothRenderingLimit,ignoreViewExtent,layer:,layerFieldsChangePolicy,layerFilterChangePolicy,layerRendererChangePolicy,legendPosition,legendValueLabelFormatter:,legendVisibility,loaderColors:,messageOptions:,model:,placeholder,queueChartCreation,replaceNoValueCategoryWithZero,returnFeaturesExtent,returnSelectionIndexes,returnSelectionOIDs,rotation,runtimeDataFilters:,secondaryYAxisLabelFormatter:,selectionData:,selectionTheme:,setTimeBinningInfoWhenNotProvided,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,timeZone,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,errorAlert,exportAsCSV,exportAsImage,notify,refresh,resetZoom,switchSelection"],
-  "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,disabledExportAction,editChartState,editChartTitle,editChartToggle,expanded,exportAsCSVState,exportAsCSVTitle,exportAsImageState,exportAsImageTitle,filterByExtentState,filterByExtentTitle,filterByExtentToggle,filterBySelectionState,filterBySelectionTitle,filterBySelectionToggle,forceDisableActions,fullExtentState,fullExtentTitle,fullExtentToggle,hiddenActions:,legendState,legendTitle,legendToggle,messageOverrides:,rotateChartState,rotateChartTitle,rotateChartToggle,selectionState,selectionTitle,selectionToggle,switchSelectionState,switchSelectionTitle,switchSelectionToggle,zoomState,zoomTitle,zoomToggle"],
+  "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,disableCSVExportForChartTypes:,disabledExportAction,editChartState,editChartTitle,editChartToggle,expanded,exportAsCSVState,exportAsCSVTitle,exportAsImageState,exportAsImageTitle,filterByExtentState,filterByExtentTitle,filterByExtentToggle,filterBySelectionState,filterBySelectionTitle,filterBySelectionToggle,forceDisableActions,fullExtentState,fullExtentTitle,fullExtentToggle,hiddenActions:,legendState,legendTitle,legendToggle,messageOverrides:,rotateChartState,rotateChartTitle,rotateChartToggle,selectionState,selectionTitle,selectionToggle,switchSelectionState,switchSelectionTitle,switchSelectionToggle,zoomState,zoomTitle,zoomToggle"],
   "arcgis-charts-config-axes": [() => import("./components/arcgis-charts-config-axes/customElement.js"), "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,messageOverrides:,model:,open,showEnableXLogOption,showEnableYLogOption,showMaxXBoundOption,showMaxYBoundOption,showMinXBoundOption,showMinYBoundOption"],
   "arcgis-charts-config-axis": [() => import("./components/arcgis-charts-config-axis/customElement.js"), "axisTitle,dataMaxValue,dataMinValue,initialMaxBound,initialMinBound,isXAxis,maxBoundMaxLimit,maxBoundMinLimit,messageOverrides:,minBoundMaxLimit,minBoundMinLimit,model:,showEnableLogOption,showMaxBoundOption,showMinBoundOption"],
   "arcgis-charts-config-bar-chart": [() => import("./components/arcgis-charts-config-bar-chart/customElement.js"), "calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,seriesColor:,timeZone,usePopupTemplateFieldsInfo"],

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

@@ -1,7 +1,7 @@
 import { WebChart } from '@arcgis/charts-spec';
 import { ChartConfig } from '../../utils';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
 import { ModelParams } from '../interfaces/chart-interfaces';
+import { LayerInfo, ModelTypes } from '../interfaces/common';
 import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
 export declare class BarChartModel extends SerialChartModel {
     /**
@@ -17,6 +17,18 @@ export declare class BarChartModel extends SerialChartModel {
     protected layerInfo: LayerInfo;
     setup(params: ModelParams<ChartConfig<typeof ModelTypes.BarChart>>): Promise<void>;
     protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    /**
+     * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
+     * @param {number} seriesIndex The index of the series.
+     * @returns {boolean | undefined}
+     */
+    getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
+    /**
+     * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
+     * @param {boolean} hide The value for hiding oversized data labels.
+     * @param {number} seriesIndex The index of the series.
+     */
+    setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
     /**
      * Gets whether to hide oversized stacked labels of the series based on the series index. If the index is out of bounds, it will return `undefined`.
      * @param {number} seriesIndex The index of the series.
@@ -25,10 +37,10 @@ export declare class BarChartModel extends SerialChartModel {
     getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
     /**
      * Sets whether to hide oversized stacked labels of the series based on the series index.
-     * @param {boolean} newValue The new value for hiding oversized stacked labels.
+     * @param {boolean} hide The value for hiding oversized stacked labels.
      * @param {number} seriesIndex The index of the series.
      */
-    setSeriesHideOversizedStackedLabels(newValue: boolean | undefined, seriesIndex: number): void;
+    setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
     /**
      * Resets the series styling to the default styling.
      */

package/dist/model/bar-chart-model/utils/bar-chart-series.d.ts

@@ -1,4 +1,34 @@
 import { ChartConfig } from '../../../utils';
 import { ModelTypes } from '../../interfaces/common';
+/**
+ * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
+ * @param {number} seriesIndex The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>} config The chart configuration.
+ * @returns {boolean | undefined}
+ */
+export declare const getHideOversizedSideBySideLabels: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => boolean | undefined;
+/**
+ * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
+ * @param {boolean} hide The value for hiding oversized labels.
+ * @param {number} seriesIndex The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>} config The chart configuration.
+ *
+ * **NOTE:** This method will only work if the series is a bar chart series.
+ */
+export declare const setHideOversizedSideBySideLabels: (hide: boolean | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => void;
+/**
+ * Gets whether to hide oversized data labels of the stacked series based on the series index. If the index is out of bounds, it will return `undefined`.
+ * @param {number} seriesIndex The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>} config The chart configuration.
+ * @returns {boolean | undefined}
+ */
 export declare const getHideOversizedStackedLabels: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => boolean | undefined;
-export declare const setHideOversizedStackedLabels: (newValue: boolean | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => void;
+/**
+ * Sets whether to hide oversized data labels of the stacked series based on the series index.
+ * @param {boolean} hide The value for hiding oversized stacked labels.
+ * @param {number} seriesIndex The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>} config The chart configuration.
+ *
+ * **NOTE:** This method will only work if the series is a bar chart series.
+ */
+export declare const setHideOversizedStackedLabels: (hide: boolean | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => void;

package/dist/model/box-plot-model/box-plot-model.d.ts

@@ -139,6 +139,10 @@ export declare class BoxPlotModel extends ChartModel {
      */
     setMeanLinesBoxColor(newColor: Color | undefined): void;
     protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    /**
+     * Resets the config to the default config
+     */
+    resetConfig(): Promise<void>;
     /**
      * Gets the name of the series based on the series index. If the index is out of bounds, it will return `undefined`.
      * @param {number} seriesIndex The index of the series.

package/dist/model/combo-bar-line-chart-model/combo-bar-line-chart-model.d.ts

@@ -1,7 +1,7 @@
-import { WebChart, WebChartLineChartSeries, RESTSimpleLineSymbolStyle, Color, RESTSimpleMarkerSymbolStyle, WebChartTypes } from '@arcgis/charts-spec';
+import { Color, RESTSimpleLineSymbolStyle, RESTSimpleMarkerSymbolStyle, WebChart, WebChartLineChartSeries, WebChartTypes } from '@arcgis/charts-spec';
 import { ChartConfig } from '../../utils';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
 import { ModelParams } from '../interfaces/chart-interfaces';
+import { LayerInfo, ModelTypes } from '../interfaces/common';
 import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
 export declare class ComboBarLineChartModel extends SerialChartModel {
     /**
@@ -183,17 +183,31 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
      */
     setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
     /**
-     * Gets whether to hide oversized stacked labels of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+     * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
+     * @param {number} seriesIndex The index of the series.
+     * @returns {boolean | undefined}
+     */
+    getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
+    /**
+     * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
+     * @param {boolean} hide The value for hiding oversized labels.
+     * @param {number} seriesIndex The index of the series.
+     *
+     * **NOTE:** This method will only work if the series is a bar chart series.
+     */
+    setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
+    /**
+     * Gets whether to hide oversized data labels of the stacked series based on the series index. If the index is out of bounds, it will return `undefined`.
      * @param {number} seriesIndex The index of the series.
      * @returns {boolean | undefined}
      */
     getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
     /**
-     * Sets whether to hide oversized stacked labels of the series based on the series index.
-     * @param {boolean} newValue The new value for hiding oversized stacked labels.
+     * Sets whether to hide oversized data labels of the stacked series based on the series index.
+     * @param {boolean} hide The value for hiding oversized stacked labels.
      * @param {number} seriesIndex The index of the series.
      *
      * **NOTE:** This method will only work if the series is a bar chart series.
      */
-    setSeriesHideOversizedStackedLabels(newValue: boolean | undefined, seriesIndex: number): void;
+    setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
 }

package/dist/model/index.d.ts

@@ -1,17 +1,16 @@
-export * from './chart-model/chart-model.js';
+export type * from './chart-model/chart-model.js';
 export type * from './chart-model/utils/types.js';
-export * from './bar-chart-model/bar-chart-model.js';
-export * from './box-plot-model/box-plot-model.js';
-export * from './gauge-model/gauge-model.js';
-export * from './histogram-model/histogram-model.js';
-export * from './line-chart-model/line-chart-model.js';
-export * from './radar-chart-model/radar-chart-model.js';
-export * from './pie-chart-model/pie-chart-model.js';
-export * from './pie-chart-model/pie-chart-legend-model.js';
-export * from './scatter-plot-model/scatter-plot-model.js';
-export * from './serial-chart-model/serial-chart-model.js';
-export * from './combo-bar-line-chart-model/combo-bar-line-chart-model.js';
-export * from './mixins';
+export type * from './bar-chart-model/bar-chart-model.js';
+export type * from './box-plot-model/box-plot-model.js';
+export type * from './gauge-model/gauge-model.js';
+export type * from './histogram-model/histogram-model.js';
+export type * from './line-chart-model/line-chart-model.js';
+export type * from './radar-chart-model/radar-chart-model.js';
+export type * from './pie-chart-model/pie-chart-model.js';
+export type * from './pie-chart-model/pie-chart-legend-model.js';
+export type * from './scatter-plot-model/scatter-plot-model.js';
+export type * from './serial-chart-model/serial-chart-model.js';
+export type * from './combo-bar-line-chart-model/combo-bar-line-chart-model.js';
 export type * from './interfaces/chart-interfaces.js';
 export * from './interfaces/common.js';
 export * from './shared/type-guards.js';

package/dist/model/interfaces/common.d.ts

@@ -1,10 +1,10 @@
-import { IField, SupportedLayer, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterPlotSeries, WebChartTypes } from '@arcgis/charts-spec';
+import { IField, SupportedLayer, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '@arcgis/charts-spec';
 import { BarChartModel } from '../bar-chart-model/bar-chart-model';
 import { BoxPlotModel } from '../box-plot-model/box-plot-model';
 import { HistogramModel } from '../histogram-model/histogram-model';
 import { LineChartModel } from '../line-chart-model/line-chart-model';
 import { PieChartModel } from '../pie-chart-model/pie-chart-model';
-import { ScatterPlotModel } from '../scatter-plot-model/scatter-plot-model';
+import { ScatterplotModel } from '../scatter-plot-model/scatter-plot-model';
 import { GaugeModel } from '../gauge-model/gauge-model';
 import { ComboBarLineChartModel } from '../combo-bar-line-chart-model/combo-bar-line-chart-model';
 import { RadarChartModel } from '../radar-chart-model/radar-chart-model';
@@ -41,6 +41,7 @@ export declare const PieChartDataModes: {
 };
 export type PieChartDataModes = (typeof PieChartDataModes)[keyof typeof PieChartDataModes];
 export declare const PieChartSlicesDisplay: {
+    readonly Category: "category";
     readonly Value: "value";
     readonly Percentage: "percentage";
     readonly Both: "both";
@@ -100,6 +101,7 @@ export interface SplitByFieldInfos {
     numericalField: string;
 }
 export interface PieSeriesDisplayOptions {
+    displayCategoryOnDataLabel: boolean;
     displayNumericValueOnDataLabel: boolean;
     displayPercentageOnDataLabel: boolean;
     displayNumericValue: boolean;
@@ -131,6 +133,6 @@ export declare const ModelTypes: {
     readonly RadarChart: "radarChart";
 };
 export type ModelTypes = (typeof ModelTypes)[keyof typeof ModelTypes];
-export type ModelTypeToSeriesType<T extends ModelTypes> = T extends typeof ModelTypes.BarChart ? WebChartBarChartSeries : T extends typeof ModelTypes.LineChart ? WebChartLineChartSeries : T extends typeof ModelTypes.ComboBarLineChart ? WebChartBarChartSeries | WebChartLineChartSeries : T extends typeof ModelTypes.BoxPlot ? WebChartBoxPlotSeries | WebChartLineChartSeries : T extends typeof ModelTypes.PieChart ? WebChartPieChartSeries : T extends typeof ModelTypes.Scatterplot ? WebChartScatterPlotSeries : T extends typeof ModelTypes.Histogram ? WebChartHistogramSeries : T extends typeof ModelTypes.Gauge ? WebChartGaugeSeries : T extends typeof ModelTypes.RadarChart ? WebChartRadarChartSeries : SupportedChartSeries;
-export type SeriesTypeToChartType<T extends SupportedChartSeries> = T extends WebChartBarChartSeries ? typeof WebChartTypes.BarSeries : T extends WebChartLineChartSeries ? typeof WebChartTypes.LineSeries : T extends WebChartBoxPlotSeries ? typeof WebChartTypes.BoxPlotSeries : T extends WebChartPieChartSeries ? typeof WebChartTypes.PieSeries : T extends WebChartScatterPlotSeries ? typeof WebChartTypes.ScatterSeries : T extends WebChartHistogramSeries ? typeof WebChartTypes.HistogramSeries : T extends WebChartGaugeSeries ? typeof WebChartTypes.GaugeSeries : T extends WebChartRadarChartSeries ? typeof WebChartTypes.RadarSeries : never;
-export type ModelOfType<T> = T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterPlotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : BarChartModel;
+export type ModelTypeToSeriesType<T extends ModelTypes> = T extends typeof ModelTypes.BarChart ? WebChartBarChartSeries : T extends typeof ModelTypes.LineChart ? WebChartLineChartSeries : T extends typeof ModelTypes.ComboBarLineChart ? WebChartBarChartSeries | WebChartLineChartSeries : T extends typeof ModelTypes.BoxPlot ? WebChartBoxPlotSeries | WebChartLineChartSeries : T extends typeof ModelTypes.PieChart ? WebChartPieChartSeries : T extends typeof ModelTypes.Scatterplot ? WebChartScatterplotSeries : T extends typeof ModelTypes.Histogram ? WebChartHistogramSeries : T extends typeof ModelTypes.Gauge ? WebChartGaugeSeries : T extends typeof ModelTypes.RadarChart ? WebChartRadarChartSeries : SupportedChartSeries;
+export type SeriesTypeToChartType<T extends SupportedChartSeries> = T extends WebChartBarChartSeries ? typeof WebChartTypes.BarSeries : T extends WebChartLineChartSeries ? typeof WebChartTypes.LineSeries : T extends WebChartBoxPlotSeries ? typeof WebChartTypes.BoxPlotSeries : T extends WebChartPieChartSeries ? typeof WebChartTypes.PieSeries : T extends WebChartScatterplotSeries ? typeof WebChartTypes.ScatterSeries : T extends WebChartHistogramSeries ? typeof WebChartTypes.HistogramSeries : T extends WebChartGaugeSeries ? typeof WebChartTypes.GaugeSeries : T extends WebChartRadarChartSeries ? typeof WebChartTypes.RadarSeries : never;
+export type ModelOfType<T> = T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterplotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : BarChartModel;

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

@@ -303,12 +303,23 @@ export declare class PieChartModel extends ChartModel {
      * @param angle The end angle for the pie chart.
      */
     setEndAngle(angle: number): void;
+    /**
+     * Gets the display category 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`.
+     */
+    getDisplayCategoryValueOnTooltip(): boolean;
     /**
      * 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 category value on tooltip setting in the chart config.
+     * @param display The boolean value to set the displayCategoryOnTooltip to
+     */
+    setDisplayCategoryOnTooltip(display: boolean): void;
     /**
      * Sets the display numeric value on tooltip setting in the chart config.
      * @param display The boolean value to set the displayNumericValueOnTooltip to

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

@@ -15,6 +15,22 @@ export declare const getDisplayNumericValue: (config: ChartConfig) => boolean;
  * This setting is only applicable to pie charts.
  */
 export declare const setDisplayNumericValue: (displayNumericValue: boolean, config: ChartConfig) => void;
+/**
+ * Gets the display of category setting for the legend items from the chart config.
+ * @param config The chart configuration object
+ * @returns {boolean}
+ * @remarks
+ * This setting is only applicable to pie charts.
+ */
+export declare const getDisplayCategory: (config: ChartConfig) => boolean;
+/**
+ * Sets the display of category setting for the legend items in the chart config.
+ * @param displayCategory The setting for the display of category in the legend
+ * @param config The chart configuration object
+ * @remarks
+ * This setting is only applicable to pie charts.
+ */
+export declare const setDisplayCategory: (displayCategory: boolean, config: ChartConfig) => void;
 /**
  * Gets the display of percentage setting for the legend items from the chart config.
  * @param config The chart configuration object

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

@@ -49,6 +49,26 @@ export declare const getEndAngle: (config: ChartConfig<typeof ModelTypes.PieChar
  * @param config The chart configuration.
  */
 export declare const setEndAngle: (angle: number, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
+/**
+ * Gets the display category value on tooltip setting from the chart config.
+ * @param config The chart configuration.
+ * @returns {boolean}
+ * @remarks If the setting is not found in the config, it will default to `true`.
+ */
+export declare const getDisplayCategoryValueOnTooltip: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
+/**
+ * Gets the display category value on data label setting from the chart config.
+ * @param config The chart configuration.
+ * @returns {boolean}
+ * @remarks If the setting is not found in the config, it will default to `true`.
+ */
+export declare const getDisplayCategoryOnDataLabel: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
+/**
+ * Sets the display category value on data label setting in the chart config.
+ * @param display The boolean value to set the displayCategoryOnDataLabel to
+ * @param config The chart configuration.
+ */
+export declare const setDisplayCategoryOnDataLabel: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the display numeric value on tooltip setting from the chart config.
  * @param config The chart configuration.
@@ -56,6 +76,12 @@ export declare const setEndAngle: (angle: number, config: ChartConfig<typeof Mod
  * @remarks If the setting is not found in the config, it will default to `true`.
  */
 export declare const getDisplayNumericValueOnTooltip: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
+/**
+ * Sets the display category value on tooltip setting in the chart config.
+ * @param display The boolean value to set the displayCategoryOnTooltip to
+ * @param config The chart configuration.
+ */
+export declare const setDisplayCategoryOnTooltip: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Sets the display numeric value on tooltip setting in the chart config.
  * @param display The boolean value to set the displayNumericValueOnTooltip to

package/dist/model/scatter-plot-model/scatter-plot-model.d.ts

@@ -1,10 +1,10 @@
-import { ISimpleLineSymbol, ISimpleMarkerSymbol, WebChart, SizePolicy, ScatterPlotOverlays } from '@arcgis/charts-spec';
+import { ISimpleLineSymbol, ISimpleMarkerSymbol, WebChart, SizePolicy, ScatterplotOverlays } from '@arcgis/charts-spec';
 import { ChartConfig, XYChartTypes } from '../../utils';
 import { ModelParams } from '../interfaces/chart-interfaces';
 import { LayerInfo, ModelTypes } from '../interfaces/common';
 import { ChartModel } from '../chart-model/chart-model';
 import { ModelWithColorMatch, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides, ModelWithLegend, ModelWithXYAxes, ModelWithTooltips } from '../mixins';
-export declare class ScatterPlotModel extends ChartModel {
+export declare class ScatterplotModel extends ChartModel {
     /**
      * Current configuration used for the scatterplot.
      */
@@ -77,13 +77,13 @@ export declare class ScatterPlotModel extends ChartModel {
     /**
      * Gets the chart overlays. The scatter plot implements only 1 overlay, **trendLine**.
      */
-    getSeriesOverlays(): ScatterPlotOverlays | undefined;
+    getSeriesOverlays(): ScatterplotOverlays | undefined;
     /**
      * Sets the chart overlays. The scatter plot implements only 1 overlay, **trendLine**.
-     * @param {ScatterPlotOverlays} overlays The overlays
+     * @param {ScatterplotOverlays} overlays The overlays
      */
-    setSeriesOverlays(overlays: ScatterPlotOverlays): void;
+    setSeriesOverlays(overlays: ScatterplotOverlays): void;
     protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
 }
-export interface ScatterPlotModel extends ModelWithXYAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides {
+export interface ScatterplotModel extends ModelWithXYAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides {
 }

package/dist/model/scatter-plot-model/utils/scatter-plot-data.d.ts

@@ -1,88 +1,88 @@
-import { SizePolicy, ISimpleMarkerSymbol, ISimpleLineSymbol, ScatterPlotOverlays } from '@arcgis/charts-spec';
-import { ScatterPlotConfig } from '../../../utils';
+import { SizePolicy, ISimpleMarkerSymbol, ISimpleLineSymbol, ScatterplotOverlays } from '@arcgis/charts-spec';
+import { ScatterplotConfig } from '../../../utils';
 import { LayerInfo } from '../../interfaces/common';
 /**
  * Gets the x-axis field from the config
  * @param config The scatter plot config
  */
-export declare const getXAxisField: (config: ScatterPlotConfig) => string;
+export declare const getXAxisField: (config: ScatterplotConfig) => string;
 /**
  * Gets the y-axis field from the config
  * @param config The scatter plot config
  */
-export declare const getYAxisField: (config: ScatterPlotConfig) => string;
+export declare const getYAxisField: (config: ScatterplotConfig) => string;
 /**
  * Sets the x-axis field name in the config
  * @param fieldName The x-axis field name
  * @param config The scatter plot config
  * @param layerInfo The layer info
  */
-export declare const setXAxisField: (fieldName: string, config: ScatterPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+export declare const setXAxisField: (fieldName: string, config: ScatterplotConfig, layerInfo: LayerInfo) => Promise<void>;
 /**
  * Sets the y-axis field in the config
  * @param fieldName The y-axis field name
  * @param config The scatter plot config
  * @param layerInfo The layer info
  */
-export declare const setYAxisField: (fieldName: string, config: ScatterPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+export declare const setYAxisField: (fieldName: string, config: ScatterplotConfig, layerInfo: LayerInfo) => Promise<void>;
 /**
  * Gets fixed marker symbol from the config
  * @param config The scatter plot config
  */
-export declare const getFixedMarkerSymbol: (config: ScatterPlotConfig) => ISimpleMarkerSymbol;
+export declare const getFixedMarkerSymbol: (config: ScatterplotConfig) => ISimpleMarkerSymbol;
 /**
  * Sets the fixed marker symbol in the config
  * @param symbol The fixed marker symbol
  * @param config The scatter plot config
  */
-export declare const setFixedMarkerSymbol: (symbol: ISimpleMarkerSymbol, config: ScatterPlotConfig) => void;
+export declare const setFixedMarkerSymbol: (symbol: ISimpleMarkerSymbol, config: ScatterplotConfig) => void;
 /**
  * Gets the show linear trend option from the config
  * @param config The scatter plot config
  */
-export declare const getShowLinearTrend: (config: ScatterPlotConfig) => boolean;
+export declare const getShowLinearTrend: (config: ScatterplotConfig) => boolean;
 /**
  * Gets linear trend symbol from the config
  * @param config The scatter plot config
  */
-export declare const getLinearTrendSymbol: (config: ScatterPlotConfig) => ISimpleLineSymbol;
+export declare const getLinearTrendSymbol: (config: ScatterplotConfig) => ISimpleLineSymbol;
 /**
  * Sets the linear trend option in the config
  * @param symbol The linear trend symbol
  * @param config The scatter plot config
  */
-export declare const setLinearTrendSymbol: (symbol: ISimpleLineSymbol, config: ScatterPlotConfig) => void;
+export declare const setLinearTrendSymbol: (symbol: ISimpleLineSymbol, config: ScatterplotConfig) => void;
 /**
  * Sets the visibility of the linear trend line in the scatter plot config
  * @param visibility The visibility of the linear trend line
  * @param config The scatter plot config
  */
-export declare const setLinearTrendLineVisibility: (visibility: boolean, config: ScatterPlotConfig) => void;
+export declare const setLinearTrendLineVisibility: (visibility: boolean, config: ScatterplotConfig) => void;
 /**
  * Sets show linear trend in the config
  * @param show Whether to show linear trend line
  * @param config The scatter plot config
  */
-export declare const setShowLinearTrend: (show: boolean, config: ScatterPlotConfig) => void;
+export declare const setShowLinearTrend: (show: boolean, config: ScatterplotConfig) => void;
 /**
  * Gets the size policy from the config
  * @param config The scatter plot config
  */
-export declare const getSizePolicy: (config: ScatterPlotConfig) => SizePolicy | undefined;
+export declare const getSizePolicy: (config: ScatterplotConfig) => SizePolicy | undefined;
 /**
  * Sets the size policy in the config
  * @param sizePolicy The size policy
  * @param config The scatter plot config
  */
-export declare const setSizePolicy: (sizePolicy: SizePolicy | undefined, config: ScatterPlotConfig) => void;
+export declare const setSizePolicy: (sizePolicy: SizePolicy | undefined, config: ScatterplotConfig) => void;
 /**
  * Gets the chart overlays. The scatter plot implements only 1 overlay, **trendLine**.
- * @param {ScatterPlotConfig} config The scatter plot config
+ * @param {ScatterplotConfig} config The scatter plot config
  */
-export declare const getSeriesOverlays: (config: ScatterPlotConfig) => ScatterPlotOverlays | undefined;
+export declare const getSeriesOverlays: (config: ScatterplotConfig) => ScatterplotOverlays | undefined;
 /**
  * Sets the chart overlays. The scatter plot implements only 1 overlay, **trendLine**.
- * @param {ScatterPlotOverlays} overlays The overlays
- * @param {ScatterPlotConfig} config The scatter plot config
+ * @param {ScatterplotOverlays} overlays The overlays
+ * @param {ScatterplotConfig} config The scatter plot config
  */
-export declare const setSeriesOverlays: (overlays: ScatterPlotOverlays, config: ScatterPlotConfig) => void;
+export declare const setSeriesOverlays: (overlays: ScatterplotOverlays, config: ScatterplotConfig) => void;

package/dist/model/shared/model-types.d.ts

@@ -0,0 +1,22 @@
+import { ChartConfig, ChartTypes } from '../../utils';
+import { ModelOfType, ModelTypes } from '../interfaces/common';
+import { ChartModel } from '../chart-model/chart-model';
+/**
+ * Converts a chart type used by charts-spec, to its corresponding model type used by the chart model.
+ * @param chartType The chart type to convert
+ * @returns The corresponding model type
+ */
+export declare function chartTypeToModelType<T extends ChartTypes>(chartType: T): ModelTypes;
+export declare function chartTypeToModelType<T extends ChartTypes>(chartType: undefined): undefined;
+export declare function chartTypeToModelType<T extends ChartTypes>(chartType: T | undefined): ModelTypes | undefined;
+/**
+ * Get the model type from the chart config
+ * @param config The chart config
+ * @returns The model type
+ */
+export declare function getModelTypeFromConfig<T extends ModelTypes>(config: ChartConfig<T>): T;
+/**
+ * Determines if the provided model's type matches the `type` argument.
+ * @param model The model to check.
+ */
+export declare function isModelOfType<T extends ModelTypes | undefined>(model: ChartModel | undefined, type: T): model is ModelOfType<T>;

package/dist/model/shared/type-guards.d.ts

@@ -1,5 +1,6 @@
 import { WebChart } from '@arcgis/charts-spec';
-import { BarChartModel, BoxPlotModel, ChartModel, LineChartModel, ModelOfType, ModelTypes, ModelWithBasicXAxis, ModelWithDataLabels, ModelWithGuides, ModelWithLegend, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithXYAxes, ModelWithYGuides, PieChartModel, ScatterPlotModel, HistogramModel } from '..';
+import { BarChartModel, BoxPlotModel, ChartModel, HistogramModel, LineChartModel, ModelOfType, ModelTypes, PieChartModel, ScatterplotModel } from '..';
+import { ModelWithBasicXAxis, ModelWithDataLabels, ModelWithGuides, ModelWithLegend, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithXYAxes, ModelWithYGuides } from '../mixins/index';
 /**
  * Determines if the provided model or config is a `ChartModel`.
  * @param model The model to check.
@@ -26,11 +27,11 @@ export declare function isPieChartModel(model: ChartModel | undefined): model is
  */
 export declare function isBoxPlotModel(model: ChartModel | undefined): model is BoxPlotModel;
 /**
- * Determines if the provided `model` is of type `ScatterPlotModel`.
+ * Determines if the provided `model` is of type `ScatterplotModel`.
  * @param model The model to check.
  *
  */
-export declare function isScatterPlotModel(model: ChartModel | undefined): model is ScatterPlotModel;
+export declare function isScatterplotModel(model: ChartModel | undefined): model is ScatterplotModel;
 /**
  * Determines if the provided `model` is of type `HistogramModel`.
  * @param model The model to check.

package/dist/model/shared/utils.d.ts

@@ -1,6 +1,5 @@
-import { ChartConfig, ChartTypes } from '../../utils';
 import { IField, SupportedLayer, WebChart, WebChartAxis, WebChartGaugeAxis } from '@arcgis/charts-spec';
-import { ModelTypes, LayerInfo, SplitByFieldInfos } from '../interfaces/common';
+import { LayerInfo, SplitByFieldInfos } from '../interfaces/common';
 /**
  * Returns the necessary information for building series based on a split-by field
  * @param props.config The chart config
@@ -43,25 +42,3 @@ export declare function getCategoryLabels(props: {
     config: WebChart;
     category: string;
 }): Promise<string[]>;
-/**
- * Converts a chart type used by charts-spec, to its corresponding model type used by the chart model.
- * @param chartType The chart type to convert
- * @returns The corresponding model type
- */
-export declare function chartTypeToModelType<T extends ChartTypes>(chartType: T): ModelTypes;
-export declare function chartTypeToModelType<T extends ChartTypes>(chartType: undefined): undefined;
-export declare function chartTypeToModelType<T extends ChartTypes>(chartType: T | undefined): ModelTypes | undefined;
-/**
- * Converts a model type used by the chart model, to its corresponding chart type used by charts-spec.
- * @param modelType The model type to convert
- * @returns The corresponding chart type
- */
-export declare function modelTypeToChartType(modelType: ModelTypes): ChartTypes;
-export declare function modelTypeToChartType(modelType: undefined): undefined;
-export declare function modelTypeToChartType(modelType: ModelTypes | undefined): ChartTypes | undefined;
-/**
- * Get the model type from the chart config
- * @param config The chart config
- * @returns The model type
- */
-export declare function getModelTypeFromConfig<T extends ModelTypes>(config: ChartConfig<T>): T;

package/dist/model/t9n/common/interfaces.d.ts

@@ -30,6 +30,6 @@ export interface ModelCommonStrings {
         lineChart: string;
         pieChart: string;
         histogram: string;
-        scatterPlot: string;
+        scatterplot: string;
     };
 }

package/dist/model/t9n/common/messages.ar.json.d.ts

@@ -30,7 +30,7 @@ declare const _default: {
     "lineChart": "مخطط خطي",
     "pieChart": "مخطط دائري",
     "histogram": "مدرج تكراري",
-    "scatterPlot": "Scatterplot"
+    "scatterplot": "Scatterplot"
   }
 }
 ;

package/dist/model/t9n/common/messages.bg.json.d.ts

@@ -30,7 +30,7 @@ declare const _default: {
     "lineChart": "Диаграма във форма на линия",
     "pieChart": "Диаграма в кръгла форма",
     "histogram": "Хистограма",
-    "scatterPlot": "Диаграма на разсейване"
+    "scatterplot": "Диаграма на разсейване"
   }
 }
 ;

package/dist/model/t9n/common/messages.bs.json.d.ts

@@ -30,7 +30,7 @@ declare const _default: {
     "lineChart": "Linijski grafikon",
     "pieChart": "Tortni grafikon",
     "histogram": "Histogram",
-    "scatterPlot": "Pravokutnik raspršivanja"
+    "scatterplot": "Pravokutnik raspršivanja"
   }
 }
 ;

package/dist/model/t9n/common/messages.ca.json.d.ts

@@ -30,7 +30,7 @@ declare const _default: {
     "lineChart": "Gràfic de línies",
     "pieChart": "Gràfic circular",
     "histogram": "Histograma",
-    "scatterPlot": "Gràfic de dispersió"
+    "scatterplot": "Gràfic de dispersió"
   }
 }
 ;

package/dist/model/t9n/common/messages.cs.json.d.ts

@@ -30,7 +30,7 @@ declare const _default: {
     "lineChart": "Spojnicový graf",
     "pieChart": "Výsečový graf",
     "histogram": "Histogram",
-    "scatterPlot": "Bodový graf"
+    "scatterplot": "Bodový graf"
   }
 }
 ;

package/dist/model/t9n/common/messages.da.json.d.ts

@@ -30,7 +30,7 @@ declare const _default: {
     "lineChart": "Linjediagram",
     "pieChart": "Cirkeldiagram",
     "histogram": "Histogram",
-    "scatterPlot": "Punktdiagram"
+    "scatterplot": "Punktdiagram"
   }
 }
 ;

package/dist/model/t9n/common/messages.de.json.d.ts

@@ -30,7 +30,7 @@ declare const _default: {
     "lineChart": "Liniendiagramm",
     "pieChart": "Kreisdiagramm",
     "histogram": "Histogramm",
-    "scatterPlot": "Scatterplot"
+    "scatterplot": "Scatterplot"
   }
 }
 ;