@arcgis/charts-components 5.2.0-next.2 → 5.2.0-next.20

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

@@ -4,10 +4,12 @@ import type { RESTSymbolType } from "../../../spec/rest-js-object-literals.js";
 import type { IField } from "../../../spec/rest-js-types.js";
 import type { WebBoxPlot, WebChart, WebChartLegend, WebChartSeriesType, WebHeatChart } from "../../../spec/web-chart.js";
 import type { DataUpdateDetails } from "../../data/interfaces.js";
+import type { ChartElementLimit } from "../../defaults/interfaces.js";
 import type { QueryObjectOrRaster as QueryObject } from "../../layer/interfaces.js";
 import type { ChartSubType, SelectionData } from "../../misc/interfaces.js";
 import type { WebChartSeriesSupportingTemporalBinning } from "./interfaces.js";
 import type { ChartOptions } from "../../../chart-rendering/common/interfaces.js";
+import type { WebChartBin, WebChartDataItem } from "../../../spec/data-source.js";
 
 /**
  * Retrieve and construct chart version information based on the input version and the currently supported ArcGIS Chart versions
@@ -95,6 +97,7 @@ export function isAbsoluteTruthWhereClause(where?: string): boolean;
  *   - where = "field = 5" => returns "field = 5"
  *   - where = "field = 'value'" => returns "field = 'value'"
  *   - where = "field = 'va'lue'" => returns "field = 'va''lue'"
+ *   - where = "field = null => returns "field IS NULL"
  *
  * @param props - the where clause to normalize
  * @internal
@@ -128,6 +131,35 @@ export function getBoxPlotChartSubType(seriesConfig: WebChartSeriesType[]): Char
  */
 export function getChartSubType(series?: WebChartSeriesType[]): ChartSubType;
 
+/**
+ * A function to determine whether the scatterplot is aggregated.
+ * It can use a map of statistics containing the number of points (computed from the data side) or
+ * a data context object usually stored within each marker.
+ *
+ * @param props - an optional map of statistics
+ * @returns A boolean indicating whether the scatterplot is aggregated
+ * @internal
+ */
+export function isScatterplotAggregated(props: {
+    statsMap?: Map<string, number>;
+    dataContext?: WebChartDataItem;
+    chartLimits?: ChartElementLimit;
+}): boolean;
+
+/**
+ * A function to determine whether a chart is aggregated.
+ * Supports scatterplot, bar, line, combo, and pie chart. Defaults to true for the other types of chart.
+ *
+ * @param props - An optional data context object
+ * @returns A boolean indicating whether the chart is aggregated
+ * @internal
+ */
+export function isChartAggregated(props: {
+    dataContext?: WebChartBin | WebChartDataItem;
+    chartConfig: WebChart;
+    chartLimits?: ChartElementLimit;
+}): boolean;
+
 /**
  * Indicates whether the bar or line series is configured to use time binning.
  *
@@ -163,6 +195,7 @@ export function hasConfigFilterChanged(previousConfig: WebChart, newConfig: WebC
  *
  * @param previousSeries
  * @param newSeries
+ * @internal
  */
 export function hasNumberOfSeriesChanged(previousSeries: WebChart["series"], newSeries: WebChart["series"]): boolean;
 
@@ -440,6 +473,7 @@ export function sortConfigSeries<T extends WebChart | undefined>(chartConfig: T,
  * This allows x and y category lists to be ordered independently from the flattened cell data traversal.
  *
  * @param props - The chart config containing the heat-chart multi-axis sort instructions
+ * @internal
  */
 export function getHeatChartAxisDataOrderInstruction(props: {
     chartConfig: WebHeatChart;
@@ -451,6 +485,7 @@ export function getHeatChartAxisDataOrderInstruction(props: {
  *
  * @param chartConfig - The chart configuration
  * @returns An array of objects with sortingField, optionally an orderBy and preferLabel, or undefined.
+ * @internal
  */
 export function getDataOrderParameters(chartConfig: WebChart | undefined): DataOrderParameters[] | undefined;
 
@@ -459,6 +494,7 @@ export function getDataOrderParameters(chartConfig: WebChart | undefined): DataO
  * the data update is needed.
  *
  * @param props - The previous chart config
+ * @internal
  */
 export function isNewSortNeeded(props: {
     oldConfig: WebChart | undefined;

package/dist/utils/chart-config/validator/index.d.ts

@@ -9,6 +9,7 @@ import type { WebChart, WebGaugeChart } from "../../../spec/web-chart.js";
  * - `Errors`: Violations in the config with regard to the JSON schema.
  * - `Warnings`: Undesired combinations in the config which don't violate the JSON schema but should still be blocked.
  *
+ * @deprecated since 5.1. Won't be replaced.
  * @param props - The input config, the query object and whether to allow using the object id field as a statistic field.
  * @returns The validation status.
  */

package/dist/utils/chart-config/validator/interfaces.d.ts

@@ -28,9 +28,9 @@ export interface CustomErrorObject {
 }
 
 /**
- * Validation Status interface which described the validity of the input WebChart config
+ * Validation Status interface which described the validity of the input WebChart config.
  *
- * @internal
+ * @deprecated since 5.1. Won't be replaced.
  */
 export interface ValidationStatus {
   valid: boolean;
@@ -55,6 +55,7 @@ export const ConfigErrorKeywords: {
 export const DataWarningKeywords: {
     readonly BadData: "badData";
     readonly EmptyDataSet: "emptyDataSet";
+    readonly NoValue: "noValue";
     readonly InvalidConfig: "invalidConfig";
     readonly HistogramEmptyField: "histogramEmptyField";
     readonly BarElementExceedsLimit: "barElementExceedsLimit";
@@ -80,7 +81,6 @@ export interface ElementCountExceededParams {
   seriesLimit?: number;
 }
 
-/** @internal */
 export interface DataWarningObject {
   keyword: DataWarningKeywords;
   header?: string;

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

@@ -158,6 +158,7 @@ export function getDataMinMaxFromSeries(props: {
  * Get the series id related to the given axis (useful in dual axis mode).
  *
  * @param props - The chart configuration
+ * @internal
  */
 export function getAxisSeriesIds(props: {
     chartConfig: WebChart;
@@ -183,6 +184,7 @@ export function whetherLogScaleIsDataCompatible(props: {
  *
  * @param modifiedData - The data to revert
  * @param seriesConfig - The series config
+ * @internal
  */
 export function revertPieFromFieldsProperties<T extends WebChartDataItem[] | WebChartDataTypes>(modifiedData: T, seriesConfig?: WebChart["series"]): T;
 
@@ -193,6 +195,7 @@ export function revertPieFromFieldsProperties<T extends WebChartDataItem[] | Web
  *
  * @param data - The data containing modified x or y values
  * @param seriesConfig - The series config
+ * @internal
  */
 export function revertOriginalXAndYValues<T extends WebChartDataItem[] | WebChartDataTypes>(data: T, seriesConfig?: WebChart["series"]): T;
 
@@ -201,6 +204,7 @@ export function revertOriginalXAndYValues<T extends WebChartDataItem[] | WebChar
  *
  * @param dataItem - The data item to sanitize
  * @returns The sanitized data item
+ * @internal
  */
 export function removeAdditionalStatisticsPerItem(dataItem: WebChartDataItem): WebChartDataItem;
 
@@ -210,6 +214,7 @@ export function removeAdditionalStatisticsPerItem(dataItem: WebChartDataItem): W
  * @param data - The data set to modify
  * @param seriesConfig - The series config
  * @returns The sanitized data
+ * @internal
  */
 export function removeAdditionalStatistics(data: WebChartDataTypes, seriesConfig: WebChartSeriesType[]): WebChartDataTypes;
 
@@ -227,6 +232,7 @@ export function roundToDecimals(num: number, dec: number): number;
  * The point is to send meaningful data to the user through events or the `chartWillRender()` function.
  *
  * @param props - The data to sanitize
+ * @internal
  */
 export function sanitizeData(props: {
     data?: WebChartDataTypes;
@@ -238,6 +244,7 @@ export function sanitizeData(props: {
  * and if the chart is aggregated we perform queries to fetch the data.
  *
  * @param props - A snapshot of the updated props, used to determine whether the selection OIDs have changed
+ * @internal
  */
 export function getSelectionItemsFromOIDs(props: {
     chartData?: WebChartDataTypes;
@@ -258,14 +265,4 @@ export function getSelectionItemsFromOIDs(props: {
     ignoreViewExtent?: ChartOptions["ignoreViewExtent"];
     errorStrings: ErrorStrings;
     selectionIDsChanged: boolean;
-}): Promise<WebChartDataItem[] | undefined>;
-
-export const dataPrivateFunctions: {
-    shouldCheckDataMinMaxForLogScaleOnXAxis: (chartConfig?: WebChart | undefined) => boolean;
-    minMaxHasZeroOrNegativeValues: (min?: number | undefined, max?: number | undefined) => boolean;
-    isChartWithZeroOrNegativeValues: (props: {
-        chartConfig: WebChart;
-        chartData: Array<WebChartDataItem> | Array<WebChartBin>;
-        axisConfigIndex: number;
-    }) => boolean;
-};
+}): Promise<WebChartDataItem[] | undefined>;

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

@@ -7,7 +7,6 @@ import type { ChartElementLimit, ChartElementTechnicalLimit, ChartTextProps, Que
 /** @internal */
 export const histogramBinCount: 32;
 
-/** @internal */
 export const featuresExtentField: "arcgis_charts_features_extent";
 
 /** @internal */
@@ -450,7 +449,7 @@ export function getDefaultHistogramOverlays(): Required<HistogramOverlays>;
 export function getDefaultHistogramSymbol(): ISimpleFillSymbol;
 
 /** @internal */
-export function getDefaultHistogramSeries(): Omit<Required<WebChartHistogramSeries>, "dataTooltipDateFormat" | "dataTooltipPercentFormat" | "dataTooltipValueFormat" | "query">;
+export function getDefaultHistogramSeries(): Omit<Required<WebChartHistogramSeries>, "dataTooltipDateFormat" | "dataTooltipFontSize" | "dataTooltipPercentFormat" | "dataTooltipValueFormat" | "query">;
 
 /**
  * @param commonStrings

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

@@ -1,6 +1,6 @@
 /**
  * Class that enhances the debugging and error handling process. Rather than returning a generic [JavaScript
- * error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error), this class returns a standardized error object with several properties.
+ * error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error), this class returns a standardized error object with several properties.
  */
 export class ArcgisChartsError<T = any> extends Error {
   /** Creates a new `ArcgisChartsError` instance. */

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

@@ -1,14 +1,14 @@
-import type Extent from "@arcgis/core/geometry/Extent.js";
 import type FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
 import type ImageryLayer from "@arcgis/core/layers/ImageryLayer.js";
 import type ImageryTileLayer from "@arcgis/core/layers/ImageryTileLayer.js";
 import type Layer from "@arcgis/core/layers/Layer.js";
-import type WCSLayer from "@arcgis/core/layers/WCSLayer.js";
 import type CodedValueDomain from "@arcgis/core/layers/support/CodedValueDomain.js";
+import type WCSLayer from "@arcgis/core/layers/WCSLayer.js";
 import type Renderer from "@arcgis/core/renderers/Renderer.js";
 import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView.js";
 import type MapView from "@arcgis/core/views/MapView.js";
 import type SceneView from "@arcgis/core/views/SceneView.js";
+import type { ChartOptions } from "../../chart-rendering/common/interfaces.js";
 import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
 import type { IFeatureLayer, IField, IImageServiceLayer, ITiledImageServiceLayer, IWCSLayer } from "../../spec/rest-js-types.js";
 import type { WebChart, WebChartDataFilters, WebChartQuery } from "../../spec/web-chart.js";
@@ -187,6 +187,7 @@ export function getFieldCodedValueDomain(queryObject: QueryObject, field?: strin
  *
  * @param fieldValue - The field value to get the description for
  * @param domain - The domain of the field
+ * @internal
  */
 export function getFieldDescriptionFromDomain(fieldValue: number | string, domain?: CodedValueDomain): string | undefined;
 
@@ -194,6 +195,7 @@ export function getFieldDescriptionFromDomain(fieldValue: number | string, domai
  * Get the field description from the query object given a field name and a field value.
  *
  * @param props - The query object (layer or feature layer view)
+ * @internal
  */
 export function getFieldDescriptionFromQueryObject(props: {
     queryObject: QueryObjectOrRaster;
@@ -274,7 +276,7 @@ export function buildQueryConfig(props: {
     chartConfig: WebChart;
     runtimeDataFilters?: WebChartDataFilters;
     ignoreViewExtent?: boolean;
-    viewExtent?: Extent;
+    view?: ChartOptions["view"];
 }): WebChartQuery;
 
 /**

package/dist/utils/layer/inline-conversion/interfaces.d.ts

@@ -1,8 +1,6 @@
 /**
  * Former interface describing the property `configFields` from an inline data source.
  * Is an object which dictate which data-item field should be used for defining a property of the rendered element (line, point, bars, etc). Used in inline data source mode only.
- *
- * @internal
  */
 export interface WebChartConfigFields {
   fillColor?: string;

package/dist/utils/layer/query-parser/index.d.ts

@@ -8,7 +8,7 @@ import type { QueryProperties } from "@arcgis/core/rest/support/Query.js";
 import type { ChartOptions } from "../../../chart-rendering/common/interfaces.js";
 import type { RESTFieldType } from "../../../spec/rest-js-object-literals.js";
 import type { WebChartHeatChartSeries, WebChartQuery, WebChartTemporalBinning } from "../../../spec/web-chart.js";
-import type { QueryObject, QueryObjectOrRaster } from "../interfaces.js";
+import type { QueryObject } from "../interfaces.js";
 
 /**
  * Indicates whether a query can be cached. It is not when:
@@ -38,11 +38,11 @@ export function combineFilters(filterList: (string | null | undefined)[], operan
 /**
  * Computes the time extent to be used by the query.
  *
- * @param queryObject - The layer or feature layer view
+ * @param viewTimeExtent - The layer or feature layer view
  * @param defaultTimeExtent - The time extent defined at the series config level or provided at runtime
  * @internal
  */
-export function getQueryTimeExtent(queryObject?: QueryObjectOrRaster, defaultTimeExtent?: WebChartQuery["timeExtent"]): WebChartQuery["timeExtent"] | undefined;
+export function getQueryTimeExtent(viewTimeExtent?: TimeExtent | null, defaultTimeExtent?: WebChartQuery["timeExtent"]): WebChartQuery["timeExtent"] | undefined;
 
 /**
  * Computes the extent to be used by the query. We prioritize the feature layer view extent

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

@@ -114,6 +114,8 @@ export const CommonStringsIdentity: (value: {
         };
         notifications: {
             invalidConfig: string;
+            invalidConfigForRaster: string;
+            invalidConfigTitle: string;
             invalidSeriesConfig: string;
             invalidSeriesConfigTitle: string;
             validateAggregationTypeMsg: string;
@@ -379,6 +381,8 @@ export const CommonStringsIdentity: (value: {
         };
         notifications: {
             invalidConfig: string;
+            invalidConfigForRaster: string;
+            invalidConfigTitle: string;
             invalidSeriesConfig: string;
             invalidSeriesConfigTitle: string;
             validateAggregationTypeMsg: string;

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

@@ -15,7 +15,6 @@ export type SerialChartType = typeof WebChartTypes.BarSeries | typeof WebChartTy
 /** @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 */
@@ -251,8 +250,8 @@ 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
+ *   - https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number/isFinite
+ *   - https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number/isNaN
  *
  * @param value
  * @internal

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

@@ -104,11 +104,7 @@ export type BoxPlotConfig = WebBoxPlot;
  */
 export type HeatChartConfig = WebHeatChart;
 
-/**
- * Type alias for the supported chart series types.
- *
- * @internal
- */
+/** Type alias for the supported chart series types. */
 export type SupportedChartSeries = WebChartBarChartSeries | WebChartBoxPlotSeries | WebChartGaugeSeries | WebChartHistogramSeries | WebChartLineChartSeries | WebChartPieChartSeries | WebChartRadarChartSeries | WebChartScatterplotSeries;
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/charts-components",
-  "version": "5.2.0-next.2",
+  "version": "5.2.0-next.20",
   "description": "Reusable ArcGIS charting Web Components.",
   "type": "module",
   "main": "./dist/index.js",
@@ -29,7 +29,7 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
     "@amcharts/amcharts4": "^4.10.31",
-    "@amcharts/amcharts5": "~5.17.2",
+    "@amcharts/amcharts5": "~5.19.1",
     "@esri/arcgis-html-sanitizer": "~4.1.0",
     "@lit/task": "^1.0.3",
     "ajv": "6.12.6",
@@ -42,12 +42,12 @@
     "luxon": "~3.7.2",
     "simple-statistics": "^7.8.8",
     "tslib": "^2.8.1",
-    "@arcgis/lumina": "5.2.0-next.2",
-    "@arcgis/toolkit": "5.2.0-next.2"
+    "@arcgis/lumina": "5.2.0-next.20",
+    "@arcgis/toolkit": "5.2.0-next.20"
   },
   "peerDependencies": {
-    "@arcgis/core": "^5.1.0-next",
-    "@esri/calcite-components": "^5.1.0-next.60"
+    "@arcgis/core": "^5.2.0-next",
+    "@esri/calcite-components": "^5.1.1"
   },
   "css.customData": [
     "dist/docs/vscode.css-custom-data.json"