@arcgis/charts-components 4.34.0-next.9 → 4.34.0-next.91

package/dist/utils/localization/interfaces.d.ts

@@ -1,3 +1,493 @@
+import { SupportedLocale } from '@arcgis/toolkit/intl';
+declare const CommonStringsIdentity: (value: {
+    utilsStrings: {
+        chartType: {
+            chart: string;
+            barChart: string;
+            lineChart: string;
+            pieChart: string;
+            histogram: string;
+            scatterplot: string;
+            boxPlot: string;
+        };
+        statistics: {
+            mean: string;
+            median: string;
+            sum: string;
+            discretePercentile: string;
+            minimum: string;
+            maximum: string;
+            firstQuartile: string;
+            thirdQuartile: string;
+            iqr: string;
+            standardDeviation: string;
+            variance: string;
+            count: string;
+            aggregation: string;
+            percent: string;
+            noAggregation: string;
+            meanValue: string;
+        };
+        overlays: {
+            mean: string;
+            median: string;
+            stdDev: string;
+            normal: string;
+            trendline: string;
+        };
+        actions: {
+            editChart: string;
+            expand: string;
+            collapse: string;
+        };
+        tooltips: {
+            logDisabled: string;
+        };
+        guideTooltipLabel: string;
+        pieChart: {
+            defaultSliceGroupingLabel: string;
+        };
+        notAvailable: string;
+        field: string;
+    };
+    errorStrings: {
+        errorHeading: string;
+        placeholders: {
+            barChartCreateMsg: string;
+            boxPlotCreateMsg: string;
+            lineChartCreateMsg: string;
+            pieChartCreateMsg: string;
+            histogramCreateMsg: string;
+            scatterplotCreateMsg: string;
+        };
+        notifications: {
+            invalidConfig: string;
+            invalidSeriesConfig: string;
+            invalidSeriesConfigTitle: string;
+            validateAggregationTypeMsg: string;
+            missingNumericFields: string;
+            noAggregationRequiresNumericFields: string;
+        };
+        tooManySelectedElements: {
+            title: string;
+            message: string;
+        };
+        incompatibleChartVersion: {
+            title: string;
+            message: string;
+        };
+        modalHeaders: {
+            invalidData: string;
+            invalidChart: string;
+            noDataAvailable: string;
+            tooManyFeatures: string;
+            cannotCombineNegativeAndPositiveSlices: string;
+            error: string;
+            warning: string;
+            newChart: string;
+        };
+        errors: {
+            divNode: string;
+            errorRequest: string;
+            warningRequest: string;
+            newChartRequest: string;
+            invalidValueFormatForLineChart: string;
+            invalidValueFormatForBarChart: string;
+            invalidValueFormatForComboBarLineChart: string;
+            invalidValueFormatForBoxPlot: string;
+            invalidValueFormatForHistogram: string;
+            invalidValueFormatForScatterplot: string;
+            invalidValueFormatForGauge: string;
+            mismatchAxisAndValueFormat: string;
+            queryError: string;
+            simpleError: string;
+            defaultInvalidChart: string;
+            categoryCountCannotExceedLimit: string;
+            uniqueSeriesBarCountCannotExceedLimit: string;
+            twoSeriesBarCountCannotExceedLimit: string;
+            threePlusSeriesBarCountCannotExceedLimit: string;
+            barSeriesCountCannotExceedLimit: string;
+            uniqueSeriesLineCountCannotExceedLimit: string;
+            twoSeriesLineCountCannotExceedLimit: string;
+            threePlusSeriesLineCountCannotExceedLimit: string;
+            uniqueTemporalSeriesLineCountCannotExceedLimit: string;
+            twoTemporalSeriesLineCountCannotExceedLimit: string;
+            threePlusTemporalSeriesLineCountCannotExceedLimit: string;
+            lineSeriesCountCannotExceedLimit: string;
+            uniqueSeriesBoxCountCannotExceedLimit: string;
+            twoSeriesBoxCountCannotExceedLimit: string;
+            threePlusBoxLineCountCannotExceedLimit: string;
+            boxSeriesCountCannotExceedLimit: string;
+            boxSeriesOutlierCannotExceedLimit: string;
+            pieChartCannotHaveMixtureOfPositiveAndNegativeSlices: string;
+            pieChartSlicesCannotExceedLimit: string;
+            gaugeCannotExceedLimit: string;
+            negativeValueInDataForLogTransformation: string;
+            negativeValueInDataForSqrtTransformation: string;
+            logarithmicXAxisNotPossible: string;
+            logarithmicYAxisNotPossible: string;
+            histogramEmptyField: string;
+            noDataMessage: string;
+            noDataFBSMessage: string;
+            noDataFBEMessage: string;
+            exportImageChartNotReady: string;
+            exportImage: string;
+            defaultError: string;
+            layerLoadFailure: string;
+            layerFieldsNotFound: string;
+            duplicateSeriesID: string;
+            nonNumericAggregation: string;
+            requiredProperty: string;
+            minLength: string;
+            minItems: string;
+            maxItems: string;
+            whiteSpacePattern: string;
+            additionalProperty: string;
+            enumValues: string;
+            anyOfValues: string;
+            bubbleChartValidateMsg: string;
+            queryBinsNotSupported: string;
+            invalidSeriesType: string;
+            or: string;
+        };
+    };
+    countSeries: string;
+    xAxis: string;
+    timeAggregationTypes: {
+        start: string;
+        end: string;
+    };
+    axisLabels: {
+        values: string;
+        standardizedValues: string;
+        aggregationOfValues: string;
+        aggregationOfFieldName: string;
+    };
+    titleLabels: {
+        aggrFieldsByCategory: string;
+        aggrTypeCategory: string;
+        aggrTypeCategoryBySplitBy: string;
+        aggrTypeOfAggrFields: string;
+        aggrTypeOfAggrFieldByCategoryBySplitByField: string;
+        aggrTypeOfAggrFieldsByCategory: string;
+        aggrFieldsByXAxisField: string;
+        aggrTypeXAxisField: string;
+        aggrTypeXAxisFieldBySplitBy: string;
+        aggrTypeOfAggrFieldByXAxisFieldBySplitByField: string;
+        aggrTypeOfAggrFieldsByXAxisField: string;
+        distributionOfField: string;
+        distributionOfFields: string;
+        distributionOfFieldsByCategory: string;
+        distributionOfFieldsByCategoryAndSplitBy: string;
+        xAndY: string;
+    };
+    customAmchartsStrings: {
+        "Zoom Out": string;
+        Play: string;
+        Stop: string;
+        Legend: string;
+        "Press ENTER to toggle": string;
+        Loading: string;
+        Home: string;
+        Chart: string;
+        "Serial chart": string;
+        "X/Y chart": string;
+        "Pie chart": string;
+        "Gauge chart": string;
+        "Radar chart": string;
+        "Sankey diagram": string;
+        "Flow diagram": string;
+        "Chord diagram": string;
+        "TreeMap chart": string;
+        "Sliced chart": string;
+        Series: string;
+        "Candlestick Series": string;
+        "OHLC Series": string;
+        "Column Series": string;
+        "Line Series": string;
+        "Pie Slice Series": string;
+        "Funnel Series": string;
+        "Pyramid Series": string;
+        "X/Y Series": string;
+        Map: string;
+        "Press ENTER to zoom in": string;
+        "Press ENTER to zoom out": string;
+        "Use arrow keys to zoom in and out": string;
+        "Use plus and minus keys on your keyboard to zoom in and out": string;
+        Export: string;
+        Image: string;
+        Data: string;
+        Print: string;
+        "Press ENTER to open": string;
+        "Press ENTER to print.": string;
+        "Press ENTER to export as %1.": string;
+        "(Press ESC to close this message)": string;
+        "Image Export Complete": string;
+        "Export operation took longer than expected. Something might have gone wrong.": string;
+        "Saved from": string;
+        "Use TAB to select grip buttons or left and right arrows to change selection": string;
+        "Use left and right arrows to move selection": string;
+        "Use left and right arrows to move left selection": string;
+        "Use left and right arrows to move right selection": string;
+        "Use TAB select grip buttons or up and down arrows to change selection": string;
+        "Use up and down arrows to move selection": string;
+        "Use up and down arrows to move lower selection": string;
+        "Use up and down arrows to move upper selection": string;
+        "From %1 to %2": string;
+        "From %1": string;
+        "To %1": string;
+        "No parser available for file: %1": string;
+        "Error parsing file: %1": string;
+        "Unable to load file: %1": string;
+        "Invalid date": string;
+    };
+}) => {
+    utilsStrings: {
+        chartType: {
+            chart: string;
+            barChart: string;
+            lineChart: string;
+            pieChart: string;
+            histogram: string;
+            scatterplot: string;
+            boxPlot: string;
+        };
+        statistics: {
+            mean: string;
+            median: string;
+            sum: string;
+            discretePercentile: string;
+            minimum: string;
+            maximum: string;
+            firstQuartile: string;
+            thirdQuartile: string;
+            iqr: string;
+            standardDeviation: string;
+            variance: string;
+            count: string;
+            aggregation: string;
+            percent: string;
+            noAggregation: string;
+            meanValue: string;
+        };
+        overlays: {
+            mean: string;
+            median: string;
+            stdDev: string;
+            normal: string;
+            trendline: string;
+        };
+        actions: {
+            editChart: string;
+            expand: string;
+            collapse: string;
+        };
+        tooltips: {
+            logDisabled: string;
+        };
+        guideTooltipLabel: string;
+        pieChart: {
+            defaultSliceGroupingLabel: string;
+        };
+        notAvailable: string;
+        field: string;
+    };
+    errorStrings: {
+        errorHeading: string;
+        placeholders: {
+            barChartCreateMsg: string;
+            boxPlotCreateMsg: string;
+            lineChartCreateMsg: string;
+            pieChartCreateMsg: string;
+            histogramCreateMsg: string;
+            scatterplotCreateMsg: string;
+        };
+        notifications: {
+            invalidConfig: string;
+            invalidSeriesConfig: string;
+            invalidSeriesConfigTitle: string;
+            validateAggregationTypeMsg: string;
+            missingNumericFields: string;
+            noAggregationRequiresNumericFields: string;
+        };
+        tooManySelectedElements: {
+            title: string;
+            message: string;
+        };
+        incompatibleChartVersion: {
+            title: string;
+            message: string;
+        };
+        modalHeaders: {
+            invalidData: string;
+            invalidChart: string;
+            noDataAvailable: string;
+            tooManyFeatures: string;
+            cannotCombineNegativeAndPositiveSlices: string;
+            error: string;
+            warning: string;
+            newChart: string;
+        };
+        errors: {
+            divNode: string;
+            errorRequest: string;
+            warningRequest: string;
+            newChartRequest: string;
+            invalidValueFormatForLineChart: string;
+            invalidValueFormatForBarChart: string;
+            invalidValueFormatForComboBarLineChart: string;
+            invalidValueFormatForBoxPlot: string;
+            invalidValueFormatForHistogram: string;
+            invalidValueFormatForScatterplot: string;
+            invalidValueFormatForGauge: string;
+            mismatchAxisAndValueFormat: string;
+            queryError: string;
+            simpleError: string;
+            defaultInvalidChart: string;
+            categoryCountCannotExceedLimit: string;
+            uniqueSeriesBarCountCannotExceedLimit: string;
+            twoSeriesBarCountCannotExceedLimit: string;
+            threePlusSeriesBarCountCannotExceedLimit: string;
+            barSeriesCountCannotExceedLimit: string;
+            uniqueSeriesLineCountCannotExceedLimit: string;
+            twoSeriesLineCountCannotExceedLimit: string;
+            threePlusSeriesLineCountCannotExceedLimit: string;
+            uniqueTemporalSeriesLineCountCannotExceedLimit: string;
+            twoTemporalSeriesLineCountCannotExceedLimit: string;
+            threePlusTemporalSeriesLineCountCannotExceedLimit: string;
+            lineSeriesCountCannotExceedLimit: string;
+            uniqueSeriesBoxCountCannotExceedLimit: string;
+            twoSeriesBoxCountCannotExceedLimit: string;
+            threePlusBoxLineCountCannotExceedLimit: string;
+            boxSeriesCountCannotExceedLimit: string;
+            boxSeriesOutlierCannotExceedLimit: string;
+            pieChartCannotHaveMixtureOfPositiveAndNegativeSlices: string;
+            pieChartSlicesCannotExceedLimit: string;
+            gaugeCannotExceedLimit: string;
+            negativeValueInDataForLogTransformation: string;
+            negativeValueInDataForSqrtTransformation: string;
+            logarithmicXAxisNotPossible: string;
+            logarithmicYAxisNotPossible: string;
+            histogramEmptyField: string;
+            noDataMessage: string;
+            noDataFBSMessage: string;
+            noDataFBEMessage: string;
+            exportImageChartNotReady: string;
+            exportImage: string;
+            defaultError: string;
+            layerLoadFailure: string;
+            layerFieldsNotFound: string;
+            duplicateSeriesID: string;
+            nonNumericAggregation: string;
+            requiredProperty: string;
+            minLength: string;
+            minItems: string;
+            maxItems: string;
+            whiteSpacePattern: string;
+            additionalProperty: string;
+            enumValues: string;
+            anyOfValues: string;
+            bubbleChartValidateMsg: string;
+            queryBinsNotSupported: string;
+            invalidSeriesType: string;
+            or: string;
+        };
+    };
+    countSeries: string;
+    xAxis: string;
+    timeAggregationTypes: {
+        start: string;
+        end: string;
+    };
+    axisLabels: {
+        values: string;
+        standardizedValues: string;
+        aggregationOfValues: string;
+        aggregationOfFieldName: string;
+    };
+    titleLabels: {
+        aggrFieldsByCategory: string;
+        aggrTypeCategory: string;
+        aggrTypeCategoryBySplitBy: string;
+        aggrTypeOfAggrFields: string;
+        aggrTypeOfAggrFieldByCategoryBySplitByField: string;
+        aggrTypeOfAggrFieldsByCategory: string;
+        aggrFieldsByXAxisField: string;
+        aggrTypeXAxisField: string;
+        aggrTypeXAxisFieldBySplitBy: string;
+        aggrTypeOfAggrFieldByXAxisFieldBySplitByField: string;
+        aggrTypeOfAggrFieldsByXAxisField: string;
+        distributionOfField: string;
+        distributionOfFields: string;
+        distributionOfFieldsByCategory: string;
+        distributionOfFieldsByCategoryAndSplitBy: string;
+        xAndY: string;
+    };
+    customAmchartsStrings: {
+        "Zoom Out": string;
+        Play: string;
+        Stop: string;
+        Legend: string;
+        "Press ENTER to toggle": string;
+        Loading: string;
+        Home: string;
+        Chart: string;
+        "Serial chart": string;
+        "X/Y chart": string;
+        "Pie chart": string;
+        "Gauge chart": string;
+        "Radar chart": string;
+        "Sankey diagram": string;
+        "Flow diagram": string;
+        "Chord diagram": string;
+        "TreeMap chart": string;
+        "Sliced chart": string;
+        Series: string;
+        "Candlestick Series": string;
+        "OHLC Series": string;
+        "Column Series": string;
+        "Line Series": string;
+        "Pie Slice Series": string;
+        "Funnel Series": string;
+        "Pyramid Series": string;
+        "X/Y Series": string;
+        Map: string;
+        "Press ENTER to zoom in": string;
+        "Press ENTER to zoom out": string;
+        "Use arrow keys to zoom in and out": string;
+        "Use plus and minus keys on your keyboard to zoom in and out": string;
+        Export: string;
+        Image: string;
+        Data: string;
+        Print: string;
+        "Press ENTER to open": string;
+        "Press ENTER to print.": string;
+        "Press ENTER to export as %1.": string;
+        "(Press ESC to close this message)": string;
+        "Image Export Complete": string;
+        "Export operation took longer than expected. Something might have gone wrong.": string;
+        "Saved from": string;
+        "Use TAB to select grip buttons or left and right arrows to change selection": string;
+        "Use left and right arrows to move selection": string;
+        "Use left and right arrows to move left selection": string;
+        "Use left and right arrows to move right selection": string;
+        "Use TAB select grip buttons or up and down arrows to change selection": string;
+        "Use up and down arrows to move selection": string;
+        "Use up and down arrows to move lower selection": string;
+        "Use up and down arrows to move upper selection": string;
+        "From %1 to %2": string;
+        "From %1": string;
+        "To %1": string;
+        "No parser available for file: %1": string;
+        "Error parsing file: %1": string;
+        "Unable to load file: %1": string;
+        "Invalid date": string;
+    };
+};
+export type CommonStrings = ReturnType<typeof CommonStringsIdentity>;
+export type ErrorStrings = ReturnType<typeof CommonStringsIdentity>["errorStrings"];
+export type UtilsStrings = ReturnType<typeof CommonStringsIdentity>["utilsStrings"];
+export type CustomAmchartsStrings = ReturnType<typeof CommonStringsIdentity>["customAmchartsStrings"];
 export interface LocaleItem {
     [key: string]: LocaleItem | string;
 }
@@ -5,59 +495,11 @@ export interface ComponentLocaleItem<T extends LocaleItem> {
     strings: T;
     direction: "ltr" | "rtl";
 }
-/**
- * Locale list (in alphabetical order) adopted from [JSAPI](https://devtopia.esri.com/WebGIS/arcgis-js-api/tree/master/esri/nls)
- * Full forms adopted from [1](https://www.science.co.il/language/Locale-codes.php) and [2](https://saimana.com/list-of-country-locale-code/)
- */
-export declare const SupportedLocales: {
-    readonly Arabic: "ar";
-    readonly ArabicLatin: "ar-u-nu-latn";
-    readonly Bosnian: "bs";
-    readonly Bulgarian: "bg";
-    readonly Catalan: "ca";
-    readonly Czech: "cs";
-    readonly Danish: "da";
-    readonly German: "de";
-    readonly Greek: "el";
-    readonly English: "en";
-    readonly EnglishUSA: "en-US";
-    readonly Spanish: "es";
-    readonly Estonian: "et";
-    readonly Finnish: "fi";
-    readonly French: "fr";
-    readonly Hebrew: "he";
-    readonly Croatian: "hr";
-    readonly Hungarian: "hu";
-    readonly Indonesian: "id";
-    readonly Italian: "it";
-    readonly Japanese: "ja";
-    readonly Korean: "ko";
-    readonly Lithuanian: "lt";
-    readonly Latvian: "lv";
-    readonly NorwegianBokml: "no";
-    readonly Dutch: "nl";
-    readonly Polish: "pl";
-    readonly PortugueseBrazil: "pt-BR";
-    readonly PortuguesePortugal: "pt-PT";
-    readonly Romanian: "ro";
-    readonly Russian: "ru";
-    readonly Serbian: "sr";
-    readonly Slovenian: "sl";
-    readonly Slovak: "sk";
-    readonly Swedish: "sv";
-    readonly Thai: "th";
-    readonly Turkish: "tr";
-    readonly Ukrainian: "uk";
-    readonly Vietnamese: "vi";
-    readonly ChineseChina: "zh-CN";
-    readonly ChineseHongKong: "zh-HK";
-    readonly ChineseTaiwan: "zh-TW";
-};
-export type SupportedLocales = (typeof SupportedLocales)[keyof typeof SupportedLocales];
 export declare const SupportedLocalesForFormats: string[];
-export type SupportedLocalesForFormats = SupportedLocales | "de-AT" | "de-CH" | "de-DE" | "en-AU" | "en-GB" | "es-ES" | "es-MX" | "it-CH" | "it-IT";
+export type SupportedLocalesForFormats = SupportedLocale | "ar-u-nu-latn" | "de-AT" | "de-CH" | "de-DE" | "en-AU" | "en-GB" | "es-ES" | "es-MX" | "it-CH" | "it-IT";
 export interface LocaleInfo {
-    locale: SupportedLocales;
+    locale: SupportedLocale;
     formatLocale: SupportedLocalesForFormats;
     rtl: boolean;
 }
+export {};

package/dist/utils/misc/index.d.ts

@@ -1,10 +1,10 @@
 import { IField, LegendItemVisibility, WebBoxPlot, WebChart, WebChartDataItem, WebChartDataItemValue, WebChartSeries, WebChartStackedKinds, OverlayTerms, WebChartSortOrderKinds, WebChartTemporalBinningUnits, WebChartTypes } from '@arcgis/charts-spec';
 import { ChartElementLimit } from '../defaults/interfaces';
 import { SelectionData, ChartSubType } from './interfaces';
-type WebChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.GaugeSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
+type WebChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.GaugeSeries | typeof WebChartTypes.HeatChartSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
 type XYChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
 type SerialChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries;
-type SupportedChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
+type SupportedChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.HeatChartSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
 export type ChartTypes = Extract<WebChartTypes, WebChartType>;
 export type XYChartTypes = Extract<WebChartTypes, XYChartType>;
 export type SerialChartTypes = Extract<WebChartTypes, SerialChartType>;
@@ -95,9 +95,24 @@ export declare function getFieldNameFromFieldAlias(fields: IField[] | undefined,
  * @param chartSeries
  */
 export declare function canShowLegend(chartSeries: WebChartSeries[]): boolean;
+/**
+ * Returns whether a scatterplot is currently supported
+ * @param config The chart's config
+ */
+declare function isSupportedScatterplot(config: WebChart): boolean;
+/**
+ * Returns whether a histogram is currently supported
+ * @param config The chart's config
+ */
+declare function isSupportedHistogram(config: WebChart): boolean;
+/**
+ * Returns whether a pie chart is currently supported
+ * @param config The chart's config
+ */
+declare function isSupportedPieChart(config: WebChart): boolean;
 /**
  * Based on a provided list of supported chart types, this function returns a boolean indicating if the config
- * contains supported series. An extra test is done for the scatter plot, pie, and histogram series.
+ * contains supported series. An extra test is done for the scatterplot, pie, and histogram series.
  * @param supportedChartTypes The list of supported chart types
  * @param config The chart's config
  */
@@ -221,4 +236,9 @@ export declare function sortArrayAUsingArrayB<T, K>(props?: {
     arrayB: T[];
     getKey: (item: T) => K;
 }): T[];
+export declare const miscPrivateFunctions: {
+    isSupportedHistogram: typeof isSupportedHistogram;
+    isSupportedPieChart: typeof isSupportedPieChart;
+    isSupportedScatterplot: typeof isSupportedScatterplot;
+};
 export {};

package/dist/utils/misc/interfaces.d.ts

@@ -81,7 +81,7 @@ export type PieSlicesSymbols = {
  * The numeric key is the series' position in the series array.
  * The value is either:
  *   - a fill symbol (bar chart and histogram)
- *   - a marker symbol (scatter plot)
+ *   - a marker symbol (scatterplot)
  *   - an object containing a line symbol and a marker symbol (line chart)
  */
 export type SeriesSymbolsMap = Map<number, SeriesSymbols | undefined>;

package/dist/utils/type-guards/index.d.ts

@@ -1,7 +1,7 @@
-import { CategoryFormatOptions, DateTimeFormatOptions, IFeatureLayer, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, NumberFormatOptions, WebBoxPlot, WebChart, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartDataTypes, WebChartGenericDataItem, WebChartHistogramDataItem, WebChartLineChartSeries, WebChartRadarChartSeries, WebChartScatterplotDataItem, WebChartSeries, WebChartStackedKinds, WebChartTextSymbol, WebGaugeChart } from '@arcgis/charts-spec';
+import { CategoryFormatOptions, DateTimeFormatOptions, IFeatureLayer, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, NumberFormatOptions, WebBoxPlot, WebChart, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartDataTypes, WebChartGenericDataItem, WebChartHistogramDataItem, WebChartLineChartSeries, WebChartRadarChartSeries, WebChartScatterplotDataItem, WebChartSeries, WebChartStackedKinds, WebChartTextSymbol, WebGaugeChart, WebHeatChart } from '@arcgis/charts-spec';
+import { ModelTypes } from '../../model';
 import { ChartTypes } from '../misc';
 import { ChartConfig } from '../types';
-import { ModelTypes } from '../../model';
 export type StringIndexable<T> = Record<string, unknown> & T;
 /**
  * Web chart series with rotated property
@@ -53,7 +53,7 @@ export declare function isWebChartTextSymbol(symbol: any): symbol is WebChartTex
  * Determines if the provided `config` has a `iLayer` property.
  * @param config
  */
-export declare function hasILayer<T extends ModelTypes>(config: ChartConfig<T> | undefined): config is ChartConfig<T, T extends "boxPlot" ? WebBoxPlot : T extends "gauge" ? WebGaugeChart : WebChart>;
+export declare function hasILayer<T extends ModelTypes>(config: ChartConfig<T> | undefined): config is ChartConfig<T, T extends "boxPlot" ? WebBoxPlot : T extends "gauge" ? WebGaugeChart : T extends "heatChart" ? WebHeatChart : WebChart>;
 export declare function hasILayer(config: WebChart | undefined): config is WebChart & {
     iLayer: IFeatureLayer;
 };
@@ -67,18 +67,18 @@ export declare function isChartType<T extends ChartConfig>(config: WebChart | un
  * Determines if the series is a box plot series.
  * @param series The series to check.
  */
-export declare function isBoxPlotSeries(series: WebChartSeries): series is WebChartBoxPlotSeries;
+export declare function isBoxPlotSeries(series: WebChartSeries | undefined): series is WebChartBoxPlotSeries;
 /**
  * Determines if the series is a line chart series.
  * @param series The series to check.
  */
-export declare function isLineChartSeries(series: WebChartSeries): series is WebChartLineChartSeries;
-export declare function isRadarChartSeries(series: WebChartSeries): series is WebChartRadarChartSeries;
+export declare function isLineChartSeries(series: WebChartSeries | undefined): series is WebChartLineChartSeries;
+export declare function isRadarChartSeries(series: WebChartSeries | undefined): series is WebChartRadarChartSeries;
 /**
  * Determines if the series is a bar chart series.
  * @param series The series to check.
  */
-export declare function isBarChartSeries(series: WebChartSeries): series is WebChartBarChartSeries;
+export declare function isBarChartSeries(series: WebChartSeries | undefined): series is WebChartBarChartSeries;
 /**
  * Type guard to check if the series is a BarChartSeries.
  * @param {WebChartSeries[]} series - The series to check.

package/dist/utils/type-guards/series-types.d.ts

@@ -1,5 +1,15 @@
 import { WebChartSeries } from '@arcgis/charts-spec';
 import { ChartTypes } from '../misc';
+/**
+ * Determines if a Set of series type matches a combo bar-line chart
+ * @param uniqueTypes The set of unique series types
+ */
+declare function isComboLineAndBarChart(uniqueTypes: Set<string>): boolean | undefined;
+/**
+ * Determines if a Set of series type matches a box plot
+ * @param uniqueTypes The set of unique series types
+ */
+declare function isBoxPlotChart(uniqueTypes: Set<string>): boolean;
 /**
  * Getting the type of a chart or series. If the input parameters are incorrect (empty array of series, or a mix of unknown/unallowed series types) the function returns `undefined`.
  * To get the series type, a valid seriesIndex is required. Otherwise, the type of a chart is determined and returned.
@@ -7,3 +17,8 @@ import { ChartTypes } from '../misc';
  * @param seriesIndex An index to get a specific series' type.  A valid index is required if the goal is to get the type of the series.
  */
 export declare function getChartOrSeriesType(chartSeries: WebChartSeries[] | undefined, seriesIndex?: number): ChartTypes | undefined;
+export declare const typeGuardsPrivateFunctions: {
+    isComboLineAndBarChart: typeof isComboLineAndBarChart;
+    isBoxPlotChart: typeof isBoxPlotChart;
+};
+export {};