@arcgis/charts-components 5.0.0-next.16 → 5.0.0-next.161

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

@@ -1,5 +1,37 @@
-import { SupportedLocale } from '@arcgis/toolkit/intl';
-declare const CommonStringsIdentity: (value: {
+import type { SupportedLocale } from "@arcgis/toolkit/intl";
+
+export type CommonStrings = ReturnType<typeof CommonStringsIdentity>;
+
+export type ErrorStrings = ReturnType<typeof CommonStringsIdentity>["errorStrings"];
+
+export type UtilsStrings = ReturnType<typeof CommonStringsIdentity>["utilsStrings"];
+
+/** @internal */
+export type CustomAmchartsStrings = ReturnType<typeof CommonStringsIdentity>["customAmchartsStrings"];
+
+/** @internal */
+export type LocaleItem = { [key: string]: LocaleItem | string; };
+
+/** @internal */
+export interface ComponentLocaleItem<T extends LocaleItem> {
+  strings: T;
+  direction: "ltr" | "rtl";
+}
+
+/** @internal */
+export const SupportedLocalesForFormats: (("id" | "ar" | "bg" | "bs" | "ca" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "he" | "hr" | "hu" | "it" | "ja" | "ko" | "lt" | "lv" | "nl" | "nb" | "no" | "pl" | "pt-BR" | "pt-PT" | "ro" | "ru" | "sk" | "sl" | "sr" | "sv" | "th" | "tr" | "uk" | "vi" | "zh-CN" | "zh-HK" | "zh-TW") | string | string | string | string | string | string | string | string | string | string | string)[];
+
+/** @internal */
+export type SupportedLocalesForFormats = SupportedLocale | "ar-u-nu-latn" | "de-AT" | "de-CH" | "de-DE" | "en-AU" | "en-GB" | "es-ES" | "es-MX" | "fr-CA" | "it-CH" | "it-IT";
+
+/** @internal */
+export interface LocaleInfo {
+  locale: SupportedLocale;
+  formatLocale: SupportedLocalesForFormats;
+  rtl: boolean;
+}
+
+export const CommonStringsIdentity: (value: {
     utilsStrings: {
         chartType: {
             chart: string;
@@ -9,6 +41,9 @@ declare const CommonStringsIdentity: (value: {
             histogram: string;
             scatterplot: string;
             boxPlot: string;
+            heatChart: string;
+            calendarHeatChart: string;
+            matrixHeatChart: string;
         };
         statistics: {
             mean: string;
@@ -40,23 +75,22 @@ declare const CommonStringsIdentity: (value: {
             expand: string;
             collapse: string;
         };
-        tooltips: {
-            logDisabled: string;
-        };
+        tooltips: { logDisabled: string; };
         guideTooltipLabel: string;
-        pieChart: {
-            defaultSliceGroupingLabel: string;
-        };
+        pieChart: { defaultSliceGroupingLabel: string; };
         notAvailable: string;
         field: string;
-        dayOfWeek: string;
-        monthOfYear: string;
-        dayOfMonth: string;
-        hourOfDay: string;
-        dayOfYear: string;
-        minuteOfDay: string;
-        weekOfYear: string;
-        quarterOfYear: string;
+        heatChartCalendarDatePartsUnits: {
+            dayOfWeek: string;
+            monthOfYear: string;
+            dayOfMonth: string;
+            hourOfDay: string;
+            dayOfYear: string;
+            minuteOfDay: string;
+            weekOfYear: string;
+            quarterOfYear: string;
+        };
+        null: string;
     };
     errorStrings: {
         errorHeading: string;
@@ -67,6 +101,7 @@ declare const CommonStringsIdentity: (value: {
             pieChartCreateMsg: string;
             histogramCreateMsg: string;
             scatterplotCreateMsg: string;
+            calendarHeatChartCreateMsg: string;
         };
         notifications: {
             invalidConfig: string;
@@ -261,6 +296,9 @@ declare const CommonStringsIdentity: (value: {
             histogram: string;
             scatterplot: string;
             boxPlot: string;
+            heatChart: string;
+            calendarHeatChart: string;
+            matrixHeatChart: string;
         };
         statistics: {
             mean: string;
@@ -292,23 +330,22 @@ declare const CommonStringsIdentity: (value: {
             expand: string;
             collapse: string;
         };
-        tooltips: {
-            logDisabled: string;
-        };
+        tooltips: { logDisabled: string; };
         guideTooltipLabel: string;
-        pieChart: {
-            defaultSliceGroupingLabel: string;
-        };
+        pieChart: { defaultSliceGroupingLabel: string; };
         notAvailable: string;
         field: string;
-        dayOfWeek: string;
-        monthOfYear: string;
-        dayOfMonth: string;
-        hourOfDay: string;
-        dayOfYear: string;
-        minuteOfDay: string;
-        weekOfYear: string;
-        quarterOfYear: string;
+        heatChartCalendarDatePartsUnits: {
+            dayOfWeek: string;
+            monthOfYear: string;
+            dayOfMonth: string;
+            hourOfDay: string;
+            dayOfYear: string;
+            minuteOfDay: string;
+            weekOfYear: string;
+            quarterOfYear: string;
+        };
+        null: string;
     };
     errorStrings: {
         errorHeading: string;
@@ -319,6 +356,7 @@ declare const CommonStringsIdentity: (value: {
             pieChartCreateMsg: string;
             histogramCreateMsg: string;
             scatterplotCreateMsg: string;
+            calendarHeatChartCreateMsg: string;
         };
         notifications: {
             invalidConfig: string;
@@ -503,23 +541,4 @@ declare const CommonStringsIdentity: (value: {
         "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;
-}
-export interface ComponentLocaleItem<T extends LocaleItem> {
-    strings: T;
-    direction: "ltr" | "rtl";
-}
-export declare const SupportedLocalesForFormats: string[];
-export type SupportedLocalesForFormats = SupportedLocale | "ar-u-nu-latn" | "de-AT" | "de-CH" | "de-DE" | "en-AU" | "en-GB" | "es-ES" | "es-MX" | "fr-CA" | "it-CH" | "it-IT";
-export interface LocaleInfo {
-    locale: SupportedLocale;
-    formatLocale: SupportedLocalesForFormats;
-    rtl: boolean;
-}
-export {};
+};

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

@@ -1,43 +1,75 @@
-import { IField, LegendItemVisibility, WebBoxPlot, WebChart, WebChartDataItem, WebChartDataItemValue, WebChartSeries, WebChartStackedKinds, OverlayTerms, WebChartSortOrderKinds, WebChartTemporalBinningUnits, WebChartTypes } from '../../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.HeatSeries | 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.HeatSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
-type SerialChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.HeatSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries;
-type SupportedChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.HeatSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
+import type { ChartElementLimit } from "../defaults/interfaces.js";
+import type { SelectionData, ChartSubType } from "./interfaces.js";
+import type { WebChartSortOrderKinds, WebChartTemporalBinningUnits, WebChartTypes, WebChartStackedKinds } from "../../spec/chart-object-literals.js";
+import type { WebBoxPlot, WebChart, WebChartSeries, WebChartSeriesType } from "../../spec/web-chart.js";
+import type { IField } from "../../spec/rest-js-types.js";
+import type { WebChartDataItem, WebChartDataItemValue } from "../../spec/data-source.js";
+import type { OverlayTerms, LegendItemVisibility } from "../../spec/events.js";
+
+/** @internal */
+export type XYChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.HeatSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
+
+/** @internal */
+export type SerialChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.HeatSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries;
+
+/** @internal */
+export type SupportedChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.HeatSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
+
+/** @internal */
 export type ChartTypes = Extract<WebChartTypes, WebChartType>;
+
+/** @internal */
 export type XYChartTypes = Extract<WebChartTypes, XYChartType>;
+
+/** @internal */
 export type SerialChartTypes = Extract<WebChartTypes, SerialChartType>;
+
+/** @internal */
 export type SupportedCharts = Extract<ChartTypes, SupportedChartType>;
+
 /**
  * Returns the color policy for the chart.  If it's not defined, `WebChartColoringPatterns.Single` will be used.
- * @param chartConfig the chart config.
+ *
+ * @param chartConfig - the chart config.
  * @returns the color policy.
+ * @internal
  */
-export declare function getColorMatch(chartConfig?: WebChart): boolean;
+export function getColorMatch(chartConfig?: WebChart): boolean;
+
 /**
  * Indicates whether or not the chart is rotated.
- * @param chartConfig the chart config.
- * @returns
+ *
+ * @param chartConfig - the chart config.
+ * @internal
  */
-export declare function isChartRotated(chartConfig?: WebChart): boolean;
+export function isChartRotated(chartConfig?: WebChart): boolean;
+
 /**
  * Getting the list of series types from a series config array.
- * @param chartSeries The array of chart's series
+ *
+ * @param chartSeries - The array of chart's series
+ * @internal
  */
-export declare function getSeriesTypes(chartSeries?: WebChartSeries[]): ChartTypes[];
+export function getSeriesTypes(chartSeries?: WebChartSeries[]): ChartTypes[];
+
 /**
  * Returns the type of stacking (side-by-side, stacked...) to be used to display the chart.
  * For Line, Bar, Box-plot, and Radar chart, default option is 'sideBySide'
- * @param series
+ *
+ * @param config
+ * @internal
  */
-export declare function getStackedType(config?: WebChart): WebChartStackedKinds | undefined;
+export function getStackedType(config?: WebChart): WebChartStackedKinds | undefined;
+
 /**
  * Escapes any single quote in the input string with a single quote for SQL.
  * For example: Cote d'Ivoire -> Cote d''Ivoire
- * @param string input string to replace for any special characters.
+ *
+ * @param string - input string to replace for any special characters.
+ * @internal
  */
-export declare function escapeSQLString(string: string): string;
+export function escapeSQLString(string: string): string;
+
 /**
  * Normalizes a string by
  *   - trimming off white spaces
@@ -50,108 +82,136 @@ export declare function escapeSQLString(string: string): string;
  * "alp'ha'" => alp''ha
  * "  'alpha'" => "alpha"
  * "alp"\/ha" => "alp\"\\\/ha"
- * @param props.value The string to normalize
- * @param props.keepSurroundingQuotes Whether to keep the surrounding quotes; default is false
- * @param props.escape Whether to escape special characters; default is true
+ *
+ * @param props - The string to normalize
+ * @internal
  */
-export declare function normalizeString(props: {
+export function normalizeString(props: {
     value: string;
     keepSurroundingQuotes?: boolean;
     escape?: boolean;
 }): string;
+
 /**
  * Indicates whether a chart respects the number limit of elements (bars, markers, cells or slices).
  * For bar chart, different limits are set according to the number of series.
  * For line chart, a limit on the number of series and the total number of markers are set.
  * For heat chart, a limit on the number of cells is set.
  * For pie chart, a limit on the number of slices is set.
- * @param props.count Number total of elements on the chart
- * @param props.seriesCount Number of series on the chart
- * @param props.seriesType The series type
- * @param props.chartLimits The runtime chart limits
+ *
+ * @param props - Number total of elements on the chart
+ * @internal
  */
-export declare function isNumberOfElementsUnderLimit(props: {
+export function isNumberOfElementsUnderLimit(props: {
     count: number;
     seriesCount: number;
     chartType?: WebChartTypes;
     chartLimits?: ChartElementLimit;
 }): boolean;
+
 /**
  * Returns the alias for the field name if it exists; otherwise return the field name itself.
- * @param fieldName The field name to look for in the field array
- * @param fields The list of fields containing all the information regarding the fields, including the alias
+ *
+ * @param fields - The field name to look for in the field array
+ * @param fieldName - The list of fields containing all the information regarding the fields, including the alias
+ * @internal
  */
-export declare function getFieldAlias(fields: IField[] | undefined, fieldName: string): string;
-export declare function getFieldAlias(fields: IField[] | undefined, fieldName: undefined): undefined;
-export declare function getFieldAlias(fields: IField[] | undefined, fieldName: string | undefined): string | undefined;
+export function getFieldAlias(fields: IField[] | undefined, fieldName: string): string;
+
 /**
- * Return the field name for the field alias if it exists; otherwise return the field alias itself.
- * @param fieldAlias The field alias to look for in the field array
- * @param fields The list of fields containing all the information regarding the fields, including the alias
+ * @param fields
+ * @param fieldName
+ * @internal
  */
-export declare function getFieldNameFromFieldAlias(fields: IField[] | undefined, fieldAlias: string): string;
+export function getFieldAlias(fields: IField[] | undefined, fieldName: undefined): undefined;
+
 /**
- * Decides whether we can show the legend or not. If it returns `false`, then we should not show the legend even if `legend.visible` is `true`.
- * For Pie charts, hide the legend when there is only one slice.
- * @param chartSeries
+ * @param fields
+ * @param fieldName
+ * @internal
  */
-export declare function canShowLegend(chartSeries: WebChartSeries[]): boolean;
+export function getFieldAlias(fields: IField[] | undefined, fieldName: string | undefined): string | undefined;
+
 /**
- * Returns whether a scatterplot is currently supported
- * @param config The chart's config
+ * @param fields
+ * @param fieldName
+ * @internal
  */
-declare function isSupportedScatterplot(config: WebChart): boolean;
+export function getFieldAlias(fields: IField[] | undefined, fieldName: string | undefined): string | undefined;
+
 /**
- * Returns whether a histogram is currently supported
- * @param config The chart's config
+ * Return the field name for the field alias if it exists; otherwise return the field alias itself.
+ *
+ * @param fields - The field alias to look for in the field array
+ * @param fieldAlias - The list of fields containing all the information regarding the fields, including the alias
+ * @internal
  */
-declare function isSupportedHistogram(config: WebChart): boolean;
+export function getFieldNameFromFieldAlias(fields: IField[] | undefined, fieldAlias: string): string;
+
 /**
- * Returns whether a pie chart is currently supported
- * @param config The chart's config
+ * Decides whether we can show the legend or not. If it returns `false`, then we should not show the legend even if `legend.visible` is `true`.
+ * For Pie charts, hide the legend when there is only one slice.
+ *
+ * @param chartSeries
+ * @internal
  */
-declare function isSupportedPieChart(config: WebChart): boolean;
+export function canShowLegend(chartSeries: WebChartSeries[]): 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 scatterplot, pie, and histogram series.
- * @param supportedChartTypes The list of supported chart types
- * @param config The chart's config
+ *
+ * @param supportedChartTypes - The list of supported chart types
+ * @param config - The chart's config
+ * @internal
  */
-export declare function isSupportedChart(supportedChartTypes: WebChartTypes[], config?: WebChart): boolean;
+export function isSupportedChart(supportedChartTypes: WebChartTypes[], config?: WebChart): boolean;
+
 /**
  * Indicates whether a string field is empty (different from undefined, null and empty string).
  * The value is stringified before being trimmed to debunk edge cases like when the value is a numeric value.
- * @param value The value to test
+ *
+ * @param value - The value to test
  * @returns `true` if empty, `false` otherwise
+ * @internal
  */
-export declare function isEmptyStringField(value: string | null | undefined): boolean;
+export function isEmptyStringField(value: string | null | undefined): boolean;
+
 /**
  * Indicates whether an object contains a property key from list of properties.
- * @param data the object to look into
- * @param propertyList the array of property keys to search the data if one of them is present.
+ *
+ * @param data - the object to look into
+ * @param propertyList - the array of property keys to search the data if one of them is present.
  * @returns An object containing a boolean indicating the propertyList presence, and the property key that matched
+ * @internal
  */
-export declare function isPropertyKeyInData<T extends WebChartDataItem>(data: T, propertyList: string[]): {
+export function isPropertyKeyInData<T extends WebChartDataItem>(data: T, propertyList: string[]): {
     isInItem: boolean;
     expr?: string;
 };
+
 /**
  * Indicates whether an object contains the result of a calculated expression coming from a
  * query (similar to "EXPR_1").
- * @param dataItem the object to look into
+ *
+ * @param dataItem - the object to look into
  * @returns An object containing a boolean indicating the expression's presence, and the expression key that matched
+ * @internal
  */
-export declare function isQueryCalculatedExprInItem(dataItem: WebChartDataItem): {
+export function isQueryCalculatedExprInItem(dataItem: WebChartDataItem): {
     isInItem: boolean;
     expr?: string;
 };
+
 /**
  * Finds localized string for the given `WebChartTemporalBinningUnits` unit type.
+ *
  * @param unit
  * @param strings
  * @returns Localized unit type label
+ * @internal
  */
-export declare function getTimeIntervalUnitLabel(unit: WebChartTemporalBinningUnits, strings: {
+export function getTimeIntervalUnitLabel(unit: WebChartTemporalBinningUnits, strings: {
     seconds?: string;
     minutes?: string;
     hours?: string;
@@ -160,86 +220,113 @@ export declare function getTimeIntervalUnitLabel(unit: WebChartTemporalBinningUn
     months?: string;
     years?: string;
 }): string;
+
 /**
  * Returns the appropriate `index` to fetch the default color from `overlayRamp[]` array for a histogram overlay
+ *
  * @param overlayType
+ * @internal
  */
-export declare function getOverlayColorIndex(overlayType: OverlayTerms | undefined): number;
+export function getOverlayColorIndex(overlayType: OverlayTerms | undefined): number;
+
 /**
  * Assigns visible property to a series or an overlay
- * @param props.config The config that gets updated for each series visibility
- * @param props.event The event that is currently being called
+ *
+ * @param event - The config that gets updated for each series visibility
+ * @param config - The event that is currently being called
+ * @internal
  */
-export declare function updateSeriesVisibility(event: CustomEvent<LegendItemVisibility>, config?: WebBoxPlot | WebChart): void;
+export function updateSeriesVisibility(event: Pick<CustomEvent<LegendItemVisibility>, "detail">, config?: WebBoxPlot | WebChart): void;
+
 /**
  * Sanitize an HTML string to prevent XSS attacks (https://owasp.org/www-community/attacks/xss/)
- * @param inputToSanitize The HTML string to sanitize
+ *
+ * @param inputToSanitize - The HTML string to sanitize
+ * @internal
  */
-export declare function sanitizeHTMLOutput(inputToSanitize: string): string;
-/** .
+export function sanitizeHTMLOutput(inputToSanitize: string): string;
+
+/**
+ * .
  * Indicates if a provided number value is valid.
  * An invalid value is: undefined | NaN | Infinite | -Infinite | null
  * See for more details:
  *   - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isFinite
  *   - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isNaN
+ *
+ * @param value
+ * @internal
  */
-export declare function isValidNumber(value: WebChartDataItemValue): boolean;
-/**
- * Updates the chart rotation for a given WebChart config.
- * Returns the updated config.
- * @param newRotation new rotation
- * @param config the chart config
- */
-export declare function updateRotation<T extends WebBoxPlot | WebChart>(newRotation: boolean, config?: T): T | undefined;
+export function isValidNumber(value: WebChartDataItemValue): boolean;
+
 /**
  * Gets the sorting field or (sorting type for box-plot) and orderBy from an input string.
- * @param stringToParse The input string to parse, like `orderByField` of a query clause or `orderDataBy` property of a chart config.
- * @param useDefault If set to `false`, the default sort order will not be used.
- * @returns
+ *
+ * @param stringToParse - The input string to parse, like `orderByField` of a query clause or `orderDataBy` property of a chart config.
+ * @param useDefault - If set to `false`, the default sort order will not be used.
+ * @internal
  */
-export declare function getOrderByComponents(stringToParse: string, useDefault?: boolean): {
+export function getOrderByComponents(stringToParse: string, useDefault?: boolean): {
     fieldToSort: string;
     orderBy?: WebChartSortOrderKinds;
 };
+
 /**
  * Gets the fields listed in the `orderByFields` property of a chart config.
- * @param {WebChart} chartConfig -  The chart config
- * @returns {string[]} The list of fields to sort by
+ *
+ * @param chartConfig - The chart config
+ * @returns The list of fields to sort by
+ * @internal
  */
-export declare function getOrderByFields(chartConfig: WebChart): string[];
+export function getOrderByFields(chartConfig: WebChart): string[];
+
 /**
  * Determines if certain chart subtype is a split by chart.
- * @param chartSubType The chart subtype
- * @returns true if the chart subtype is a split by chart, false otherwise
+ *
+ * @param chartSubType - The chart subtype
+ * @returns `true` if the chart subtype is a split by chart, `false` otherwise
+ * @internal
  */
-export declare function isSplitByChart(chartSubType: ChartSubType): boolean;
+export function isSplitByChart(chartSubType: ChartSubType): boolean;
+
 /**
  * Util function to know if the selection data changed.
  * The selection items and selection OIDs are compared, not the selection source nor the selection indexes.
- * @param selectionA The first selection data
- * @param selectionB The second selection data
+ *
+ * @param selectionA - The first selection data
+ * @param selectionB - The second selection data
  * @returns a boolean indicating whether the two selections are equal
+ * @internal
  */
-export declare function hasSelectionChanged(selectionA?: SelectionData, selectionB?: SelectionData): boolean;
+export function hasSelectionChanged(selectionA?: SelectionData, selectionB?: SelectionData): boolean;
+
 /**
  * Indicates whether the selection data is empty.
- * @param selectionData The selection data to check
+ *
+ * @param selectionData - The selection data to check
+ * @internal
  */
-export declare function isSelectionEmpty(selectionData: SelectionData | undefined): boolean;
+export function isSelectionEmpty(selectionData: SelectionData | undefined): boolean;
+
 /**
- * Sorts arrayA based on the indexes of the elements in arrayB
- * @param {T[]} props.arrayA - The array to be sorted
- * @param {T[]} props.arrayB - The array to be used for sorting
- * @param {function} props.getKey - The function to get the key of an item
+ * Sorts `arrayA` based on the indexes of the elements in `arrayB`.
+ *
+ * @param props - The array to be sorted
+ * @internal
  */
-export declare function sortArrayAUsingArrayB<T, K>(props?: {
+export function sortArrayAUsingArrayB<T, K>(props?: {
     arrayA: T[];
     arrayB: T[];
     getKey: (item: T) => K;
 }): T[];
-export declare const miscPrivateFunctions: {
-    isSupportedHistogram: typeof isSupportedHistogram;
-    isSupportedPieChart: typeof isSupportedPieChart;
-    isSupportedScatterplot: typeof isSupportedScatterplot;
-};
-export {};
+
+/**
+ * Gets the display x field for a chart subtype.
+ *
+ * @param chartSubType - The chart subtype
+ * @param series - The series
+ * @returns The default x field
+ */
+export function getDisplayXField(chartSubType: ChartSubType, series?: WebChartSeriesType): string;
+
+export type WebChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.GaugeSeries | typeof WebChartTypes.HeatSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;