@arcgis/charts-components 5.0.0-next.4 → 5.0.0-next.42

package/dist/json-schema/index.d.ts

@@ -1258,7 +1258,7 @@ export namespace WebChartJSONSchemas {
                 objectIds: {
                     type: string;
                     items: {
-                        type: string;
+                        type: string[];
                     };
                     description: string;
                 };
@@ -1666,7 +1666,7 @@ export namespace WebChartJSONSchemas {
                 objectIds: {
                     type: string;
                     items: {
-                        type: string;
+                        type: string[];
                     };
                     description: string;
                 };
@@ -2916,6 +2916,8 @@ export namespace WebChartJSONSchemas {
                         items?: undefined;
                     })[];
                     description: string;
+                    minLength: number;
+                    minItems: number;
                 };
                 fillSymbol: {
                     $ref: string;
@@ -6422,6 +6424,11 @@ export namespace WebChartJSONSchemas {
             required: string[];
             title: string;
         };
+        Layer: {
+            $ref: string;
+            description: string;
+            title: string;
+        };
         RGBObject: {
             type: string;
             properties: {
@@ -6630,6 +6637,10 @@ export namespace WebChartJSONSchemas {
                     $ref: string;
                     description: string;
                 };
+                serverLimitReached: {
+                    type: string;
+                    description: string;
+                };
             };
             required: string[];
             description: string;

package/dist/loader.js

@@ -2,9 +2,9 @@ import { r as e } from "./chunks/runtime.js";
 import { makeDefineCustomElements as t } from "@arcgis/lumina";
 /*! 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.4 */
+v5.0.0-next.42 */
 const o = t(e, {
-  "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,allowUsingObjectIdStat,autoDisposeChart,autoInverseDataLabelTextColor,chartIndex,chartLimits:,chartWillRender:,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableBetaFeatures,enableConfiguration,enableResponsiveFeatures,errorPolicy,featureIndex,filterByExtent,filterBySelection,gaugeInnerLabelFormatter:,guideTooltipFormatter:,hideEmptySeries,hideLicenseWatermark,hideLoaderAnimation,ignoreSmoothRenderingLimit,ignoreViewExtent,layer:,layerFieldsChangePolicy,layerFilterChangePolicy,layerItemId,layerRendererChangePolicy,legendPosition,legendValueLabelFormatter:,legendVisibility,loaderColors:,model:,nullAsValid,placeholder,queueChartCreation,replaceNoValueCategoryWithZero,returnFeaturesExtent,returnSelectionIndexes,returnSelectionOIDs,rotation,runtimeDataFilters:,secondaryYAxisLabelFormatter:,selectionData:,selectionTheme:,setTimeBinningInfoWhenNotProvided,showUIMessages,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,timeZone,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,errorAlert,exportAsCSV,exportAsImage,loadModel,notify,refresh,resetZoom,switchSelection"],
+  "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,allowUsingObjectIdStat,autoDisposeChart,autoInverseDataLabelTextColor,chartIndex,chartLimits:,chartWillRender:,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableBetaFeatures,enableConfiguration,enableResponsiveFeatures,errorPolicy,featureIndex,filterByExtent,filterBySelection,gaugeInnerLabelFormatter:,guideTooltipFormatter:,hideEmptySeries,hideLicenseWatermark,hideLoaderAnimation,ignoreSmoothRenderingLimit,ignoreViewExtent,layer:,layerFieldsChangePolicy,layerFilterChangePolicy,layerItemId,layerRendererChangePolicy,legendPosition,legendValueLabelFormatter:,legendVisibility,loaderColors:,messageOverrides:,model:,nullAsValid,placeholder,queueChartCreation,replaceNoValueCategoryWithZero,returnFeaturesExtent,returnSelectionIndexes,returnSelectionOIDs,rotation,runtimeDataFilters:,secondaryYAxisLabelFormatter:,selectionData:,selectionTheme:,setTimeBinningInfoWhenNotProvided,showUIMessages,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,timeZone,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,errorAlert,exportAsCSV,exportAsImage,loadModel,notify,refresh,resetZoom,switchSelection"],
   "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,disableCSVExportForChartTypes:,editChartState,editChartTitle,editChartToggle,expanded,exportActionState,exportAsCSVState,exportAsCSVTitle,exportAsImageState,exportAsImageTitle,filterByExtentState,filterByExtentTitle,filterByExtentToggle,filterBySelectionState,filterBySelectionTitle,filterBySelectionToggle,forceDisableActions,fullExtentState,fullExtentTitle,fullExtentToggle,hiddenActions:,legendState,legendTitle,legendToggle,messageOverrides:,rotateChartState,rotateChartTitle,rotateChartToggle,selectionState,selectionTitle,selectionToggle,switchSelectionState,switchSelectionTitle,switchSelectionToggle,zoomState,zoomTitle,zoomToggle"],
   "arcgis-charts-config-axes": [() => import("./components/arcgis-charts-config-axes/customElement.js"), "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,messageOverrides:,model:,open,showEnableXLogOption,showEnableYLogOption,showMaxXBoundOption,showMaxYBoundOption,showMinXBoundOption,showMinYBoundOption"],
   "arcgis-charts-config-axis": [() => import("./components/arcgis-charts-config-axis/customElement.js"), "axisTitle,dataMaxValue,dataMinValue,initialMaxBound,initialMinBound,isXAxis,maxBoundMaxLimit,maxBoundMinLimit,messageOverrides:,minBoundMaxLimit,minBoundMinLimit,model:,showEnableLogOption,showMaxBoundOption,showMinBoundOption"],

package/dist/model/box-plot-model/box-plot-model.d.ts

@@ -199,14 +199,12 @@ export declare class BoxPlotModel extends ChartModel {
     moveSeries(fromIndex: number, toIndex: number): void;
     /**
      * The index of the box plot series in the series array in config object when show mean is true.
-     *
-     * **NOTE**: There is only one box plot series when show mean is true. The function returns '-1' if show mean is false.
+     * **Note:** There is only one box plot series when show mean is true. The function returns '-1' if show mean is false.
      */
     get boxPlotSeriesIndexWhenMeanLinesShown(): number;
     /**
      * Move the custom sort values in-place for the order by list in the config.
-     *
-     * NOTE: This method should be only used when the sort order is set to `BoxPlotDataSortingKinds.customSort`.
+     * **Note:** This method should be only used when the sort order is set to `BoxPlotDataSortingKinds.customSort`.
      * @param {number} fromIndex The index to move the custom sort item from.
      * @param {number} toIndex The index to move the category item to.
      */

package/dist/model/box-plot-model/utils/box-plot-data.d.ts

@@ -133,6 +133,8 @@ export declare const setOrderByList: (values: string[], config: ChartConfig<type
  * @returns string[] - The custom sort values.
  */
 export declare const getCustomSortValues: (config: ChartConfig<typeof ModelTypes.BoxPlot>, layerInfo: LayerInfo) => Promise<string[]>;
+export declare const categoryIsEmpty: (category: string) => boolean;
+export declare const shouldClearSplitByField: (category: string, numericFields: string[]) => boolean;
 /**
  * Determines whether to use the split-by field based on the current category and numeric fields.
  */

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

@@ -77,8 +77,7 @@ export declare abstract class ChartModel extends EventTarget {
     set chartId(id: string | undefined);
     /**
      * Promise that resolves when the setup process is complete.
-     *
-     * **Note: This promise does not need to be awaited if the `setup` method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.**
+     * **Note:** This promise does not need to be awaited if the `setup` method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.
      */
     setupFinished: Promise<void>;
     /**
@@ -104,34 +103,25 @@ export declare abstract class ChartModel extends EventTarget {
     set descriptionText(description: string);
     /**
      * Whether or not the chart title is visible.
-     *
      * `true`: Chart title is visible.
-     *
      * `false`: Chart title is hidden.
-     *
-     * **Note: Even if the title is visible, it may not be displayed if the title text is empty.**
+     * **Note:** Even if the title is visible, it may not be displayed if the title text is empty.
      */
     get chartTitleVisibility(): boolean;
     set chartTitleVisibility(visibility: boolean);
     /**
      * Whether or not the chart subtitle is visible.
-     *
      * `true`: Chart subtitle is visible.
-     *
      * `false`: Chart subtitle is hidden.
-     *
-     * **Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.**
+     * **Note:** Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.
      */
     get chartSubtitleVisibility(): boolean;
     set chartSubtitleVisibility(visibility: boolean);
     /**
      * Whether or not the chart description is visible.
-     *
      * `true`: Description is visible.
-     *
      * `false`: Description is hidden.
-     *
-     * **Note: Even if the description is visible, it may not be displayed if the description text is empty.**
+     * **Note:** Even if the description is visible, it may not be displayed if the description text is empty.
      */
     get descriptionVisibility(): boolean;
     set descriptionVisibility(visibility: boolean);
@@ -168,16 +158,11 @@ export declare abstract class ChartModel extends EventTarget {
     getSeriesVisibility(seriesIndex: number): boolean;
     /**
      * Sets the visibility of a series.
-     * @param {boolean} props.visible
-     * @param {string} props.seriesId
-     * @param {OverlayTerms} props.overlayType
-     * @param {string} props.sliceId
-     * @param {WebChartDataItem} props.sliceData
+     * @param {LegendItemVisibility} props - Visibility options for the series.
      */
     setSeriesVisibility(props: LegendItemVisibility): void;
     /**
      * Gets the series ID for a given series index.
-     *
      * If the series index is out of bounds, this function will return `undefined`.
      *
      * @param {number} seriesIndex The index of the series.
@@ -186,10 +171,9 @@ export declare abstract class ChartModel extends EventTarget {
     getSeriesId(seriesIndex: number): string | undefined;
     /**
      * Gets the series index for a given series ID.
-     *
      * If the series ID is not found, this function will return `undefined`.
      *
-     * @param {string} seriesId
+     * @param {string} seriesId The ID of the series.
      * @returns {number | undefined}
      */
     getSeriesIndex(seriesId: string): number | undefined;
@@ -232,7 +216,8 @@ export declare abstract class ChartModel extends EventTarget {
      */
     getDataFilters(): WebChartDataFilters | undefined;
     /**
-     * Shared method for all chart types.
+     * Sets the data filter for the chart.
+     * @param {WebChartDataFilters | undefined} newDataFilters The new data filter.
      */
     setDataFilters(newDataFilters: WebChartDataFilters | undefined): Promise<void>;
     /**

package/dist/model/combo-bar-line-chart-model/combo-bar-line-chart-model.d.ts

@@ -23,6 +23,11 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
      * @category Private
      */
     protected initDefaultSeries(): void;
+    /**
+     * Changes the chart series type at the specified index from bar to line and vice-versa.
+     * @param {number} seriesIndex - The index of the series to update.
+     * @param {WebChartTypes} seriesType - The new chart series type to apply.
+     */
     setSeriesType(seriesIndex: number, seriesType: WebChartTypes): void;
     /**
      * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
@@ -32,10 +37,9 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
     /**
      * Sets the line style of the series based on the series index.
+     * **Note:** This method will only work if the series is a line chart series.
      * @param {RESTSimpleLineSymbolStyle | undefined} newStyle The new style for the series.
      * @param {number} seriesIndex The index of the series.
-     *
-     * **NOTE:** This method will only work if the series is a line chart series.
      */
     setSeriesLineStyle(newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number): void;
     /**
@@ -46,10 +50,9 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     getSeriesLineWidth(seriesIndex: number): number | undefined;
     /**
      * Sets the line width of the series based on the series index.
+     * **Note:** This method will only work if the series is a line chart series.
      * @param {number | undefined} newWidth The new width for the series.
      * @param {number} seriesIndex The index of the series.
-     *
-     * **NOTE:** This method will only work if the series is a line chart series.
      */
     setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
     /**
@@ -60,10 +63,9 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     getSeriesMarkerColor(seriesIndex: number): Color | undefined;
     /**
      * Sets the marker color of the series based on the series index.
+     * **Note:** This method will only work if the series is a line chart series.
      * @param {Color | undefined} newColor The new color for the series.
      * @param {number} seriesIndex The index of the series.
-     *
-     * **NOTE:** This method will only work if the series is a line chart series.
      */
     setSeriesMarkerColor(newColor: Color | undefined, seriesIndex: number): void;
     /**
@@ -74,10 +76,9 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     getSeriesMarkerStyle(seriesIndex: number): RESTSimpleMarkerSymbolStyle | undefined;
     /**
      * Sets the marker style of the series based on the series index.
+     * **Note:** This method will only work if the series is a line chart series.
      * @param {RESTSimpleMarkerSymbolStyle | undefined} newStyle The new style for the series.
      * @param {number} seriesIndex The index of the series.
-     *
-     * **NOTE:** This method will only work if the series is a line chart series.
      */
     setSeriesMarkerStyle(newStyle: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex: number): void;
     /**
@@ -88,10 +89,9 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     getSeriesMarkerSize(seriesIndex: number): number | undefined;
     /**
      * Sets the marker size of the series based on the series index.
+     * **Note:** This method will only work if the series is a line chart series.
      * @param {number | undefined} newSize The new size for the series.
      * @param {number} seriesIndex The index of the series.
-     *
-     * **NOTE:** This method will only work if the series is a line chart series.
      */
     setSeriesMarkerSize(newSize: number | undefined, seriesIndex: number): void;
     /**
@@ -104,10 +104,9 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     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.
-     *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * **Note:** This method will only work if the series is a line chart series.
+     * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      * @default false
      */
     setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
@@ -121,10 +120,9 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     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.
-     *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * **Note:** This method will only work if the series is a line chart 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;
     /**
@@ -137,49 +135,39 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     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.
-     *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * **Note:** This method will only work if the series is a line chart 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.
-     *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * **Note:** This method will only work if the series is a line chart 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;
     /**
      * 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:** This method will only work if the series is a line chart 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:** This method will only work if the series is a line chart series.
+     * @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;
     /**
@@ -193,7 +181,7 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
      * @param {boolean} hide The value for hiding oversized labels.
      * @param {number} seriesIndex The index of the series.
      *
-     * **NOTE:** This method will only work if the series is a bar chart series.
+     * **Note:** This method will only work if the series is a bar chart series.
      */
     setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
     /**
@@ -204,10 +192,9 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
     /**
      * Sets whether to hide oversized data labels of the stacked series based on the series index.
+     * **Note:** This method will only work if the series is a bar chart series.
      * @param {boolean} hide The value for hiding oversized stacked labels.
      * @param {number} seriesIndex The index of the series.
-     *
-     * **NOTE:** This method will only work if the series is a bar chart series.
      */
     setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
 }

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

@@ -1,4 +1,4 @@
-import { WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartHeatChartSeries, WebChartLegendPositions } from '../../spec';
+import { ISimpleFillSymbol, WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartNullPolicyTypes, WebChartStatisticType, WebChartLegendPositions } from '../../spec';
 import { ChartConfig } from '../../utils';
 import { ModelParams } from '../interfaces/chart-interfaces';
 import { LayerInfo, ModelTypes } from '../interfaces/common';
@@ -11,36 +11,101 @@ export declare class HeatChartModel extends SerialChartModel {
      * Current configuration used for the Heat chart.
      */
     protected _config: ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
-    /**
-     * Default series for the heat chart. Used in resetting the series styling.
-     * @category Protected
-     */
-    protected defaultSeries: WebChartHeatChartSeries | undefined;
     protected _chartType: "heatSeries";
     protected layerInfo: LayerInfo;
     setup(params: ModelParams<ChartConfig<typeof ModelTypes.HeatChart>>): Promise<void>;
-    get xField(): string | undefined;
-    set xField(xField: string | undefined);
-    get yField(): string | undefined;
-    set yField(yField: string | undefined);
+    /**
+     * The x axis field used by the heat chart
+     */
+    get xAxisField(): string;
+    set xAxisField(xField: string);
+    /**
+     * The y axis field used by the heat chart
+     */
+    get yAxisField(): string;
+    set yAxisField(yAxisField: string);
+    /**
+     * The x temporal binning used by the heat chart
+     */
     get xTemporalBinning(): WebChartCalendarDatePartsBinning | undefined;
     set xTemporalBinning(binning: WebChartCalendarDatePartsBinning | undefined);
+    /**
+     * The y temporal binning used by the heat chart
+     */
     get yTemporalBinning(): WebChartCalendarDatePartsBinning | undefined;
     set yTemporalBinning(binning: WebChartCalendarDatePartsBinning | undefined);
+    /**
+     * The grid line width used by the heat chart
+     */
     get gridLineWidth(): number | undefined;
     set gridLineWidth(width: number | undefined);
+    /**
+     * The grid line color used by the heat chart
+     */
     get gridLineColor(): number[] | undefined;
     set gridLineColor(color: number[] | undefined);
+    /**
+     * The name of the series that is used by the heat chart
+     */
     get seriesName(): string | undefined;
     set seriesName(seriesName: string | undefined);
+    /**
+     * The heat rules type used by the heat chart
+     */
     get heatRulesType(): WebChartHeatChartHeatRulesTypes | undefined;
     set heatRulesType(heatRulesTypes: WebChartHeatChartHeatRulesTypes | undefined);
+    /**
+     * The grandient rules used by the heat chart
+     */
     get gradientRules(): WebChartHeatChartGradient | undefined;
     set gradientRules(gradientRule: WebChartHeatChartGradient | undefined);
+    /**
+     * The numeric fields used by the heat chart. Only the first field in the array will be used.
+     * An empty string will be ignored.
+     */
+    get numericFields(): string[];
+    set numericFields(fields: string[]);
+    /**
+     * The aggregation type for the heat chart. Must be one of the values allowed by WebChartStatisticType.
+     */
+    get aggregationType(): WebChartStatisticType;
+    set aggregationType(aggregationType: WebChartStatisticType);
+    /**
+     * Split-by field is not used by heat chart
+     */
+    get splitByField(): string;
+    set splitByField(_: string);
+    /**
+     * The heat charts legend's title (not supported yet)
+     */
     set legendTitleText(_: string);
     get legendPosition(): WebChartLegendPositions;
+    /**
+     * The heat charts legend's position
+     */
     set legendPosition(position: WebChartLegendPositions);
+    /**
+     * The heat chart's rotatedState (not supported)
+     */
     set rotatedState(_: boolean);
+    get nullPolicy(): WebChartNullPolicyTypes | undefined;
+    /**
+     * The heat charts null policy
+     */
+    set nullPolicy(policy: WebChartNullPolicyTypes | undefined);
+    get emptyCellText(): string | undefined;
+    /**
+     * The heat charts empty cell text
+     */
+    set emptyCellText(text: string | undefined);
+    get emptyCellSymbol(): ISimpleFillSymbol | undefined;
+    /**
+     * The heat charts empty cell symbol
+     */
+    set emptyCellSymbol(symbol: ISimpleFillSymbol | undefined);
+    /**
+     * Generates the default config for the heat chart
+     */
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
 }
 export interface HeatChartModel extends ModelWithTooltips, ModelWithDataLabels {

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,7 +17,7 @@ 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;
 /**
  * Sets the heat rule type
  * @param config the chart config
@@ -47,7 +47,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 +55,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
@@ -111,4 +111,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/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;
 }