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

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

@@ -4,28 +4,40 @@ import type { CategoryFormatOptions, DateTimeFormatOptions, HistogramOverlays, N
 import type { CommonStrings } from "../localization/interfaces.js";
 import type { ChartElementLimit, ChartElementTechnicalLimit, ChartTextProps, QueryDefaults, TextElements } from "./interfaces.js";
 
+/** @internal */
 export const histogramBinCount: 32;
 
+/** @internal */
 export const featuresExtentField: "arcgis_charts_features_extent";
 
+/** @internal */
 export const queryDefaults: QueryDefaults;
 
+/** @internal */
 export const queryCalculatedExpr: (string | string | string | string)[];
 
+/** @internal */
 export const fullOpacity: 1;
 
+/** @internal */
 export const reducedOpacity: 0.7;
 
+/** @internal */
 export const defaultGridLineOpacity: 25;
 
+/** @internal */
 export const defaultAxisLineColor: Color;
 
+/** @internal */
 export const defaultPieTickColor: Color;
 
+/** @internal */
 export const defaultLineSymbolStyle: "esriSLSSolid";
 
+/** @internal */
 export const defaultLineSymbolWidth: 2;
 
+/** @internal */
 export const pieChartSpecialSlicesId: {
     defaultGroupOfSlicesId: string;
     sliceIdPrefix: string;
@@ -34,23 +46,33 @@ export const pieChartSpecialSlicesId: {
     emptySliceId: string;
 };
 
+/** @internal */
 export const defaultBoxPlotCategory: "arcgis_charts_box_plot_category";
 
+/** @internal */
 export const defaultHeatChartFields: {
     valueField: string;
     xField: string;
     yField: string;
 };
 
+/** @internal */
 export const defaultHeatChartNumberOfBreaks: {
     min: number;
     max: number;
 };
 
+/**
+ * default color set from Pro
+ *
+ * @internal
+ */
 export const ramp: Color[];
 
+/** @internal */
 export const darkModeRamp: Color[];
 
+/** @internal */
 export const darkModeOverlayRamp: Color[];
 
 /**
@@ -58,6 +80,7 @@ export const darkModeOverlayRamp: Color[];
  * we use modulo to get the corresponding color.
  *
  * @param props - The index to fetch the color from the `ramp` or `overlayRamp` array
+ * @internal
  */
 export function getOneRampColor(props: {
     colorIndex?: number;
@@ -65,13 +88,17 @@ export function getOneRampColor(props: {
     histogramOverlays?: boolean;
 }): Color;
 
-/** @param opacity */
+/**
+ * @param opacity
+ * @internal
+ */
 export function getDefaultColor(opacity?: number): Color;
 
 /**
  * Gets default cursor crosshair
  *
  * @returns default cursor crosshair
+ * @internal
  */
 export function getDefaultCursorCrosshair(): WebChartCursorCrosshair;
 
@@ -79,23 +106,34 @@ export function getDefaultCursorCrosshair(): WebChartCursorCrosshair;
  * random color with alpha 70% for authoring page.
  *
  * @param opacityPercentage - default is 1
+ * @internal
  */
 export function generateRandomRestColor(opacityPercentage?: number): Color;
 
-/** @param type */
+/**
+ * @param type
+ * @internal
+ */
 export function getDefaultFont(type?: TextElements): IFont;
 
 /**
  * @param text
  * @param font
  * @param type
+ * @internal
  */
 export function getDefaultTextSymbol(text?: string, font?: IFont, type?: TextElements): WebChartTextSymbol;
 
-/** @param props */
+/**
+ * @param props
+ * @internal
+ */
 export function getDefaultChartText(props?: ChartTextProps): WebChartText;
 
-/** @param props */
+/**
+ * @param props
+ * @internal
+ */
 export function getDefaultLineSymbol(props?: {
     color?: Color;
     useRandomColor?: boolean;
@@ -105,32 +143,49 @@ export function getDefaultLineSymbol(props?: {
     isHistogramOverlay?: boolean;
 }): ISimpleLineSymbol;
 
+/** @internal */
 export function getDefaultCategoryFormat(): CategoryFormatOptions;
 
+/** @internal */
 export function getDefaultDateFormat(): DateTimeFormatOptions;
 
+/** @internal */
 export function getDefaultNumberFormat(): NumberFormatOptions;
 
+/** @internal */
 export function getDefaultStatNumberFormat(): NumberFormatOptions;
 
+/** @internal */
 export function getDefaultPercentNumberFormat(): NumberFormatOptions;
 
-/** @param text */
+/**
+ * @param text
+ * @internal
+ */
 export function getDefaultValueAxis(text?: string): WebChartAxis;
 
+/** @internal */
 export function getDefaultLegend(): WebChartLegend;
 
-/** @param overlayIndex */
+/**
+ * @param overlayIndex
+ * @internal
+ */
 export function getDefaultOverlay(overlayIndex: number): WebChartOverlay;
 
+/** @internal */
 export function getDefaultBackground(): Color;
 
-/** @param commonStrings */
+/**
+ * @param commonStrings
+ * @internal
+ */
 export function getDefaultTitle(commonStrings: CommonStrings): string;
 
 /**
  * @param seriesIndex
  * @param useRandomColor
+ * @internal
  */
 export function getDefaultBoxPlotElementSymbol(seriesIndex: number | undefined, useRandomColor?: boolean): ISimpleFillSymbol;
 
@@ -138,6 +193,7 @@ export function getDefaultBoxPlotElementSymbol(seriesIndex: number | undefined,
  * Returns a default marker symbol for a line chart
  *
  * @param seriesIndex - The series index to pick a symbol color
+ * @internal
  */
 export function getDefaultLineChartMarkerSymbol(seriesIndex?: number): ISimpleMarkerSymbol;
 
@@ -145,23 +201,33 @@ export function getDefaultLineChartMarkerSymbol(seriesIndex?: number): ISimpleMa
  * Returns a default line symbol for a line chart
  *
  * @param seriesIndex - The series index to pick a symbol color
+ * @internal
  */
 export function getDefaultLineChartLineSymbol(seriesIndex?: number): ISimpleLineSymbol;
 
-/** @param useRandomColor */
+/**
+ * @param useRandomColor
+ * @internal
+ */
 export function getDefaultScatterplotMarkerSymbol(useRandomColor?: boolean): ISimpleMarkerSymbol;
 
+/** @internal */
 export function getDefaultScatterplotSizePolicy(): Required<SizePolicy>;
 
-/** @param useRandomColor */
+/**
+ * @param useRandomColor
+ * @internal
+ */
 export function getDefaultTrendLine(useRandomColor?: boolean): Required<ScatterplotOverlays>;
 
 /**
  * @param commonStrings
  * @param objectIDField
+ * @internal
  */
 export function getHeatChartSeries(commonStrings: CommonStrings, objectIDField?: string): WebChartHeatChartSeries;
 
+/** @internal */
 export function getScatterplotSeries(): WebChartScatterplotSeries;
 
 /**
@@ -169,16 +235,22 @@ export function getScatterplotSeries(): WebChartScatterplotSeries;
  *
  * @param commonStrings - The common strings used in the chart
  * @param chartType - The type of WebChart which is of type WebChartTypes
+ * @internal
  */
 export function getDefaultAxes(commonStrings: CommonStrings, chartType: WebChartTypes): WebChartAxis[];
 
-/** Returns the default gauge needle */
+/**
+ * Returns the default gauge needle
+ *
+ * @internal
+ */
 export function getDefaultGaugeNeedle(): WebChartNeedle;
 
 /**
  * Returns the gauge axes
  *
  * @param commonStrings
+ * @internal
  */
 export function getGaugeAxes(commonStrings: CommonStrings): WebChartGaugeAxis[];
 
@@ -186,6 +258,7 @@ export function getGaugeAxes(commonStrings: CommonStrings): WebChartGaugeAxis[];
  * Returns a default LineChartSeries object as per the WebChart Specification
  *
  * @param props
+ * @internal
  */
 export function getDefaultLineChartSeries(props: {
     commonStrings: CommonStrings;
@@ -197,6 +270,7 @@ export function getDefaultLineChartSeries(props: {
  * Returns a default RadarChartSeries object as per the WebChart Specification
  *
  * @param props
+ * @internal
  */
 export function getDefaultRadarChartSeries(props: {
     commonStrings: CommonStrings;
@@ -208,6 +282,7 @@ export function getDefaultRadarChartSeries(props: {
  * Returns a default symbol for a bar chart series
  *
  * @param seriesIndex - The series index to pick a symbol color
+ * @internal
  */
 export function getDefaultBarChartSeriesSymbol(seriesIndex?: number): ISimpleFillSymbol;
 
@@ -215,6 +290,7 @@ export function getDefaultBarChartSeriesSymbol(seriesIndex?: number): ISimpleFil
  * Returns a default BarChartSeries object as per the WebChart Specification
  *
  * @param props
+ * @internal
  */
 export function getDefaultBarChartSeries(props: {
     objectIDField?: string;
@@ -227,13 +303,22 @@ export function getDefaultBarChartSeries(props: {
  *
  * @param commonStrings
  * @param seriesIndex
+ * @internal
  */
 export function getDefaultBoxPlotSeries(commonStrings: CommonStrings, seriesIndex?: number): WebChartBoxPlotSeries;
 
-/** Returns a default pie chart tick object as per the WebChart Specification */
+/**
+ * Returns a default pie chart tick object as per the WebChart Specification
+ *
+ * @internal
+ */
 export function getDefaultPieChartTick(): WebChartPieChartTick;
 
-/** Returns a default symbol for a pie chart */
+/**
+ * Returns a default symbol for a pie chart
+ *
+ * @internal
+ */
 export function getDefaultPieChartSymbol(): ISimpleFillSymbol;
 
 /**
@@ -241,6 +326,7 @@ export function getDefaultPieChartSymbol(): ISimpleFillSymbol;
  *
  * @param commonStrings
  * @param objectIDField
+ * @internal
  */
 export function getDefaultPieChartSeries(commonStrings: CommonStrings, objectIDField?: string): Required<Pick<WebChartPieChartSeries, "dataLabels" | "fillSymbol" | "query">> & WebChartPieChartSeries;
 
@@ -248,51 +334,63 @@ export function getDefaultPieChartSeries(commonStrings: CommonStrings, objectIDF
  * Returns a default GaugeSeries object as per the WebChart Specification
  *
  * @param props
+ * @internal
  */
 export function getDefaultGaugeSeries(props: { objectIDField?: string; }): WebChartGaugeSeries;
 
-/** Returns the default chart rotation. */
+/**
+ * Returns the default chart rotation.
+ *
+ * @internal
+ */
 export function getDefaultChartRotation(): boolean;
 
 /**
  * @param commonStrings
  * @param id
+ * @internal
  */
 export function getDefaultBarChart(commonStrings: CommonStrings, id?: string): WebChart;
 
 /**
  * @param commonStrings
  * @param id
+ * @internal
  */
 export function getDefaultBoxPlot(commonStrings: CommonStrings, id?: string): WebBoxPlot;
 
 /**
  * @param commonStrings
  * @param id
+ * @internal
  */
 export function getDefaultLineChart(commonStrings: CommonStrings, id?: string): WebChart;
 
 /**
  * @param commonStrings
  * @param id
+ * @internal
  */
 export function getDefaultRadarChart(commonStrings: CommonStrings, id?: string): WebChart;
 
 /**
  * @param commonStrings
  * @param id
+ * @internal
  */
 export function getDefaultPieChart(commonStrings: CommonStrings, id?: string): WebChart;
 
 /**
  * @param commonStrings
  * @param id
+ * @internal
  */
 export function getDefaultGauge(commonStrings: CommonStrings, id?: string): WebGaugeChart;
 
 /**
  * @param commonStrings
  * @param id
+ * @internal
  */
 export function getDefaultScatterplot(commonStrings: CommonStrings, id?: string): WebChart;
 
@@ -302,18 +400,23 @@ export function getDefaultScatterplot(commonStrings: CommonStrings, id?: string)
  * @param commonStrings - Common strings
  * @param objectIDField - Object ID field
  * @returns WebHeatChart
+ * @internal
  */
 export function getDefaultHeatChart(commonStrings: CommonStrings, objectIDField: string): WebHeatChart;
 
+/** @internal */
 export function getDefaultHistogramOverlays(): Required<HistogramOverlays>;
 
+/** @internal */
 export function getDefaultHistogramSymbol(): ISimpleFillSymbol;
 
+/** @internal */
 export function getDefaultHistogramSeries(): Omit<Required<WebChartHistogramSeries>, "dataTooltipDateFormat" | "dataTooltipPercentFormat" | "dataTooltipValueFormat" | "query">;
 
 /**
  * @param commonStrings
  * @param id
+ * @internal
  */
 export function getDefaultHistogram(commonStrings: CommonStrings, id?: string): WebChart;
 
@@ -322,10 +425,15 @@ export function getDefaultHistogram(commonStrings: CommonStrings, id?: string):
  * or let as defaults.
  *
  * @param customizedLimits
+ * @internal
  */
 export function getChartLimits(customizedLimits?: ChartElementLimit): Required<ChartElementLimit>;
 
-/** Returns a list of technical limitations, mainly to the size of large queries. */
+/**
+ * Returns a list of technical limitations, mainly to the size of large queries.
+ *
+ * @internal
+ */
 export function getChartTechnicalLimits(): ChartElementTechnicalLimit;
 
 /**
@@ -333,6 +441,7 @@ export function getChartTechnicalLimits(): ChartElementTechnicalLimit;
  *
  * @param aggregationType
  * @param commonStrings
+ * @internal
  */
 export function getDefaultAggregationTypeLabel(aggregationType: string | undefined, commonStrings: CommonStrings): string;
 
@@ -341,25 +450,36 @@ export function getDefaultAggregationTypeLabel(aggregationType: string | undefin
  *
  * @param timeAggregationType
  * @param commonStrings
+ * @internal
  */
 export function getDefaultTimeAggregationTypeLabel(timeAggregationType: string | undefined, commonStrings: CommonStrings): string;
 
-/** Returns the default stacked type for Bar or Line chart with multiple series. */
+/**
+ * Returns the default stacked type for Bar or Line chart with multiple series.
+ *
+ * @internal
+ */
 export function getDefaultStackedType(): WebChartStackedKinds;
 
 /**
  * Returns the default label to show when there is no R2 value computed or set for scatterplot
  *
  * @param commonStrings
+ * @internal
  */
 export function getDefaultNoR2Label(commonStrings: CommonStrings): string;
 
+/** @internal */
 export const pieChartInnerRadius: 0;
 
+/** @internal */
 export const boxPlotOutliersSuffix: "_arcgis_charts_outliers";
 
+/** @internal */
 export const boxPlotZScoreSuffix: "_arcgis_charts_z_score";
 
+/** @internal */
 export const defaultColorForBoxPlotWithMeanLines: Color;
 
+/** @internal */
 export const percentageSuffix: " percentage ";

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

@@ -44,6 +44,7 @@ export interface ChartElementTechnicalLimit {
   maxOperandsPerWhereClause: number;
 }
 
+/** @internal */
 export interface QueryDefaults {
   maxRecordCountFactor: number;
   maxParallelRequests: number;
@@ -53,6 +54,7 @@ export interface QueryDefaults {
   orderByJSAPIDelimiter: string;
 }
 
+/** @internal */
 export interface ChartTextProps {
   text: string;
   visible: boolean;
@@ -60,6 +62,7 @@ export interface ChartTextProps {
   type?: TextElements;
 }
 
+/** @internal */
 export const TextElements: {
     readonly AxisLabels: "axisLabels";
     readonly GuideLabel: "guideLabel";
@@ -72,4 +75,5 @@ export const TextElements: {
     readonly DescriptionText: "descriptionText";
 };
 
+/** @internal */
 export type TextElements = (typeof TextElements)[keyof typeof TextElements];

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

@@ -12,6 +12,7 @@ import type { WebChart, WebChartDataFilters, WebChartQuery } from "../../spec/we
  * Returns the renderer type and the field and normalization field if applicable.
  *
  * @param layerRenderer
+ * @internal
  */
 export function getRendererInfo(layerRenderer?: Renderer): RendererInfo;
 
@@ -19,6 +20,8 @@ export function getRendererInfo(layerRenderer?: Renderer): RendererInfo;
  * Function creating a FeatureLayer from a set of parameters.
  * It returns the created Feature Layer.
  * It is memoized (cached) to avoid multiple requests for a same feature layer.
+ *
+ * @internal
  */
 export const getFeatureLayer: (featureLayer: IFeatureLayer) => Promise<FeatureLayer>;
 
@@ -27,6 +30,7 @@ export const getFeatureLayer: (featureLayer: IFeatureLayer) => Promise<FeatureLa
  * If can return either a FeatureLayer or a FeatureLayerView (and possibly nothing)
  *
  * @param props
+ * @internal
  */
 export function getQueryObject(props: QueryObjectProps): Promise<QueryObject>;
 
@@ -35,6 +39,7 @@ export function getQueryObject(props: QueryObjectProps): Promise<QueryObject>;
  *
  * @param queryObject
  * @param usePopupTemplateFieldsInfo - whether to use the aliases from the popupTemplate
+ * @internal
  */
 export function fetchLayerFieldsInfo(queryObject: QueryObject, usePopupTemplateFieldsInfo?: boolean): Promise<IField[]>;
 
@@ -44,6 +49,7 @@ export function fetchLayerFieldsInfo(queryObject: QueryObject, usePopupTemplateF
  *
  * @param fieldName - The list of fields containing all the information regarding the fields, including the name
  * @param fields
+ * @internal
  */
 export function getFieldFromName(fieldName: string, fields?: IField[]): IField | undefined;
 
@@ -54,6 +60,7 @@ export function getFieldFromName(fieldName: string, fields?: IField[]): IField |
  * @param layer - The layer
  * @returns An object containing the unique ID fields or the object ID field and a boolean indicating if it is a traditional Object ID field
  * When the layer is undefined, returns undefined ID fields and false for the boolean.
+ * @internal
  */
 export function getLayerUniqueIdOrObjectIdFields(layer?: SupportedLayer): {
     idFields: string[] | undefined;
@@ -65,6 +72,7 @@ export function getLayerUniqueIdOrObjectIdFields(layer?: SupportedLayer): {
  * If the layer has unique ID fields defined, the first field is returned.
  *
  * @param layer - The layer
+ * @internal
  */
 export function getObjectIdField(layer?: SupportedLayer): {
     idField: string;
@@ -76,6 +84,7 @@ export function getObjectIdField(layer?: SupportedLayer): {
  * Fields descriptions are [here](http://resources.esri.com/help/9.3/ArcGISEngine/ArcObjects/esriGeoDatabase/esriFieldType.htm).
  *
  * @param field
+ * @internal
  */
 export function isNumericField(field: IField): boolean;
 
@@ -84,6 +93,7 @@ export function isNumericField(field: IField): boolean;
  * Fields descriptions are [here](http://resources.esri.com/help/9.3/ArcGISEngine/ArcObjects/esriGeoDatabase/esriFieldType.htm).
  *
  * @param field
+ * @internal
  */
 export function isDateField(field: IField): boolean;
 
@@ -92,6 +102,7 @@ export function isDateField(field: IField): boolean;
  * Fields descriptions are [here](http://resources.esri.com/help/9.3/ArcGISEngine/ArcObjects/esriGeoDatabase/esriFieldType.htm).
  *
  * @param field
+ * @internal
  */
 export function isIntegerField(field: IField): boolean;
 
@@ -99,6 +110,7 @@ export function isIntegerField(field: IField): boolean;
  * Returns list of date field names from an array of fields of type IField
  *
  * @param fieldsInfo
+ * @internal
  */
 export function getLayerDateFields(fieldsInfo: IField[]): string[];
 
@@ -106,15 +118,32 @@ export function getLayerDateFields(fieldsInfo: IField[]): string[];
  * Returns list of numeric field names from an array of fields of type IField
  *
  * @param fieldsInfo
+ * @internal
  */
 export function getLayerNumericFields(fieldsInfo: IField[]): string[];
 
+/**
+ * Retrieve the subtype name from the subtype id, if available.
+ * Otherwise, just simply returns the original value.
+ *
+ * @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)
+ * @internal
+ */
+export function getSubtypeName(props: {
+    subtypeInfo?: SubtypeInfo;
+    fieldName: string;
+    fieldValueToMatch: number | string;
+}): string | undefined;
+
 /**
  * Retrieve subtype information from the query object.
  *
  * @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
  */
 export function getLayerSubtypeInfo(queryObject: QueryObject): SubtypeInfo | undefined;
 
@@ -124,6 +153,7 @@ export function getLayerSubtypeInfo(queryObject: QueryObject): SubtypeInfo | und
  *
  * @param props - the name of the field
  * @returns The field description if available; otherwise undefined.
+ * @internal
  */
 export function getFieldDescription(props: {
     fieldName: string;
@@ -136,6 +166,7 @@ export function getFieldDescription(props: {
  * Returns feature layer field names used in its renderer.
  *
  * @param layer
+ * @internal
  */
 export function getRendererFieldNames(layer: SupportedLayer): Promise<string[]>;
 
@@ -144,6 +175,7 @@ export function getRendererFieldNames(layer: SupportedLayer): Promise<string[]>;
  * https://doc.arcgis.com/en/arcgis-online/reference/faq.htm#anchor7
  *
  * @param layer
+ * @internal
  */
 export function isStandardLayer(layer: SupportedLayer): Promise<boolean>;
 
@@ -151,6 +183,7 @@ export function isStandardLayer(layer: SupportedLayer): Promise<boolean>;
  * Finds the matching field name for a given layer based on the fieldToMatch parameter.
  *
  * @param props
+ * @internal
  */
 export function findMatchingLayerFieldName(props: {
     queryObject: QueryObject;
@@ -172,6 +205,7 @@ export function findMatchingLayerFieldName(props: {
  * @param layerFieldList - The list of fields to search in.
  * @param fieldToMatch - The field name to match.
  * @returns The matching field if found, otherwise undefined.
+ * @internal
  */
 export function findMatchingField(layerFieldList: IField[], fieldToMatch: string): IField | undefined;
 
@@ -179,6 +213,7 @@ export function findMatchingField(layerFieldList: IField[], fieldToMatch: string
  * Finds the matching layer fields for a list of fields.
  *
  * @param props
+ * @internal
  */
 export function matchFieldsList(props: {
     fieldsList: string[] | undefined;
@@ -192,6 +227,7 @@ export function matchFieldsList(props: {
  * Regarding the other filters (by geometry, gdb version and time extent) only one of each can be applied. The runtime filters are chosen over the config filters.
  *
  * @param props - The query object (feature layer or feature layer view)
+ * @internal
  */
 export function buildQueryConfig(props: {
     queryObject?: QueryObject;
@@ -205,6 +241,7 @@ export function buildQueryConfig(props: {
  *
  * @param layer - the supported layer
  * @returns The list of fields used in the charts
+ * @internal
  */
 export function getFieldsUsedInCharts(layer: SupportedLayer): Promise<string[]>;
 
@@ -214,6 +251,7 @@ export function getFieldsUsedInCharts(layer: SupportedLayer): Promise<string[]>;
  * @param config - The chart configuration
  * @param layer - The feature layer
  * @returns The list of matching fields
+ * @internal
  */
 export function extractFieldsUsedInConfig(config: WebChart, layer: SupportedLayer | undefined): Promise<string[]>;
 
@@ -222,6 +260,7 @@ export function extractFieldsUsedInConfig(config: WebChart, layer: SupportedLaye
  *
  * @param layer - The layer
  * @returns The list of layer fields
+ * @internal
  */
 export function extractFieldsFromConfigList(layer: SupportedLayer): Promise<string[]>;
 
@@ -239,6 +278,7 @@ export function extractFieldsFromConfigList(layer: SupportedLayer): Promise<stri
  * @requires
  * - view
  * - portalItemId
+ * @internal
  */
 export function findMatchingLayerFromView(props: {
     view?: MapView | SceneView;