@arcgis/charts-components 5.0.0-next.10 → 5.0.0-next.101

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

@@ -1,7 +1,11 @@
-import { IFeatureLayer, IField, SupportedLayer, WebChart, WebChartDataFilters, WebChartQuery } from '../../spec';
 import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer.js';
-import { default as SubtypeGroupLayer } from '@arcgis/core/layers/SubtypeGroupLayer';
+import { default as SubtypeGroupLayer } from '@arcgis/core/layers/SubtypeGroupLayer.js';
 import { default as Renderer } from '@arcgis/core/renderers/Renderer';
+import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
+import { default as MapView } from '@arcgis/core/views/MapView.js';
+import { default as SceneView } from '@arcgis/core/views/SceneView.js';
+import { SupportedLayer } from '../../interfaces';
+import { IFeatureLayer, IField, WebChart, WebChartDataFilters, WebChartQuery } from '../../spec';
 import { IFeatureType, QueryObject, QueryObjectProps, RendererInfo, SubtypeInfo } from './interfaces';
 /**
  * Returns the renderer type and the field and normalization field if applicable.
@@ -33,12 +37,26 @@ export declare function fetchLayerFieldsInfo(queryObject: QueryObject, usePopupT
  */
 export declare function getFieldFromName(fieldName: string, fields?: IField[]): IField | undefined;
 /**
- * Look for an OID field among a list of feature layer fields.
- * The function `find` used can return in theory an `undefined` value, but in our case we're sure to bring back
- * the field ID (every feature layer has one).
- * As a consequence the backup value returned if `oidField.name` is `undefined` doesn't matter because it will not happen.
+ * Returns the unique ID fields or the object ID field of the given layer.
+ * Also return a boolean indicating whether the returned ID field is a traditional Object ID field.
+ * @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.
  */
-export declare function getObjectIdField(layerFieldsInfo: IField[]): string;
+export declare function getLayerUniqueIdOrObjectIdFields(layer?: SupportedLayer): {
+    idFields: string[] | undefined;
+    isTraditionalTypeOID: boolean;
+};
+/**
+ * Returns the object ID field of the given layer and a boolean indicating whether it is a traditional Object ID field.
+ * If the layer has unique ID fields defined, the first field is returned.
+ * @param layer - The layer
+ * @returns
+ */
+export declare function getObjectIdField(layer?: SupportedLayer): {
+    idField: string;
+    isTraditionalTypeOID: boolean;
+};
 /**
  * Checks whether the given field has a valid numeric type.
  * Fields descriptions are [here](http://resources.esri.com/help/9.3/ArcGISEngine/ArcObjects/esriGeoDatabase/esriFieldType.htm).
@@ -114,31 +132,23 @@ export declare function getFieldDescription(props: {
 }): string | undefined;
 /**
  * Returns feature layer field names used in its renderer.
- * @param {FeatureLayer} layer
- * @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
+ *
+ * @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
- * @param {FeatureLayer} layer
- * @returns {Promise<boolean>}
  */
 export declare function isStandardLayer(layer: SupportedLayer): Promise<boolean>;
 /**
  * Finds the matching field name for a given layer based on the fieldToMatch parameter.
- * @param {QueryObject} props.queryObject
- * @param {string} props.fieldToMatch
- * @param {boolean} props.returnUndefinedIfNotFound
- * @returns {Promise<string>}
  */
 export declare function findMatchingLayerFieldName(props: {
     queryObject: QueryObject;
@@ -146,12 +156,23 @@ export declare function findMatchingLayerFieldName(props: {
     returnUndefinedIfNotFound?: boolean;
 }): Promise<string>;
 /**
- * Finds the matching layer fields for a list of fields.
+ * Find the matching field in a list of fields based on the fieldToMatch parameter.
+ * It first looks for a perfect match (case-sensitive), then for an approximate match (case-insensitive).
  *
- * @param {(string[] | undefined)} props.fields
- * @param {SupportedLayer} props.queryObject
- * @param {boolean} props.returnUndefinedIfNotFound
- * @returns
+ * We look for a match in 2 steps:
+ *
+ * 1. Perfect match: the case of the fields is exactly the same. This helps when the layer has fields with the same name but with a
+ *    different case (e.g. "field" and "FiElD"). Refer to https://devtopia.esri.com/WebGIS/arcgis-charts/issues/8305
+ *
+ * 2: Approximate match: we upper-case the fields to compare them
+ *
+ * @param layerFieldList - The list of fields to search in.
+ * @param fieldToMatch - The field name to match.
+ * @returns The matching field if found, otherwise undefined.
+ */
+export declare function findMatchingField(layerFieldList: IField[], fieldToMatch: string): IField | undefined;
+/**
+ * Finds the matching layer fields for a list of fields.
  */
 export declare function matchFieldsList(props: {
     fieldsList: string[] | undefined;
@@ -161,12 +182,12 @@ export declare function matchFieldsList(props: {
 /**
  * Builds a WebChartQuery based on information coming from the runtime filters (chart options), the config and the data source.
  * The filters by attributes from all sources are all combined together (using the AND operator).
- * 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.queryObject The query object (feature layer or feature layer view)
- * @param props.chartConfig The chart's config
- * @param props.runtimeDataFilters The runtime data filters
- * @param props.ignoreViewExtent Whether to ignore the view extent
+ * 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.queryObject - The query object (feature layer or feature layer view)
+ * @param props.chartConfig - The chart's config
+ * @param props.runtimeDataFilters - The runtime data filters
+ * @param props.ignoreViewExtent - Whether to ignore the view extent
  */
 export declare function buildQueryConfig(props: {
     queryObject?: QueryObject;
@@ -176,30 +197,49 @@ export declare function buildQueryConfig(props: {
 }): WebChartQuery;
 /**
  * Ger the list of the fields used in the charts
- * @category Public
- *
  *
- * @param {WebChart[] | undefined} layer - the supported layer
- * @param {WebChart[] | undefined} chartList - List of charts stored in the layer
- *
- * @returns {Promise<string[]>} - The list of fields used in the charts
+ * @param layer - the supported layer
+ * @param chartList - List of charts stored in the layer
+ * @returns The list of fields used in the charts
  */
 export declare function getFieldsUsedInCharts(layer: SupportedLayer): Promise<string[]>;
 /**
  * Fetches the fields used in the chart configuration and returns the matching fields from the feature layer.
- * @param {ChartConfig} config The chart configuration
- * @param {SupportedLayer} layer The feature layer
  *
- * @returns {Promise<string[]>} The list of matching fields
+ * @param config - The chart configuration
+ * @param layer - The feature layer
+ * @returns The list of matching fields
  */
 export declare function extractFieldsUsedInConfig(config: WebChart, layer: SupportedLayer | undefined): Promise<string[]>;
 /**
  * Get the list of layer fields from the series list of the chart config.
- * @param {SupportedLayer} layer The layer
  *
- * @returns {string[]} The list of layer fields
+ * @param layer - The layer
+ * @returns The list of layer fields
  */
 export declare function extractFieldsFromConfigList(layer: SupportedLayer): Promise<string[]>;
+/**
+ * Finds the matching layer in the view based on the provided layer's portal item id.
+ * - The matching is done based on the portalItem id.
+ * - If no matching layer is found, returns `undefined`.
+ *
+ * @example
+ * ```ts
+ * const matchingLayer = findMatchingLayerFromView({ view, portalItemId: 'abc123' });
+ * ```
+ *
+ * @param props.view - The map or scene view
+ * @param props.portalItemId - The portal item id of the layer
+ * @returns The matching layer in the view or undefined if not found
+ *
+ * @requires
+ * - view
+ * - portalItemId
+ */
+export declare function findMatchingLayerFromView(props: {
+    view?: MapView | SceneView;
+    portalItemId: string;
+}): FeatureLayerView | SupportedLayer | undefined;
 export declare const layerPrivateFunctions: {
     getServerRestInfo: typeof getServerRestInfo;
     getSubtypeName: typeof getSubtypeName;

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

@@ -1,11 +1,13 @@
-import { RESTRendererType, WebChart, ICodedValue, SupportedLayer } from '../../spec';
+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';
 export interface QueryObjectProps {
     chartConfig: WebChart;
     layer?: FeatureLayerView | SupportedLayer;
     view?: MapView | SceneView;
+    filterByExtent?: boolean;
 }
 export interface RendererInfo {
     rendererType?: RESTRendererType;

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

@@ -1,6 +1,6 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
+import { default as AttributeBinsGraphic } from '@arcgis/core/AttributeBinsGraphic.js';
 import { default as AttributeBinsFeatureSet } from '@arcgis/core/rest/support/AttributeBinsFeatureSet.js';
-import { WebBoxPlot, WebChart, WebChartDataItem, WebChartQuery, WebChartTemporalBinning, WebHeatChart } from '../../../spec';
+import { WebChartDataItem, WebChartQuery, WebChartTemporalBinning, WebHeatChart } from '../../../spec';
 import { ErrorStrings } from '../../localization/interfaces';
 import { ChartSubType } from '../../misc/interfaces';
 import { QueryObject } from '../interfaces';
@@ -38,7 +38,7 @@ export declare function getQueryAttributeBinsForScatterplotFieldsAlias(x: string
  * @param props.errorStrings The t9n error strings
  */
 export declare function queryAttributeBinsForHeatChart(props: {
-    chartConfig: WebBoxPlot | WebChart | WebHeatChart;
+    chartConfig: WebHeatChart;
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
     errorStrings: ErrorStrings;
@@ -53,7 +53,7 @@ export declare function queryAttributeBinsForHeatChart(props: {
  * @param props.abortKey The key to abort the query
  */
 export declare function queryFeaturesForMatrixHeatChart(props: {
-    chartConfig: WebBoxPlot | WebChart | WebHeatChart;
+    chartConfig: WebHeatChart;
     queryObject: QueryObject;
     queryConfig: WebChartQuery;
     returnFeaturesExtent?: boolean;
@@ -140,7 +140,7 @@ export declare function queryUniqueIDs(props: {
     queryConfig: WebChartQuery;
     uniqueFeature?: boolean;
     abortKey?: AbortControllerKeyType;
-}): Promise<number[]>;
+}): 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.
@@ -169,4 +169,4 @@ export declare function queryAttributeBinsForTemporalData(props: {
     dateField: string;
     splitByField?: string;
     abortKey?: AbortControllerKeyType;
-}): Promise<__esri.AttributeBinsGraphic[]>;
+}): Promise<AttributeBinsGraphic[]>;

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

@@ -1,9 +1,10 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
 import { default as Geometry } from '@arcgis/core/geometry/Geometry';
+import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer.js';
+import { default as SubtypeSublayer } from '@arcgis/core/layers/support/SubtypeSublayer.js';
 import { default as AttributeBinsQuery } from '@arcgis/core/rest/support/AttributeBinsQuery.js';
-import { default as Query } from '@arcgis/core/rest/support/Query.js';
+import { QueryProperties, default as Query } from '@arcgis/core/rest/support/Query.js';
 import { default as TimeExtent } from '@arcgis/core/time/TimeExtent.js';
-import { SupportedLayer, WebChartHeatChartSeries, WebChartQuery, WebChartTemporalBinning, RESTFieldType } from '../../../spec';
+import { WebChartHeatChartSeries, WebChartQuery, WebChartTemporalBinning, RESTFieldType } from '../../../spec';
 import { QueryObject } from '../interfaces';
 /**
  * Indicates whether a query can be cached. It is not when:
@@ -11,8 +12,8 @@ import { QueryObject } from '../interfaces';
  * - a date filter is set
  * @param query The query object or query parameters
  */
-export declare function isQueryCacheable(query: __esri.QueryProperties | AttributeBinsQuery | Query): boolean;
-export declare function getMaxRecords(layer?: SupportedLayer): number;
+export declare function isQueryCacheable(query: AttributeBinsQuery | Query | QueryProperties): boolean;
+export declare function getMaxRecords(layer?: Pick<FeatureLayer, "sourceJSON"> | SubtypeSublayer): number;
 /**
  * Function building a where clause by concatenating a list of filters by using the AND operator.
  * @param filterList The list of filters to combine
@@ -74,11 +75,19 @@ export declare function mapAttributeBinsQueryForTemporalData(props: {
  * @param props.field The field used by the heat chart
  * @param props.fieldType The field type
  * @param props.unit The unit of the temporal binning
+ * @param props.addIntervalStatement Whether to add the interval statement to shift the date from the data time zone to the output time zone
+ * @param props.outTimeZone The output time zone
+ * @param props.dataTimeZone The data time zone
+ * @param props.runsOnClientQueryEngine Whether the query will be executed on the client query engine (FeatureLayerView) or on the server
  */
 export declare function getCalendarDatePartsParameters(props: {
     field: string;
     fieldType?: RESTFieldType;
     unit?: string;
+    addIntervalStatement: boolean;
+    outTimeZone?: string;
+    dataTimeZone?: string | null;
+    runsOnClientQueryEngine?: boolean;
 }): {
     expression?: string;
     start?: number;
@@ -137,7 +146,7 @@ export declare function mapQuery(props: {
     queryConfig?: WebChartQuery;
     maxRecordCountFactor?: number;
 }): Query;
-export declare function getMaxRecordCountFactor(layer?: SupportedLayer): number | undefined;
+export declare function getMaxRecordCountFactor(layer?: Pick<FeatureLayer, "sourceJSON"> | SubtypeSublayer): number | undefined;
 export declare const queryParserPrivateFunctions: {
     sanitizeOutFields: typeof sanitizeOutFields;
 };

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

@@ -1,9 +1,10 @@
-import { SupportedLayer, WebChart } from '../../../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 { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
+import { WebChart } from '../../../spec';
 import { QueryObject } from '../interfaces';
+import { SupportedLayer } from '../../../interfaces';
 /**
  * Indicates whether the input object is a feature collection.
  * @param queryObject
@@ -13,7 +14,7 @@ export declare function isFeatureCollectionLayer(queryObject: QueryObject): quer
  * Indicates whether the input object is an instance of `FeatureLayerView`.
  * @param queryObject
  */
-export declare function isFeatureLayerView(queryObject: QueryObject): queryObject is FeatureLayerView;
+export declare function isFeatureLayerView(queryObject: QueryObject | SubtypeGroupLayer): queryObject is FeatureLayerView;
 /**
  * Indicates whether the input object is an instance of `FeatureLayer`.
  * @param queryObject
@@ -28,7 +29,7 @@ export declare function isSubtypeGroupLayer(queryObject: QueryObject | SubtypeGr
  * Indicates whether the input object is an instance of `SubtypeSublayer`.
  * @param queryObject
  */
-export declare function isSubtypeSublayer(queryObject: QueryObject): queryObject is SubtypeSublayer;
+export declare function isSubtypeSublayer(queryObject: Pick<SubtypeSublayer, "type"> | QueryObject): queryObject is SubtypeSublayer;
 /**
  * Indicates whether the input object is an instance of `SupportedLayer` (`FeatureLayer` or `SubtypeSublayer`).
  * @param queryObject
@@ -41,8 +42,8 @@ export declare function isSupportedLayer(queryObject: QueryObject): queryObject
  *
  * @param layer
  */
-export declare function getMainLayer(layer: SupportedLayer): FeatureLayer | SubtypeGroupLayer;
-export declare function getMainLayer(layer: SupportedLayer | undefined): FeatureLayer | SubtypeGroupLayer | null | undefined;
+export declare function getMainLayer(layer: FeatureLayer | Pick<SubtypeSublayer, "parent" | "type">): FeatureLayer | SubtypeGroupLayer;
+export declare function getMainLayer(layer: FeatureLayer | Pick<SubtypeSublayer, "parent" | "type"> | undefined): FeatureLayer | SubtypeGroupLayer | null | undefined;
 /**
  * Indicates whether a layer supports queries with a `distance` parameter
  * @param layer The layer to test

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

@@ -3,27 +3,19 @@ import { ErrorStrings, LocaleInfo, UtilsStrings, SupportedLocalesForFormats } fr
 /**
  * Finds the locale info of the closest element to the given element.
  *
- * @param element The element to get the locale info from.
+ * @param element - The element to get the locale info from.
  */
 export declare function getLocaleInfo(element?: HTMLElement): LocaleInfo;
 /**
  * Converts the given `timeZone` from ArcGIS `MapView` to a valid time zone string.
- * @param {MapView["timeZone"] | undefined} timeZone
- * @returns {MapView["timeZone"] | undefined}
  */
 export declare function convertTimeZone(timeZone: MapView["timeZone"] | undefined): string | undefined;
 /**
  * Returns the date string in the Calcite date picker's expected format `YYYY-MM-DD` based on the given date and time zone.
- * @param {Date} date
- * @param {string} timeZone
- * @returns {string}
  */
 export declare function getDateStringInCalciteDatePickerFormat(date: Date, timeZone: string): string;
 /**
  * Returns the time string in the Calcite time picker's expected format `HH:mm` based on the given date and time zone.
- * @param {Date} date
- * @param {string} timeZone
- * @returns {string}
  */
 export declare function getTimeStringInCalciteTimePickerFormat(date: Date, timeZone: string): string;
 /**

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

@@ -170,7 +170,7 @@ export declare function getOverlayColorIndex(overlayType: OverlayTerms | undefin
  * @param props.config The config that gets updated for each series visibility
  * @param props.event The event that is currently being called
  */
-export declare function updateSeriesVisibility(event: CustomEvent<LegendItemVisibility>, config?: WebBoxPlot | WebChart): void;
+export declare function updateSeriesVisibility(event: Pick<CustomEvent<LegendItemVisibility>, "detail">, config?: WebBoxPlot | WebChart): void;
 /**
  * Sanitize an HTML string to prevent XSS attacks (https://owasp.org/www-community/attacks/xss/)
  * @param inputToSanitize The HTML string to sanitize
@@ -184,13 +184,6 @@ export declare function sanitizeHTMLOutput(inputToSanitize: string): string;
  *   - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isNaN
  */
 export declare function isValidNumber(value: WebChartDataItemValue): boolean;
-/**
- * Updates the chart rotation for a given WebChart config.
- * Returns the updated config.
- * @param newRotation new rotation
- * @param config the chart config
- */
-export declare function updateRotation<T extends WebBoxPlot | WebChart>(newRotation: boolean, config?: T): T | undefined;
 /**
  * Gets the sorting field or (sorting type for box-plot) and orderBy from an input string.
  * @param stringToParse The input string to parse, like `orderByField` of a query clause or `orderDataBy` property of a chart config.
@@ -203,34 +196,39 @@ export declare function getOrderByComponents(stringToParse: string, useDefault?:
 };
 /**
  * Gets the fields listed in the `orderByFields` property of a chart config.
- * @param {WebChart} chartConfig -  The chart config
- * @returns {string[]} The list of fields to sort by
+ *
+ * @param chartConfig -  The chart config
+ * @returns The list of fields to sort by
  */
 export declare function getOrderByFields(chartConfig: WebChart): string[];
 /**
  * Determines if certain chart subtype is a split by chart.
- * @param chartSubType The chart subtype
- * @returns true if the chart subtype is a split by chart, false otherwise
+ *
+ * @param chartSubType - The chart subtype
+ * @returns `true` if the chart subtype is a split by chart, `false` otherwise
  */
 export declare function isSplitByChart(chartSubType: ChartSubType): boolean;
 /**
  * Util function to know if the selection data changed.
  * The selection items and selection OIDs are compared, not the selection source nor the selection indexes.
- * @param selectionA The first selection data
- * @param selectionB The second selection data
+ *
+ * @param selectionA - The first selection data
+ * @param selectionB - The second selection data
  * @returns a boolean indicating whether the two selections are equal
  */
 export declare function hasSelectionChanged(selectionA?: SelectionData, selectionB?: SelectionData): boolean;
 /**
  * Indicates whether the selection data is empty.
- * @param selectionData The selection data to check
+ *
+ * @param selectionData - The selection data to check
  */
 export declare function isSelectionEmpty(selectionData: SelectionData | undefined): boolean;
 /**
- * Sorts arrayA based on the indexes of the elements in arrayB
- * @param {T[]} props.arrayA - The array to be sorted
- * @param {T[]} props.arrayB - The array to be used for sorting
- * @param {function} props.getKey - The function to get the key of an item
+ * Sorts `arrayA` based on the indexes of the elements in `arrayB`.
+ *
+ * @param props.arrayA - The array to be sorted
+ * @param props.arrayB - The array to be used for sorting
+ * @param props.getKey - The function to get the key of an item
  */
 export declare function sortArrayAUsingArrayB<T, K>(props?: {
     arrayA: T[];

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

@@ -1,4 +1,4 @@
-import { ISimpleFillSymbol, ISimpleMarkerSymbol, ISimpleLineSymbol, Color, WebChartDataItem, WebChartPieChartGroupSlice, WebChartPieChartSlice } from '../../spec';
+import { ISimpleFillSymbol, ISimpleMarkerSymbol, ISimpleLineSymbol, Color, WebChartDataItem, WebChartPieChartGroupSlice, WebChartPieChartSlice, WebChartHeatChartHeatRulesTypes } from '../../spec';
 export declare const ChartSubType: {
     readonly NonSpecific: "nonSpecific";
     readonly BarAndLineNoAggregation: "barAndLineNoAggregation";
@@ -32,7 +32,7 @@ export type SelectionIndexes = Map<number, {
 export interface SelectionData {
     selectionItems?: WebChartDataItem[];
     selectionIndexes?: SelectionIndexes;
-    selectionOIDs?: number[];
+    selectionOIDs?: (number | string)[];
     selectionSource?: SelectionSource;
 }
 export interface SelectionThemeProperties {
@@ -53,6 +53,18 @@ export interface LoaderColors {
     curtainColor?: Color;
     spinnerColor?: Color;
 }
+export interface HeatSeriesColorChangePayload {
+    heatRulesType: WebChartHeatChartHeatRulesTypes | undefined;
+    seriesColors: HeatSeriesColorChangePayloadClassSymbols[] | HeatSeriesColorChangePayloadGradient | undefined;
+}
+export interface HeatSeriesColorChangePayloadGradient {
+    startColor: readonly [number, number, number, number];
+    endColor: readonly [number, number, number, number];
+}
+export type HeatSeriesColorChangePayloadClassSymbols = {
+    label: string;
+    symbol: ISimpleFillSymbol;
+};
 export type BoxPlotSymbols = {
     fillSymbol?: ISimpleFillSymbol;
 } | {

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

@@ -0,0 +1,13 @@
+import { WebBoxPlot, WebChart, WebHeatChart } from '../../spec';
+/**
+ * Determines if the chart config is a heat chart configuration
+ * @param chartConfig The chart configuration object.
+ * @returns True if the chart config is a heat chart configuration, false otherwise.
+ */
+export declare function isHeatChartConfig(chartConfig?: WebChart): chartConfig is WebHeatChart;
+/**
+ * Determines if the chart config is a box plot chart configuration
+ * @param chartConfig The chart configuration object.
+ * @returns True if the chart config is a box plot chart configuration, false otherwise.
+ */
+export declare function isBoxPlotChartConfig(chartConfig?: WebChart): chartConfig is WebBoxPlot;

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

@@ -10,7 +10,8 @@ export type WebChartSeriesWithRotatedProp = WebChartSeries & {
     rotated?: boolean;
 };
 /**
- * Check if the chart config supports rotation or not
+ * Check if the chart config supports rotation or not.
+ *
  * @param config - the chart config
  */
 export declare function isRotationSupported(config: WebChart): config is WebChart & {
@@ -23,35 +24,31 @@ type WebChartSeriesWithStackedTypeProp = WebChartSeries & {
     stackedType?: WebChartStackedKinds;
 };
 /**
- * Check if the chart config supports rotation or not
+ * Check if the chart config supports rotation or not.
+ *
  * @param config - the chart config
  */
 export declare function isStackedTypeSupported(config: WebChart): config is WebChart & {
     series: WebChartSeriesWithStackedTypeProp[];
 };
 /**
- * Type guard for ISimpleFillSymbol
- * @param symbol
+ * Type guard for `ISimpleFillSymbol`
  */
 export declare function isSFS(symbol: any): symbol is ISimpleFillSymbol;
 /**
- * Type guard for ISimpleLineSymbol
- * @param symbol
+ * Type guard for `ISimpleLineSymbol`
  */
 export declare function isSLS(symbol: any): symbol is ISimpleLineSymbol;
 /**
- * Type guard for ISimpleMarkerSymbol
- * @param symbol
+ * Type guard for `ISimpleMarkerSymbol`
  */
 export declare function isSMS(symbol: any): symbol is ISimpleMarkerSymbol;
 /**
- * Type guard for WebChartTextSymbol
- * @param symbol
+ * Type guard for `WebChartTextSymbol`
  */
 export declare function isWebChartTextSymbol(symbol: any): symbol is WebChartTextSymbol;
 /**
  * Determines if the provided `config` has a `iLayer` property.
- * @param config
  */
 export declare function hasILayer<T extends ModelTypes>(config: ChartConfig<T> | undefined): config is ChartConfig<T, T extends "boxPlot" ? WebBoxPlot : T extends "gauge" ? WebGaugeChart : T extends "heatChart" ? WebHeatChart : WebChart>;
 export declare function hasILayer(config: WebChart | undefined): config is WebChart & {
@@ -59,66 +56,80 @@ export declare function hasILayer(config: WebChart | undefined): config is WebCh
 };
 /**
  * Determines if the provided `config` is the specified chart type `T`.
- * @param config The chart config to check.
- * @param chartType The chart type to check against.
+ *
+ * @param config - The chart config to check.
+ * @param chartType - The chart type to check against.
  */
 export declare function isChartType<T extends ChartConfig>(config: WebChart | undefined, chartType: ChartTypes | undefined): config is T;
 /**
  * Determines if the series is a box plot series.
- * @param series The series to check.
+ *
+ * @param series - The series to check.
  */
 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.
+ *
+ * @param series - The series to check.
  */
 export declare function isLineChartSeries(series: WebChartSeries | undefined): series is WebChartLineChartSeries;
+/**
+ * Determines if the series is a radar chart series.
+ *
+ * @param series - The series to check.
+ */
 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.
+ *
+ * @param series - The series to check.
  */
 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.
- * @returns {series is WebChartBarChartSeries[]}
+ * Type guard to check if the series is a `BarChartSeries`.
+ *
+ * @param series - The series to check.
  */
 export declare const isBarChartSeriesArray: (series: WebChartSeries[]) => series is WebChartBarChartSeries[];
 /**
- * Type guard to check if the series is a LineChartSeries.
- * @param {WebChartSeries[]} series - The series to check.
- * @returns {series is WebChartLineChartSeries[]}
+ * Type guard to check if the series is a `LineChartSeries`.
+ *
+ * @param series - The series to check.
  */
 export declare const isLineChartSeriesArray: (series: WebChartSeries[]) => series is WebChartLineChartSeries[];
 /**
- * Type guard to check if the series is a RadarChartSeries.
- * @param {WebChartSeries[]} series - The series to check.
- * @returns {series is WebChartLineChartSeries[]}
+ * Type guard to check if the series is a `RadarChartSeries`.
+ *
+ * @param series - The series to check.
  */
 export declare const isRadarChartSeriesArray: (series: WebChartSeries[]) => series is WebChartRadarChartSeries[];
 /**
  * Determines if the series array is of type box plot series.
- * @param series The series to check.
+ *
+ * @param series - The series to check.
  */
 export declare function isBoxPlotSeriesArray(series: WebChartSeries[]): series is WebChartBoxPlotSeries[];
 /**
- * Type guard for axis format being NumberFormatOptions
+ * Type guard for axis format being `NumberFormatOptions`
+ *
  * @param valueFormat - valueFormat to check
  */
 export declare function isNumberFormatOptions(valueFormat: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined): valueFormat is NumberFormatOptions;
 /**
- * Type guard for WebChartDataTypes being WebChartHistogramDataItem
+ * Type guard for `WebChartDataTypes` being `WebChartHistogramDataItem`.
+ *
  * @param data - dataItem to check
  */
 export declare function isWebChartHistogramDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartHistogramDataItem | undefined;
 /**
- * Type guard for WebChartDataTypes being WebChartGenericDataItem
+ * Type guard for `WebChartDataTypes` being `WebChartGenericDataItem`.
+ *
  * @param data - dataItem to check
  */
 export declare function isWebChartGenericDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartGenericDataItem | undefined;
 /**
- * Type guard for WebChartDataTypes being WebChartScatterplotDataItem
+ * Type guard for `WebChartDataTypes` being `WebChartScatterplotDataItem`.
+ *
  * @param data - dataItem to check
  */
 export declare function isWebChartScatterplotDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartScatterplotDataItem | undefined;