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

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

@@ -1,13 +1,15 @@
-import type { ChartOptions } from "../../../chart-rendering/common/interfaces.js";
+import type { DataOrderParameters } from "../../../chart-rendering/common/data/utils/summarize-data/interfaces.js";
 import type { WebChartTypes, WebChartVersionStatus } from "../../../spec/chart-object-literals.js";
 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 } from "../../misc/interfaces.js";
+import type { ChartSubType, SelectionData } from "../../misc/interfaces.js";
 import type { WebChartSeriesSupportingTemporalBinning } from "./interfaces.js";
-import type { DataOrderParameters } from "../../../chart-rendering/common/data/utils/summarize-data/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;
 
@@ -205,7 +238,7 @@ export function hasAdditionalTooltipFieldsChanged(props: {
  * @param newConfig - The updated config
  * @internal
  */
-export function hasColorMatchChanged(oldConfig: WebChart, newConfig: WebChart): boolean;
+export function hasColorMatchChanged(oldConfig: WebChart | undefined, newConfig: WebChart): boolean;
 
 /**
  * Compares two configs and indicates whether the stacked type changed
@@ -269,7 +302,7 @@ export function hasHeatRulesTypeChanged(oldConfig: WebHeatChart, newConfig: WebH
  * @internal
  */
 export function hasSlicesConfigChanged(props: {
-    oldConfig: WebChart;
+    oldConfig: WebChart | undefined;
     newConfig: WebChart;
 }): boolean;
 
@@ -279,7 +312,8 @@ export function hasSlicesConfigChanged(props: {
  */
 export function hasDataForFilterBySelectionChanged(props: {
     previousSelectionOIDs?: (number | string)[];
-    options?: ChartOptions;
+    selectionData?: SelectionData;
+    filterBySelection?: boolean;
 }): boolean;
 
 /**
@@ -409,11 +443,14 @@ export function doSizePolicyChangesRequireSeriesReinit(oldConfig: WebChart, newC
 export function doesConfigChangeRequireNewData(props: {
     previousConfig: WebBoxPlot | WebChart;
     newConfig: WebBoxPlot | WebChart;
-    options?: ChartOptions;
     previousFilterBySelection?: boolean;
     previousSelectionOIDs?: (number | string)[];
     fieldList?: IField[];
     queryObject?: QueryObject;
+    filterBySelection?: ChartOptions["filterBySelection"];
+    selectionData?: ChartOptions["selectionData"];
+    setTimeBinningInfoWhenNotProvided?: ChartOptions["setTimeBinningInfoWhenNotProvided"];
+    chartLimits?: ChartOptions["chartLimits"];
 }): {
     dataUpdateNeeded: boolean;
     dataUpdateDetails: DataUpdateDetails;
@@ -436,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;
@@ -447,17 +485,19 @@ 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): DataOrderParameters[] | undefined;
+export function getDataOrderParameters(chartConfig: WebChart | undefined): 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 - The previous chart config
+ * @internal
  */
 export function isNewSortNeeded(props: {
-    oldConfig: WebChart;
+    oldConfig: WebChart | undefined;
     newConfig: WebChart;
     dataWasUpdated: boolean;
 }): boolean;

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,10 +81,9 @@ export interface ElementCountExceededParams {
   seriesLimit?: number;
 }
 
-/** @internal */
 export interface DataWarningObject {
   keyword: DataWarningKeywords;
-  header: string;
+  header?: string;
   message: string;
   params?: ElementCountExceededParams;
 }

package/dist/utils/components/themes.d.ts

@@ -0,0 +1,8 @@
+/** Interface representing the name of the CSS variables to pull the theme colors from. */
+export interface CalciteThemeCSSVariables {
+  background: string;
+  text: string;
+  line: string;
+  secondaryLine: string;
+  spinner: string;
+}

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

@@ -1,7 +1,8 @@
+import type { WebChartQuery } from "../../../spec/web-chart.js";
 import type { ChartElementLimit } from "../../defaults/interfaces.js";
 import type { QueryObject } from "../../layer/interfaces.js";
 import type { AbortControllerKeyType } from "../../layer/query-features/interfaces.js";
-import type { WebChartQuery } from "../../../spec/web-chart.js";
+import type { ErrorStrings } from "../../localization/interfaces.js";
 
 /**
  * Fetches the unique values from a given field.
@@ -23,5 +24,7 @@ export function uniqueValues(props: {
     category: string;
     splitByField?: string;
     chartLimits?: ChartElementLimit;
+    errorStrings: ErrorStrings;
     abortKey?: AbortControllerKeyType;
+    abortSignal?: AbortSignal;
 }): Promise<(number | string)[]>;

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

@@ -1,10 +1,11 @@
+import type { ChartOptions } from "../../chart-rendering/common/interfaces.js";
+import type { WebChartStatisticType } from "../../spec/chart-object-literals.js";
 import type { WebChartBin, WebChartDataItem, WebChartDataTypes } from "../../spec/data-source.js";
 import type { WebChart, WebChartSeriesType, WebGaugeChart } from "../../spec/web-chart.js";
-import type { ChartSubType } from "../misc/interfaces.js";
-import type { BoxPlotYValueProps, DataMinMax, BoxPlotYFieldKeys } from "./interfaces.js";
-import type { ChartOptions } from "../../chart-rendering/common/interfaces.js";
 import type { QueryObject } from "../layer/interfaces.js";
 import type { ErrorStrings } from "../localization/interfaces.js";
+import type { ChartSubType } from "../misc/interfaces.js";
+import type { BoxPlotYValueProps, DataMinMax, BoxPlotYFieldKeys } from "./interfaces.js";
 
 /**
  * Generates the y field names for box plot
@@ -99,6 +100,7 @@ export function validateBarNLineChartDataItem(props: {
     x: string;
     y: string;
     nullAsValid?: boolean;
+    aggregationType?: WebChartStatisticType;
 }): boolean;
 
 /**
@@ -156,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;
@@ -181,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;
 
@@ -191,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;
 
@@ -199,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;
 
@@ -208,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;
 
@@ -225,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;
@@ -236,26 +244,25 @@ 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: {
-    updatedPropsSnapshot: Map<string, {
-        oldValue: unknown;
-        newValue: unknown;
-    }>;
     chartData?: WebChartDataTypes;
     chartConfig: WebChart;
     queryObject: QueryObject;
     dataWasUpdated?: boolean;
-    options?: ChartOptions;
+    selectionData?: ChartOptions["selectionData"];
+    replaceNoValueCategoryWithZero?: ChartOptions["replaceNoValueCategoryWithZero"];
+    hideZeroCountCategories?: ChartOptions["hideZeroCountCategories"];
+    chartLimits?: ChartOptions["chartLimits"];
+    setTimeBinningInfoWhenNotProvided?: ChartOptions["setTimeBinningInfoWhenNotProvided"];
+    returnFeaturesExtent?: ChartOptions["returnFeaturesExtent"];
+    popupTemplateFieldInfosEnabled?: ChartOptions["popupTemplateFieldInfosEnabled"];
+    view?: ChartOptions["view"];
+    viewExtentUpdated?: ChartOptions["viewExtentUpdated"];
+    returnSelectionOIDs?: ChartOptions["returnSelectionOIDs"];
+    runtimeDataFilters?: ChartOptions["runtimeDataFilters"];
+    ignoreViewExtent?: ChartOptions["ignoreViewExtent"];
     errorStrings: ErrorStrings;
-}): 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;
-};
+    selectionIDsChanged: 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 */
@@ -85,7 +84,10 @@ export const loaderBackgroundLight: Color;
  */
 export const loaderBackgroundDark: Color;
 
-/** @internal */
+/**
+ * @deprecated since 5.1. Will be replaced by the Calcite CSS variable --calcite-color-brand-hover.
+ * @internal
+ */
 export const loaderSpinnerColor: Color;
 
 /** @internal */
@@ -268,6 +270,20 @@ export function getDefaultAxes(commonStrings: CommonStrings, chartType: WebChart
  */
 export function getDefaultGaugeNeedle(): WebChartNeedle;
 
+/**
+ * Returns the default progress base band symbol for gauge charts
+ *
+ * @internal
+ */
+export function getDefaultProgressBaseBandSymbol(): ISimpleFillSymbol;
+
+/**
+ * Returns the default progress target band symbol for gauge charts
+ *
+ * @internal
+ */
+export function getDefaultProgressTargetBandSymbol(): ISimpleFillSymbol;
+
 /**
  * Returns the gauge axes
  *
@@ -433,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
@@ -504,4 +520,7 @@ export const boxPlotZScoreSuffix: "_arcgis_charts_z_score";
 export const defaultColorForBoxPlotWithMeanLines: Color;
 
 /** @internal */
-export const percentageSuffix: " percentage ";
+export const percentageSuffix: " percentage ";
+
+/** @internal */
+export const heatChartFirstDayOfWeek: 7;

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,13 +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 WCSLayer from "@arcgis/core/layers/WCSLayer.js";
+import type Layer from "@arcgis/core/layers/Layer.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";
@@ -33,19 +34,28 @@ export function getRendererInfo(layerRenderer?: Renderer): RendererInfo;
 export function getFeatureLayer(featureLayer: IFeatureLayer, abortSignal?: AbortSignal): Promise<FeatureLayer>;
 
 /**
- * A wrapper function creating a FeatureLayer, ImageryLayer, ImagegeryTileLayer, or WCSLayer from a set of parameters.
+ * A wrapper function creating a FeatureLayer, ImageryLayer, ImageryTileLayer, or WCSLayer from a set of parameters.
  * It returns the created FeatureLayer, ImageryLayer, ImageryTileLayer, or WCSLayer.
  *
  * @param iLayer
+ * @param abortSignal
  * @internal
  */
-export function getLayer(iLayer: IFeatureLayer): Promise<FeatureLayer>;
+export function getLayer(iLayer: IFeatureLayer, abortSignal?: AbortSignal): Promise<FeatureLayer>;
 
-/** @param iLayer */
-export function getLayer(iLayer: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer | IWCSLayer): Promise<FeatureLayer | ImageryLayer | ImageryTileLayer | WCSLayer>;
+/**
+ * @param iLayer
+ * @param abortSignal
+ * @internal
+ */
+export function getLayer(iLayer: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer | IWCSLayer, abortSignal?: AbortSignal): Promise<FeatureLayer | ImageryLayer | ImageryTileLayer | WCSLayer>;
 
-/** @param iLayer */
-export function getLayer(iLayer: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer | IWCSLayer): Promise<FeatureLayer | ImageryLayer | ImageryTileLayer | WCSLayer>;
+/**
+ * @param iLayer
+ * @param abortSignal
+ * @internal
+ */
+export function getLayer(iLayer: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer | IWCSLayer, abortSignal?: AbortSignal): Promise<FeatureLayer | ImageryLayer | ImageryTileLayer | WCSLayer>;
 
 /**
  * Returns the proper query object to use according to the situation.
@@ -177,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;
 
@@ -184,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;
@@ -204,9 +216,10 @@ export function getRendererFieldNames(layer: SupportedLayer | undefined): Promis
  * https://doc.arcgis.com/en/arcgis-online/reference/faq.htm#anchor7
  *
  * @param layer
+ * @param abortSignal
  * @internal
  */
-export function isStandardLayer(layer: SupportedLayer | undefined): Promise<boolean>;
+export function isStandardLayer(layer: SupportedLayer | undefined, abortSignal?: AbortSignal): Promise<boolean>;
 
 /**
  * Finds the matching field name for a given layer based on the fieldToMatch parameter.
@@ -263,7 +276,7 @@ export function buildQueryConfig(props: {
     chartConfig: WebChart;
     runtimeDataFilters?: WebChartDataFilters;
     ignoreViewExtent?: boolean;
-    viewExtent?: Extent;
+    view?: ChartOptions["view"];
 }): WebChartQuery;
 
 /**
@@ -313,4 +326,12 @@ export function extractFieldsFromConfigList(layer: SupportedLayer): Promise<stri
 export function findMatchingLayerFromView(props: {
     view?: MapView | SceneView;
     portalItemId: string;
-}): FeatureLayerView | SupportedLayer | undefined;
+}): FeatureLayerView | SupportedLayer | undefined;
+
+/**
+ * Loads the layer. Generates raster info if it's an ImageryLayer or an ImageryTileLayer.
+ *
+ * @param layer - The layer
+ * @param abortSignal - Optional abort signal to cancel the request
+ */
+export function loadLayer(layer: Layer | SupportedLayer | SupportedRasterLayer, abortSignal?: AbortSignal): Promise<void>;

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-features/index.d.ts

@@ -1,12 +1,12 @@
 import type AttributeBinsGraphic from "@arcgis/core/AttributeBinsGraphic.js";
 import type AttributeBinsFeatureSet from "@arcgis/core/rest/support/AttributeBinsFeatureSet.js";
-import type { ChartOptions } from "../../../chart-rendering/common/interfaces.js";
 import type { WebChartDataItem } from "../../../spec/data-source.js";
 import type { WebChartQuery, WebChartTemporalBinning, WebHeatChart } from "../../../spec/web-chart.js";
 import type { ErrorStrings } from "../../localization/interfaces.js";
 import type { ChartSubType } from "../../misc/interfaces.js";
 import type { QueryObject } from "../interfaces.js";
 import type { AbortControllerKeyType, Features } from "./interfaces.js";
+import type { ChartOptions } from "../../../chart-rendering/common/interfaces.js";
 
 /**
  * Performs a query analytic.
@@ -20,6 +20,8 @@ export function queryAnalytic(props: {
     outAnalytics: string;
     outputFormat: string;
     dataFormat: string;
+    errorStrings: ErrorStrings;
+    abortSignal?: AbortSignal;
 }): Promise<WebChartDataItem | undefined>;
 
 /**
@@ -45,8 +47,10 @@ export function queryAttributeBinsForHeatChart(props: {
     chartConfig: WebHeatChart;
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
-    options?: ChartOptions;
+    view?: ChartOptions["view"];
+    syncViewTimeZone?: ChartOptions["syncViewTimeZone"];
     errorStrings: ErrorStrings;
+    abortSignal?: AbortSignal;
 }): Promise<AttributeBinsFeatureSet | undefined>;
 
 /**
@@ -62,6 +66,7 @@ export function queryFeaturesForMatrixHeatChart(props: {
     returnFeaturesExtent?: boolean;
     errorStrings: ErrorStrings;
     abortKey?: AbortControllerKeyType;
+    abortSignal?: AbortSignal;
 }): Promise<Features | undefined>;
 
 /**
@@ -80,6 +85,7 @@ export function queryAttributeBinsForScatterplot(props: {
     x: string;
     y: string;
     errorStrings: ErrorStrings;
+    abortSignal?: AbortSignal;
 }): Promise<AttributeBinsFeatureSet | undefined>;
 
 /**
@@ -94,6 +100,7 @@ export function queryFeatureCount(props: {
     chartSubType: ChartSubType;
     x: string;
     isGaugeByFeature?: boolean;
+    abortSignal?: AbortSignal;
 }): Promise<number | undefined>;
 
 /**
@@ -106,7 +113,9 @@ export function queryFeatureCount(props: {
 export function queryStatistics<T extends Date | number | string>(props: {
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
+    errorStrings: ErrorStrings;
     abortKey?: AbortControllerKeyType;
+    abortSignal?: AbortSignal;
 }): Promise<Map<string, T>>;
 
 /**
@@ -117,7 +126,9 @@ export function queryFeatures(props: {
     queryObject: QueryObject;
     queryConfig?: WebChartQuery;
     returnUniqueIdsOnly?: boolean;
+    errorStrings: ErrorStrings;
     abortKey?: AbortControllerKeyType;
+    abortSignal?: AbortSignal;
 }): Promise<Features>;
 
 /**
@@ -133,7 +144,9 @@ export function queryAllFeatures(props: {
     returnUniqueIdsOnly?: boolean;
     featureCount?: number;
     noBatch?: boolean;
+    errorStrings: ErrorStrings;
     abortKey?: AbortControllerKeyType;
+    abortSignal?: AbortSignal;
 }): Promise<Features>;
 
 /**
@@ -146,6 +159,7 @@ export function queryUniqueIDs(props: {
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
     uniqueFeature?: boolean;
+    errorStrings: ErrorStrings;
     abortKey?: AbortControllerKeyType;
 }): Promise<(number | string)[]>;
 
@@ -182,6 +196,9 @@ export function queryAttributeBinsForTemporalData(props: {
     dateField: string;
     splitByField?: string;
     axisTimeZone: string | undefined;
-    options?: ChartOptions;
+    errorStrings: ErrorStrings;
+    view?: ChartOptions["view"];
+    syncViewTimeZone?: boolean;
     abortKey?: AbortControllerKeyType;
+    abortSignal?: AbortSignal;
 }): Promise<AttributeBinsGraphic[]>;

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
@@ -86,7 +86,8 @@ export function mapAttributeBinsQueryForTemporalData(props: {
     dateField: string;
     splitByField?: string;
     axisTimeZone?: string;
-    options?: ChartOptions;
+    view?: ChartOptions["view"];
+    syncViewTimeZone?: ChartOptions["syncViewTimeZone"];
 }): AttributeBinsQuery;
 
 /**
@@ -126,7 +127,8 @@ export function mapAttributeBinsQueryForHeatChart(props: {
     firstDayOfWeek?: number;
     configTimeZone?: string;
     includeLeapDay?: boolean;
-    options?: ChartOptions;
+    view?: ChartOptions["view"];
+    syncViewTimeZone?: ChartOptions["syncViewTimeZone"];
 }): AttributeBinsQuery;
 
 /**