@arcgis/charts-components 5.1.0-next.8 → 5.1.0-next.80

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

@@ -1,12 +1,16 @@
+import type Extent from "@arcgis/core/geometry/Extent.js";
 import type FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
-import type Renderer from "@arcgis/core/renderers/Renderer";
-import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView";
+import type ImageryLayer from "@arcgis/core/layers/ImageryLayer.js";
+import type ImageryTileLayer from "@arcgis/core/layers/ImageryTileLayer.js";
+import type CodedValueDomain from "@arcgis/core/layers/support/CodedValueDomain.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 { SupportedLayer } from "../../interfaces.js";
-import type { QueryObject, QueryObjectProps, RendererInfo, SubtypeInfo } from "./interfaces.js";
-import type { IFeatureLayer, IField } from "../../spec/rest-js-types.js";
+import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
+import type { IFeatureLayer, IField, IImageServiceLayer, ITiledImageServiceLayer } from "../../spec/rest-js-types.js";
 import type { WebChart, WebChartDataFilters, WebChartQuery } from "../../spec/web-chart.js";
+import type { QueryObject, QueryObjectOrRaster, QueryObjectProps, RendererInfo } from "./interfaces.js";
 
 /**
  * Returns the renderer type and the field and normalization field if applicable.
@@ -21,27 +25,50 @@ export function getRendererInfo(layerRenderer?: Renderer): RendererInfo;
  * It returns the created Feature Layer.
  * It is memoized (cached) to avoid multiple requests for a same feature layer.
  *
+ * @param featureLayer
+ * @param abortSignal
  * @internal
  */
-export const getFeatureLayer: (featureLayer: IFeatureLayer) => Promise<FeatureLayer>;
+export function getFeatureLayer(featureLayer: IFeatureLayer, abortSignal?: AbortSignal): Promise<FeatureLayer>;
+
+/**
+ * A wrapper function creating a FeatureLayer, ImageryLayer, or ImagegeryTileLayer from a set of parameters.
+ * It returns the created FeatureLayer, ImageryLayer, or ImagegeryTileLayer.
+ *
+ * @param iLayer
+ * @internal
+ */
+export function getLayer(iLayer: IFeatureLayer): Promise<FeatureLayer>;
+
+/** @param iLayer */
+export function getLayer(iLayer: IImageServiceLayer): Promise<ImageryLayer>;
+
+/** @param iLayer */
+export function getLayer(iLayer: ITiledImageServiceLayer): Promise<ImageryTileLayer>;
+
+/** @param iLayer */
+export function getLayer(iLayer: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer): Promise<FeatureLayer | ImageryLayer | ImageryTileLayer>;
+
+/** @param iLayer */
+export function getLayer(iLayer: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer): Promise<FeatureLayer | ImageryLayer | ImageryTileLayer>;
 
 /**
  * Returns the proper query object to use according to the situation.
- * If can return either a FeatureLayer or a FeatureLayerView (and possibly nothing)
+ * It can return either a FeatureLayer, an ImageryLayer, an ImageryTileLayer, or a FeatureLayerView (and possibly nothing).
  *
  * @param props
  * @internal
  */
-export function getQueryObject(props: QueryObjectProps): Promise<QueryObject>;
+export function getQueryObject(props: QueryObjectProps): Promise<QueryObjectOrRaster | undefined>;
 
 /**
- * Fetches all the fields info a feature layer.
+ * Fetches all the fields info from a layer.
  *
- * @param queryObject
+ * @param queryObject - The query object (layer or feature layer view) to fetch the fields info from. **Ensure the query object's layer is loaded before calling this function**.
  * @param usePopupTemplateFieldsInfo - whether to use the aliases from the popupTemplate
  * @internal
  */
-export function fetchLayerFieldsInfo(queryObject: QueryObject, usePopupTemplateFieldsInfo?: boolean): Promise<IField[]>;
+export function fetchLayerFieldsInfo(queryObject: QueryObjectOrRaster, usePopupTemplateFieldsInfo?: boolean): IField[];
 
 /**
  * Looks into a list of fields for one having a specific name, and returning it if found.
@@ -62,7 +89,7 @@ export function getFieldFromName(fieldName: string, fields?: IField[]): IField |
  * When the layer is undefined, returns undefined ID fields and false for the boolean.
  * @internal
  */
-export function getLayerUniqueIdOrObjectIdFields(layer?: SupportedLayer): {
+export function getLayerUniqueIdOrObjectIdFields(layer?: SupportedLayer | SupportedRasterLayer): {
     idFields: string[] | undefined;
     isTraditionalTypeOID: boolean;
 };
@@ -74,7 +101,7 @@ export function getLayerUniqueIdOrObjectIdFields(layer?: SupportedLayer): {
  * @param layer - The layer
  * @internal
  */
-export function getObjectIdField(layer?: SupportedLayer): {
+export function getObjectIdField(layer?: SupportedLayer | SupportedRasterLayer): {
     idField: string;
     isTraditionalTypeOID: boolean;
 };
@@ -86,7 +113,7 @@ export function getObjectIdField(layer?: SupportedLayer): {
  * @param field
  * @internal
  */
-export function isNumericField(field: IField): boolean;
+export function isNumericField(field?: IField): boolean;
 
 /**
  * Checks whether the given field has a valid date type.
@@ -95,7 +122,25 @@ export function isNumericField(field: IField): boolean;
  * @param field
  * @internal
  */
-export function isDateField(field: IField): boolean;
+export function isDateField(field?: IField): boolean;
+
+/**
+ * Checks whether the given field has a valid string type.
+ * Fields descriptions are [here](http://resources.esri.com/help/9.3/ArcGISEngine/ArcObjects/esriGeoDatabase/esriFieldType.htm).
+ *
+ * @param field
+ * @internal
+ */
+export function isStringField(field?: IField): boolean;
+
+/**
+ * Checks whether the given field has a valid time only type.
+ * Fields descriptions are [here](http://resources.esri.com/help/9.3/ArcGISEngine/ArcObjects/esriGeoDatabase/esriFieldType.htm).
+ *
+ * @param field
+ * @internal
+ */
+export function isTimeOnlyField(field?: IField): boolean;
 
 /**
  * Checks whether the given field has a valid integer type.
@@ -104,7 +149,7 @@ export function isDateField(field: IField): boolean;
  * @param field
  * @internal
  */
-export function isIntegerField(field: IField): boolean;
+export function isIntegerField(field?: IField): boolean;
 
 /**
  * Returns list of date field names from an array of fields of type IField
@@ -123,43 +168,32 @@ export function getLayerDateFields(fieldsInfo: IField[]): string[];
 export function getLayerNumericFields(fieldsInfo: IField[]): string[];
 
 /**
- * Retrieve the subtype name from the subtype id, if available.
- * Otherwise, just simply returns the original value.
+ * Get the coded value domain associated to the given field, if any.
+ * The RangeDomain is currently not supported.
  *
- * @param props - The subtypeInfo which consists of a typeIdField and a list of subtypes.
- * @returns The matching subtype name if it's a subtype field; otherwise undefined.
- * //TODO: may need to revise regrading the typeIdField property (See https://devtopia.esri.com/WebGIS/arcgis-js-api/issues/42555)
+ * @param queryObject - The query object (layer or feature layer view)
+ * @param field - The field to retrieve the domain from
  * @internal
  */
-export function getSubtypeName(props: {
-    subtypeInfo?: SubtypeInfo;
-    fieldName: string;
-    fieldValueToMatch: number | string;
-}): string | undefined;
+export function getFieldCodedValueDomain(queryObject: QueryObject, field?: string): CodedValueDomain | undefined;
 
 /**
- * Retrieve subtype information from the query object.
+ * Get the field description from the domain given a field value.
  *
- * @param queryObject - The query object from which to retrieve the feature layer.
- * @returns subtype info like typeIdField and the subtypes, if defined; otherwise undefined.
- * //TODO: may need to revise regrading the typeIdField property (See https://devtopia.esri.com/WebGIS/arcgis-js-api/issues/42555)
- * @internal
+ * @param fieldValue - The field value to get the description for
+ * @param domain - The domain of the field
  */
-export function getLayerSubtypeInfo(queryObject: QueryObject): SubtypeInfo | undefined;
+export function getFieldDescriptionFromDomain(fieldValue: number | string, domain?: CodedValueDomain): string | undefined;
 
 /**
- * Get the field description if the field contains subtype or domain value.
- * This field description is mainly for displaying purpose (while its id is used in queries).
+ * Get the field description from the query object given a field name and a field value.
  *
- * @param props - the name of the field
- * @returns The field description if available; otherwise undefined.
- * @internal
+ * @param props - The query object (layer or feature layer view)
  */
-export function getFieldDescription(props: {
-    fieldName: string;
-    fieldValueToMatch: number | string;
-    subtypeInfo?: SubtypeInfo;
-    fieldList?: IField[];
+export function getFieldDescriptionFromQueryObject(props: {
+    queryObject: QueryObjectOrRaster;
+    fieldName?: string;
+    fieldValue: number | string;
 }): string | undefined;
 
 /**
@@ -168,7 +202,7 @@ export function getFieldDescription(props: {
  * @param layer
  * @internal
  */
-export function getRendererFieldNames(layer: SupportedLayer): Promise<string[]>;
+export function getRendererFieldNames(layer: SupportedLayer | undefined): Promise<string[]>;
 
 /**
  * Returns a boolean to indicate if the feature layer is on standard feature data store or not.
@@ -177,7 +211,7 @@ export function getRendererFieldNames(layer: SupportedLayer): Promise<string[]>;
  * @param layer
  * @internal
  */
-export function isStandardLayer(layer: SupportedLayer): Promise<boolean>;
+export function isStandardLayer(layer: SupportedLayer | undefined): Promise<boolean>;
 
 /**
  * Finds the matching field name for a given layer based on the fieldToMatch parameter.
@@ -186,10 +220,10 @@ export function isStandardLayer(layer: SupportedLayer): Promise<boolean>;
  * @internal
  */
 export function findMatchingLayerFieldName(props: {
-    queryObject: QueryObject;
+    queryObject: QueryObjectOrRaster;
     fieldToMatch: string;
     returnUndefinedIfNotFound?: boolean;
-}): Promise<string>;
+}): string;
 
 /**
  * Find the matching field in a list of fields based on the fieldToMatch parameter.
@@ -217,9 +251,9 @@ export function findMatchingField(layerFieldList: IField[], fieldToMatch: string
  */
 export function matchFieldsList(props: {
     fieldsList: string[] | undefined;
-    queryObject: SupportedLayer;
+    queryObject: SupportedLayer | SupportedRasterLayer;
     returnUndefinedIfNotFound?: boolean;
-}): Promise<string[] | undefined>;
+}): string[] | undefined;
 
 /**
  * Builds a WebChartQuery based on information coming from the runtime filters (chart options), the config and the data source.
@@ -230,10 +264,11 @@ export function matchFieldsList(props: {
  * @internal
  */
 export function buildQueryConfig(props: {
-    queryObject?: QueryObject;
+    queryObject?: QueryObjectOrRaster;
     chartConfig: WebChart;
     runtimeDataFilters?: WebChartDataFilters;
     ignoreViewExtent?: boolean;
+    viewExtent?: Extent;
 }): WebChartQuery;
 
 /**

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

@@ -1,13 +1,13 @@
-import type FeatureLayer from "@arcgis/core/layers/FeatureLayer";
+import type FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
 import type { WebChartConfigFields } from "./interfaces.js";
 import type { IFeatureLayer } from "../../../spec/rest-js-types.js";
 import type { WebChartDataTypes } from "../../../spec/data-source.js";
 import type { WebChart } from "../../../spec/web-chart.js";
 
 /**
- * Creates a chart renderer based on the provided config fields and inline data
+ * Creates a chart renderer based on the provided config fields and inline data.
  *
- * @param props - The category field
+ * @param props - The category field, the numeric fields, the config fields and the data to convert.
  */
 export function convertConfigFieldsToChartRenderer(props: {
     categoryField: string;
@@ -17,9 +17,9 @@ export function convertConfigFieldsToChartRenderer(props: {
 }): WebChart["chartRenderer"];
 
 /**
- * Converts an array of inline data to a feature set and returns an IFeatureLayer
+ * Converts an array of inline data to a feature set and returns an `IFeatureLayer`.
  *
- * @param props - The category field
+ * @param props - The category field, the category type, the numeric fields and the inline data to convert.
  */
 export function convertInlineDataToLayerDefinition(props: {
     categoryField: string;
@@ -29,10 +29,9 @@ export function convertInlineDataToLayerDefinition(props: {
 }): IFeatureLayer | undefined;
 
 /**
- * Converts an array of inline data into a feature collection.
- * Also returns a chartRenderer if the configFields are provided.
+ * Converts an array of inline data into a feature collection. Also returns a `chartRenderer` if the `configFields` are provided.
  *
- * @param props - The category field
+ * @param props - The category field, the category type, the numeric fields, the config fields and the inline data to convert.
  */
 export function convertInlineConfigToLayerConfig(props: {
     categoryField: string;

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

@@ -1,17 +1,17 @@
-import type MapView from "@arcgis/core/views/MapView";
-import type SceneView from "@arcgis/core/views/SceneView";
-import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView";
-import type { SupportedLayer } from "../../interfaces.js";
-import type { WebChart } from "../../spec/web-chart.js";
+import type MapView from "@arcgis/core/views/MapView.js";
+import type SceneView from "@arcgis/core/views/SceneView.js";
+import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView.js";
+import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
 import type { RESTRendererType } from "../../spec/rest-js-object-literals.js";
-import type { ICodedValue } from "../../spec/rest-js-types.js";
+import type { WebChart } from "../../spec/web-chart.js";
 
 /** @internal */
 export interface QueryObjectProps {
-  chartConfig: WebChart;
-  layer?: FeatureLayerView | SupportedLayer;
+  chartConfig?: WebChart;
+  layer?: QueryObjectOrRaster;
   view?: MapView | SceneView;
   filterByExtent?: boolean;
+  abortSignal?: AbortSignal;
 }
 
 /** @internal */
@@ -33,41 +33,6 @@ export interface ServerRestInfo {
   };
 }
 
-/**
- * Store information about coded-value domains in the subtype
- *
- * @internal
- */
-export interface ICodedValueDomain {
-  fieldName: string;
-  name: string;
-  codedValues?: ICodedValue[];
-}
-
-/**
- * Store information about featureType
- *
- * @internal
- */
-export interface IFeatureType {
-  id: number | string;
-  name: string;
-  domains?: ICodedValueDomain[];
-}
-
-/**
- * Store information about subtypes from the feature layer, if any, with:
- * - either the couple typeIdField + types
- * - or the couple subtypeField + subtypes
- *  representing the field name and information associating a code with a name
- *
- * @internal
- */
-export interface SubtypeInfo {
-  typeIdField?: string;
-  types?: IFeatureType[];
-  subtypeField?: string;
-  subtypes?: IFeatureType[];
-}
+export type QueryObject = FeatureLayerView | SupportedLayer;
 
-export type QueryObject = FeatureLayerView | SupportedLayer | undefined;
+export type QueryObjectOrRaster = QueryObject | SupportedRasterLayer;

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

@@ -6,6 +6,7 @@ import type { QueryObject } from "../interfaces.js";
 import type { AbortControllerKeyType, Features } from "./interfaces.js";
 import type { WebChartQuery, WebChartTemporalBinning, WebHeatChart } from "../../../spec/web-chart.js";
 import type { WebChartDataItem } from "../../../spec/data-source.js";
+import type { ChartOptions } from "../../../chart-rendering/common/interfaces.js";
 
 /**
  * Performs a query analytic.
@@ -44,6 +45,7 @@ export function queryAttributeBinsForHeatChart(props: {
     chartConfig: WebHeatChart;
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
+    options?: ChartOptions;
     errorStrings: ErrorStrings;
 }): Promise<AttributeBinsFeatureSet | undefined>;
 
@@ -112,7 +114,7 @@ export function queryStatistics<T extends Date | number | string>(props: {
  * @internal
  */
 export function queryFeatures(props: {
-    queryObject?: QueryObject;
+    queryObject: QueryObject;
     queryConfig?: WebChartQuery;
     returnUniqueIdsOnly?: boolean;
     abortKey?: AbortControllerKeyType;
@@ -126,7 +128,7 @@ export function queryFeatures(props: {
  * @internal
  */
 export function queryAllFeatures(props: {
-    queryObject?: QueryObject;
+    queryObject: QueryObject;
     queryConfig?: WebChartQuery;
     returnUniqueIdsOnly?: boolean;
     featureCount?: number;
@@ -141,7 +143,7 @@ export function queryAllFeatures(props: {
  * @internal
  */
 export function queryUniqueIDs(props: {
-    queryObject?: QueryObject;
+    queryObject: QueryObject;
     queryConfig: WebChartQuery;
     uniqueFeature?: boolean;
     abortKey?: AbortControllerKeyType;
@@ -174,7 +176,7 @@ export function getQueryAttributeBinsForTemporalDataAliases(x: string): {
  * @internal
  */
 export function queryAttributeBinsForTemporalData(props: {
-    queryObject?: QueryObject;
+    queryObject: QueryObject;
     queryConfig: WebChartQuery;
     temporalBinning?: WebChartTemporalBinning;
     dateField: string;

package/dist/utils/layer/query-features/interfaces.d.ts

@@ -1,4 +1,4 @@
-import type Graphic from "@arcgis/core/Graphic";
+import type Graphic from "@arcgis/core/Graphic.js";
 
 /** @internal */
 export type AbortControllerKeyType = Date | number | string;

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

@@ -1,4 +1,4 @@
-import type Geometry from "@arcgis/core/geometry/Geometry";
+import type Geometry from "@arcgis/core/geometry/Geometry.js";
 import type FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
 import type SubtypeSublayer from "@arcgis/core/layers/support/SubtypeSublayer.js";
 import type AttributeBinsQuery from "@arcgis/core/rest/support/AttributeBinsQuery.js";
@@ -7,7 +7,8 @@ import type TimeExtent from "@arcgis/core/time/TimeExtent.js";
 import type { QueryProperties } from "@arcgis/core/rest/support/Query.js";
 import type { RESTFieldType } from "../../../spec/rest-js-object-literals.js";
 import type { WebChartHeatChartSeries, WebChartQuery, WebChartTemporalBinning } from "../../../spec/web-chart.js";
-import type { QueryObject } from "../interfaces.js";
+import type { QueryObject, QueryObjectOrRaster } from "../interfaces.js";
+import type { ChartOptions } from "../../../chart-rendering/common/interfaces.js";
 
 /**
  * Indicates whether a query can be cached. It is not when:
@@ -19,7 +20,10 @@ import type { QueryObject } from "../interfaces.js";
  */
 export function isQueryCacheable(query: AttributeBinsQuery | Query | QueryProperties): boolean;
 
-/** @param layer */
+/**
+ * @param layer
+ * @internal
+ */
 export function getMaxRecords(layer?: Pick<FeatureLayer, "sourceJSON"> | SubtypeSublayer): number;
 
 /**
@@ -38,7 +42,7 @@ export function combineFilters(filterList: (string | null | undefined)[], operan
  * @param defaultTimeExtent - The time extent defined at the series config level or provided at runtime
  * @internal
  */
-export function getQueryTimeExtent(queryObject: QueryObject, defaultTimeExtent?: WebChartQuery["timeExtent"]): WebChartQuery["timeExtent"] | undefined;
+export function getQueryTimeExtent(queryObject?: QueryObjectOrRaster, defaultTimeExtent?: WebChartQuery["timeExtent"]): WebChartQuery["timeExtent"] | undefined;
 
 /**
  * Computes the extent to be used by the query. We prioritize the feature layer view extent
@@ -48,7 +52,7 @@ export function getQueryTimeExtent(queryObject: QueryObject, defaultTimeExtent?:
  * @internal
  */
 export function getQueryGeometry(props: {
-    queryObject: QueryObject;
+    queryObject?: QueryObject;
     defaultGeometry?: WebChartQuery["geometry"];
     ignoreViewExtent?: boolean;
 }): WebChartQuery["geometry"] | undefined;
@@ -76,12 +80,12 @@ export function mapQueryGeometry(geometryConfig?: WebChartQuery["geometry"]): Ge
  * @internal
  */
 export function mapAttributeBinsQueryForTemporalData(props: {
-    queryObject?: QueryObject;
+    queryObject: QueryObject;
     queryConfig?: WebChartQuery;
     temporalBinning: WebChartTemporalBinning;
     dateField: string;
     splitByField?: string;
-}): Promise<AttributeBinsQuery>;
+}): AttributeBinsQuery;
 
 /**
  * Builds a SQL expression as well as the start and end values necessary for the calendar date parts binning.
@@ -111,16 +115,17 @@ export function getCalendarDatePartsParameters(props: {
  * @internal
  */
 export function mapAttributeBinsQueryForHeatChart(props: {
-    queryObject?: QueryObject;
+    queryObject: QueryObject;
     queryConfig?: WebChartQuery;
     x: string;
     y: string;
     xTemporalBinning?: WebChartHeatChartSeries["xTemporalBinning"];
     yTemporalBinning?: WebChartHeatChartSeries["yTemporalBinning"];
     firstDayOfWeek?: number;
-    outTimeZone?: string;
+    configTimeZone?: string;
     includeLeapDay?: boolean;
-}): Promise<AttributeBinsQuery>;
+    options?: ChartOptions;
+}): AttributeBinsQuery;
 
 /**
  * Maps properties from a WebChartQuery and properties specific to temporal binning into an AttributeBinsQuery object.
@@ -129,7 +134,7 @@ export function mapAttributeBinsQueryForHeatChart(props: {
  * @internal
  */
 export function mapAttributeBinsQueryForScatterplot(props: {
-    queryObject?: QueryObject;
+    queryObject: QueryObject;
     queryConfig?: WebChartQuery;
     xStep: number;
     yStep: number;
@@ -146,7 +151,7 @@ export function mapAttributeBinsQueryForScatterplot(props: {
  * @internal
  */
 export function mapQuery(props: {
-    queryObject?: QueryObject;
+    queryObject: QueryObject;
     queryConfig?: WebChartQuery;
     maxRecordCountFactor?: number;
 }): Query;