@arcgis/charts-components 5.0.0-next.149 → 5.0.0-next.150

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

@@ -1,6 +1,8 @@
 /**
  * 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/interfaces.d.ts

@@ -6,6 +6,7 @@ import type { WebChart } from "../../spec/web-chart.js";
 import type { RESTRendererType } from "../../spec/rest-js-object-literals.js";
 import type { ICodedValue } from "../../spec/rest-js-types.js";
 
+/** @internal */
 export interface QueryObjectProps {
   chartConfig: WebChart;
   layer?: FeatureLayerView | SupportedLayer;
@@ -13,12 +14,14 @@ export interface QueryObjectProps {
   filterByExtent?: boolean;
 }
 
+/** @internal */
 export interface RendererInfo {
   rendererType?: RESTRendererType;
   rendererField?: string;
   rendererNormalizationField?: string;
 }
 
+/** @internal */
 export interface ServerRestInfo {
   currentVersion?: string;
   fullVersion?: string;
@@ -30,14 +33,22 @@ export interface ServerRestInfo {
   };
 }
 
-/** Store information about coded-value domains in the subtype */
+/**
+ * Store information about coded-value domains in the subtype
+ *
+ * @internal
+ */
 export interface ICodedValueDomain {
   fieldName: string;
   name: string;
   codedValues?: ICodedValue[];
 }
 
-/** Store information about featureType */
+/**
+ * Store information about featureType
+ *
+ * @internal
+ */
 export interface IFeatureType {
   id: number | string;
   name: string;
@@ -49,6 +60,8 @@ export interface IFeatureType {
  * - 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;

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

@@ -11,6 +11,7 @@ import type { WebChartDataItem } from "../../../spec/data-source.js";
  * Performs a query analytic.
  *
  * @param props - The object used to query (FL or FLV)
+ * @internal
  */
 export function queryAnalytic(props: {
     queryObject: QueryObject;
@@ -25,6 +26,7 @@ export function queryAnalytic(props: {
  *
  * @param x - The x field used for the stack alias
  * @param y - The y field used by the stacks
+ * @internal
  */
 export function getQueryAttributeBinsForScatterplotFieldsAlias(x: string, y: string): {
     lowerBoundaryAlias: string;
@@ -36,6 +38,7 @@ export function getQueryAttributeBinsForScatterplotFieldsAlias(x: string, y: str
  * Fetches and returns the heat chart data using query(Attribute)Bins
  *
  * @param props - The chart configuration
+ * @internal
  */
 export function queryAttributeBinsForHeatChart(props: {
     chartConfig: WebHeatChart;
@@ -48,6 +51,7 @@ export function queryAttributeBinsForHeatChart(props: {
  * Query the features for the matrix heat chart.
  *
  * @param props - The chart configuration
+ * @internal
  */
 export function queryFeaturesForMatrixHeatChart(props: {
     chartConfig: WebHeatChart;
@@ -62,6 +66,7 @@ export function queryFeaturesForMatrixHeatChart(props: {
  * Uses query(Attribute)Bins to fetch the aggregated scatterplot data
  *
  * @param props - The object used to query (FL or FLV)
+ * @internal
  */
 export function queryAttributeBinsForScatterplot(props: {
     queryObject: QueryObject;
@@ -79,6 +84,7 @@ export function queryAttributeBinsForScatterplot(props: {
  * Performs a query feature count based on the provided parameters.
  *
  * @param props - The object used to query (FL or FLV)
+ * @internal
  */
 export function queryFeatureCount(props: {
     queryObject: QueryObject;
@@ -93,6 +99,7 @@ export function queryFeatureCount(props: {
  * Returns an object mapping the outStatisticFieldName with its value
  *
  * @param props - The object used to query (FL or FLV)
+ * @internal
  */
 export function queryStatistics<T extends Date | number | string>(props: {
     queryObject: QueryObject;
@@ -100,11 +107,23 @@ export function queryStatistics<T extends Date | number | string>(props: {
     abortKey?: AbortControllerKeyType;
 }): Promise<Map<string, T>>;
 
+/**
+ * @param props
+ * @internal
+ */
+export function queryFeatures(props: {
+    queryObject?: QueryObject;
+    queryConfig?: WebChartQuery;
+    returnUniqueIdsOnly?: boolean;
+    abortKey?: AbortControllerKeyType;
+}): Promise<Features>;
+
 /**
  * Fetches all the features from the input QueryObject, according to the other specified input settings (query, outFields...).
  * Handles the paging.
  *
  * @param props - The object used to query (FL or FLV)
+ * @internal
  */
 export function queryAllFeatures(props: {
     queryObject?: QueryObject;
@@ -119,6 +138,7 @@ export function queryAllFeatures(props: {
  * Fetches the extent of all the features that are represented by their object ids
  *
  * @param props - The object used to query (FL or FLV)
+ * @internal
  */
 export function queryUniqueIDs(props: {
     queryObject?: QueryObject;
@@ -132,10 +152,14 @@ export function queryUniqueIDs(props: {
  * to a unique key to avoid cancelling queries for other charts.
  *
  * @param key - The key pointing to the abort controller to execute
+ * @internal
  */
 export function abortPendingQueries(key?: AbortControllerKeyType): void;
 
-/** @param x */
+/**
+ * @param x
+ * @internal
+ */
 export function getQueryAttributeBinsForTemporalDataAliases(x: string): {
     lowerBoundaryAlias: string;
     upperBoundaryAlias: string;
@@ -147,6 +171,7 @@ export function getQueryAttributeBinsForTemporalDataAliases(x: string): {
  * TODO: support for abortKey input parameter
  *
  * @param props - The object used to query (FL or FLV)
+ * @internal
  */
 export function queryAttributeBinsForTemporalData(props: {
     queryObject?: QueryObject;

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

@@ -1,7 +1,10 @@
 import type Graphic from "@arcgis/core/Graphic";
 
+/** @internal */
 export type AbortControllerKeyType = Date | number | string;
 
+/** @internal */
 export const abortControllerMap: Map<AbortControllerKeyType, AbortController>;
 
+/** @internal */
 export type Features = (number | string)[] | Graphic[];

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

@@ -15,6 +15,7 @@ import type { QueryObject } from "../interfaces.js";
  * - a date filter is set
  *
  * @param query - The query object or query parameters
+ * @internal
  */
 export function isQueryCacheable(query: AttributeBinsQuery | Query | QueryProperties): boolean;
 
@@ -26,6 +27,7 @@ export function getMaxRecords(layer?: Pick<FeatureLayer, "sourceJSON"> | Subtype
  *
  * @param filterList - The list of filters to combine
  * @param operand - The operand to use to combine the filters (OR, AND...)
+ * @internal
  */
 export function combineFilters(filterList: (string | null | undefined)[], operand?: string): string;
 
@@ -34,6 +36,7 @@ export function combineFilters(filterList: (string | null | undefined)[], operan
  *
  * @param queryObject - 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: QueryObject, defaultTimeExtent?: WebChartQuery["timeExtent"]): WebChartQuery["timeExtent"] | undefined;
 
@@ -42,6 +45,7 @@ export function getQueryTimeExtent(queryObject: QueryObject, defaultTimeExtent?:
  * over the series config extent, unless `ignoreViewExtent` is set to true.
  *
  * @param props - The layer or feature layer view
+ * @internal
  */
 export function getQueryGeometry(props: {
     queryObject: QueryObject;
@@ -53,6 +57,7 @@ export function getQueryGeometry(props: {
  * Transforms a [timestamp, timestamp] to a JSAPI TimeExtent object
  *
  * @param timeExtentConfig - The time extent filter from the config
+ * @internal
  */
 export function mapQueryTimeExtent(timeExtentConfig?: WebChartQuery["timeExtent"]): TimeExtent | undefined;
 
@@ -60,6 +65,7 @@ export function mapQueryTimeExtent(timeExtentConfig?: WebChartQuery["timeExtent"
  * Transforms a IGeometry to a JSAPI Geometry
  *
  * @param geometryConfig - The geometry from the config
+ * @internal
  */
 export function mapQueryGeometry(geometryConfig?: WebChartQuery["geometry"]): Geometry | null | undefined;
 
@@ -67,6 +73,7 @@ export function mapQueryGeometry(geometryConfig?: WebChartQuery["geometry"]): Ge
  * Maps properties from a WebChartQuery and properties specific to temporal binning into an AttributeBinsQuery object.
  *
  * @param props - The layer or feature layer view
+ * @internal
  */
 export function mapAttributeBinsQueryForTemporalData(props: {
     queryObject?: QueryObject;
@@ -80,6 +87,7 @@ export function mapAttributeBinsQueryForTemporalData(props: {
  * Builds a SQL expression as well as the start and end values necessary for the calendar date parts binning.
  *
  * @param props - The field used by the heat chart
+ * @internal
  */
 export function getCalendarDatePartsParameters(props: {
     field: string;
@@ -100,6 +108,7 @@ export function getCalendarDatePartsParameters(props: {
  * Maps properties from a WebChartQuery and properties specific to heat chart into an AttributeBinsQuery object.
  *
  * @param props - The layer or feature layer view
+ * @internal
  */
 export function mapAttributeBinsQueryForHeatChart(props: {
     queryObject?: QueryObject;
@@ -117,6 +126,7 @@ export function mapAttributeBinsQueryForHeatChart(props: {
  * Maps properties from a WebChartQuery and properties specific to temporal binning into an AttributeBinsQuery object.
  *
  * @param props - The layer or feature layer view
+ * @internal
  */
 export function mapAttributeBinsQueryForScatterplot(props: {
     queryObject?: QueryObject;
@@ -133,6 +143,7 @@ export function mapAttributeBinsQueryForScatterplot(props: {
  * Maps properties from a WebChartQuery into a Query object.
  *
  * @param props - The layer or feature layer view
+ * @internal
  */
 export function mapQuery(props: {
     queryObject?: QueryObject;
@@ -140,5 +151,8 @@ export function mapQuery(props: {
     maxRecordCountFactor?: number;
 }): Query;
 
-/** @param layer */
+/**
+ * @param layer
+ * @internal
+ */
 export function getMaxRecordCountFactor(layer?: Pick<FeatureLayer, "sourceJSON"> | SubtypeSublayer): number | undefined;

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

@@ -10,6 +10,7 @@ import type { WebChart } from "../../../spec/web-chart.js";
  * Indicates whether the input object is a feature collection.
  *
  * @param queryObject
+ * @internal
  */
 export function isFeatureCollectionLayer(queryObject: QueryObject): queryObject is FeatureLayerView;
 
@@ -17,6 +18,7 @@ export function isFeatureCollectionLayer(queryObject: QueryObject): queryObject
  * Indicates whether the input object is an instance of `FeatureLayerView`.
  *
  * @param queryObject
+ * @internal
  */
 export function isFeatureLayerView(queryObject: QueryObject | SubtypeGroupLayer): queryObject is FeatureLayerView;
 
@@ -24,6 +26,7 @@ export function isFeatureLayerView(queryObject: QueryObject | SubtypeGroupLayer)
  * Indicates whether the input object is an instance of `FeatureLayer`.
  *
  * @param queryObject
+ * @internal
  */
 export function isFeatureLayer(queryObject: QueryObject): queryObject is FeatureLayer;
 
@@ -31,6 +34,7 @@ export function isFeatureLayer(queryObject: QueryObject): queryObject is Feature
  * Indicates whether the input object is an instance of `SubtypeGroupLayer`.
  *
  * @param queryObject
+ * @internal
  */
 export function isSubtypeGroupLayer(queryObject: QueryObject | SubtypeGroupLayer): queryObject is SubtypeGroupLayer;
 
@@ -38,6 +42,7 @@ export function isSubtypeGroupLayer(queryObject: QueryObject | SubtypeGroupLayer
  * Indicates whether the input object is an instance of `SubtypeSublayer`.
  *
  * @param queryObject
+ * @internal
  */
 export function isSubtypeSublayer(queryObject: Pick<SubtypeSublayer, "type"> | QueryObject): queryObject is SubtypeSublayer;
 
@@ -45,6 +50,7 @@ export function isSubtypeSublayer(queryObject: Pick<SubtypeSublayer, "type"> | Q
  * Indicates whether the input object is an instance of `SupportedLayer` (`FeatureLayer` or `SubtypeSublayer`).
  *
  * @param queryObject
+ * @internal
  */
 export function isSupportedLayer(queryObject: QueryObject): queryObject is SupportedLayer;
 
@@ -54,6 +60,7 @@ export function isSupportedLayer(queryObject: QueryObject): queryObject is Suppo
  * Only needed for the case where the layer is a `SubtypeSublayer`, in which case we use the parent layer which is a `SubtypeGroupLayer`.
  *
  * @param layer
+ * @internal
  */
 export function getMainLayer(layer: FeatureLayer | Pick<SubtypeSublayer, "parent" | "type">): FeatureLayer | SubtypeGroupLayer;
 
@@ -68,6 +75,7 @@ export function getMainLayer(layer: FeatureLayer | Pick<SubtypeSublayer, "parent
  *
  * @param layer - The layer to test
  * @returns A boolean
+ * @internal
  */
 export function doesLayerSupportQueryWithDistance(layer: SupportedLayer): boolean;
 
@@ -77,6 +85,7 @@ export function doesLayerSupportQueryWithDistance(layer: SupportedLayer): boolea
  * @param layer - The layer to test
  * @param queryObject
  * @returns A boolean indicating whether the operation is supported
+ * @internal
  */
 export function doesLayerSupportsQueryBinsForHeatChart(layer: SupportedLayer, queryObject: QueryObject): boolean;
 
@@ -88,6 +97,7 @@ export function doesLayerSupportsQueryBinsForHeatChart(layer: SupportedLayer, qu
  * @param layer - The layer to test
  * @param splitByField - The split-by field
  * @returns A boolean indicating whether the operation is supported
+ * @internal
  */
 export function doesLayerSupportsQueryBinsForTemporalData(layer?: FeatureLayerView | SubtypeGroupLayer | SupportedLayer, splitByField?: string): boolean;
 
@@ -95,6 +105,7 @@ export function doesLayerSupportsQueryBinsForTemporalData(layer?: FeatureLayerVi
  * Indicates whether the layer supports the cacheHint parameter for the queryBins operation
  *
  * @param queryObject - The layer or feature layer view
+ * @internal
  */
 export function doesLayerSupportsCacheHintForQueryBins(queryObject: QueryObject): boolean;
 
@@ -105,6 +116,7 @@ export function doesLayerSupportsCacheHintForQueryBins(queryObject: QueryObject)
  * - statistics: supports MAX and COUNT
  *
  * @param queryObject - The layer or feature layer view
+ * @internal
  */
 export function doesLayerSupportsQueryBinsForScatterplot(queryObject: QueryObject): boolean;
 
@@ -113,6 +125,7 @@ export function doesLayerSupportsQueryBinsForScatterplot(queryObject: QueryObjec
  * It will use the QueryObject itself if it's a Feature Layer, or the `layer` property from it if it's a Feature Layer View.
  *
  * @param layerOrLayerView
+ * @internal
  */
 export function getLayerFromLayerOrLayerView(layerOrLayerView: FeatureLayerView | SupportedLayer): SupportedLayer;
 
@@ -121,6 +134,7 @@ export function getLayerFromLayerOrLayerView(layerOrLayerView: FeatureLayerView
  * It will use the QueryObject itself if it's a Feature Layer, or the `layer` property from it if it's a Feature Layer View.
  *
  * @param queryObject
+ * @internal
  */
 export function getLayerFromQueryObject(queryObject: QueryObject): SupportedLayer;
 
@@ -130,6 +144,7 @@ export function getLayerFromQueryObject(queryObject: QueryObject): SupportedLaye
  *
  * @param layer - The layer instance
  * @returns A sum up of the capabilities
+ * @internal
  */
 export function getLayerSpatialAggregationStatisticsCapabilities(layer: SupportedLayer): boolean;
 
@@ -139,6 +154,7 @@ export function getLayerSpatialAggregationStatisticsCapabilities(layer: Supporte
  *
  * @param props - The chart config with no iLayer
  * @returns The update chart config with a `iLayer` property
+ * @internal
  */
 export function addILayer<T extends WebChart>(props: {
     chartConfig: T;

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

@@ -5,6 +5,7 @@ import type { ErrorStrings, LocaleInfo, UtilsStrings, SupportedLocalesForFormats
  * Finds the locale info of the closest element to the given element.
  *
  * @param element - The element to get the locale info from.
+ * @internal
  */
 export function getLocaleInfo(element?: HTMLElement): LocaleInfo;
 
@@ -12,6 +13,7 @@ export function getLocaleInfo(element?: HTMLElement): LocaleInfo;
  * Converts the given `timeZone` from ArcGIS `MapView` to a valid time zone string.
  *
  * @param timeZone
+ * @internal
  */
 export function convertTimeZone(timeZone: MapView["timeZone"] | undefined): string | undefined;
 
@@ -20,6 +22,7 @@ export function convertTimeZone(timeZone: MapView["timeZone"] | undefined): stri
  *
  * @param date
  * @param timeZone
+ * @internal
  */
 export function getDateStringInCalciteDatePickerFormat(date: Date, timeZone: string): string;
 
@@ -28,6 +31,7 @@ export function getDateStringInCalciteDatePickerFormat(date: Date, timeZone: str
  *
  * @param date
  * @param timeZone
+ * @internal
  */
 export function getTimeStringInCalciteTimePickerFormat(date: Date, timeZone: string): string;
 
@@ -36,6 +40,7 @@ export function getTimeStringInCalciteTimePickerFormat(date: Date, timeZone: str
  *
  * @param localizedString - string that has to be parsed
  * @param locale - locale used for parsing the float
+ * @internal
  */
 export function localeParseFloat(localizedString: string, locale?: string): number;
 
@@ -43,17 +48,22 @@ export function localeParseFloat(localizedString: string, locale?: string): numb
  * Gets the format locale from the given element.
  *
  * @param element - HTMLElement to get the locale from
+ * @internal
  */
 export function getElementFormatLocale(element: HTMLElement): SupportedLocalesForFormats;
 
 /**
  * Returns a default `CommonStrings` t9n object.
  * This is used by the chart components unit tests and the charts-js Storybook demos.
+ *
+ * @internal
  */
 export function getDefaultErrorsStrings(): Promise<ErrorStrings>;
 
 /**
  * Returns a default `UtilsStrings` t9n object.
  * This is used by the chart components unit tests and the charts-js Storybook demos.
+ *
+ * @internal
  */
 export function getDefaultUtilsStrings(): Promise<UtilsStrings>;

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

@@ -8,17 +8,22 @@ export type UtilsStrings = ReturnType<typeof CommonStringsIdentity>["utilsString
 
 export type CustomAmchartsStrings = ReturnType<typeof CommonStringsIdentity>["customAmchartsStrings"];
 
+/** @internal */
 export type LocaleItem = { [key: string]: LocaleItem | string; };
 
+/** @internal */
 export interface ComponentLocaleItem<T extends LocaleItem> {
   strings: T;
   direction: "ltr" | "rtl";
 }
 
+/** @internal */
 export const SupportedLocalesForFormats: (("id" | "ar" | "bg" | "bs" | "ca" | "cs" | "da" | "de" | "el" | "en" | "es" | "et" | "fi" | "fr" | "he" | "hr" | "hu" | "it" | "ja" | "ko" | "lt" | "lv" | "nl" | "nb" | "no" | "pl" | "pt-BR" | "pt-PT" | "ro" | "ru" | "sk" | "sl" | "sr" | "sv" | "th" | "tr" | "uk" | "vi" | "zh-CN" | "zh-HK" | "zh-TW") | string | string | string | string | string | string | string | string | string | string | string)[];
 
+/** @internal */
 export type SupportedLocalesForFormats = SupportedLocale | "ar-u-nu-latn" | "de-AT" | "de-CH" | "de-DE" | "en-AU" | "en-GB" | "es-ES" | "es-MX" | "fr-CA" | "it-CH" | "it-IT";
 
+/** @internal */
 export interface LocaleInfo {
   locale: SupportedLocale;
   formatLocale: SupportedLocalesForFormats;
@@ -36,6 +41,8 @@ export const CommonStringsIdentity: (value: {
             scatterplot: string;
             boxPlot: string;
             heatChart: string;
+            calendarHeatChart: string;
+            matrixHeatChart: string;
         };
         statistics: {
             mean: string;
@@ -82,6 +89,7 @@ export const CommonStringsIdentity: (value: {
             weekOfYear: string;
             quarterOfYear: string;
         };
+        null: string;
     };
     errorStrings: {
         errorHeading: string;
@@ -288,6 +296,8 @@ export const CommonStringsIdentity: (value: {
             scatterplot: string;
             boxPlot: string;
             heatChart: string;
+            calendarHeatChart: string;
+            matrixHeatChart: string;
         };
         statistics: {
             mean: string;
@@ -334,6 +344,7 @@ export const CommonStringsIdentity: (value: {
             weekOfYear: string;
             quarterOfYear: string;
         };
+        null: string;
     };
     errorStrings: {
         errorHeading: string;