@arcgis/charts-components 5.0.0-next.98 → 5.0.0

package/dist/chart-rendering/common/axes/index.d.ts

@@ -1,142 +0,0 @@
-import { DateTimeFormatOptions, NumberFormatOptions, WebChart, WebChartAxis, WebChartTypes } from '../../../spec';
-import { ErrorStrings } from '../../../utils';
-/**
- * Return the x-axis value format
- *
- * @param chartConfig The chart's config
- */
-export declare function getXAxisValueFormat(chartConfig: WebChart): WebChartTypes | undefined;
-/**
- * Return dateFormat or numberFormat for the `WebChartAxis`
- *
- * @param valueFormat NumberFormatOptions | DateTimeFormatOptions
- */
-export declare function mapValueFormat<T extends DateTimeFormatOptions | NumberFormatOptions>(valueFormat: T): T["intlOptions"];
-/**
- * Return true if the input `WebChartAxis` is a **Value axis** (represents only **numerical** data)
- *
- * @param valueFormat Esri's REST representation of Web Chart Axis Value Format property
- */
-export declare function isNumberValueFormat(valueFormat?: WebChartAxis["valueFormat"]): valueFormat is NumberFormatOptions;
-/**
- * Return true if the input `WebChartAxis` is a **Value axis** (represents only **numerical** data)
- * and the format uses a `percent` style.
- *
- * @param valueFormat Esri's REST representation of Web Chart Axis Value Format property
- */
-export declare function isPercentNumberValueFormat(valueFormat: WebChartAxis["valueFormat"]): boolean;
-/**
- * Return true if the input `WebChartAxis` is a **Category axis** (represents only string or **categorical** data)
- *
- * @param valueFormat Esri's REST representation of Web Chart Axis Value Format property
- */
-export declare function isCategoryValueFormat(valueFormat?: WebChartAxis["valueFormat"]): boolean;
-/**
- * Return true if the input `WebChartAxis` is a **Date axis** (represents only temporal or **date-time** data)
- *
- * @param valueFormat Esri's REST representation of Web Chart Axis Value Format property
- */
-export declare function isDateValueFormat(valueFormat?: WebChartAxis["valueFormat"]): boolean;
-/**
- * Returns for each axis a boolean indicating if the labels behavior property changed since the previous update.
- * The first index contains the result for the horizontal axis (whether it's the x or y axis) and the second index
- * the result for the vertical axis.
- *
- * @param props.oldConfig The config from the previous update
- * @param props.newConfig The config from the current update
- * @param props.rotationChanged Indicates whether a change of rotation has taken place
- */
-export declare function hasAxisLabelsBehaviorChanged(props: {
-    oldConfig: WebChart;
-    newConfig: WebChart;
-    rotationChanged: boolean;
-}): [boolean, boolean];
-/**
- * Checks if the line chart axes value format are valid.
- *
- * @param axesConfig The array of axes config
- * @returns A boolean indicating whether the axes value format is valid.
- */
-declare function hasValidLineChartAxesValueFormat(axesConfig: WebChart["axes"]): boolean;
-/**
- * Checks if the bar chart axes value format are valid.
- *
- * @param axesConfig The array of axes config
- * @returns A boolean indicating whether the axes value format is valid.
- */
-declare function hasValidBarChartAxesValueFormat(axesConfig: WebChart["axes"]): boolean;
-/**
- * Checks if the combo bar-line chart axes value format are valid.
- *
- * @param axesConfig The array of axes config
- * @returns A boolean indicating whether the axes value format is valid.
- */
-declare function hasValidComboLineAndBarChartAxesValueFormat(axesConfig: WebChart["axes"]): boolean;
-/**
- * Checks if the scatterplot axes value format are valid.
- *
- * @param axesConfig The array of axes config
- * @returns A boolean indicating whether the axes value format is valid.
- */
-declare function hasValidScatterplotAxesValueFormat(axesConfig: WebChart["axes"]): boolean;
-/**
- * Checks if the histogram axes value format are valid.
- *
- * @param axesConfig The array of axes config
- * @returns A boolean indicating whether the axes value format is valid.
- */
-declare function hasValidHistogramAxesValueFormat(axesConfig: WebChart["axes"]): boolean;
-/**
- * Checks if the gauge axis value format is valid.
- *
- * @param axesConfig The array of axes config
- * @returns A boolean indicating whether the axis value format is valid.
- */
-declare function hasValidGaugeAxisValueFormat(axesConfig: WebChart["axes"]): boolean;
-/**
- * Validates the provided value format properties are compatible with the type of chart
- *
- * @param props.axesConfig The array of axes config
- * @param props.chartType The chart type
- * @param props.errorStrings The t9n error strings
- */
-export declare function validateAxesValueFormat(props: {
-    axesConfig: WebChart["axes"];
-    chartType?: WebChartTypes;
-    errorStrings: ErrorStrings;
-}): void;
-/**
- * Function deciding whether we should create a category axis
- *
- * @param props.isXAxis Whether the axis is the x-axis
- * @param props.chartType The chart type
- * @param props.valueFormat The axis value format
- * @param props.isAxisForHistogramOverlaySeries Whether the axis is for a histogram column series
- */
-export declare function useCategoryAxis(props: {
-    isXAxis: boolean;
-    chartType?: WebChartTypes;
-    valueFormat?: WebChartAxis["valueFormat"];
-    isAxisForHistogramOverlaySeries?: boolean;
-}): boolean;
-/**
- * Get the series id related to the given axis (useful in dual axis mode).
- *
- * @param props.chartConfig The chart configuration
- * @param props.isSecondValueAxis Whether the axis is the second value axis (in dual axis mode)
- * @param props.seriesId The series id
- */
-export declare function getAxisSeriesIds(props: {
-    chartConfig: WebChart;
-    isSecondValueAxis?: boolean;
-    seriesIds?: string[];
-}): string[] | undefined;
-export declare const commonAxesPrivateFunctions: {
-    hasValidLineChartAxesValueFormat: typeof hasValidLineChartAxesValueFormat;
-    hasValidBarChartAxesValueFormat: typeof hasValidBarChartAxesValueFormat;
-    hasValidComboLineAndBarChartAxesValueFormat: typeof hasValidComboLineAndBarChartAxesValueFormat;
-    hasValidScatterplotAxesValueFormat: typeof hasValidScatterplotAxesValueFormat;
-    hasValidHistogramAxesValueFormat: typeof hasValidHistogramAxesValueFormat;
-    hasValidGaugeAxisValueFormat: typeof hasValidGaugeAxisValueFormat;
-};
-export {};

package/dist/chart-rendering/common/axes/utils/axis-renderer/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * Calculates the minimum value to the nearest and lowest power of 10 for an axis when the axis is logarithmic
- * For example,
- * - if min = 5, we set the new min to 1
- * - if min = 12, we set the new min to 10
- * - if min = 55, we set the new min to 10
- * - if min = 9999, we set the new min to 1,000
- * - if min = 12345, we set the new min to 10,000
- * - if min = 0.05, we set the new min to 0.01
- * - if min = 0.0005, we set the new min to 0.0001
- * The point is to force the axis to render nice rounded values, going 10, 100, 1,000...
- * ...rather than something like 344.67, 3,446.7, 34,467...
- *
- * @param dataMinValue The minimum value from the data
- * @returns The calculated minimum value if the input dataMinValue is greater than 0
- * Otherwise, the input value
- */
-export declare function getBestMinValueForAxisLogarithmic(dataMinValue: number): number | undefined;

package/dist/chart-rendering/common/color-match/renderer-color-match/index.d.ts

@@ -1,228 +0,0 @@
-import { default as Graphic } from '@arcgis/core/Graphic.js';
-import { default as Renderer } from '@arcgis/core/renderers/Renderer';
-import { IRendererSymbol, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, WebChart, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartDataItem, WebChartLineChartSeries, WebChartRadarChartSeries, WebChartSeriesType, RESTRendererType } from '../../../../spec';
-import { QueryObject, ChartSubType } from '../../../../utils';
-import { RendererOrigin } from './interfaces';
-/**
- * Centralizes all the rules indicating whether a chart can use the color match mode.
- *
- * @param props.chartConfig The chart config
- * @param props.queryObject The query object
- */
-export declare function isColorMatchAllowed(props: {
-    chartConfig: WebChart;
-    queryObject: QueryObject;
-}): boolean;
-/**
- * Returns the renderer type, from either the chart renderer or the layer's.
- * It normalizes the chart renderer type to a RESTRendererType.
- *
- * @param chartRenderer The chart renderer
- * @param renderer The layer's renderer
- */
-export declare function getRendererType(chartRenderer?: WebChart["chartRenderer"] | null, renderer?: Renderer | null): RESTRendererType | undefined;
-/**
- * Returns the renderer label from the data context if it founds one.
- *
- * @param dataContext The data context to look into
- */
-export declare function getDataItemRendererLabel(dataContext: WebChartDataItem): string | undefined;
-/**
- * Determines whether a renderer symbol is valid.
- *
- * @param rendererSymbol The renderer symbol to validate
- * @returns
- */
-declare function isValidRendererSymbol(rendererSymbol?: IRendererSymbol): boolean;
-/**
- * Updates a data item by adding a renderer symbol to it, after eventually tweaking the color opacity.
- *
- * @param props.symbolField The field name to use to store the symbol
- * @param props.dataItem The data item to complete
- * @param props.rendererSymbol The symbol to store within the data item
- * @param props.rendererOrigin Whether the renderer comes from the chart renderer or the layer's
- * @returns Whether the color match was applied to the data item.
- */
-declare function updateDataItemWithRendererSymbol(props: {
-    symbolField: string;
-    dataItem: WebChartDataItem;
-    rendererSymbol?: IRendererSymbol;
-    rendererOrigin: RendererOrigin;
-}): boolean;
-/**
- * Returns the suffix symbol key(s) to use to retrieve the renderer symbol from a data item,
- * base on the chart sub type and the renderer type.
- *
- * Any combination of chart sub type and renderer type that is not handled here will return the default symbol key `CommonChartDefaults.rendererSymbolField`.
- *
- * The caller should handle the case where the return is an array of strings to match with the dataItem
- * to find the correct symbol suffix key.  At this time, this only happens for BoxPlot series with PieChart renderer.
- *
- * @param props.seriesConfig The series config
- * @param props.chartSubType The chart sub type
- * @param props.rendererType The renderer type using the kebab case
- * @returns The suffix key(s) or the default color key `CommonChartDefaults.rendererSymbolField` to use to retrieve the renderer color from a data item.
- */
-declare function getRendererSymbolSuffixKey(props: {
-    seriesConfig: WebChartBarChartSeries | WebChartBoxPlotSeries | WebChartLineChartSeries | WebChartRadarChartSeries;
-    chartSubType: ChartSubType;
-    rendererType?: RESTRendererType;
-}): string[] | string;
-/**
- * Returns the symbol field to retrieve the renderer symbol from a data item.
- *
- * @param props.seriesConfig The series config
- * @param props.chartSubType The chart sub type
- * @param props.rendererType The renderer type
- * @param props.dataItem The data item to retrieve the renderer symbol (only used for BoxPlot series with PieChart renderer)
- * @returns The symbol field to use to retrieve the renderer symbol from a data item.
- */
-declare function getRendererSymbolField(props: {
-    seriesConfig: WebChartBarChartSeries | WebChartBoxPlotSeries | WebChartLineChartSeries | WebChartRadarChartSeries;
-    chartSubType: ChartSubType;
-    rendererType?: RESTRendererType;
-    dataItem?: WebChartDataItem;
-}): string;
-/**
- * Gets a graphic template to use to compute the renderer color.
- *
- * @param props.chartRenderer The chart renderer
- * @param props.queryObject The query object (layer or feature layer view)
- */
-export declare function getGraphicTemplate(props: {
-    chartRenderer: WebChart["chartRenderer"];
-    queryObject?: QueryObject;
-}): Graphic;
-/**
- * Computes the renderer symbol of a data item from a layer or chart renderer.
- *
- * @param props.seriesConfig The series config
- * @param props.dataItem The data related to the the feature we want to compute a color for
- * @param props.renderer The renderer definition, from the chartRenderer or the JSON version of the layer's
- * @param props.rendererType The renderer type
- * @param props.chartSubType The chart sub type
- * @param props.splitByField The split by field
- * @param props.graphicTemplate The graphic template to use to compute the color
- * @param props.rendererFieldNames The fields used by the layer's renderer
- * @param props.mapAttributesToSymbol The map to store the computed symbol for a given data item
- * @returns An object containing the renderer symbol and whether the color match was applied to the data item.
- */
-export declare function computeRendererSymbol(props: {
-    seriesConfig: WebChart["series"];
-    dataItem: WebChartDataItem;
-    renderer?: Renderer | WebChart["chartRenderer"];
-    rendererType?: RESTRendererType;
-    rendererOrigin: RendererOrigin;
-    chartSubType: ChartSubType;
-    splitByField?: string;
-    graphicTemplate: Graphic;
-    rendererFieldNames?: string[];
-    mapAttributesToSymbol?: Map<string, IRendererSymbol | undefined>;
-}): Promise<{
-    rendererSymbol: IRendererSymbol | undefined;
-    colorMatchApplied: boolean;
-}>;
-/**
- * Values passed as `null` are ignored by the `@arcgis/core` functions `getDisplayedSymbol()` & `getDisplayedColor()`
- * To bypass it we transcode the `null` value to a string beforehand.
- * `computeRendererSymbol()` applies the same transformation on the data item itself to ensure the color is correctly computed.
- * We only apply this transformation to a chart renderer (not layer renderer).
- * Refer to https://devtopia.esri.com/WebGIS/arcgis-charts/issues/7770
- *
- * @param chartRenderer The chart renderer
- */
-declare function replaceChartRendererNullValue(chartRenderer?: WebChart["chartRenderer"]): WebChart["chartRenderer"];
-/**
- * Encodes `null` by `CommonChartDefaults.nullValue` or reverts it.
- *
- * @param props.mode Encode or revert the null values
- * @param props.attributes The attributes to update
- * @param props.splitByField The split by field
- * @param props.x The x field
- */
-declare function handleNullValuesForRenderer(props: {
-    mode: "encode" | "revert";
-    attributes: WebChartDataItem;
-    splitByField?: string;
-    x: string;
-}): void;
-/**
- * Completes a data set with renderer colors.
- *
- * @param props.data The data set to complete
- * @param props.chartConfig The chart config
- * @param props.queryObject The query object (layer or feature layer view)
- * @param props.allowColorMatch Whether the color match is allowed
- * @returns An object containing the data items that may be filled with the renderer symbol and whether the color match was applied to any of the data items.
- */
-export declare function completeDataWithRendererSymbol(props: {
-    data: WebChartDataItem[];
-    chartConfig: WebChart;
-    queryObject?: QueryObject;
-    allowColorMatch: boolean;
-}): Promise<{
-    dataItems: WebChartDataItem[];
-    colorMatchApplied: boolean;
-    rendererFieldNames: string[];
-}>;
-/**
- * Gets the renderer color stored in the data item, when in color match mode.
- *
- * @param props.dataItem The dataItem to retrieve the renderer color
- * @param props.seriesConfig The series config
- * @param props.chartSubType The ChartSubType
- * @param props.colorMatch Whether the color match mode is enabled
- * @param props.rendererType The type of renderer
- * @returns
- */
-export declare function getRendererElementSymbol(props: {
-    dataItem: WebChartDataItem;
-    seriesConfig: WebChartSeriesType;
-    chartSubType: ChartSubType;
-    colorMatch: boolean;
-    rendererType?: RESTRendererType;
-}): IRendererSymbol | undefined;
-/**
- * Merges the styling information coming from a renderer symbol with a series symbol.
- *
- * @param props.seriesSymbol The series symbol
- * @param props.rendererSymbol The renderer symbol
- * @param props.colorIndex A color index used when using the color ramp
- */
-export declare function mergeRendererSymbolWithSeriesSymbol<T extends ISimpleFillSymbol | ISimpleLineSymbol | ISimpleMarkerSymbol>(props: {
-    seriesSymbol: T;
-    rendererSymbol?: IRendererSymbol;
-    colorIndex?: number;
-}): T;
-/**
- * Returns the category (fields) of a by field chart.
- *
- * @param chartConfig The chart config
- * @returns The categories of the by field chart
- */
-declare function getCategoriesFromByFieldChart(chartConfig: WebChart): string[];
-/**
- * Determines whether renderer's label can be used.
- *
- * @param chartConfig The chart config
- * @param rendererFields The fields used by the renderer
- * @returns
- */
-export declare function canUseRendererLabel(chartConfig?: WebChart, rendererFields?: string[]): boolean;
-/**
- * Returns the fields used by the renderer.
- *
- * @param layer The layer
- * @returns The fields used by the renderer
- */
-export declare function getChartRendererFieldNames(chartRenderer: WebChart["chartRenderer"]): string[];
-export declare const commonRenderColorMatchPrivateFunctions: {
-    getRendererSymbolSuffixKey: typeof getRendererSymbolSuffixKey;
-    getRendererSymbolField: typeof getRendererSymbolField;
-    updateDataItemWithRendererSymbol: typeof updateDataItemWithRendererSymbol;
-    isValidRendererSymbol: typeof isValidRendererSymbol;
-    replaceChartRendererNullValue: typeof replaceChartRendererNullValue;
-    handleNullValuesForRenderer: typeof handleNullValuesForRenderer;
-    getCategoriesFromByFieldChart: typeof getCategoriesFromByFieldChart;
-};
-export {};

package/dist/chart-rendering/common/color-match/renderer-color-match/interfaces.d.ts

@@ -1,5 +0,0 @@
-export declare const RendererOrigin: {
-    readonly ChartRenderer: 1;
-    readonly LayerRenderer: 2;
-};
-export type RendererOrigin = (typeof RendererOrigin)[keyof typeof RendererOrigin];

package/dist/chart-rendering/common/config-utils/index.d.ts

@@ -1,99 +0,0 @@
-import { WebBoxPlot, WebChart, WebChartSeries, WebHeatChart } from '../../../spec';
-import { DataOrderParameters } from '../data/utils/summarize-data/interfaces';
-import { EsriColor } from '../types';
-/**
- * Returns the field to be used by the x-axis.
- *
- * @param chartConfig The chart's config
- */
-export declare function getXAxisField(chartConfig: WebChart): string;
-/**
- * Check if chart is stacked
- *
- * @param config The chart config
- */
-export declare function isChartStacked(config: WebChart): boolean;
-/**
- * Gets the `sortingField`s and `orderBy`s from the `orderOptions.data` for the heat chart.
- * @param chartConfig The chart config
- * @returns An array of two objects with sortingField and orderBy, one for x and one for y, or undefined.
- *
- */
-declare function getDataOrderParametersForHeatChart(chartConfig: WebHeatChart): DataOrderParameters[] | undefined;
-/**
- * Gets the `sortingField` and `orderBy` from the `orderOptions.data` for the boxplot chart.
- *
- * @param chartConfig The chart config
- * @returns An object with sortingField, optionally an orderBy and preferLabel, or undefined.
- */
-declare function getDataOrderParametersForBoxPlot(chartConfig: WebBoxPlot): DataOrderParameters | undefined;
-/**
- * Gets the `sortingField` and `orderBy` from the `orderOptions.data` for bar, line, and pie charts,
- * It also considers other parameters such as the type of chart, stacked type or number of series
- * (for bar and line) when determining the sorting field.
- *
- * **Note**: this function does not apply to boxplot, which is handled by `getDataOrderParametersForBoxPlot()`.
- *
- * @param chartConfig - The chart configuration
- * @returns An object with sortingField, optionally an orderBy and preferLabel, or undefined.
- */
-declare function getDataOrderParametersForCommonChart(chartConfig: WebChart): DataOrderParameters | undefined;
-/**
- * Constructs the `sortingField`, `orderBy`, and/or optionally `preferLabel` for sorting the chart data.
- *
- * @param chartConfig The chart configuration
- * @returns An array of objects with sortingField, optionally an orderBy and preferLabel, or undefined.
- */
-export declare function getDataOrderParameters(chartConfig: WebChart): DataOrderParameters[] | undefined;
-/**
- * Returns true if the data order instructions (orderType or sortingField, orderBy, and/or preferLabel) have changed, or
- * the data update is needed.
- *
- * @param props.oldConfig The previous chart config
- * @param props.newConfig The new chart config
- * @param props.dataWasUpdated Indicates if the data was updated; this is used by and important for box-plot charts. It's ignored for non-boxplot charts.
- */
-export declare function isNewSortNeeded(props: {
-    oldConfig: WebChart;
-    newConfig: WebChart;
-    dataWasUpdated: boolean;
-}): boolean;
-/**
- * After comparing two arrays containing the same number of series, returns the potential changes
- * in the series order among their array.
- * Ex: if oldSeries contains [0, 1 ,2] and newSeries [1, 0, 2], the function returns [[0,1]]
- *
- * @param oldSeries
- * @param newSeries
- */
-export declare function getPositionChanges(oldSeries: WebChartSeries[], newSeries: WebChartSeries[]): number[][];
-/**
- * Compares two colors (array of 4 numbers) and indicates if they are equal
- *
- * @param color1
- * @param color2
- */
-export declare function areColorsEqual(color1?: EsriColor, color2?: EsriColor): boolean;
-/**
- * In "Mean lines" mode, the boxes are not matching their config anymore:
- * - C5 becomes C1
- * - C6 becomes C2
- * - C7 becomes C3
- * To fetch the proper data we alter the config to remove the `where` clause, which is the same as removing
- * the split-by field and apply the right combination
- */
-export declare function getMeanLinesBoxPlotConfig(chartConfig: WebBoxPlot): WebBoxPlot;
-/**
- * Checks if the given chart config is a matrix heat chart.  A matrix heat chart is defined as a heat chart with
- * both axes using a category value format.
- *
- * @param chartConfig The chart config
- * @returns True if the chart is a matrix heat chart, false otherwise
- */
-export declare function isMatrixHeatChart(chartConfig?: WebHeatChart): boolean;
-export declare const commonConfigutilsPrivateFunctions: {
-    getDataOrderParametersForCommonChart: typeof getDataOrderParametersForCommonChart;
-    getDataOrderParametersForBoxPlot: typeof getDataOrderParametersForBoxPlot;
-    getDataOrderParametersForHeatChart: typeof getDataOrderParametersForHeatChart;
-};
-export {};

package/dist/chart-rendering/common/cursor/index.d.ts

@@ -1,14 +0,0 @@
-import { ActionModes, CursorRange } from '../../../utils';
-import { CursorBehavior } from './interfaces';
-/**
- * Sets the cursor behavior based on the action mode and cursor range.
- *
- * @param props.actionMode The action mode (selection, zoon...)
- * @param props.cursorRange The cursor range (multi-axes, x-axis...)
- * @param props.isRotated Whether the chart is rotated
- */
-export declare function mapCursorRangeToCursorBehavior(props: {
-    actionMode: ActionModes;
-    cursorRange: CursorRange;
-    isRotated?: boolean;
-}): CursorBehavior;

package/dist/chart-rendering/common/cursor/interfaces.d.ts

@@ -1,10 +0,0 @@
-export declare const CursorBehavior: {
-    readonly SelectXY: "selectXY";
-    readonly SelectX: "selectX";
-    readonly SelectY: "selectY";
-    readonly ZoomXY: "zoomXY";
-    readonly ZoomX: "zoomX";
-    readonly ZoomY: "zoomY";
-    readonly None: "none";
-};
-export type CursorBehavior = (typeof CursorBehavior)[keyof typeof CursorBehavior];

package/dist/chart-rendering/common/data/box-plot/index.d.ts

@@ -1,162 +0,0 @@
-import { WebBoxPlot, WebChartDataItem, WebChartQuery, WebChartStatisticType } from '../../../../spec';
-import { AbortControllerKeyType, ChartElementLimit, QueryObject, BoxPlotYFieldKeys, ChartSubType } from '../../../../utils';
-import { OutliersFilterProps } from './interfaces';
-/**
- * Builds a key (string) used to identify the properties carrying the global average and standard deviation stats
- *
- * @param y The numeric field
- * @param statType The type of stat (Average or StandardDeviation)
- */
-declare function getMeanAndStandardDeviationPerFieldKey(y: string, statType: WebChartStatisticType): string;
-/**
- * calculate z-score for the given value
- *
- * @param props.value The current value
- * @param props.mean The mean of the whole series
- * @param props.stdDev The standard deviation of the whole series
- */
-declare function calculateZScore(props: {
-    value: number;
-    mean: number;
-    stdDev: number;
-}): number;
-/**
- * Adds z-score statistic property and value pair to the box plot data item
- *
- * @param props.dataItem The data item for the given box plot
- * @param props.chartSubType The box plot sub type
- * @param props.y The y value of the box plot series
- * @param props.splitByValue The split-by value for the given box plot series
- * @param props.meanPerField The mean from a whole numeric field
- * @param props.stdDevPerField The standard deviation from a whole numeric field
- */
-declare function addZScoreItemToDataItem(props: {
-    dataItem: WebChartDataItem;
-    chartSubType: ChartSubType;
-    y?: string;
-    splitByValue?: string;
-    meanPerField?: number;
-    stdDevPerField?: number;
-}): WebChartDataItem;
-/**
- * Adds missing alternative data to the given chart configuration and data.
- * This happens when fetchBoxPlotAlternativeData() doesn't bring back results for a specific field.
- * In that case we set the alternative data to the original data.
- *
- * @param chartConfig The chart config
- * @param data The data to add missing alternative data to
- */
-declare function addMissingAlternativeData(chartConfig: WebBoxPlot, data: WebChartDataItem[]): void;
-/**
- * Calculating the outliers threshold for a given data item (representing one candle and whiskers)
- *
- * @param dataItem The data item containing the stats
- * @param yFieldNames The box plot y field names
- */
-declare function getOutliersThresholds(dataItem: WebChartDataItem, yFieldNames: Record<BoxPlotYFieldKeys, string>): {
-    outlierMinThreshold?: number;
-    outlierMaxThreshold?: number;
-};
-/**
- * Builds the query filter necessary to fetch either the outliers or the alternative data by using the x, y and split-by fields and values.
- *
- * @param props.yField The y-axis field
- * @param props.xField The x-axis field
- * @param props.xValue The category value
- * @param props.splitByField The split-by field for a given series
- * @param props.splitByValue The split-by value for a given series
- * @param props.outlierMinThreshold The outlier min threshold for a given data item
- * @param props.outlierMaxThreshold The outlier max threshold for a given data item
- * @param props.target Whether the function is called to build the outliers or the alternative data filter
- */
-declare function buildBoxPlotFilter(props: OutliersFilterProps): string;
-/**
- * Generates the query filters necessary to fetch the box plot outliers and alternative data.
- * The filters are returned as an array because if they contain too many operands they are split
- * into multiple filters.
- *
- * @param props.data The main data set
- * @param props.yField The numeric field
- * @param props.x The x-axis field
- * @param props.chartSubType The chart sub type
- * @param props.splitByField The split-by field
- */
-declare function generateBoxPlotQueriesFilter(props: {
-    data: WebChartDataItem[];
-    yField: string;
-    x?: string;
-    chartSubType: ChartSubType;
-    splitByField?: string;
-}): {
-    outliersFilterBatches: string[];
-    dataWithoutOutliersFilterBatches: string[];
-};
-/**
- * Merges two data sets from the category and split-by field
- *
- * @param props.data The main data set
- * @param props.additionalData The additional data
- * @param props.chartConfig The chart's config
- */
-declare function mergeBoxPlotAlternativeData(props: {
-    data: WebChartDataItem[];
-    additionalData: WebChartDataItem[];
-    chartConfig: WebBoxPlot;
-}): WebChartDataItem[];
-/**
- * Processes the fetched data for a box plot chart and transforms it into the appropriate format for the amCharts library.
- * Depending on the query type, the data may need to be grouped and/or flattened before being returned.
- * If the query type is BoxPlotMonoFieldAndCategory, the data is already in the correct format and no further transformation is needed.
- *
- * @param props.chartConfig - The configuration object for the chart.
- * @param props.data - The fetched data to be processed.
- * @param props.calculateZScore - Determines whether to calculate z-score or not for the box plots.
- * @param props.meanAndStdDevPerField - Object containing the mean and stddev for all the numeric fields used by the chart
- * @returns The processed data in the appropriate format for the amCharts library.
- */
-export declare function processDataForBoxPlot(props: {
-    chartConfig: WebBoxPlot;
-    data: WebChartDataItem[];
-    calculateZScore: boolean;
-    meanAndStdDevPerField?: WebChartDataItem;
-}): WebChartDataItem[];
-/**
- * Main function completing and processing the box plot data:
- * - outliers
- * - alternative data (shown when outliers are enabled)
- * - mean and standard deviation per numeric field
- *
- * @param props.data The main data set
- * @param props.queryObject The query object (layer or feature layer view)
- * @param props.uniqueQuery The query config
- * @param props.fetchFullBoxPlotData Whether to fetch all the box plot data
- * @param props.chartConfig The chart config
- * @param props.elementCount The number of features to fetch
- * @param props.chartLimits The chart limits
- * @param props.errorStrings The t9n error strings
- * @param props.abortKey The key to abort the queries
- */
-export declare function completeBoxPlotResults(props: {
-    data: WebChartDataItem[];
-    queryObject: QueryObject;
-    uniqueQuery: WebChartQuery;
-    fetchFullBoxPlotData?: boolean;
-    chartConfig: WebBoxPlot;
-    elementCount?: number;
-    chartLimits?: ChartElementLimit;
-    abortKey?: AbortControllerKeyType;
-}): Promise<{
-    dataItems: WebChartDataItem[];
-    outliers: WebChartDataItem[];
-}>;
-export declare const commonDataBoxplotPrivateFunctions: {
-    getOutliersThresholds: typeof getOutliersThresholds;
-    buildBoxPlotFilter: typeof buildBoxPlotFilter;
-    generateBoxPlotQueriesFilter: typeof generateBoxPlotQueriesFilter;
-    mergeBoxPlotAlternativeData: typeof mergeBoxPlotAlternativeData;
-    calculateZScore: typeof calculateZScore;
-    addZScoreItemToDataItem: typeof addZScoreItemToDataItem;
-    getMeanAndStandardDeviationPerFieldKey: typeof getMeanAndStandardDeviationPerFieldKey;
-    addMissingAlternativeData: typeof addMissingAlternativeData;
-};
-export {};