@arcgis/charts-components 5.0.0-next.9 → 5.0.0-next.90

package/dist/model/heat-chart-model/utils/heat-chart-data.d.ts

@@ -1,7 +1,7 @@
-import { WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartLegendPositions } from '../../../spec';
+import { ISimpleFillSymbol, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartNullPolicyTypes, WebHeatChart, WebChartLegendPositions, WebChartStatisticType } from '../../../spec';
 import { ChartConfig } from '../../../utils';
 import { LayerInfo, ModelTypes } from '../../interfaces/common';
-type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
+type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebHeatChart>;
 /**
  * Sets the x field
  * @param xField The numeric field
@@ -9,7 +9,7 @@ type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
  * @param layerInfo The layer info
  */
 export declare const setXField: (props: {
-    xField?: string;
+    xField: string;
     config: HeatChartConfig;
     layerInfo: LayerInfo;
 }) => void;
@@ -17,13 +17,24 @@ export declare const setXField: (props: {
  * Gets the x field
  * @param config the heat chart config
  */
-export declare const getXField: (config: HeatChartConfig) => string | undefined;
+export declare const getXField: (config: HeatChartConfig) => string;
+/**
+ * Gets the hide empty rows and columns setting
+ * @param config The heat chart config
+ */
+export declare const getHideEmptyRowsAndColumns: (config: HeatChartConfig) => boolean | undefined;
+/**
+ * Sets the hide empty rows and columns setting
+ * @param config The heat chart config
+ * @param hideEmptyRowsAndColumns The hide empty rows and columns setting
+ */
+export declare const setHideEmptyRowsAndColumns: (config: HeatChartConfig, hideEmptyRowsAndColumns: boolean | undefined) => void;
 /**
  * Sets the heat rule type
  * @param config the chart config
- * @param heatRulesTypes the heat rules types
+ * @param heatRulesType the heat rules type
  */
-export declare const setHeatRulesType: (config: HeatChartConfig, heatRulesTypes?: WebChartHeatChartHeatRulesTypes) => void;
+export declare const setHeatRulesType: (config: HeatChartConfig, heatRulesType?: WebChartHeatChartHeatRulesTypes) => void;
 /**
  * Gets the heat rule type
  * @param config the chart config
@@ -47,7 +58,7 @@ export declare const getGradientRules: (config: HeatChartConfig) => WebChartHeat
  * @param layerInfo The layer info
  */
 export declare const setYField: (props: {
-    yField?: string;
+    yField: string;
     config: HeatChartConfig;
     layerInfo: LayerInfo;
 }) => void;
@@ -55,7 +66,7 @@ export declare const setYField: (props: {
  * Gets the y field
  * @param config the heat chart config
  */
-export declare const getYField: (config: HeatChartConfig) => string | undefined;
+export declare const getYField: (config: HeatChartConfig) => string;
 /**
  * Sets x binning
  * @param binning the x binning
@@ -78,6 +89,12 @@ export declare const setYTemporalBinning: (binning: WebChartCalendarDatePartsBin
  * @param config the heat chart config
  */
 export declare const getYTemporalBinning: (config: HeatChartConfig) => WebChartCalendarDatePartsBinning | undefined;
+/**
+ * Set the order by list in the config. The order by list is only used when the sort order kind is custom sort.
+ * @param values The order by values
+ * @param config The heat chart config
+ */
+export declare const setHeatChartOrderByList: (values: string[], config: HeatChartConfig) => void;
 /**
  * Sets the grid line width
  * @param width the grid line width
@@ -111,4 +128,59 @@ export declare const setLegendPosition: (position: WebChartLegendPositions, conf
  * @param config the heat chart config
  */
 export declare const getLegendPosition: (config: HeatChartConfig) => WebChartLegendPositions;
+/**
+ * Gets the numericField from the query
+ * @param config The heat chart config
+ */
+export declare const getNumericField: (config: HeatChartConfig) => string | undefined;
+/**
+ * Sets the numericField for the query
+ * @param field the field
+ * @param config The heat chart config
+ */
+export declare const setNumericField: (field: string, config: HeatChartConfig) => void;
+/**
+ * Gets the aggregationType from the query
+ * @param config the heat chart config
+ */
+export declare const getAggregationType: (config: HeatChartConfig) => "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile-continuous" | "percentile-discrete" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate";
+/**
+ * Sets the aggregationType for the query
+ * @param aggregationType the aggregation type
+ * @param config The heat chart config
+ */
+export declare const setAggregationType: (aggregationType: WebChartStatisticType, config: HeatChartConfig) => void;
+/**
+ * Gets the null policy
+ * @param config the heat chart config
+ */
+export declare const getNullPolicy: (config: HeatChartConfig) => WebChartNullPolicyTypes | undefined;
+/**
+ * Sets the null policy for the query
+ * @param nullPolicy the null policy
+ * @param config The heat chart config
+ */
+export declare const setNullPolicy: (nullPolicy: WebChartNullPolicyTypes | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the empty cell text
+ * @param config the heat chart config
+ */
+export declare const getEmptyCellText: (config: HeatChartConfig) => string | undefined;
+/**
+ * Sets the empty cell text
+ * @param text the text
+ * @param config The heat chart config
+ */
+export declare const setEmptyCellText: (text: string | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the empty cell symbol
+ * @param config the heat chart config
+ */
+export declare const getEmptyCellSymbol: (config: HeatChartConfig) => ISimpleFillSymbol | undefined;
+/**
+ * Sets the empty cell symbol
+ * @param symbol the symbol
+ * @param config The heat chart config
+ */
+export declare const setEmptyCellSymbol: (symbol: ISimpleFillSymbol | undefined, config: HeatChartConfig) => void;
 export {};

package/dist/model/interfaces/chart-interfaces.d.ts

@@ -1,6 +1,7 @@
 import { ChartConfig } from '../../utils';
-import { IFeatureLayer, SupportedLayer, WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
+import { IFeatureLayer, WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
 import { ModelTypes } from './common';
+import { SupportedLayer } from '../../interfaces';
 /**
  * Parameters for creating a chart model.
  */

package/dist/model/interfaces/common.d.ts

@@ -1,4 +1,5 @@
-import { IField, SupportedLayer, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '../../spec';
+import { SupportedLayer } from '../../interfaces';
+import { IField, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '../../spec';
 import { SupportedChartSeries } from '../../utils';
 import { BarChartModel } from '../bar-chart-model/bar-chart-model';
 import { BoxPlotModel } from '../box-plot-model/box-plot-model';
@@ -28,6 +29,12 @@ export declare const BoxPlotDataSortingKinds: {
     readonly customSort: "customSort";
 };
 export type BoxPlotDataSortingKinds = (typeof BoxPlotDataSortingKinds)[keyof typeof BoxPlotDataSortingKinds];
+export declare const HeatChartDataSortingKinds: {
+    readonly Asc: "Asc";
+    readonly Desc: "Desc";
+    readonly customSort: "customSort";
+};
+export type HeatChartDataSortingKinds = (typeof HeatChartDataSortingKinds)[keyof typeof HeatChartDataSortingKinds];
 export declare const PieChartDataSortingKinds: {
     readonly labelAsc: "labelAsc";
     readonly labelDesc: "labelDesc";

package/dist/model/mixins/model-with-baseline-stacking.d.ts

@@ -5,23 +5,17 @@ export declare abstract class ModelWithBaselineStacking extends ChartModel {
     protected _config: ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
     /**
      * Specify how negative values are treated in stacked series.
+     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
      * @param {number} seriesIndex - The index of the series.
-     *
-     * NOTE: If true, negative values will be stacked on the base line.
-     * If false, negative values will be stacked in relation to their previous values in the stack.
-     *
      * @default true
      * @returns {boolean}
      */
     isNegativeValuesStackedToBaseline(seriesIndex: number): boolean;
     /**
      * Specify how negative values are treated in stacked series.
-     * @param {boolean} props.stackedToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
-     *
-     * NOTE: If true, negative values will be stacked on the base line.
-     * If false, negative values will be stacked in relation to their previous values in the stack.
-     *
+     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
+     * @param {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
 }

package/dist/model/mixins/model-with-line-marker-styling.d.ts

@@ -74,8 +74,8 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isLineSmoothed(seriesIndex: number): boolean;
     /**
      * Specify whether line segments of the series should be smoothed.
-     * @param {boolean} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
     /**
@@ -86,12 +86,10 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
      */
     getConnectLines(seriesIndex: number): boolean | undefined;
     /**
-     * Specify the color of the filled area for line chart.
-     * @param {boolean | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
-     *
-     * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
-     *
+     * Specify whether to connect the lines when there's a gap in the data.
+     * **Note:** Can be overridden by the temporal data setting `nullPolicy`.
+     * @param {boolean | undefined} connect - Whether to connect the gap in the data
+     * @param {number} seriesIndex - The index of the series.
      */
     setConnectLines(connect: boolean | undefined, seriesIndex: number): void;
     /**
@@ -104,8 +102,8 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isAreaVisible(seriesIndex: number): boolean;
     /**
      * Specify whether the line series should show area.
-     * @param {boolean} props.visible - `true` if the line series should show area, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} visible - `true` if the line series should show area, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setAreaVisible(visible: boolean, seriesIndex: number): void;
     /**
@@ -118,23 +116,21 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isMarkerVisible(seriesIndex: number): boolean;
     /**
      * Indicate whether to show or hide the markers/bullets of the line series.
-     * @param {boolean} props.visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setMarkerVisible(visible: boolean, seriesIndex: number): void;
     /**
      * Specify the color of the filled area for line chart.
+     * **Note:** `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
      * @param {number} seriesIndex - The index of the series.
-     *
-     * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
-     *
      * @returns {Color | undefined}
      */
     getAreaColor(seriesIndex: number): Color | undefined;
     /**
      * Specify the color of the filled area for line chart.
-     * @param {Color | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {Color | undefined} color - The color of the filled area for line chart.
+     * @param {number} seriesIndex - The index of the series.
      */
     setAreaColor(color: Color | undefined, seriesIndex: number): void;
 }

package/dist/model/mixins/model-with-multi-axes.d.ts

@@ -103,6 +103,7 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     setAxisScrollbar(scrollbar: WebChartAxisScrollBar, axisIndex: number): void;
     /**
      * Gets the specified title text symbol. Contains styling information such as font, color, and symbol style.
+     * @param {number} axisIndex The index of the axis to get the title symbol for
      * @returns {WebChartTextSymbol | undefined}
      */
     getAxisTitleSymbol(axisIndex: number): WebChartTextSymbol | undefined;
@@ -149,9 +150,9 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     setGridLinesSymbol(linesSymbol: ISimpleLineSymbol | undefined, axisIndices?: number[]): void;
     /**
      * Get the default x-axis title text.
-     * @returns {Promise<string>}
+     * @returns {string}
      */
-    getDefaultXAxisTitleText(): Promise<string>;
+    getDefaultXAxisTitleText(): string;
     /**
      * Gets the display zero line setting for the specified axis.
      * @param axisIndex The index of the axis to get the display zero line for.
@@ -285,5 +286,5 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
      *
      * @returns {string}
      */
-    abstract generateYAxisTitle(): Promise<string> | string;
+    abstract generateYAxisTitle(): string;
 }

package/dist/model/mixins/utils/baseline-stacking.d.ts

@@ -2,25 +2,19 @@ import { ChartConfig } from '../../../utils';
 import { ModelTypes } from '../../interfaces/common';
 /**
  * Specify how negative values are treated in stacked series.
+ *  * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
  * @param {number} seriesIndex - The index of the series.
  * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
- * NOTE: If true, negative values will be stacked on the base line.
- * If false, negative values will be stacked in relation to their previous values in the stack.
- *
  * @default true
  * @returns {boolean}
  */
 export declare const isNegativeValuesStackedToBaseline: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Specify how negative values are treated in stacked series.
- * @param {boolean} props.stackedToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
- *
- * NOTE: If true, negative values will be stacked on the base line.
- * If false, negative values will be stacked in relation to their previous values in the stack.
- *
+ * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
+ * @param {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setNegativeValuesStackedToBaseline: (props: {
     stackNegativeValuesToBaseline: boolean;

package/dist/model/mixins/utils/line-marker-styling.d.ts

@@ -22,9 +22,9 @@ export declare const setMarkerSize: (newSize: number | undefined, seriesIndex: n
 export declare const isLineSmoothed: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Specify whether line segments of the series should be smoothed.
- * @param {boolean} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setLineSmoothed: (props: {
     smoothed: boolean;
@@ -42,9 +42,9 @@ export declare const setLineSmoothed: (props: {
 export declare const isAreaVisible: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Specify whether the line series should show area.
- * @param {boolean} props.visible - `true` if the line series should show area, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * @param {boolean} visible - `true` if the line series should show area, `false` otherwise.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setAreaVisible: (props: {
     visible: boolean;
@@ -62,9 +62,9 @@ export declare const setAreaVisible: (props: {
 export declare const isMarkerVisible: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Indicate whether to show or hide the markers/bullets of the line series.
- * @param {boolean} props.visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * @param {boolean} visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setMarkerVisible: (props: {
     visible: boolean;
@@ -73,21 +73,18 @@ export declare const setMarkerVisible: (props: {
 }) => void;
 /**
  * Specify the color of the filled area for line chart.
+ * **Note:** areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
  * @param {number} seriesIndex - The index of the series.
  * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
- * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
- *
  * @returns {Color | undefined}
  */
 export declare const getAreaColor: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => Color | undefined;
 /**
  * Specify the color of the filled area for line chart.
- * @param {Color | undefined} props.color - The color of the filled area for line chart.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
- *
- * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+ * **Note:** areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+ * @param {Color | undefined} color - The color of the filled area for line chart.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setAreaColor: (props: {
     color: Color | undefined;
@@ -98,17 +95,15 @@ export declare const setAreaColor: (props: {
  * Specify whether to connect the lines when there's a gap in the data.
  * @param {number} seriesIndex - The index of the series.
  * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
  * @returns {boolean | undefined}
  */
 export declare const getConnectLines: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean | undefined;
 /**
  * Specify whether to connect the lines when there's a gap in the data.
- * @param {boolean | undefined} props.connect - Whether to connect the gap in the data
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
- *
- * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
+ * **Note:** Can be overridden by the temporal data setting `nullPolicy`.
+ * @param {boolean | undefined} connect - Whether to connect the gap in the data
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setConnectLines: (props: {
     connect: boolean | undefined;

package/dist/model/pie-chart-model/pie-chart-model.d.ts

@@ -51,15 +51,17 @@ export declare class PieChartModel extends ChartModel {
     /**
      * Sets the sort order for the pie chart.
      * @param {PieChartDataSortingKinds} sortOrder The sort order.
+     * @param {string[]} orderByList The list of category values.
      */
     setSortOrder(sortOrder: PieChartDataSortingKinds, orderByList?: string[]): void;
+    /**
+     * List of category's values for custom sort
+     */
     get orderByList(): string[];
     set orderByList(orderByList: string[]);
     /**
      * The pie chart data mode (Category or Fields).
-     *
      * `category` - The chart is using values from the category field to determine each slice.
-     *
      * `fields` - The chart is using aggregated values from the numeric fields to determine each slice.
      */
     get mode(): PieChartDataModes;
@@ -124,6 +126,7 @@ export declare class PieChartModel extends ChartModel {
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Gets the original name of the slice based on the slice index.
+     * @param {number} sliceIndex - The index of the slice.
      * @returns {Date | number | string | null | undefined}
      */
     getOriginalSliceName(sliceIndex: number): Date | number | string | null | undefined;

package/dist/model/serial-chart-model/serial-chart-model.d.ts

@@ -2,7 +2,7 @@ import { SerialChartTypes } from '../../utils';
 import { ChartModel } from '../chart-model/chart-model';
 import { Color, WebChartDataFilters, WebChartNullCategory, WebChartStackedKinds, WebChartStatisticType } from '../../spec';
 import { SerialChartConfig } from '../interfaces/chart-interfaces';
-import { SerialChartDataSortingKinds } from '../interfaces/common';
+import { HeatChartDataSortingKinds, SerialChartDataSortingKinds } from '../interfaces/common';
 import { ModelWithColorMatch, ModelWithDataLabels, ModelWithLegend, ModelWithTooltips, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithYGuides, ModelWithMultiAxes } from '../mixins';
 export declare abstract class SerialChartModel extends ChartModel {
     /**
@@ -70,13 +70,13 @@ export declare abstract class SerialChartModel extends ChartModel {
      * Gets the sort order for the bar chart.
      * @returns {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}
      */
-    getSortOrder(): SerialChartDataSortingKinds;
+    getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
     /**
      * Sets the sort order for the bar chart.
-     * @param {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc"}  newSortOrder The new sort order.
+     * @param {"Asc" | "Desc" | "xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}  newSortOrder The new sort order.
      * @param {string[]} orderByList The list of category's values to order by.
      */
-    setSortOrder(newSortOrder: SerialChartDataSortingKinds, orderByList?: string[]): void;
+    setSortOrder(newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, orderByList?: string[]): void;
     /**
      * Gets the list of the category values for the chart.
      * @returns {string[]}
@@ -84,7 +84,7 @@ export declare abstract class SerialChartModel extends ChartModel {
     getCustomSortValues(): Promise<string[]>;
     /**
      * Sets the data filter for the bar chart.
-     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
+     * @param newDataFilter The new data filter.
      */
     setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
     /**
@@ -165,6 +165,10 @@ export declare abstract class SerialChartModel extends ChartModel {
     moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
     /**
      * The null category configuration of the bar chart.
+     *
+     * @requires the following to be set on the model for the null category to be applied:
+     * - `fetchNULLValues` to be set to `true` on the model.
+     * - `colorMatch` to be set to `false` on the model
      */
     get nullCategory(): WebChartNullCategory | undefined;
     set nullCategory(nullCategory: WebChartNullCategory | undefined);

package/dist/model/serial-chart-model/utils/serial-chart-data.d.ts

@@ -1,7 +1,7 @@
 import { WebChartStatisticType } from '../../../spec';
 import { ChartConfig, CommonStrings } from '../../../utils';
 import { SerialChartConfig } from '../../interfaces/chart-interfaces';
-import { LayerInfo, SerialChartDataSortingKinds } from '../../interfaces/common';
+import { HeatChartDataSortingKinds, LayerInfo, SerialChartDataSortingKinds } from '../../interfaces/common';
 /**
  * Generate default series value
  * @param {number | undefined } props.seriesIndex - The series index.
@@ -46,7 +46,7 @@ export declare const getNumericFields: (config: SerialChartConfig) => string[];
 /**
  * Gets the sort order kind.
  */
-export declare const getSortOrderKind: (config: ChartConfig) => SerialChartDataSortingKinds;
+export declare const getSortOrderKind: (config: ChartConfig) => HeatChartDataSortingKinds[] | SerialChartDataSortingKinds[];
 /**
  * Build a series array based on a list of numeric fields and aggregation type,
  * when the chart has no category field.

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

@@ -1,8 +1,23 @@
+import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
+import { IField, WebChartOrderDataByTypes, WebChartSortOrderKinds, WebChartStatisticType } from '../../spec';
 import { ChartConfig } from '../../utils';
-import { SupportedLayer, WebChartStatisticType } from '../../spec';
-import { PieChartDataModes, SerialChartDataSortingKinds } from '../interfaces/common';
 import { SerialChartConfig } from '../interfaces/chart-interfaces';
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
+import { HeatChartDataSortingKinds, PieChartDataModes, SerialChartDataSortingKinds } from '../interfaces/common';
+import { SupportedLayer } from '../../interfaces';
+/**
+ * Gets the sort order kind for serial charts.
+ * @param orderBy The order by value(s)
+ * @param orderType The order type value
+ * @returns
+ */
+export declare function getSerialChartSortOrderKind(orderBy: string[] | WebChartSortOrderKinds, orderType: Omit<WebChartOrderDataByTypes, "arcgis-charts-multi-axes">): SerialChartDataSortingKinds;
+/**
+ * Gets the sort order kind for heat charts.
+ * @param orderBy The order by value(s)
+ * @param orderType The order type value
+ * @returns
+ */
+export declare function getHeatChartSortOrderKind(orderBy: string[] | WebChartSortOrderKinds, orderType: Omit<WebChartOrderDataByTypes, "arcgis-charts-multi-axes">): HeatChartDataSortingKinds;
 /**
  * Get the sort order kind for the bar and line chart
  * @param {SerialChartConfig} config - the chart configuration
@@ -29,8 +44,9 @@ export declare const getOrderByList: (config: SerialChartConfig) => string[];
  * @param {SerialChartDataSortingKinds} newSortOrderKind - the new sort order kind
  * @param {ChartConfig} config - the chart configuration
  * @param {string[] | undefined} orderByList - the list of fields to order by
+ * @param {boolean | undefined} isYAxis - whether to set the sort order for y-axis (heat chart only)
  */
-export declare const setSortOrderKind: (newSortOrderKind: SerialChartDataSortingKinds, config: ChartConfig, orderByList?: string[]) => void;
+export declare const setSortOrderKind: (newSortOrderKind: HeatChartDataSortingKinds | SerialChartDataSortingKinds, config: ChartConfig, orderByList?: string[], isYAxis?: boolean) => void;
 /**
  * Gets the x-axis field.
  * @param {ChartConfig} config - The chart config.
@@ -47,6 +63,10 @@ export declare const getXAxisField: (config: ChartConfig) => string;
  * @param {WebChartStatisticType} props.aggregationType - The type of aggregation to apply to the numeric fields.
  * @param {PieChartDataModes} [props.mode] - [Optional] The mode for pie chart data, if applicable.
  * @param {FeatureLayerView | SupportedLayer} [props.layer] - [Optional] The layer from which the data is being queried.
+ * @param {number} [props.numericFieldIndex] - [Optional] The index of the numeric field to use when multiple fields are available.
+ * @param {number} [props.seriesIndex] - [Optional] The index of the series being configured, useful when multiple series exist.
+ * @param {string} [props.splitByField] - [Optional] The field used to split the data into multiple series.
+ * @param {IField[]} [props.fieldList] - [Optional] List of fields to use instead of fetching them from the layer.
  *
  * @returns {Object} An object containing the name and description for the series.y field.
  */
@@ -60,11 +80,49 @@ export declare const getYForNewSeries: (props: {
     numericFieldIndex?: number;
     seriesIndex?: number;
     splitByField?: string;
+    fieldList?: IField[];
 }) => {
     name: string;
     description: string;
 };
+/**
+ * Determines if the x-axis field is considered "empty" for chart from fields scenarios.
+ *
+ * An x-axis field is considered empty when:
+ * - the x-axis field is not defined, or
+ * - the x-axis field is an empty string, or
+ * - the x-axis field does not match any of the layer fields
+ * - the x-axis field is set to the default "from fields" variation name
+ *
+ * @param {string} props.fieldName - The field used for the x-axis.
+ * @param {IField[]} props.fieldList - list of fields to use instead of fetching them from the layer
+ *
+ * @returns {boolean} True if the x-axis field is empty, otherwise false.
+ */
+export declare function xAxisFieldIsEmpty(props: {
+    fieldName: string;
+    fieldList: IField[];
+}): boolean;
 /**
  * Determines if the chart should be built as a "chart from fields" based on the x-axis field and numeric fields.
+ *
+ * This is true when `xAxisFieldIsEmpty` returns true, meaning:
+ * - the x-axis field is not defined, or
+ * - the x-axis field is an empty string, or
+ * - the x-axis field does not match any of the layer fields
+ * - the x-axis field is set to the default "from fields" variation name
+ *
+ * AND
+ *
+ * - there is at least one numeric field available (excluding objectId field)
+ *
+ * @param {string} props.fieldName - The field used for the x-axis.
+ * @param {string[]} props.numericFields - The list of numeric fields.
+ * @param {QueryObject} props.queryObject - the query object (feature layer or feature layer view)
+ * @param {IField[]} [props.fieldList] - list of fields to use instead of fetching them from the layer
  */
-export declare function shouldUseChartFromFields(xAxisField?: string, numericFields?: string[]): boolean;
+export declare function shouldUseChartFromFields(props: {
+    fieldName: string;
+    numericFields: string[];
+    fieldList: IField[];
+}): boolean;

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

@@ -1,6 +1,7 @@
 import { ChartConfig } from '../../utils';
-import { IFeatureLayer, SupportedLayer } from '../../spec';
+import { IFeatureLayer } from '../../spec';
 import { ModelOfType, ModelTypes } from '../interfaces/common';
+import { SupportedLayer } from '../../interfaces';
 declare namespace CreateModelPropsOptions {
     /**
      * Properties used by the `createModel` function to create a new model based on the provided `layer` and `chartType`.

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

@@ -1,5 +1,6 @@
-import { IField, SupportedLayer, WebChart, WebChartAxis, WebChartGaugeAxis } from '../../spec';
+import { IField, WebChart, WebChartAxis, WebChartGaugeAxis } from '../../spec';
 import { LayerInfo, SplitByFieldInfos } from '../interfaces/common';
+import { SupportedLayer } from '../../interfaces';
 /**
  * Returns the necessary information for building series based on a split-by field
  * @param props.config The chart config