@arcgis/charts-components 5.0.0-next.13 → 5.0.0-next.131

package/dist/model/shared/type-guards.d.ts

@@ -1,6 +1,26 @@
-import { WebChart } from '../../spec';
-import { BarChartModel, BoxPlotModel, ChartModel, HistogramModel, LineChartModel, ModelOfType, ModelTypes, PieChartModel, ScatterplotModel, SerialChartModel } from '..';
-import { ModelWithBasicXAxis, ModelWithDataLabels, ModelWithGuides, ModelWithLegend, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithYGuides, ModelWithMultiAxes } from '../mixins/index';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+import { HeatChartModel } from '../heat-chart-model/heat-chart-model';
+import { BarChartModel } from '../bar-chart-model/bar-chart-model';
+import { BoxPlotModel } from '../box-plot-model/box-plot-model';
+import { ChartModel } from '../chart-model/chart-model';
+import { ComboBarLineChartModel } from '../combo-bar-line-chart-model/combo-bar-line-chart-model';
+import { GaugeModel } from '../gauge-model/gauge-model';
+import { HistogramModel } from '../histogram-model/histogram-model';
+import { ModelTypes, ModelOfType } from '../interfaces/common';
+import { LineChartModel } from '../line-chart-model/line-chart-model';
+import { PieChartLegendModel } from '../pie-chart-model/pie-chart-legend-model';
+import { PieChartModel } from '../pie-chart-model/pie-chart-model';
+import { ScatterplotModel } from '../scatterplot-model/scatterplot-model';
+import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
+import { WebChart } from '../../spec/web-chart';
+import { ModelWithMultiAxes } from '../mixins/model-with-multi-axes';
+import { ModelWithLineMarkerStyling } from '../mixins/model-with-line-marker-styling';
+import { ModelWithTooltips } from '../mixins/model-with-tooltips';
+import { ModelWithGuides } from '../mixins/model-with-guides';
+import { ModelWithXGuides } from '../mixins/model-with-x-guides';
+import { ModelWithYGuides } from '../mixins/model-with-y-guides';
+import { ModelWithLegend } from '../mixins/model-with-legend';
+import { ModelWithTemporalBinning } from '../mixins/model-with-temporal-binning';
 /**
  * Determines if the provided model or config is a `ChartModel`.
  * @param model The model to check.
@@ -10,59 +30,69 @@ export declare function isChartModel(model: ChartModel | WebChart | undefined):
  * Determines if the provided `model` is of type `BarChartModel`.
  * @param model The model to check.
  */
-export declare function isBarChartModel(model: ChartModel | undefined): model is BarChartModel;
+export declare function isBarChartModel(model: ChartModelBase | undefined): model is BarChartModel;
 /**
  * Determines if the provided `model` is of type `LineChartModel`.
  * @param model The model to check.
  */
-export declare function isLineChartModel(model: ChartModel | undefined): model is LineChartModel;
+export declare function isLineChartModel(model: ChartModelBase | undefined): model is LineChartModel;
+/**
+ * Determines if the provided `model` is of type `ComboBarLineChartModel`.
+ * @param model The model to check.
+ */
+export declare function isComboBarLineChartModel(model: ChartModelBase | undefined): model is ComboBarLineChartModel;
 /**
  * Determines if the provided `model` is of type `SerialChartModel`.
  * This includes LineSeries, BarSeries, ComboLineAndBarSeries, and RadarSeries.
  * @param model The model to check.
  */
-export declare function isSerialChartModel(model: SerialChartModel | undefined): model is SerialChartModel;
+export declare function isSerialChartModel(model: ChartModelBase | undefined): model is SerialChartModel;
 /**
  * Determines if the provided `model` is of type `PieChartModel`.
  * @param model The model to check.
  */
-export declare function isPieChartModel(model: ChartModel | undefined): model is PieChartModel;
+export declare function isPieChartModel(model: ChartModelBase | undefined): model is PieChartModel;
 /**
  * Determines if the provided `model` is of type `BoxPlotModel`.
  * @param model The model to check.
  */
-export declare function isBoxPlotModel(model: ChartModel | undefined): model is BoxPlotModel;
+export declare function isBoxPlotModel(model: ChartModelBase | undefined): model is BoxPlotModel;
 /**
  * Determines if the provided `model` is of type `ScatterplotModel`.
  * @param model The model to check.
  *
  */
-export declare function isScatterplotModel(model: ChartModel | undefined): model is ScatterplotModel;
+export declare function isScatterplotModel(model: ChartModelBase | undefined): model is ScatterplotModel;
 /**
  * Determines if the provided `model` is of type `HistogramModel`.
  * @param model The model to check.
  */
-export declare function isHistogramModel(model: ChartModel | undefined): model is HistogramModel;
+export declare function isHistogramModel(model: ChartModelBase | undefined): model is HistogramModel;
 /**
- * Type guard for ModelWithBasicXAxis
- * @param model
+ * Determines if the provided `model` is of type `HeatChartModel`.
+ * @param model The model to check.
  */
-export declare function isModelWithBasicXAxis(model: ChartModel | undefined): model is ModelWithBasicXAxis;
+export declare function isHeatChartModel(model: ChartModelBase | undefined): model is HeatChartModel;
+/**
+ * Determines if the provided `model` is of type `GaugeModel`.
+ * @param model The model to check.
+ */
+export declare function isGaugeModel(model: ChartModelBase | undefined): model is GaugeModel;
 /**
  * Type guard for ModelWithMultiAxes
  * @param model
  */
 export declare function isModelWithMultiAxes(model: ChartModel | undefined): model is ModelWithMultiAxes;
 /**
- * Type guard for ModelWithRotation
+ * Type guard for ModelWithLineMarkerStyling
  * @param model
  */
-export declare function isModelWithRotation(model: ChartModel | undefined): model is ModelWithRotation;
+export declare function isModelWithLineMarkerStyling(model: ChartModel | undefined): model is ModelWithLineMarkerStyling;
 /**
- * Determines if the provided `model` is of type `ModelWithDataLabels`.
- * @param model The model to check.
+ * Type guard for ModelWithTooltips
+ * @param model
  */
-export declare function isModelWithDataLabels(model: ChartModel | undefined): model is ModelWithDataLabels;
+export declare function isModelWithTooltips(model: ChartModel | undefined): model is ModelWithTooltips;
 /**
  * Determines if the provided `model` is of type `ModelWithGuides`.
  * @param model The model to check.
@@ -83,6 +113,11 @@ export declare function isModelWithYGuides(model: ChartModel | undefined): model
  * @param model The model to check.
  */
 export declare function isModelWithLegend(model: ChartModel | undefined): model is ModelWithLegend;
+/**
+ * Determines if the provided `model` is of type `PieChartLegendModel`.
+ * @param model The model to check.
+ */
+export declare function isPieChartLegendModel(model: ChartModel | undefined): model is PieChartLegendModel;
 /**
  * Determines if the provided `model` is of type `ModelWithTemporalBinning`.
  * @param model The model to check.

package/dist/model/shared/utils.d.ts

@@ -1,7 +1,10 @@
-import { IField, SupportedLayer, WebChart, WebChartAxis, WebChartGaugeAxis } from '../../spec';
+import { SupportedLayer } from '../../interfaces';
+import { IField, WebChart, WebChartAxis, WebChartGaugeAxis, WebHeatChart } from '../../spec';
+import { ChartConfig } from '../../utils';
 import { LayerInfo, SplitByFieldInfos } from '../interfaces/common';
 /**
- * Returns the necessary information for building series based on a split-by field
+ * Returns the necessary information for building series based on a split-by field.
+ *
  * @param props.config The chart config
  * @param props.layer The layer instance
  * @param props.layerFieldsInfo Fields Information of the layer
@@ -22,22 +25,34 @@ export declare function getSplitByFieldInfos(props: {
 export declare function isWebGaugeChartAxis(params: WebChartAxis[] | [WebChartGaugeAxis] | undefined): params is [WebChartGaugeAxis];
 export declare function isValidSplitByField(layerFieldsInfo: IField[], splitByField: string): boolean;
 export declare function isValidNumericFields(layerFieldsInfo: IField[], numericFields: string[]): boolean;
+type AbstractConstructor = abstract new (...args: any) => any;
+export type MixinInstances<T extends readonly AbstractConstructor[]> = T extends readonly [infer H, ...infer R] ? H extends AbstractConstructor ? R extends readonly AbstractConstructor[] ? InstanceType<H> & MixinInstances<R> : InstanceType<H> : unknown : unknown;
 /**
- * This function applies mixins to a class. [source](https://www.typescriptlang.org/docs/handbook/mixins.html)
- * @param derivedCtor
- * @param constructors
+ * Runtime helper that copies prototype members from each mixin constructor onto the target.
+ *
+ * Accepts a readonly tuple so it lines up with the typed mixin lists used in MixinInstances.
+ *
+ * [source](https://www.typescriptlang.org/docs/handbook/mixins.html)
  */
-export declare function applyMixins(derivedCtor: any, constructors: any[]): void;
+export declare function applyMixins(derivedCtor: any, constructors: readonly AbstractConstructor[]): void;
 /**
- * Get the list of category's values or labels from the layer
- * @param {LayerInfo} props.layerInfo The layer information
- * @param {WebChart} props.config The chart configuration
- * @param {string} props.category The category
+ * Get the list of category's values or labels from the layer.
  *
- * @returns {Promise<string[]>}
+ * @param props.layerInfo The layer information
+ * @param props.config The chart configuration
+ * @param props.category The category
  */
 export declare function getCategoryLabels(props: {
     layerInfo: LayerInfo;
     config: WebChart;
     category: string;
 }): Promise<string[]>;
+/**
+ * Checks if the given chart config is a matrix heat chart.  A matrix heat chart is defined as a heat chart with
+ * both axes using a category value format.
+ *
+ * @param chartConfig The chart config
+ * @returns True if the chart is a matrix heat chart, false otherwise
+ */
+export declare function isMatrixHeatChart(chartConfig?: ChartConfig | WebHeatChart): boolean;
+export {};

package/dist/model.js

@@ -1,10 +1,10 @@
 import { M as i } from "./chunks/common.js";
-import { B as m, C as y, F as g, G as w, L as C, a as f, P as u, b, S as p, T as L, c as T } from "./chunks/common.js";
-import { s as r, t as s, u as n } from "./chunks/type-guards.js";
-import { a as B, e as P, i as S, g as x, b as W, r as v, h as G, l as K, m as D, p as F, j as H, k as O, q as R, n as A, o as E, d as X, f as Y, c as $ } from "./chunks/type-guards.js";
+import { B as m, C as y, F as g, G as C, H as w, L as f, a as u, P as L, b, S as p, T, c as S } from "./chunks/common.js";
+import { v as r, w as s, x as n } from "./chunks/type-guards.js";
+import { a as P, f as B, i as x, c as v, k as G, j as H, h as K, b as W, u as D, o as F, r as O, m as E, l as R, t as Y, n as $, p as j, q, s as A, e as X, g as z, d as I } from "./chunks/type-guards.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.13 */
+v5.0.0-next.131 */
 async function c(t) {
   const o = "config" in t ? r(t.config) : t.chartType;
   let a;
@@ -82,32 +82,36 @@ export {
   m as BoxPlotDataSortingKinds,
   y as ColorFormatKeys,
   g as FormatKeys,
-  w as GuideOrientation,
-  C as LineFormatKeys,
+  C as GuideOrientation,
+  w as HeatChartDataSortingKinds,
+  f as LineFormatKeys,
   i as ModelTypes,
-  f as PieChartDataModes,
-  u as PieChartDataSortingKinds,
+  u as PieChartDataModes,
+  L as PieChartDataSortingKinds,
   b as PieChartSlicesDisplay,
   p as SerialChartDataSortingKinds,
-  L as TextFormatKeys,
+  T as TextFormatKeys,
   c as createModel,
-  T as customSortString,
-  B as isBarChartModel,
-  P as isBoxPlotModel,
-  S as isChartModel,
-  x as isHistogramModel,
+  S as customSortString,
+  P as isBarChartModel,
+  B as isBoxPlotModel,
+  x as isChartModel,
+  v as isComboBarLineChartModel,
+  G as isGaugeModel,
+  H as isHeatChartModel,
+  K as isHistogramModel,
   W as isLineChartModel,
-  v as isModelOfType,
-  G as isModelWithBasicXAxis,
-  K as isModelWithDataLabels,
-  D as isModelWithGuides,
-  F as isModelWithLegend,
-  H as isModelWithMultiAxes,
-  O as isModelWithRotation,
-  R as isModelWithTemporalBinning,
-  A as isModelWithXGuides,
-  E as isModelWithYGuides,
+  D as isModelOfType,
+  F as isModelWithGuides,
+  O as isModelWithLegend,
+  E as isModelWithLineMarkerStyling,
+  R as isModelWithMultiAxes,
+  Y as isModelWithTemporalBinning,
+  $ as isModelWithTooltips,
+  j as isModelWithXGuides,
+  q as isModelWithYGuides,
+  A as isPieChartLegendModel,
   X as isPieChartModel,
-  Y as isScatterplotModel,
-  $ as isSerialChartModel
+  z as isScatterplotModel,
+  I as isSerialChartModel
 };

package/dist/spec/chart-object-literals.d.ts

@@ -134,6 +134,7 @@ export type WebChartCalendarBinningOffsetUnits = (typeof WebChartCalendarBinning
  */
 export declare const WebChartHeatChartHeatRulesTypes: {
     readonly Gradient: "gradient";
+    readonly Renderer: "renderer";
 };
 export type WebChartHeatChartHeatRulesTypes = (typeof WebChartHeatChartHeatRulesTypes)[keyof typeof WebChartHeatChartHeatRulesTypes];
 /**
@@ -212,17 +213,42 @@ export declare const WebChartOrderDataByTypes: {
     readonly Mean: "arcgis-charts-mean";
     readonly Median: "arcgis-charts-median";
     readonly Category: "arcgis-charts-category";
+    readonly MultiAxes: "arcgis-charts-multi-axes";
 };
 export type WebChartOrderDataByTypes = (typeof WebChartOrderDataByTypes)[keyof typeof WebChartOrderDataByTypes];
 /**
- * A data order option that the items are to be ordered either ascending or descending.
- * It can be used for any type of order, like by category, by mean, by median, etc.
+ * A data order option that allows the items to be ordered on both the x- and y-axes;
+ *
+ * For each axis, the order can be either a direction (ascending or descending) for all axis types;
+ * or a predefined list of labels when the axis is categorical.
+ *
+ * @remarks This order option is currently only used in heat charts.
+ */
+export interface WebChartMultiAxesDataOrder {
+    /**
+     * The type of order, which is two dimensional.
+     */
+    orderType: "arcgis-charts-multi-axes";
+    /**
+     * The direction of the order for the x axis. If the axis is categorical, this can also be a predefined list of labels.
+     */
+    orderByX?: string[] | WebChartSortOrderKinds;
+    /**
+     * The direction of the order for the y axis. If the axis is categorical, this can also be a predefined list of labels.
+     */
+    orderByY?: string[] | WebChartSortOrderKinds;
+}
+/**
+ * A data order option that allows the items to be ordered either ascending or descending.
+ * This option can be used for the following types of order: by category, by mean, by median, and by y value.
+ *
+ * @remarks This order option is currently not available for Heat charts.
  */
 export interface WebChartDirectionalDataOrder {
     /**
      * The type of order, eg by category, by mean, by median, or by y value.
      */
-    orderType: WebChartOrderDataByTypes;
+    orderType: "arcgis-charts-category" | "arcgis-charts-mean" | "arcgis-charts-median" | "arcgis-charts-y-value";
     /**
      * The direction of the order, either ascending or descending.
      */
@@ -238,7 +264,7 @@ export interface WebChartDirectionalDataOrder {
     preferLabel?: boolean;
 }
 /**
- * A data order option for the items to be ordered by `category` based on a predefined list of labels.
+ * A data order option that allows the items to be ordered by `category` based on a predefined list of labels.
  */
 export interface WebChartPredefinedLabelsDataOrder {
     /**
@@ -286,3 +312,30 @@ export interface WebChartOrderSeriesBy {
      */
     orderBy?: WebChartSortOrderKinds;
 }
+/**
+ * Represents the different types of views that can be applied to a heat chart.
+ */
+export declare const WebChartHeatChartViewTypes: {
+    /**
+     * A single calendar view showing all data in one calendar.
+     */
+    readonly singleCalendarView: "SingleCalendarView";
+    /**
+     * Multiple sequential calendar views (e.g., years).
+     */
+    readonly sequentialCalendarViews: "SequentialCalendarViews";
+};
+export type WebChartHeatChartViewTypes = (typeof WebChartHeatChartViewTypes)[keyof typeof WebChartHeatChartViewTypes];
+/**
+ * Class break types for data classification in charts.
+ */
+export declare const WebChartClassBreakTypes: {
+    readonly equalInterval: "equal-interval";
+    readonly quantile: "quantile";
+    readonly naturalBreaks: "natural-breaks";
+    readonly manual: "manual";
+};
+/**
+ * Class break types for data classification in charts.
+ */
+export type WebChartClassBreakTypes = (typeof WebChartClassBreakTypes)[keyof typeof WebChartClassBreakTypes];

package/dist/spec/data-source.d.ts

@@ -1,11 +1,5 @@
-import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer';
-import { default as SubtypeSublayer } from '@arcgis/core/layers/support/SubtypeSublayer';
 import { WebChartTemporalBinningUnits } from './chart-object-literals';
 import { Color, IExtent, ISimpleLineSymbol, ISymbol, SimpleFillSymbolStyle, SimpleLineSymbolStyle, SimpleMarkerSymbolStyle } from './rest-js-types';
-/**
- * Supported layer type for ArcGIS charts.
- */
-export type SupportedLayer = FeatureLayer | SubtypeSublayer;
 /**
  * JSON representation of the color object
  */

package/dist/spec/index.d.ts

@@ -1,7 +1,14 @@
+/** @public */
 export * from './web-chart.js';
+/** @public */
 export type * from './data-source.js';
+/** @public */
 export * from './chart-object-literals.js';
+/** @public */
 export * from './rest-js-object-literals.js';
+/** @public */
 export * from './config-defaults.js';
+/** @public */
 export * from './events.js';
+/** @public */
 export type * from './rest-js-types.js';

package/dist/spec/web-chart.d.ts

@@ -1,14 +1,14 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
-import { GaugeChartSubTypes, SizePolicyScaleTypes, WebChartCalendarDatePartsUnits, WebChartDataTransformations, WebChartDirectionalDataOrder, WebChartHeatChartHeatRulesTypes, WebChartLabelBehavior, WebChartLegendPositions, WebChartNullPolicyTypes, WebChartOrderSeriesBy, WebChartPredefinedLabelsDataOrder, WebChartRadarChartAxisLabelsOrientation, WebChartStackedKinds, WebChartTemporalBinningUnits, WebChartTimeAggregationTypes, WebChartTypes } from './chart-object-literals';
+import { GaugeChartSubTypes, SizePolicyScaleTypes, WebChartCalendarDatePartsUnits, WebChartClassBreakTypes, WebChartDataTransformations, WebChartDirectionalDataOrder, WebChartHeatChartHeatRulesTypes, WebChartHeatChartViewTypes, WebChartLabelBehavior, WebChartLegendPositions, WebChartMultiAxesDataOrder, WebChartNullPolicyTypes, WebChartOrderSeriesBy, WebChartPredefinedLabelsDataOrder, WebChartRadarChartAxisLabelsOrientation, WebChartStackedKinds, WebChartTemporalBinningUnits, WebChartTimeAggregationTypes, WebChartTypes } from './chart-object-literals';
 import { TimeIntervalInfo } from './data-source';
 import { RESTUnits } from './rest-js-object-literals';
 import { Color, IDrawingInfo, IEnvelope, IExtent, IFeatureLayer, IPoint, IPolygon, IPolygonWithCurves, IPolyline, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, IStatisticDefinition, ITextSymbol } from './rest-js-types';
+import { QueryMixin } from '@arcgis/core/rest/support/QueryMixin';
 /**
  * Version of the current specification.
  */
-export declare const WebChartCurrentVersion = "24.4.0";
+export declare const WebChartCurrentVersion = "25.0.0";
 /**
- * Stores information regarding a numeric conversion
+ * Stores information regarding a numeric conversion.
  */
 export interface ValueConversion {
     /**
@@ -412,7 +412,9 @@ export interface WebChartAxis {
     /**
      * The desired minimum distance between two adjacent axis ticks. The actual distance may fluctuate depending on the chart's size.
      * When not provided a default value is assigned according to the axis type and axis labels behavior.
-     * @remarks This property only applies for axes of an XYChart, not Gauge.
+     *
+     * **Note**: This property only applies for axes of an XYChart, not Gauge.
+     *
      * @minimum 1
      */
     tickSpacing?: number;
@@ -594,7 +596,7 @@ export interface WebChartQuery {
     /**
      * For spatial filters, this parameter defines the spatial relationship to filter features in the layer view against the filter geometry.
      */
-    spatialRelationship?: __esri.Query["spatialRelationship"];
+    spatialRelationship?: QueryMixin["spatialRelationship"];
     /**
      * Specifies a search distance for the `geometry`. To be associated with the `units` property. For compatible layers only.
      */
@@ -627,14 +629,14 @@ export interface WebChartQuery {
      */
     fetchNullValues?: boolean;
     /**
-     * An array of objectIds of the features to be filtered.
+     * An array of objectIds or uniqueIds of the features to be filtered.
      */
-    objectIds?: number[];
+    objectIds?: (number | string)[];
 }
 /**
- * Subset of the WebChartQuery, used at the series level
+ * Subset of the `WebChartQuery`, used at the series level.
  *
- * @remarks The former `orderByFields` property is replaced by the `orderOptions` property of `WebChart`.
+ * **Note**: The former `orderByFields` property is replaced by the `orderOptions` property of `WebChart`.
  */
 export type WebChartSeriesQuery = Omit<WebChartQuery, "distance" | "gdbVersion" | "geometry" | "num" | "objectIds" | "orderByFields" | "spatialRelationship" | "start" | "timeExtent" | "units">;
 /**
@@ -761,6 +763,11 @@ interface WebChartTemporalBinningExtras {
     nullPolicy?: WebChartNullPolicyTypes;
 }
 export interface WebChartCalendarDatePartsBinning extends WebChartTemporalBinningBase {
+    /**
+     * Represents a unique string identifier for the CalendarDatePartsBinning object.
+     * For CalendarDatePartsBinning object, it is "calendarDateParts".
+     */
+    type: typeof WebChartTypes.CalendarDateParts;
     /**
      * Represents the unit to use to bin the data.
      */
@@ -1283,6 +1290,8 @@ export interface WebChartBoxPlotSeries extends WebChartSeries {
     type: typeof WebChartTypes.BoxPlotSeries;
     /**
      * Specifies the numeric field(s) used by the box plot series.
+     * @minLength 1
+     * @minItems 1
      */
     y: string[] | string;
     /**
@@ -1322,6 +1331,38 @@ export interface WebChartHeatChartGradient {
      */
     outsideRangeUpperColor?: Color;
 }
+/**
+ * JSON representation of the Heat chart - class breaks type
+ */
+export interface WebChartHeatChartHeatClassBreaks {
+    /**
+     * The number of classes breaks to be used for the heat chart.
+     *
+     * @default 5
+     */
+    breaksCount?: number;
+    /**
+     * The classification method to be used for the  heat chart.
+     */
+    classificationMethod?: WebChartClassBreakTypes;
+}
+/**
+ * JSON representation of the Heat chart empty cell configuration
+ */
+export interface WebChartHeatChartEmptyCell {
+    /**
+     * Specifies the text to use by the empty cells.
+     * If none is provided, the default `null` text will be used.
+     *
+     * @default `null`
+     */
+    text?: string;
+    /**
+     * Specifies the symbol to use by the empty cells.
+     * If none is provided, the default symbol will be used.
+     */
+    symbol?: ISimpleFillSymbol;
+}
 /**
  * JSON representation of the Heat chart series
  */
@@ -1354,23 +1395,14 @@ export interface WebChartHeatChartSeries extends WebChartSeries {
      * Specifies the details of the gradient rules for the heat chart.
      */
     gradientRules?: WebChartHeatChartGradient;
+    /**
+     * Specifies the details of the class breaks rules for the heat chart.
+     */
+    classBreaksRules?: WebChartHeatChartHeatClassBreaks;
     /**
      * Specifies how to display the empty cells, in terms of text and symbology.
      */
-    emptyCells?: {
-        /**
-         * Specifies the text to use by the empty cells.
-         * If none is provided, the default `null` text will be used.
-         *
-         * @default `null`
-         */
-        text?: string;
-        /**
-         * Specifies the symbol to use by the empty cells.
-         * If none is provided, the default symbol will be used.
-         */
-        symbol?: ISimpleFillSymbol;
-    };
+    emptyCells?: WebChartHeatChartEmptyCell;
 }
 export type WebChartRadarChartSeries = WebChartLineChartSeries<"radarSeries">;
 /**
@@ -1494,10 +1526,12 @@ export interface WebChart {
         series?: WebChartOrderSeriesBy;
         /**
          * How data for a chart should be ordered. It is recommended to use this property over its sibling `orderByFields` to order the chart data.
-         *
          * If not provided, the data will be displayed as it was retrieved from the server. No additional ordering will be applied.
+         *
+         * The WebChartDirectionalDataOrder and WebChartPredefinedLabelsDataOrder are applicable to all chart types except Heat chart.
+         * The WebChartMultiAxesDataOrder is specifically used for Heat chart.
          */
-        data?: WebChartDirectionalDataOrder | WebChartPredefinedLabelsDataOrder;
+        data?: WebChartDirectionalDataOrder | WebChartMultiAxesDataOrder | WebChartPredefinedLabelsDataOrder;
         /**
          * The orderByFields to be sent with the query when retrieving data for the chart.  It represents the desired sorting order of the output result from the server.
          *
@@ -1506,6 +1540,7 @@ export interface WebChart {
          * @example ["STATE_NAME DESC", "CITY_NAME ASC", "CITY_NAME"]
          *
          * In case both this property and its sibling `data` object are provided, the order of the chart elements are settled by the order instruction in the `data` property.
+         * This property is applicable to all chart types, but Heat chart.
          */
         orderByFields?: string[];
     };
@@ -1587,5 +1622,29 @@ export interface WebHeatChart extends WebChart, WebChartTemporalBinningExtras {
      * @minItems 1
      */
     series: WebChartHeatChartSeries[];
+    orderOptions?: Omit<WebChart["orderOptions"], "data" | "orderByFields"> & {
+        /**
+         * How data for a chart should be ordered.
+         *
+         * If not provided, the data will be displayed as it was retrieved from the server. No additional ordering will be applied.
+         */
+        data?: WebChartMultiAxesDataOrder;
+    };
+    /**
+     * Whether to hide entire rows or columns that are empty (i.e. contain no valid data).
+     * @default false
+     */
+    hideEmptyRowsAndColumns?: boolean;
+    /**
+     * The calendar view type for the heat chart.
+     *
+     * **NOTE**: This property is only applicable to the Calendar heat chart.
+     */
+    viewType?: WebChartHeatChartViewTypes;
+    /**
+     * Whether to include leap day (Feb. 29th) in queries
+     * @default false
+     */
+    includeLeapDay?: boolean;
 }
 export {};

package/dist/store.d.ts

@@ -39,12 +39,12 @@ declare const state: {
     timeBinningIntervalMap: {};
 };
 /**
- * Generates the min max axis key for the selected chart based on the axis type and logarithmic scale.
- * The key is used to fetch/store the min max axis related values in the state for the selected chart
+ * Generates the min/max axis key for the selected chart based on the axis type and logarithmic scale.
+ * The key is used to fetch/store the min/max axis related values in the state for the selected chart.
  *
- * @param {string} props.chartId - The selected chart id
- * @param {boolean} props.isXAxis - The axis type (`true` for x-axis, `false` for y-axis)
- * @param {boolean} props.isLogarithmic - The axis scale (`true` for logarithmic)
+ * @param props.chartId - The selected chart id
+ * @param props.isXAxis - The axis type (`true` for x-axis, `false` for y-axis)
+ * @param props.isLogarithmic - The axis scale (`true` for logarithmic)
  */
 export declare const generateAxisMinMaxKey: (props: {
     chartId: string;
@@ -52,26 +52,29 @@ export declare const generateAxisMinMaxKey: (props: {
     isLogarithmic: boolean;
 }) => string;
 /**
- * Deletes the min max axis key from the state for the selected chart
+ * Deletes the min/max axis key from the state for the selected chart.
  *
- * @param {AppState} appState - The current app state
+ * @param appState - The current app state
  */
 export declare const deleteMinMaxAxisKey: (appState: AppState) => void;
 /**
- * Gets the axes bound data for the selected chart
- * @param {AppState} appState - The current app state
- * @returns {TimeIntervalInfo | undefined} - The axes bound data map for the selected chart
+ * Gets the axes bound data for the selected chart.
+ *
+ * @param appState - The current app state
+ * @returns The axes bound data map for the selected chart
  */
 export declare const getTimeBinningForChart: (appState: AppState) => TimeIntervalInfo | undefined;
 /**
- * Sets the time binning interval for a specific chart
- * @param {AppState} appState - The current app state
- * @param {TimeIntervalInfo} timeBinning - The time binning interval to set
+ * Sets the time binning interval for a specific chart.
+ *
+ * @param appState - The current app state
+ * @param timeBinning - The time binning interval to set
  */
 export declare const setTimeBinningForChart: (appState: AppState, timeBinning: TimeIntervalInfo) => void;
 /**
- * Resets the time binning interval for a specific chart
- * @param {AppState} appState - The current app state
+ * Resets the time binning interval for a specific chart.
+ *
+ * @param appState - The current app state
  */
 export declare const resetTimeBinningForChart: (appState: AppState) => void;
 export default state;

package/dist/types/components.d.ts

@@ -1 +1,2 @@
-export * from "./stencil";
+/** @deprecated import from stencil.d.ts instead */
+export * from "./stencil.js";