@arcgis/charts-components 4.34.0-next.7 → 4.34.0-next.71

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

@@ -1,6 +1,76 @@
 import { WebChart, WebGaugeChart } from '@arcgis/charts-spec';
+import { WebChartJSONSchemas } from '@arcgis/charts-spec/json-schema';
+import { ErrorObject } from 'ajv';
 import { QueryObject } from '../../layer/interfaces';
-import { ValidationStatus } from './interfaces';
+import { ConfigWarningObject, CustomErrorObject, ValidationStatus } from './interfaces';
+/**
+ * Extracts schema name from the schema `$ref` path
+ * For e.g.:
+ *   - "#/definitions/WebChartInlineDataSource" => "WebChartInlineDataSource"
+ *   - "#/definitions/WebChartBarChartSeries" => "WebChartBarChartSeries"
+ * @param schemaRefPath
+ */
+declare function extractSchemaNameFromRefPath(schemaRefPath: string): string;
+/**
+ * Formats specific error messages based on the error keyword.
+ * @param errors Array storing the errors met during the validation
+ */
+declare function customizeValidationErrors(errors: ErrorObject[]): Promise<ErrorObject[]>;
+/**
+ * By default, the JSON schema created by ac-spec is suitable for WebChart validation.
+ * If we want to validate any other object, an appropriate schema can be generated via this function.
+ * @param schema
+ * @param schemaKey
+ */
+declare function createStartingSchema(schema: typeof WebChartJSONSchemas, schemaKey: keyof typeof WebChartJSONSchemas.definitions): typeof WebChartJSONSchemas;
+/**
+ * Tests whether a layer can be loaded.
+ * @param queryObject The query object (layer or feature layer view)
+ */
+declare function findLayerLoadError(queryObject: QueryObject): Promise<CustomErrorObject | undefined>;
+/**
+ * Check whether there exists a `StatisticDefinition` in any series' `Query` where non-count aggregation is applied to a non-numeric field
+ * @param props.seriesConfigs The series config list
+ * @param props.queryObject The query object
+ * @param props.allowUsingObjectIdStat Whether to allow using the object id field as a statistic field
+ */
+declare function findNumericAggregationWarnings(props: {
+    seriesConfigs: WebChart["series"];
+    queryObject: QueryObject;
+    allowUsingObjectIdStat?: boolean;
+}): Promise<ConfigWarningObject[]>;
+/**
+ * Verifies that the chart series are unique. Sets a message to display if not.
+ * @param chartConfig The chart config
+ */
+declare function findDuplicateSeriesIDWarnings(chartConfig?: WebChart): Promise<ConfigWarningObject[]>;
+/**
+ * Look for issues of level 'warning' in the chart config.
+ * @param props.input The input config
+ * @param props.queryObject The query object
+ * @param props.allowUsingObjectIdStat Whether to allow using the object id field as a statistic field
+ */
+declare function findWarnings(props: {
+    input: WebChart;
+    queryObject: QueryObject;
+    allowUsingObjectIdStat?: boolean;
+}): Promise<ConfigWarningObject[]>;
+/**
+ * Look for specific errors independent from the JSON schema.
+ * @param queryObject The query object
+ * @param chartConfig The chart config
+ */
+declare function findCustomErrors(queryObject?: QueryObject, chartConfig?: WebChart | WebGaugeChart): Promise<CustomErrorObject[]>;
+export declare const chartConfigValidatorPrivateFunctions: {
+    findCustomErrors: typeof findCustomErrors;
+    findWarnings: typeof findWarnings;
+    findNumericAggregationWarnings: typeof findNumericAggregationWarnings;
+    findDuplicateSeriesIDWarnings: typeof findDuplicateSeriesIDWarnings;
+    findLayerLoadError: typeof findLayerLoadError;
+    createStartingSchema: typeof createStartingSchema;
+    extractSchemaNameFromRefPath: typeof extractSchemaNameFromRefPath;
+    customizeValidationErrors: typeof customizeValidationErrors;
+};
 /**
  * Validates the `WebChart` config by checking for  and displays `Errors` and `Warnings`.
  * - `Errors` are violations in the config w.r.t the JSON schema.
@@ -20,3 +90,4 @@ export declare function validateWebChart(props: {
  * @param config The config to analyze
  */
 export declare function isPartialConfig(config?: WebChart): boolean;
+export {};

package/dist/utils/components/action-bar-utils.d.ts

@@ -9,21 +9,6 @@ import { ChartTypes, DefaultChartActions } from '../../utils';
  * @returns {DefaultChartActions[]} The default actions for the given chart type
  */
 export declare function getDefaultChartActions(chartType: ChartTypes | undefined): DefaultChartActions[];
-/**
- * Creates a new tooltip object and adds it to the DOM
- *
- * @param innerHTML HTML to be displayed inside tooltip
- * @param referenceElement Element for which the tooltip will be shown
- * @returns The tooltip object that was created
- */
-export declare function createTooltip(innerHTML: string, referenceElement?: HTMLElement): HTMLCalciteTooltipElement;
-/**
- * Destroys tooltip by removing it from the DOM
- *
- * @param tooltip The tooltip to be destroyed
- * @returns Null return for caller to easily reset tooltip object to null
- */
-export declare function destroyTooltip(tooltip: HTMLCalciteTooltipElement | null): null;
 /**
  * Event handler for action bar slot change.
  *
@@ -34,8 +19,15 @@ export declare const onActionBarSlotChange: (e: Event, chartComponent: HTMLArcgi
 /**
  * Updates the action bar states based on the properties of the chart component and the config object.
  *
- * @param actionBar
- * @param chartComponent
- * @param config
+ * @param {HTMLArcgisChartsActionBarElement} props.actionBar - The action bar element to update.
+ * @param {HTMLArcgisChartElement} props.chartComponent - The chart component element.
+ * @param {WebChart} [props.config] - The configuration object for the chart.
+ * @param {boolean} [props.isWarningDisplayed] - Optional flag to indicate if a warning is displayed.
+ *
  */
-export declare function updateActionBarStates(actionBar: HTMLArcgisChartsActionBarElement, chartComponent: HTMLArcgisChartElement, config?: WebChart): void;
+export declare function updateActionBarStates(props: {
+    actionBar: HTMLArcgisChartsActionBarElement;
+    chartComponent: HTMLArcgisChartElement;
+    config?: WebChart;
+    isWarningDisplayed?: boolean;
+}): void;

package/dist/utils/components/chart-ui-utils.d.ts

@@ -88,18 +88,6 @@ export declare function sanitizeColor(color: RGB | undefined): RGB | null;
  * @param e Input element "keydown" event
  */
 export declare const blockNumericE: (e: KeyboardEvent) => void;
-/**
- * Creates a tooltip for the hovered action.
- *
- * @param actionElement
- */
-export declare const createActionTooltip: (actionElement: HTMLCalciteActionElement | HTMLCalciteIconElement | HTMLCalciteListElement) => HTMLCalciteTooltipElement;
-/**
- * Destroys tooltip for the action that was being hovered.
- *
- * @param tooltip
- */
-export declare const destroyActionTooltip: (tooltip: HTMLCalciteTooltipElement | undefined) => void;
 /**
  * emit numeric field change event
  *
@@ -115,3 +103,18 @@ export declare const emitNumericFieldsChange: (props: NumericFieldsChangeProps)
  * @param lineStyle
  */
 export declare function getLineStyleType(lineStyle: RESTSimpleLineSymbolStyle | undefined): string;
+/**
+ * Downloads an object as a file using a data URL.
+ *
+ * @param {string} objectURL - The data URL of the object to download.
+ * @param {string} downloadString - The name of the file to download.
+ * @category Public
+ */
+export declare function downloadFile(objectURL: string, downloadString: string): void;
+/**
+ * Destroys tooltip by removing it from the DOM
+ *
+ * @param tooltip The tooltip to be destroyed
+ * @returns Null return for caller to easily reset tooltip object to null
+ */
+export declare function destroyTooltip(tooltip: HTMLCalciteTooltipElement | null | undefined): null;

package/dist/utils/components/config-update.d.ts

@@ -1,5 +1,5 @@
 import { SupportedLayer, WebChart, WebChartLegendPositions } from '@arcgis/charts-spec';
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
+import { FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
 import { ChartOptions } from '../../chart-rendering/common/interfaces';
 import { ArcgisChart } from '../../components/arcgis-chart/customElement.js';
 /**
@@ -43,4 +43,4 @@ export declare function isValidDataSource(config?: WebChart, layer?: FeatureLaye
  * @param component The chart component
  * @param options The runtime options
  */
-export declare function addMissingSplitBySeries(component: ArcgisChart, options: ChartOptions): Promise<void>;
+export declare function addMissingSplitBySeries(component: ArcgisChart, config: WebChart | undefined, options: ChartOptions): Promise<void>;

package/dist/utils/components/event-payloads.d.ts

@@ -1,3 +1,5 @@
+import { default as MapView } from '@arcgis/core/views/MapView';
+import { default as SceneView } from '@arcgis/core/views/SceneView';
 import { ChartModel } from '../../model';
 import { DefaultChartActions, PieSlicesSymbols, SelectionData, SeriesSymbolsMap } from '../../utils';
 import { CalculatedMinMaxBoundsPayload, LegendItemVisibility, WebChartDataTypes, WebChartLegendPositions } from '@arcgis/charts-spec';
@@ -35,7 +37,7 @@ export type SeriesColorChangePayload = {
 };
 export type NoRenderPropChangePayload = {
     propName: string;
-    value: WebChartLegendPositions | boolean;
+    value: MapView | SceneView | WebChartLegendPositions | boolean | number | undefined;
     model: ChartModel | undefined;
 };
 export type LegendItemVisibilityChangePayload = {

package/dist/utils/components/web-component-utils.d.ts

@@ -1,5 +1,8 @@
 import { CSVOptions } from '../../interfaces';
-import { ChartModel } from '../../model';
+import { ModelTypes } from '../../model';
+import { IField, SupportedLayer } from '@arcgis/charts-spec';
+import { ChartConfig } from '../types';
+import { FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
 /**
  * A utility function to compare if a value has changed deeply.
  * @param value
@@ -31,7 +34,61 @@ export declare function arrayToCSV<T extends Record<string, unknown>>(data: T[],
 /**
  * Transform the raw data to a format that is suitable for exporting to CSV.
  * This function is used to transform the data before it is passed to the CSV export function.
- * @param rawData - The raw data to be transformed.
- * @param model - The model that defines the chart type and the data transformation.
+ * @param props.config - [Optional] The chart configuration that defines the chart type and data transformation.
+ * @param props.rawData - The raw data to be transformed, which is an array of objects.
+ * @param props.layer - [Optional] The layer associated with the chart, used for additional data context.
+ * @param props.fieldList - [Optional] The list of fields in the layer, used to determine field types and names.
  */
-export declare function transformChartData<T extends Record<string, unknown>>(rawData: T[], model?: ChartModel): T[];
+export declare function transformChartData<T extends Record<string, unknown>>(props: {
+    config?: ChartConfig;
+    rawData: T[];
+    layer?: FeatureLayerView | SupportedLayer;
+    fieldList?: IField[];
+}): T[];
+/**
+ * Transform the histogram data to a format that is suitable for exporting to CSV.
+ * @param config - The histogram model or config
+ * @param rows - The raw data to be transformed.
+ */
+export declare function transformHistogramData<T extends Record<string, unknown>>(config: ChartConfig<typeof ModelTypes.Histogram>, rows: T[]): T[];
+/**
+ * Processes the chart data for bar and line charts.
+ * @param props.config - The chart model.
+ * @param props.rows - The raw data to be transformed.
+ * @param props.layer - The layer associated with the chart.
+ */
+export declare function transformBarLineChartData<T extends Record<string, unknown>>(props: {
+    config: ChartConfig<typeof ModelTypes.BarChart | typeof ModelTypes.ComboBarLineChart | typeof ModelTypes.LineChart>;
+    rows: T[];
+    layer?: FeatureLayerView | SupportedLayer;
+    fieldList?: IField[];
+}): T[];
+/**
+ * Transform the pie chart data to a format that is suitable for exporting to CSV.
+ * @param props.model - The pie chart model.
+ * @param props.rows - The raw data to be transformed.
+ * @param props.layer - The layer associated with the chart.
+ */
+export declare function transformPieChartData<T extends Record<string, unknown>>(props: {
+    config: ChartConfig<typeof ModelTypes.PieChart>;
+    rows: T[];
+    layer?: FeatureLayerView | SupportedLayer;
+    fieldList?: IField[];
+}): T[];
+/**
+ * Transform the box plot data to a format that is suitable for exporting to CSV.
+ * @param model - The box plot model.
+ * @param rows - The raw data to be transformed.
+ * @returns The transformed data.
+ */
+export declare function transformBoxPlotData<T extends Record<string, unknown>>(props: {
+    config: ChartConfig<typeof ModelTypes.BoxPlot>;
+    rows: T[];
+    layer?: FeatureLayerView | SupportedLayer;
+    fieldList?: IField[];
+}): T[];
+/**
+ * Check if the provided date is valid.
+ * @param {unknown} date - The date to check, should be a string or a number.
+ */
+export declare const isValidDate: (date: unknown) => date is Date | number | string;

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

@@ -19,7 +19,7 @@ export declare const pieChartSpecialSlicesId: {
     emptySliceId: string;
 };
 export declare const defaultBoxPlotCategory = "arcgis_charts_box_plot_category";
-export declare const ramp: number[][];
+export declare const ramp: Color[];
 /**
  * Returns a specific color from the default ramp, given an index. If the index is > than the ramp length,
  * we use modulo to get the corresponding color.

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

@@ -1,7 +1,8 @@
 import { IFeatureLayer, IField, SupportedLayer, WebChart, WebChartDataFilters, WebChartQuery } from '@arcgis/charts-spec';
 import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer.js';
+import { default as SubtypeGroupLayer } from '@arcgis/core/layers/SubtypeGroupLayer';
 import { default as Renderer } from '@arcgis/core/renderers/Renderer';
-import { QueryObject, QueryObjectProps, RendererInfo, SubtypeInfo } from './interfaces';
+import { IFeatureType, QueryObject, QueryObjectProps, RendererInfo, SubtypeInfo } from './interfaces';
 /**
  * Returns the renderer type and the field and normalization field if applicable.
  * @param layerRenderer
@@ -66,6 +67,29 @@ export declare function getLayerDateFields(fieldsInfo: IField[]): string[];
  * @param fieldsInfo
  */
 export declare function getLayerNumericFields(fieldsInfo: IField[]): string[];
+/**
+ * Retrieve the subtype name from the subtype id, if available.
+ * Otherwise, just simply returns the original value.
+ * @param props.subtypeInfo The subtypeInfo which consists of a typeIdField and a list of subtypes.
+ * @param props.fieldName The field name to check against the subtype's typeIdField
+ * @param props.fieldValueToMatch The field value, mainly the subtype id, to find the matching subtype name (if it's from a field that holds the subtypes for the features).
+ * @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)
+ */
+declare function getSubtypeName(props: {
+    subtypeInfo?: SubtypeInfo;
+    fieldName: string;
+    fieldValueToMatch: number | string;
+}): string | undefined;
+/**
+ * Get the feature types from the layer, including all coded-value domains
+ * defined in the feature types.
+ * @param layer The layer to retrieve the information.
+ * @param propName Whether to fetch the types or subtypes
+ * @returns the feature types or undefined
+ */
+declare function getFeatureTypes(layer: FeatureLayer, propName: "types"): IFeatureType[] | undefined;
+declare function getFeatureTypes(layer: FeatureLayer | SubtypeGroupLayer, propName: "subtypes"): IFeatureType[] | undefined;
 /**
  * Retrieve subtype information from the query object.
  * @param queryObject The query object from which to retrieve the feature layer.
@@ -94,6 +118,14 @@ export declare function getFieldDescription(props: {
  * @returns {Promise<string[]>}
  */
 export declare function getRendererFieldNames(layer: SupportedLayer): Promise<string[]>;
+/**
+ * Returns the ArcGIS server's rest/info url of the feature server given a feature layer url.
+ * @example   getServerRestInfo(https://servicesdev.arcgis.com/b5ADkBof6gCHCFQm/arcgis/rest/services/Steph_Curry/FeatureServer/2
+ * returns https://servicesdev.arcgis.com/b5ADkBof6gCHCFQm/arcgis/rest/info
+ * @param {string} resUrl
+ * @returns {string}
+ */
+declare function getServerRestInfo(resUrl: string): string;
 /**
  * Returns a boolean to indicate if the feature layer is on standard feature data store or not.
  * https://doc.arcgis.com/en/arcgis-online/reference/faq.htm#anchor7
@@ -168,3 +200,9 @@ export declare function extractFieldsUsedInConfig(config: WebChart, layer: Suppo
  * @returns {string[]} The list of layer fields
  */
 export declare function extractFieldsFromConfigList(layer: SupportedLayer): Promise<string[]>;
+export declare const layerPrivateFunctions: {
+    getServerRestInfo: typeof getServerRestInfo;
+    getSubtypeName: typeof getSubtypeName;
+    getFeatureTypes: typeof getFeatureTypes;
+};
+export {};

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

@@ -1,6 +1,17 @@
-import { IFeatureLayer, WebChart, WebChartDataTypes } from '@arcgis/charts-spec';
+import { Color, IFeatureLayer, WebChart, WebChartDataItemValue, WebChartDataTypes } from '@arcgis/charts-spec';
 import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer';
 import { WebChartConfigFields } from './interfaces';
+/**
+ * Converts a hex color into a ESRI Color array ([number, number, number, number])
+ * @param hex The hex code 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
@@ -14,6 +25,17 @@ export declare function convertConfigFieldsToChartRenderer(props: {
     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
@@ -47,3 +69,9 @@ export declare function convertInlineConfigToLayerConfig(props: {
     iLayer?: IFeatureLayer;
     layer?: FeatureLayer;
 }>;
+export declare const inlineConversionPrivateFunctions: {
+    hexToRGB: typeof hexToRGB;
+    convertColor: typeof convertColor;
+    removeConfigFieldsFromData: typeof removeConfigFieldsFromData;
+};
+export {};

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

@@ -1,7 +1,7 @@
 import { RESTRendererType, WebChart, ICodedValue, SupportedLayer } from '@arcgis/charts-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 { FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
 export interface QueryObjectProps {
     chartConfig: WebChart;
     layer?: FeatureLayerView | SupportedLayer;

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

@@ -47,6 +47,13 @@ export declare function mapQueryTimeExtent(timeExtentConfig?: WebChartQuery["tim
  * @param geometryConfig The geometry from the config
  */
 export declare function mapQueryGeometry(geometryConfig?: WebChartQuery["geometry"]): Geometry | null | undefined;
+/**
+ * Sanitizes an outFields array by:
+ * - removing the duplicates
+ * @param outFields The array to sanitize
+ * @returns The sanitized array
+ */
+declare function sanitizeOutFields(outFields?: string[]): string[];
 /**
  * Maps properties from a WebChartQuery and properties specific to temporal binning into an AttributeBinsQuery object.
  * @param props.queryObject The layer or feature layer view
@@ -61,7 +68,7 @@ export declare function mapAttributeBinsQueryForTemporalData(props: {
     temporalBinning: WebChartCalendarBasedBinning | WebChartFixedDateBinning;
     dateField: string;
     splitByField?: string;
-}): AttributeBinsQuery;
+}): Promise<AttributeBinsQuery>;
 /**
  * Maps properties from a WebChartQuery and properties specific to temporal binning into an AttributeBinsQuery object.
  * @param props.queryObject The layer or feature layer view
@@ -95,3 +102,7 @@ export declare function mapQuery(props: {
     maxRecordCountFactor?: number;
 }): Query;
 export declare function getMaxRecordCountFactor(layer?: SupportedLayer): number | undefined;
+export declare const queryParserPrivateFunctions: {
+    sanitizeOutFields: typeof sanitizeOutFields;
+};
+export {};

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

@@ -2,7 +2,7 @@ import { SupportedLayer, WebChart } from '@arcgis/charts-spec';
 import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer';
 import { default as SubtypeGroupLayer } from '@arcgis/core/layers/SubtypeGroupLayer';
 import { default as SubtypeSublayer } from '@arcgis/core/layers/support/SubtypeSublayer';
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
+import { FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
 import { QueryObject } from '../interfaces';
 /**
  * Indicates whether the input object is a feature collection.

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

@@ -95,6 +95,21 @@ export declare function getFieldNameFromFieldAlias(fields: IField[] | undefined,
  * @param chartSeries
  */
 export declare function canShowLegend(chartSeries: WebChartSeries[]): boolean;
+/**
+ * Returns whether a scatter plot is currently supported
+ * @param config The chart's config
+ */
+declare function isSupportedScatterplot(config: WebChart): boolean;
+/**
+ * Returns whether a histogram is currently supported
+ * @param config The chart's config
+ */
+declare function isSupportedHistogram(config: WebChart): boolean;
+/**
+ * Returns whether a pie chart is currently supported
+ * @param config The chart's config
+ */
+declare function isSupportedPieChart(config: WebChart): boolean;
 /**
  * Based on a provided list of supported chart types, this function returns a boolean indicating if the config
  * contains supported series. An extra test is done for the scatter plot, pie, and histogram series.
@@ -221,4 +236,9 @@ export declare function sortArrayAUsingArrayB<T, K>(props?: {
     arrayB: T[];
     getKey: (item: T) => K;
 }): T[];
+export declare const miscPrivateFunctions: {
+    isSupportedHistogram: typeof isSupportedHistogram;
+    isSupportedPieChart: typeof isSupportedPieChart;
+    isSupportedScatterplot: typeof isSupportedScatterplot;
+};
 export {};

package/dist/utils/type-guards/index.d.ts

@@ -67,18 +67,18 @@ export declare function isChartType<T extends ChartConfig>(config: WebChart | un
  * Determines if the series is a box plot series.
  * @param series The series to check.
  */
-export declare function isBoxPlotSeries(series: WebChartSeries): series is WebChartBoxPlotSeries;
+export declare function isBoxPlotSeries(series: WebChartSeries | undefined): series is WebChartBoxPlotSeries;
 /**
  * Determines if the series is a line chart series.
  * @param series The series to check.
  */
-export declare function isLineChartSeries(series: WebChartSeries): series is WebChartLineChartSeries;
-export declare function isRadarChartSeries(series: WebChartSeries): series is WebChartRadarChartSeries;
+export declare function isLineChartSeries(series: WebChartSeries | undefined): series is WebChartLineChartSeries;
+export declare function isRadarChartSeries(series: WebChartSeries | undefined): series is WebChartRadarChartSeries;
 /**
  * Determines if the series is a bar chart series.
  * @param series The series to check.
  */
-export declare function isBarChartSeries(series: WebChartSeries): series is WebChartBarChartSeries;
+export declare function isBarChartSeries(series: WebChartSeries | undefined): series is WebChartBarChartSeries;
 /**
  * Type guard to check if the series is a BarChartSeries.
  * @param {WebChartSeries[]} series - The series to check.

package/dist/utils/type-guards/series-types.d.ts

@@ -1,5 +1,15 @@
 import { WebChartSeries } from '@arcgis/charts-spec';
 import { ChartTypes } from '../misc';
+/**
+ * Determines if a Set of series type matches a combo bar-line chart
+ * @param uniqueTypes The set of unique series types
+ */
+declare function isComboLineAndBarChart(uniqueTypes: Set<string>): boolean | undefined;
+/**
+ * Determines if a Set of series type matches a box plot
+ * @param uniqueTypes The set of unique series types
+ */
+declare function isBoxPlotChart(uniqueTypes: Set<string>): boolean;
 /**
  * Getting the type of a chart or series. If the input parameters are incorrect (empty array of series, or a mix of unknown/unallowed series types) the function returns `undefined`.
  * To get the series type, a valid seriesIndex is required. Otherwise, the type of a chart is determined and returned.
@@ -7,3 +17,8 @@ import { ChartTypes } from '../misc';
  * @param seriesIndex An index to get a specific series' type.  A valid index is required if the goal is to get the type of the series.
  */
 export declare function getChartOrSeriesType(chartSeries: WebChartSeries[] | undefined, seriesIndex?: number): ChartTypes | undefined;
+export declare const typeGuardsPrivateFunctions: {
+    isComboLineAndBarChart: typeof isComboLineAndBarChart;
+    isBoxPlotChart: typeof isBoxPlotChart;
+};
+export {};

package/dist/utils/ui/popover-ui-utils.d.ts

@@ -1,122 +1,19 @@
-import { WebChartTextSymbol, IField, ISimpleLineSymbol, Color } from '@arcgis/charts-spec';
-export declare const PopoverType: {
-    readonly BarChartDataPopover: "HTMLArcgisChartsConfigBarChartPopoverElement";
-    readonly BarChartSeriesPopover: "HTMLArcgisChartsConfigBarChartSeriesPopoverElement";
-    readonly BoxPlotDataPopover: "HTMLArcgisChartsConfigBoxPlotPopoverElement";
-    readonly BoxPlotSeriesPopover: "HTMLArcgisChartsConfigBoxPlotSeriesPopoverElement";
-    readonly ChartRenamePopover: "HTMLArcgisChartsConfigChartRenamePopoverElement";
-    readonly FormatPopover: "HTMLArcgisChartsConfigFormatPopoverElement";
-    readonly GuidePopover: "HTMLArcgisChartsConfigGuidePopoverElement";
-    readonly HistogramDataPopover: "HTMLArcgisChartsConfigHistogramPopoverElement";
-    readonly LineChartDataPopover: "HTMLArcgisChartsConfigLineChartPopoverElement";
-    readonly LineChartSeriesPopover: "HTMLArcgisChartsConfigLineChartSeriesPopoverElement";
-    readonly PieChartDataPopover: "HTMLArcgisChartsConfigPieChartPopoverElement";
-    readonly PieChartSlicesPopover: "HTMLArcgisChartsConfigPieChartSlicesPopoverElement";
-    readonly ScatterplotDataPopover: "HTMLArcgisChartsConfigScatterplotPopoverElement";
-    readonly SelectChartTypePopover: "HTMLArcgisChartsConfigSelectChartTypePopoverElement";
-};
-export type PopoverType = (typeof PopoverType)[keyof typeof PopoverType];
-interface IPopoverConfig {
-    popoverClose: (e: CustomEvent) => void;
-}
-interface IDataPopoverConfig extends IPopoverConfig {
-    layerFieldsInfo: IField[];
-}
-interface IConfigPopoverConfig extends IPopoverConfig {
-    hostElement?: any;
-    placement: string;
-    referenceElement?: HTMLElement;
-}
-export interface IHistogramDataPopoverConfig extends IDataPopoverConfig {
-    updateSymbolProps: (e: CustomEvent) => void;
-    updateProps: (e: CustomEvent) => void;
-    openChange: (e: CustomEvent) => void;
-}
-export interface IBarChartDataPopoverConfig extends IDataPopoverConfig {
-    onBarChartDataChange: (e: CustomEvent) => void;
-}
-export interface IBarChartSeriesPopoverConfig extends IConfigPopoverConfig {
-    seriesNameChange: (e: CustomEvent) => void;
-    seriesColorChange: (e: CustomEvent) => void;
-    openChange: (e: CustomEvent) => void;
-}
-export interface IBoxPlotDataPopoverConfig extends IDataPopoverConfig {
-    onBoxPlotDataChange: (e: CustomEvent) => void;
-}
-export interface IBoxPlotSeriesPopoverConfig extends IConfigPopoverConfig {
-    seriesNameChange: (e: CustomEvent) => void;
-    seriesColorChange: (e: CustomEvent) => void;
-    seriesLineStyleChange: (e: CustomEvent) => void;
-    seriesLineWidthChange: (e: CustomEvent) => void;
-    openChange: (e: CustomEvent) => void;
-    labelCanBeConfigured: boolean;
-}
-export interface ILineChartDataPopoverConfig extends IDataPopoverConfig {
-    onLineChartDataChange: (e: CustomEvent) => void;
-}
-export interface IPieChartDataPopoverConfig extends IDataPopoverConfig {
-    onPieChartDataChange: (e: CustomEvent) => void;
-}
-export interface IChartFormatPopoverConfig extends IConfigPopoverConfig {
-    selectedElement: Color | ISimpleLineSymbol | WebChartTextSymbol | undefined;
-    referenceElement: any;
-    updateSymbolProps: (e: CustomEvent) => void;
-    updateTextProps: (e: CustomEvent) => void;
-    updateBackground: (e: CustomEvent) => void;
-    openChange: (e: CustomEvent) => void;
-}
-export interface IGuidePopoverConfig extends IPopoverConfig {
-    colorChange: (e: CustomEvent<Color>) => void;
-    symbolChange: (e: CustomEvent<ISimpleLineSymbol>) => void;
-    popoverDismiss: (e: CustomEvent) => void;
-}
-export interface ILineChartSeriesPopoverConfig extends IPopoverConfig {
-    referenceElement: any;
-    placement: string;
-    seriesNameChange: (e: CustomEvent) => void;
-    seriesColorChange: (e: CustomEvent) => void;
-    seriesLineStyleChange: (e: CustomEvent) => void;
-    seriesLineWidthChange: (e: CustomEvent) => void;
-    openChange: (e: CustomEvent) => void;
-}
-export interface IPieChartSlicePopoverConfig extends IPopoverConfig {
-    referenceElement: any;
-    placement: string;
-    sliceNameChange: (e: CustomEvent) => void;
-    sliceColorChange: (e: CustomEvent) => void;
-    openChange: (e: CustomEvent) => void;
-}
-export interface IScatterplotChartPopoverConfig extends IPopoverConfig {
-    setTrendLineSymbol: (e: CustomEvent) => void;
-    setFixedSymbolRGBAColor: (e: CustomEvent<Color>) => void;
-    setXYField: (e: CustomEvent<string>) => void;
-    setSizeVariableField: (e: CustomEvent<string>) => void;
-    openChange: (e: CustomEvent) => void;
-}
-export interface ISelectChartTypePopoverConfig extends IPopoverConfig {
-    onSelectChartTypeChange: (e: CustomEvent) => Promise<void> | void;
-}
-export interface IChartRenamePopoverConfig extends IPopoverConfig {
-    name: string;
-    popoverReferenceElement: any;
-    onChartRename: (e: CustomEvent) => void;
-}
+import { IntervalPopoverProps } from '../../interfaces';
 /**
- * remove popover element
+ * Remove popover element
  * @param popover popover element to be removed
  */
 export declare const removePopover: (popover: any) => null;
 /**
- * create a popover element based on the input parameters
- * @param popoverType popover type to be created
- * @param popoverConfig config used to configure popover
- * @returns popover element
- */
-export declare const createPopover: (popoverType: PopoverType, popoverConfig: IPopoverConfig) => any;
-/**
- * edit popover element dynamically
+ * Edit popover element dynamically
  * @param popover a popover element
  * @param isOpen determine whether to open popover or not
  */
 export declare const editPopover: (popover: any, isOpen?: boolean) => void;
-export {};
+/**
+ * Check if the selected content in the popover has changed. Ignores cases going to or coming from `undefined`, as this indicates setup or teardown of the popover rather than a change in selection.
+ * @param newSelectedContent new selected content
+ * @param oldSelectedContent old selected content
+ * @returns true if the selected content has changed, false otherwise
+ */
+export declare const popoverSelectedContentHasChanged: (newSelectedContent: IntervalPopoverProps | string[] | string | undefined, oldSelectedContent: IntervalPopoverProps | string[] | string | undefined) => boolean;