@arcgis/charts-components 5.0.0-next.135 → 5.0.0-next.137

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

@@ -1,369 +0,0 @@
-import { default as Graphic } from '@arcgis/core/Graphic';
-import { IExtent, IField, IStatisticDefinition, WebChart, WebChartAxis, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartDataItem, WebChartDataItemValue, WebChartLineChartSeries, WebChartPieChartSeries, WebChartQuery, WebChartSeriesType, WebHeatChart, WebChartCalendarDatePartsUnits, WebChartSortOrderKinds, WebChartTypes } from '../../../../../spec';
-import { DataInfo, QueryObject, SubtypeInfo, ChartSubType, LimitBehavior } from '../../../../../utils';
-import { ChartOptions, FetchDataProps } from '../../../interfaces';
-import { DataOrderParameters, ProcessUniqueQueryProps } from './interfaces';
-/**
- * Returns the feature extent and the extent key for a feature.
- *
- * @param props.feature The feature to fetch the extent from
- * @param props.splitByField The split-by field from the config
- * @param props.chartSubType The chart subtype
- * @returns
- */
-export declare function getFeatureGeometryExtent(props: {
-    feature: Graphic;
-    splitByField?: string;
-    chartSubType?: ChartSubType;
-}): {
-    featureExtent: IExtent | undefined;
-    featureExtentKey: string;
-};
-/**
- * Regroups all the data items related to a same category together.
- *
- * @param props.input The scattered list of data items
- * @param props.x The category field used to group the data
- * @param props.splitByField The split-by field from the config
- */
-declare function mergeDataItems(props: {
-    input: WebChartDataItem[];
-    x: string;
-    splitByField?: string;
-}): WebChartDataItem;
-/**
- * Group a dataset over a x field
- *
- * Notes: we regroup the data for:
- * - processed data on split-by bar and line charts
- * - selection data on multi-series bar and line charts
- *
- * @param props.data the input data to be grouped
- * @param props.x the category field used to group the data
- * @param props.splitByField the split-by field from the config
- */
-export declare function groupDataByCategory(props: {
-    data: WebChartDataItem[];
-    x: string;
-    splitByField?: string;
-}): WebChartDataItem[];
-/**
- * Calculates for each data item (category) for bar and line:
- *   - the category's sum
- *   - the percent for the first series
- *
- * @param data The chart's data
- * @param seriesConfig The series config
- * @returns
- */
-declare function calculateSeriesPercent(data: WebChartDataItem[], seriesConfig: WebChartBarChartSeries[] | WebChartBoxPlotSeries[] | WebChartLineChartSeries[] | WebChartPieChartSeries[]): WebChartDataItem[];
-/**
- * Calculate the Interquartile Range (IQR) for the given attributes and return the processed attributes objects with calculated IQR property .
- *   IQR is the difference between the first quartile and the third quartile.
- *   `@param` {WebChartBoxPlotSeries[]} seriesConfig - The list of series in the box plot chart config
- *   `@param` {WebChartDataItem} attributes - The data object containing the first and third quartile values.
- */
-declare function calculateInterQuartileRange(seriesConfig: WebChartBoxPlotSeries[], attributes: WebChartDataItem): WebChartDataItem;
-/**
- * Assigns the specified property to a best-guessed value from the query results.
- * If its upper-cased or lowercased corresponding properties (that are not coming from the config) exist, remove them as well.
- *
- * @param attributes The attributes associated with a feature returned from the query result
- * @param propertyNames The properties referencing the proper case
- */
-export declare function restoreAttributesCase(attributes: WebChartDataItem, propertyNames: (string | undefined)[] | string): void;
-/**
- * Builds a list of the outStatisticFieldName used in the config and restore their case to prevent a shift between
- * the query results' case and the config's.
- * See issues:
- * - https://devtopia.esri.com/webgis/arcgis-charts/issues/6038
- * - https://devtopia.esri.com/WebGIS/arcgis-charts/issues/7837
- *
- * @param attributes The attributes associated with a feature returned from the query result
- * @param seriesConfig The series config
- */
-declare function restoreStatFieldNamesCase(attributes: WebChartDataItem, seriesConfig: WebChartSeriesType[]): void;
-/**
- * This function goes through the properties of the dataItem and compare them with the outStatisticFieldNames
- * in the list of outStatistics. If a match is found, swap that property to its corresponding onStatisticField
- * property instead.
- *
- * Refer to issue https://devtopia.esri.com/webgis/arcgis-charts/issues/6018 for details
- *
- * @param dataItem The dataItem of which properties may change.
- * @param outStatistics The list of outStatistics to find the matching onStatisticFields for the properties in the dataItem.
- */
-declare function swapStatFieldNamesToStatisticFields(dataItem: WebChartDataItem, outStatistics: IStatisticDefinition[]): WebChartDataItem;
-/**
- * Since the series's dataFields.valueY was set to `${y}_${splitByValue},
- * we need to add a new property to the dataItem using that format and populate it with the value from to the y property.
- *
- * @param props.dataItem The dataItem of which properties are to be manipulated.
- * @param props.splitByField The split-by-field
- * @param props.y The y property for all series.
- * @param props.fieldOID The layer's object id field.
- */
-declare function renameYFieldForSplitByNoAggregation(props: {
-    dataItem: WebChartDataItem;
-    splitByField: string;
-    y: string;
-    fieldOID?: string;
-}): void;
-/**
- * Removes a prefix added to the box plot out statistic field names by `buildUniqueBoxPlotOutStatistics()`.
- * The prefix was added to avoid the queries to fail on some specific services. Refer to https://devtopia.esri.com/WebGIS/arcgis-charts/issues/7376
- *
- * @param attributes The attributes to be modified
- * @param y The numeric field name used as a prefix
- */
-declare function removeBoxPlotOutStatisticFieldNamePrefix(attributes: WebChartDataItem, y: string): void;
-/**
- * Trims the number of categories based on the provided `maxCategoryCount`. This is possible only for charts having
- * a query response for which each result is a category. If a result contains potentially multiple categories it will
- * be handled by the `limitCategories()` function.
- *
- * @param props.queryResponse The query response to be trimmed
- * @param props.chartConfig The chart configuration
- * @param props.maxCategoryCount The maximum number of categories to keep
- */
-declare function trimCategories(props: {
-    queryResponse: Graphic[];
-    chartConfig: WebChart;
-    maxCategoryCount?: number;
-}): Graphic[];
-/**
- * Limits the number of categories based on the provided `maxCategoryCount`.
- * This function is called for each data item and will decide whether to keep the item or not.
- *
- * @param props.attributes The attributes to be checked
- * @param props.uniqueCategoryList The list of unique categories to keep track of how many categories have been processed
- * @param props.maxCategoryCount The maximum number of categories to keep
- * @param props.x The x field
- * @param props.chartSubType The chart sub-type
- */
-declare function limitCategories(props: {
-    attributes: WebChartDataItem;
-    uniqueCategoryList: Set<WebChartDataItemValue>;
-    maxCategoryCount?: number;
-    x: string;
-    chartSubType: ChartSubType;
-}): boolean;
-/**
- * Adds fields description from coded domain or subtype to the provided attributes.
- * @param props.attributes The attributes to be modified
- * @param props.xValue The x value
- * @param props.yValue The y value
- * @param props.x The x field name
- * @param props.y The y field name
- * @param props.subtypeInfo The layer's subtype info
- * @param props.fieldList The layer's field list
- * @param props.chartType The chart type
- * @param props.chartSubType The chart sub-type
- * @param props.xAxisValueFormat The x axis value format
- * @param props.yAxisValueFormat The y axis value format
- */
-declare function addFieldsDescription(props: {
-    attributes: WebChartDataItem;
-    xValue: WebChartDataItemValue;
-    yValue: WebChartDataItemValue;
-    x: string;
-    y?: string[] | string;
-    subtypeInfo?: SubtypeInfo;
-    fieldList?: IField[];
-    chartType?: WebChartTypes;
-    chartSubType: ChartSubType;
-    xAxisValueFormat?: WebChartAxis["valueFormat"];
-    yAxisValueFormat?: WebChartAxis["valueFormat"];
-}): void;
-/**
- * Function executing a unique query and processing its results.
- *
- * @param props
- */
-export declare function processUniqueQueryResults(props: ProcessUniqueQueryProps): Promise<WebChartDataItem[]>;
-/**
- * Returns the number total of elements (bar | markers | slices) to be displayed on a chart.
- * It considers the chart will display all the categories/dates (filter on).
- * TODO: that is only necessary because the REST API doesn't return (yet?) the features for which the result (sum, count...) is 0.
- *
- * @param props
- */
-export declare function getTotalElementCount(props: {
-    chartConfig: WebChart;
-    queryObject: QueryObject;
-    queryConfig: WebChartQuery;
-    behaviorAfterLimit?: LimitBehavior;
-    numberMaxOfFeaturesToFetch?: number;
-    isGaugeByFeature?: boolean;
-}): Promise<{
-    categoryOrDateCount?: number;
-    elementCount?: number;
-}>;
-/**
- * Determines whether the provided sort type is allowed for heat chart.
- * For a heat chart, direction sort is allow on any axis, and custom label sort is only allowed on category axes.
- * @param orderBy The order by parameter which can be an array of custom labels or a directional order.
- * @param axisFormatOptions The format options of the axis to determine if sorting is allowed.
- * @returns
- */
-declare function isDataSortTypeAllowedForHeatChart(props: {
-    orderBy?: string[] | WebChartSortOrderKinds;
-    axisFormatOptions?: WebChartAxis["valueFormat"];
-}): boolean;
-/**
- * Compares two values based on the specified order criteria.
- * @param a The first value to compare
- * @param b The second value to compare
- * @param order The order criteria which can be an array of custom labels or a directional order.
- * @returns A number indicating the sort order between `a` and `b`.
- */
-declare function compareByOrder(a: WebChartDataItemValue, b: WebChartDataItemValue, order: string[] | WebChartSortOrderKinds | undefined): number;
-/**
- * Sorts the fetched heat chart data based on the provided order parameters.
- * @param props.arrayToSort The array of data items to sort
- * @param props.chartConfig The heat chart config
- * @param props.dataOrderParamerters The order instructions for x and y axes
- */
-declare function sortFetchedHeatChartData(props: {
-    arrayToSort: WebChartDataItem[];
-    chartConfig: WebHeatChart;
-    dataOrderParameters?: DataOrderParameters[];
-}): void;
-/**
- * Sorts the data.
- * No sorting will be performed if no sorting instruction is provided via the chart config's `orderOptions.data` property.
- * Also, if it's a time binning series, the data is already sorted by the query and other routines, we won't need to resort them.
- *
- * @param props.arrayToSort The data array to sort
- * @param props.chartConfig The chart's config
- * @param props.fieldList The layer field list
- * @param props.isTimeBinningSeries Whether the series is a time binning series
- */
-export declare function sortFetchedData(props: {
-    arrayToSort: WebChartDataItem[];
-    chartConfig: WebChart;
-    fieldList?: IField[];
-    isTimeBinningSeries?: boolean;
-}): void;
-/**
- * Fetching the data for multiple types of chart.
- *
- * @param props
- */
-export declare function fetchFinishedGenericChartData(props: FetchDataProps): Promise<DataInfo>;
-/**
- * Generates an array of values based on the given unit
- * @param unit The unit used to generate the values to return
- * @returns an array of string values, from "1" to the maximum value of the unit (e.g. "12" for MonthOfYear)
- */
-declare function getExpectedValuesFromDatePartsUnit(unit: WebChartCalendarDatePartsUnits): string[] | undefined;
-/**
- * Determines whether empty rows and columns should be filtered out in a heat chart
- * @param chartConfig The heat chart config
- * @returns
- */
-declare function shouldFilterOutEmptyRowsAndColumns(chartConfig: WebHeatChart): boolean;
-/**
- * Filters out rows and columns that are completely empty (i.e., all values are equal to `valueToUse`)
- * @param props
- * @returns
- */
-declare function filterOutEmptyRowsAndColumns(props: {
-    dataItems: WebChartDataItem[];
-    valueField: string;
-    valueToUse: 0 | null;
-    xField: string;
-    yField: string;
-}): WebChartDataItem[];
-/**
- * Fills missing cells in a heat chart dataset with a specified value.
- * It will return only the missing cells (with the filled values) to be added to the original dataset.
- * @param props
- * @returns
- */
-declare function fillMissingCells(props: {
-    dataItems: WebChartDataItem[];
-    xUniqueValues: (number | string)[];
-    yUniqueValues: (number | string)[];
-    xField: string;
-    yField: string;
-    valueField: string;
-    valueToUse: 0 | null;
-}): WebChartDataItem[];
-/**
- * Indicates whether the provided day and month combination is invalid
- * @param props.day The day of the month
- * @param props.month The month of the year
- * @param props.includeLeapDay If we should include Feb 29th
- */
-declare function isInvalidDayOfMonth(props: {
-    day: number;
-    month: number;
-    includeLeapDay?: boolean;
-}): boolean;
-/**
- * Fetching the data for a heat chart.
- * It fetches the data from the attribute bins and processes it to match the heat chart data structure.
- * @param props The list of properties required to fetch the data
- */
-export declare function fetchFinishedHeatChartData(props: FetchDataProps): Promise<DataInfo>;
-/**
- * Function trimming the temporal dataset by considering the rendering limits.
- * @param props.chartConfig The chart's config
- * @param props.options The chart's options
- * @param props.data The data to trim
- */
-declare function trimTemporalDataset(props: {
-    chartConfig: WebChart;
-    options?: ChartOptions;
-    data: WebChartDataItem[];
-}): WebChartDataItem[];
-/**
- * Fetching the data for specifically a line chart using time binning options.
- *
- * @param props
- */
-export declare function fetchFinishedBinnedTemporalData(props: FetchDataProps): Promise<DataInfo>;
-/**
- * Fetching selection data for multiple types of chart.
- * This function is a subset of `fetchFinishedGenericChartData` and was created to avoid bringing too much
- * complexity to it. They need to evolve together if the data fetching pattern changes.
- *
- * @param props
- */
-export declare function fetchFinishedGenericChartSelectionData(props: FetchDataProps): Promise<DataInfo>;
-/**
- * Fetching selection data for box plot.
- *
- * @param props.chartConfig The chart config
- * @param props.queryConfig The query config
- * @param props.queryObject The query object
- * @param props.options The runtime chart options
- * @param props.errorStrings The t9n error strings
- * @param props.abortKey The abort key to cancel queries
- */
-export declare function fetchFinishedBoxPlotSelectionData(props: FetchDataProps): Promise<DataInfo>;
-/** @private */
-export declare const commonUtilsSummarizeDataPrivateFunctions: {
-    restoreStatFieldNamesCase: typeof restoreStatFieldNamesCase;
-    mergeDataItems: typeof mergeDataItems;
-    removeBoxPlotOutStatisticFieldNamePrefix: typeof removeBoxPlotOutStatisticFieldNamePrefix;
-    calculateSeriesPercent: typeof calculateSeriesPercent;
-    calculateInterQuartileRange: typeof calculateInterQuartileRange;
-    getFeatureGeometryExtent: typeof getFeatureGeometryExtent;
-    swapStatFieldNamesToStatisticFields: typeof swapStatFieldNamesToStatisticFields;
-    renameYFieldForSplitByNoAggregation: typeof renameYFieldForSplitByNoAggregation;
-    trimCategories: typeof trimCategories;
-    limitCategories: typeof limitCategories;
-    getExpectedValuesFromDatePartsUnit: typeof getExpectedValuesFromDatePartsUnit;
-    trimTemporalDataset: typeof trimTemporalDataset;
-    shouldFilterOutEmptyRowsAndColumns: typeof shouldFilterOutEmptyRowsAndColumns;
-    isDataSortTypeAllowedForHeatChart: typeof isDataSortTypeAllowedForHeatChart;
-    compareByOrder: typeof compareByOrder;
-    sortFetchedHeatChartData: typeof sortFetchedHeatChartData;
-    filterOutEmptyRowsAndColumns: typeof filterOutEmptyRowsAndColumns;
-    fillMissingCells: typeof fillMissingCells;
-    isInvalidDayOfMonth: typeof isInvalidDayOfMonth;
-    addFieldsDescription: typeof addFieldsDescription;
-};
-export {};

package/dist/chart-rendering/common/data/utils/summarize-data/interfaces.d.ts

@@ -1,36 +0,0 @@
-import { default as Graphic } from '@arcgis/core/Graphic.js';
-import { WebChartDataItemValue, WebChartDataItem, WebChartQuery, WebChart, IStatisticDefinition, WebChartSortOrderKinds } from '../../../../../spec';
-import { QueryObject, AbortControllerKeyType, ChartElementLimit } from '../../../../../utils';
-import { ChartSubType } from '../../../../../utils/misc/interfaces';
-export interface SummarizeDataProps {
-    data: [WebChartDataItemValue, WebChartDataItem[]][];
-    statType: IStatisticDefinition["statisticType"];
-    onStatisticField: string;
-    seriesX: string;
-    seriesY?: string;
-}
-/**
- * Ordering instructions to use when sorting chart data.
- */
-export interface DataOrderParameters {
-    sortingField: string;
-    orderBy?: string[] | WebChartSortOrderKinds;
-    preferLabel?: boolean;
-}
-export interface ProcessUniqueQueryProps {
-    queryObject?: QueryObject;
-    uniqueQuery: WebChartQuery;
-    chartConfig: WebChart;
-    mapToStatField?: Map<number | string | null, string>;
-    elementCount?: number;
-    isTimeBinningSeries: boolean;
-    showMean?: boolean;
-    chartLimits?: ChartElementLimit;
-    abortKey?: AbortControllerKeyType;
-    usePopupTemplateFieldsInfo?: boolean;
-    preFetchedQueryResponse?: Graphic[];
-}
-/** List of chart subtypes that support direct category trimming. */
-export declare const supportedSubTypesForCategoryTrimming: ChartSubType[];
-export declare const totalFeatureCount = "arcgis_charts_total_feature_count";
-export declare const queryBinsServerLimit = 8000;

package/dist/chart-rendering/common/data/utils/summarize-data/time-binning/index.d.ts

@@ -1,96 +0,0 @@
-import { default as AttributeBinsGraphic } from '@arcgis/core/AttributeBinsGraphic.js';
-import { TimeIntervalInfo, WebChart, WebChartDataItem, WebChartQuery, WebChartSeriesType, WebChartNullPolicyTypes, WebChartTemporalBinningUnits } from '../../../../../../spec';
-import { DateRange, QueryObject, TimeBinningStatistics, WebChartSeriesSupportingTemporalBinning } from '../../../../../../utils';
-/**
- * Given `getNumberOfBinsWithinDataRange()` returns a diff in days for weeks, months and years, we need
- * to divide the result to get a better approximation of the element count.
- * TODO: we need to find a better way to do that by using the `luxon` diff function
- *
- * @param initialDayCount The initial number of elements in days
- * @param unit The unit used to bin the temporal data
- */
-export declare function adjustElementCount(initialDayCount: number, unit?: WebChartTemporalBinningUnits): number;
-export declare function getNumberOfBinsWithinDataRange(props: {
-    dateMinTimestamp: number;
-    dateMaxTimestamp: number;
-    timeIntervalInfo: TimeIntervalInfo;
-}): {
-    numberOfFinalBinsWithinDataRange: number;
-    numberOfSingleBinsWithinDataRange: number;
-};
-export declare function getTimeBinningStatistics(props: {
-    queryObject: QueryObject;
-    x: string;
-    queryConfig: WebChartQuery;
-}): Promise<TimeBinningStatistics>;
-/**
- * Maps query results into a WebChartDataItem[] for a chart using the charts solution for temporal binning.
- * @param props.chartConfig The chart configuration
- * @param props.queryResults The query results
- * @param props.mapToStatField The map of unique values to stat fields
- * @param props.splitByField The split-by field
- * @param props.nullPolicy The null policy
- * @param props.x The series x field
- * @param props.y The series y field
- * @param props.queryObject The query object used to fetch the data
- */
-export declare function mapTemporalBinningQueryAttributeBinsResults(props: {
-    chartConfig: WebChart;
-    queryResults: AttributeBinsGraphic[];
-    mapToStatField: Map<number | string | null, string>;
-    splitByField?: string;
-    nullPolicy?: WebChartNullPolicyTypes;
-    x: string;
-    y?: string;
-    queryObject?: QueryObject;
-}): Promise<WebChartDataItem[]>;
-/**
- * Maps query results into a WebChartDataItem[] for a chart using the charts solution for temporal binning.
- * @param props.queryObject The object to query (layer or feature layer view)
- * @param props.data The query results
- * @param props.queryConfig The query configuration
- * @param props.x The series x field
- * @param props.seriesConfig The series configuration
- * @param props.dateRange The date range
- * @param props.timeIntervalInfo The time interval info
- */
-export declare function mapTemporalBinningQueryResults(props: {
-    queryObject: QueryObject;
-    queryResults: WebChartDataItem[];
-    queryConfig: WebChartQuery;
-    x: string;
-    seriesConfig: WebChartSeriesSupportingTemporalBinning[];
-    dateRange: DateRange;
-    timeIntervalInfo: TimeIntervalInfo;
-    chartRenderer?: WebChart["chartRenderer"];
-}): Promise<WebChartDataItem[]>;
-/**
- * Calculates the best interval (unit and size) based on the provided data range.
- * This algorithm comes from ArcGIS Pro and was adapter from C++ to ts. See function `GetDefaultTimeInterval`
- * in Pro (actually here: https://devtopia.esri.com/ArcGISPro/ArcGISPro/blob/ddf7cbe19ec80228179e905c9f85e84710f54ab7/MapX/CartoX/MappingCore/ChartUtils.cpp#L1621)
- *
- * @param props
- */
-export declare function getBestInterval(timeBinningStats: TimeBinningStatistics): TimeIntervalInfo;
-/**
- * Indicates if calculating the time interval unit and size is necessary for the series.
- * It is necessary if the series is a line series, doesn't provide the interval unit and size
- * while the boolean `setTimeBinningInfoWhenNotProvided` is true.
- *
- * @param props.series The series config
- * @param props.isTimeBinningSeries Indicates whether the series is using the time binning feature
- * @param props.setTimeBinningInfoWhenNotProvided Indicates whether the time interval needs to be recalculated if the one provided is incomplete
- */
-export declare function needsToCalculateTimeIntervalInfo(props: {
-    series: WebChartSeriesType;
-    isTimeBinningSeries: boolean;
-    setTimeBinningInfoWhenNotProvided?: boolean;
-}): boolean;
-/**
- * Converts a date from the SQL SQL-92 format 'YYYY-MM-DD HH:mm:ss' to a
- * JS Date
- *
- * @param sqlDate
- * @returns
- */
-export declare function createDatefromAttributes(attributes: WebChartDataItem): number;