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

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

@@ -1,64 +1,39 @@
-import { Color, IFeatureLayer, WebChart, WebChartDataItemValue, WebChartDataTypes } from '../../../spec';
-import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer';
-import { WebChartConfigFields } from './interfaces';
+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";
+
 /**
- * Converts a hex color into a ESRI Color array ([number, number, number, number])
- * @param hex The hex code to convert
+ * 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.
  */
-declare function hexToRGB(hex: string): Color | undefined;
-/**
- * Converts an input value typed as WebChartDataItemValue into a Color.
- * Only values representing a hex code or an ESRI color will yield a result.
- * @param inputColor The input value to convert to a color
- */
-declare function convertColor(inputColor?: WebChartDataItemValue): Color | undefined;
-/**
- * Creates a chart renderer based on the provided config fields and inline data
- * @param props.categoryField The category field
- * @param props.numericFields The numeric fields
- * @param props.configFields The config fields
- * @param props.inlineData The data to convert
- */
-export declare function convertConfigFieldsToChartRenderer(props: {
+export function convertConfigFieldsToChartRenderer(props: {
     categoryField: string;
     numericFields: string[];
     configFields?: WebChartConfigFields;
     inlineData: WebChartDataTypes;
 }): WebChart["chartRenderer"];
+
 /**
- * Removes the config fields from the feature set to add to the feature collection
- * @param numericFields The list of numeric fields
- * @param configFields The config fields
- * @param inlineData The data to cure
- */
-declare function removeConfigFieldsFromData(props: {
-    numericFields: string[];
-    configFields: WebChartConfigFields;
-    inlineData: WebChartDataTypes;
-}): WebChartDataTypes;
-/**
- * Converts an array of inline data to a feature set and returns an IFeatureLayer
- * @param props.categoryField The category field
- * @param props.categoryType The category type
- * @param props.numericFields The numeric fields
- * @param props.inlineData The inline data to convert
+ * 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.
  */
-export declare function convertInlineDataToLayerDefinition(props: {
+export function convertInlineDataToLayerDefinition(props: {
     categoryField: string;
     categoryType: "date" | "dateOnly" | "number" | "string" | "timeStampOffset";
     numericFields: string[];
     inlineData: WebChartDataTypes;
 }): IFeatureLayer | undefined;
+
 /**
- * Converts an array of inline data into a feature collection.
- * Also returns a chartRenderer if the configFields are provided.
- * @param props.categoryField The category field
- * @param props.categoryType The category type
- * @param props.numericFields The numeric fields
- * @param props.configFields The config fields
- * @param props.inlineData The inline data
+ * 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.
  */
-export declare function convertInlineConfigToLayerConfig(props: {
+export function convertInlineConfigToLayerConfig(props: {
     categoryField: string;
     categoryType: "date" | "dateOnly" | "number" | "string" | "timeStampOffset";
     numericFields: string[];
@@ -68,10 +43,4 @@ export declare function convertInlineConfigToLayerConfig(props: {
     chartRenderer?: WebChart["chartRenderer"];
     iLayer?: IFeatureLayer;
     layer?: FeatureLayer;
-}>;
-export declare const inlineConversionPrivateFunctions: {
-    hexToRGB: typeof hexToRGB;
-    convertColor: typeof convertColor;
-    removeConfigFieldsFromData: typeof removeConfigFieldsFromData;
-};
-export {};
+}>;

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

@@ -1,19 +1,21 @@
 /**
  * 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;
-    fillOpacity?: string;
-    fillStyle?: string;
-    lineColor?: string;
-    lineOpacity?: string;
-    lineWidth?: string;
-    lineStyle?: string;
-    markerSize?: string;
-    outlineColor?: string;
-    outlineOpacity?: string;
-    outlineWidth?: string;
-    outlineStyle?: string;
-    displayLabel?: string;
-}
+  fillColor?: string;
+  fillOpacity?: string;
+  fillStyle?: string;
+  lineColor?: string;
+  lineOpacity?: string;
+  lineWidth?: string;
+  lineStyle?: string;
+  markerSize?: string;
+  outlineColor?: string;
+  outlineOpacity?: string;
+  outlineWidth?: string;
+  outlineStyle?: string;
+  displayLabel?: string;
+}

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

@@ -1,55 +1,73 @@
-import { RESTRendererType, WebChart, ICodedValue } from '../../spec';
-import { default as MapView } from '@arcgis/core/views/MapView';
-import { default as SceneView } from '@arcgis/core/views/SceneView';
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
-import { SupportedLayer } from '../../interfaces';
+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 } from "../../interfaces.js";
+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;
-    view?: MapView | SceneView;
-    filterByExtent?: boolean;
+  chartConfig: WebChart;
+  layer?: FeatureLayerView | SupportedLayer;
+  view?: MapView | SceneView;
+  filterByExtent?: boolean;
 }
+
+/** @internal */
 export interface RendererInfo {
-    rendererType?: RESTRendererType;
-    rendererField?: string;
-    rendererNormalizationField?: string;
+  rendererType?: RESTRendererType;
+  rendererField?: string;
+  rendererNormalizationField?: string;
 }
+
+/** @internal */
 export interface ServerRestInfo {
-    currentVersion?: string;
-    fullVersion?: string;
-    owningSystemUrl?: string;
-    owningTenant?: string;
-    authInfo?: {
-        isTokenBasedSecurity: boolean;
-        tokenServicesUrl: string;
-    };
+  currentVersion?: string;
+  fullVersion?: string;
+  owningSystemUrl?: string;
+  owningTenant?: string;
+  authInfo?: {
+      isTokenBasedSecurity: boolean;
+      tokenServicesUrl: string;
+  };
 }
+
 /**
  * Store information about coded-value domains in the subtype
+ *
+ * @internal
  */
 export interface ICodedValueDomain {
-    fieldName: string;
-    name: string;
-    codedValues?: ICodedValue[];
+  fieldName: string;
+  name: string;
+  codedValues?: ICodedValue[];
 }
+
 /**
  * Store information about featureType
+ *
+ * @internal
  */
 export interface IFeatureType {
-    id: number | string;
-    name: string;
-    domains?: ICodedValueDomain[];
+  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[];
+  typeIdField?: string;
+  types?: IFeatureType[];
+  subtypeField?: string;
+  subtypes?: IFeatureType[];
 }
-export type QueryObject = FeatureLayerView | SupportedLayer | undefined;
+
+export type QueryObject = FeatureLayerView | SupportedLayer | undefined;

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

@@ -1,58 +1,59 @@
-import { default as AttributeBinsGraphic } from '@arcgis/core/AttributeBinsGraphic.js';
-import { default as AttributeBinsFeatureSet } from '@arcgis/core/rest/support/AttributeBinsFeatureSet.js';
-import { WebChartDataItem, WebChartQuery, WebChartTemporalBinning, WebHeatChart } from '../../../spec';
-import { ErrorStrings } from '../../localization/interfaces';
-import { ChartSubType } from '../../misc/interfaces';
-import { QueryObject } from '../interfaces';
-import { AbortControllerKeyType, Features } from './interfaces';
+import type AttributeBinsGraphic from "@arcgis/core/AttributeBinsGraphic.js";
+import type AttributeBinsFeatureSet from "@arcgis/core/rest/support/AttributeBinsFeatureSet.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 { WebChartQuery, WebChartTemporalBinning, WebHeatChart } from "../../../spec/web-chart.js";
+import type { WebChartDataItem } from "../../../spec/data-source.js";
+
 /**
  * Performs a query analytic.
- * @param props.queryObject The object used to query (FL or FLV)
- * @param props.queryConfig The WebChartQuery
- * @param props.outAnalytics The out analytics
- * @param props.outputFormat The output format
- * @param props.dataFormat The data format
+ *
+ * @param props - The object used to query (FL or FLV)
+ * @internal
  */
-export declare function queryAnalytic(props: {
+export function queryAnalytic(props: {
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
     outAnalytics: string;
     outputFormat: string;
     dataFormat: string;
 }): Promise<WebChartDataItem | undefined>;
+
 /**
  * Generates the aliases to use in the queryAttributeBins query to name the stacks and boundaries for the x field
- * @param x The x field used for the stack alias
- * @param y The y field used by the stacks
+ *
+ * @param x - The x field used for the stack alias
+ * @param y - The y field used by the stacks
+ * @internal
  */
-export declare function getQueryAttributeBinsForScatterplotFieldsAlias(x: string, y: string): {
+export function getQueryAttributeBinsForScatterplotFieldsAlias(x: string, y: string): {
     lowerBoundaryAlias: string;
     upperBoundaryAlias: string;
     stackAlias: string;
 };
+
 /**
  * Fetches and returns the heat chart data using query(Attribute)Bins
- * @param props.chartConfig The chart configuration
- * @param props.queryObject The object used to query (FL or FLV)
- * @param props.queryConfig The query configuration
- * @param props.errorStrings The t9n error strings
+ *
+ * @param props - The chart configuration
+ * @internal
  */
-export declare function queryAttributeBinsForHeatChart(props: {
+export function queryAttributeBinsForHeatChart(props: {
     chartConfig: WebHeatChart;
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
     errorStrings: ErrorStrings;
 }): Promise<AttributeBinsFeatureSet | undefined>;
+
 /**
  * Query the features for the matrix heat chart.
- * @param props.chartConfig The chart configuration
- * @param props.queryObject The object used to query (FL or FLV)
- * @param props.queryConfig The query configuration
- * @param props.returnFeaturesExtent Whether to add an out statistic to fetch the features extent
- * @param props.errorStrings The t9n error strings
- * @param props.abortKey The key to abort the query
+ *
+ * @param props - The chart configuration
+ * @internal
  */
-export declare function queryFeaturesForMatrixHeatChart(props: {
+export function queryFeaturesForMatrixHeatChart(props: {
     chartConfig: WebHeatChart;
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
@@ -60,19 +61,14 @@ export declare function queryFeaturesForMatrixHeatChart(props: {
     errorStrings: ErrorStrings;
     abortKey?: AbortControllerKeyType;
 }): Promise<Features | undefined>;
+
 /**
  * Uses query(Attribute)Bins to fetch the aggregated scatterplot data
- * @param props.queryObject The object used to query (FL or FLV)
- * @param props.queryConfig The query configuration
- * @param props.xStep The x step
- * @param props.yStep The y step
- * @param props.xMin The x min
- * @param props.xMax The x max
- * @param props.x The x field
- * @param props.y The y field
- * @param props.errorStrings The t9n error strings
+ *
+ * @param props - The object used to query (FL or FLV)
+ * @internal
  */
-export declare function queryAttributeBinsForScatterplot(props: {
+export function queryAttributeBinsForScatterplot(props: {
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
     xStep: number;
@@ -83,44 +79,53 @@ export declare function queryAttributeBinsForScatterplot(props: {
     y: string;
     errorStrings: ErrorStrings;
 }): Promise<AttributeBinsFeatureSet | undefined>;
+
 /**
  * Performs a query feature count based on the provided parameters.
- * @param props.queryObject The object used to query (FL or FLV)
- * @param props.queryConfig The WebChartQuery containing parameters about the query to execute
- * @param props.chartSubType The chart sub type
- * @param props.x The x field
- * @param props.isGaugeByFeature Indicate whether it's a gauge by feature. Will be defaulted to `false` if not provided.
+ *
+ * @param props - The object used to query (FL or FLV)
+ * @internal
  */
-export declare function queryFeatureCount(props: {
+export function queryFeatureCount(props: {
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
     chartSubType: ChartSubType;
     x: string;
     isGaugeByFeature?: boolean;
 }): Promise<number | undefined>;
+
 /**
  * Fetches multiple statistics (min, max, count...).
  * Returns an object mapping the outStatisticFieldName with its value
- * @param props.queryObject The object used to query (FL or FLV)
- * @param props.queryConfig The WebChartQuery containing parameters about the query to execute
- * @param props.abortKey The key to abort the query
+ *
+ * @param props - The object used to query (FL or FLV)
+ * @internal
  */
-export declare function queryStatistics<T extends Date | number | string>(props: {
+export function queryStatistics<T extends Date | number | string>(props: {
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
     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.queryObject The object used to query (FL or FLV)
- * @param props.queryConfig The WebChartQuery containing parameters about the query to execute
- * @param props.returnUniqueIdsOnly If true, the function will return only the unique IDs of the features
- * @param props.featureCount The number of features to fetch
- * @param props.noBatch If true, the function will not use the batching mechanism
- * @param props.abortKey The key to abort the query
+ *
+ * @param props - The object used to query (FL or FLV)
+ * @internal
  */
-export declare function queryAllFeatures(props: {
+export function queryAllFeatures(props: {
     queryObject?: QueryObject;
     queryConfig?: WebChartQuery;
     returnUniqueIdsOnly?: boolean;
@@ -128,45 +133,51 @@ export declare function queryAllFeatures(props: {
     noBatch?: boolean;
     abortKey?: AbortControllerKeyType;
 }): Promise<Features>;
+
 /**
  * Fetches the extent of all the features that are represented by their object ids
- * @param props.queryObject The object used to query (FL or FLV)
- * @param props.queryConfig The WebChartQuery containing parameters about the query to execute
- * @param props.uniqueFeature Whether the query is made to fetch a unique feature
- * @param props.abortKey The key to abort the query
+ *
+ * @param props - The object used to query (FL or FLV)
+ * @internal
  */
-export declare function queryUniqueIDs(props: {
+export function queryUniqueIDs(props: {
     queryObject?: QueryObject;
     queryConfig: WebChartQuery;
     uniqueFeature?: boolean;
     abortKey?: AbortControllerKeyType;
 }): Promise<(number | string)[]>;
+
 /**
  * Aborts all existing queries and initializes a controller for new ones. The queries are associated
  * to a unique key to avoid cancelling queries for other charts.
- * @param key The key pointing to the abort controller to execute
+ *
+ * @param key - The key pointing to the abort controller to execute
+ * @internal
+ */
+export function abortPendingQueries(key?: AbortControllerKeyType): void;
+
+/**
+ * @param x
+ * @internal
  */
-export declare function abortPendingQueries(key?: AbortControllerKeyType): void;
-export declare function getQueryAttributeBinsForTemporalDataAliases(x: string): {
+export function getQueryAttributeBinsForTemporalDataAliases(x: string): {
     lowerBoundaryAlias: string;
     upperBoundaryAlias: string;
 };
+
 /**
  * Fetches binned temporal data using queryAttributeBins().
  * TODO: support for offset
  * TODO: support for abortKey input parameter
- * @param props.queryObject The object used to query (FL or FLV)
- * @param props.queryConfig The WebChartQuery containing parameters about the query to execute
- * @param props.temporalBinning The temporal binning configuration
- * @param props.dateField The date field to bin
- * @param props.splitByField The split-by field
- * @param props.abortKey The key to abort the query
+ *
+ * @param props - The object used to query (FL or FLV)
+ * @internal
  */
-export declare function queryAttributeBinsForTemporalData(props: {
+export function queryAttributeBinsForTemporalData(props: {
     queryObject?: QueryObject;
     queryConfig: WebChartQuery;
     temporalBinning?: WebChartTemporalBinning;
     dateField: string;
     splitByField?: string;
     abortKey?: AbortControllerKeyType;
-}): Promise<AttributeBinsGraphic[]>;
+}): Promise<AttributeBinsGraphic[]>;

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

@@ -1,4 +1,10 @@
-import { default as Graphic } from '@arcgis/core/Graphic';
+import type Graphic from "@arcgis/core/Graphic.js";
+
+/** @internal */
 export type AbortControllerKeyType = Date | number | string;
-export declare const abortControllerMap: Map<AbortControllerKeyType, AbortController>;
-export type Features = (number | string)[] | Graphic[];
+
+/** @internal */
+export const abortControllerMap: Map<AbortControllerKeyType, AbortController>;
+
+/** @internal */
+export type Features = (number | string)[] | Graphic[];