@arcgis/charts-components 5.2.0-next.1 → 5.2.0-next.10

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,33 @@ 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
+ */
+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
+ */
+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.
  *

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

@@ -30,6 +30,7 @@ export interface CustomErrorObject {
 /**
  * Validation Status interface which described the validity of the input WebChart config
  *
+ * @deprecated since 5.1. Won't be replaced.
  * @internal
  */
 export interface ValidationStatus {
@@ -55,6 +56,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";

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/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";
@@ -274,7 +274,7 @@ export function buildQueryConfig(props: {
     chartConfig: WebChart;
     runtimeDataFilters?: WebChartDataFilters;
     ignoreViewExtent?: boolean;
-    viewExtent?: Extent;
+    view?: ChartOptions["view"];
 }): WebChartQuery;
 
 /**

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

@@ -8,6 +8,7 @@ import type { WebChart } from "../../../spec/web-chart.js";
  * Creates a chart renderer based on the provided config fields and inline data.
  *
  * @param props - The category field, the numeric fields, the config fields and the data to convert.
+ * @internal
  */
 export function convertConfigFieldsToChartRenderer(props: {
     categoryField: string;
@@ -20,6 +21,7 @@ export function convertConfigFieldsToChartRenderer(props: {
  * Converts an array of inline data to a feature set and returns an `IFeatureLayer`.
  *
  * @param props - The category field, the category type, the numeric fields and the inline data to convert.
+ * @internal
  */
 export function convertInlineDataToLayerDefinition(props: {
     categoryField: string;
@@ -32,6 +34,7 @@ export function convertInlineDataToLayerDefinition(props: {
  * Converts an array of inline data into a feature collection. Also returns a `chartRenderer` if the `configFields` are provided.
  *
  * @param props - The category field, the category type, the numeric fields, the config fields and the inline data to convert.
+ * @internal
  */
 export function convertInlineConfigToLayerConfig(props: {
     categoryField: 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/charts-components",
-  "version": "5.2.0-next.1",
+  "version": "5.2.0-next.10",
   "description": "Reusable ArcGIS charting Web Components.",
   "type": "module",
   "main": "./dist/index.js",
@@ -8,6 +8,8 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": "./dist/index.js",
+    "./utils/chart-config/converter/index": "./dist/utils/chart-config/converter/index.js",
+    "./model/shared/setup-utils": "./dist/model/shared/setup-utils.js",
     "./loader": "./dist/loader.js",
     "./package.json": "./package.json",
     "./components/*/customElement": "./dist/components/*/customElement.js",
@@ -27,7 +29,7 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
     "@amcharts/amcharts4": "^4.10.31",
-    "@amcharts/amcharts5": "~5.17.2",
+    "@amcharts/amcharts5": "~5.18.0",
     "@esri/arcgis-html-sanitizer": "~4.1.0",
     "@lit/task": "^1.0.3",
     "ajv": "6.12.6",
@@ -40,12 +42,12 @@
     "luxon": "~3.7.2",
     "simple-statistics": "^7.8.8",
     "tslib": "^2.8.1",
-    "@arcgis/lumina": "5.2.0-next.1",
-    "@arcgis/toolkit": "5.2.0-next.1"
+    "@arcgis/lumina": "5.2.0-next.10",
+    "@arcgis/toolkit": "5.2.0-next.10"
   },
   "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-next.3"
   },
   "css.customData": [
     "dist/docs/vscode.css-custom-data.json"