@arcgis/charts-components 5.1.0-next.8 → 5.1.0-next.80

package/dist/loader.js

@@ -1,8 +1,8 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
 import { r as e } from "./chunks/runtime.js";
 import { makeDefineCustomElements as t } from "@arcgis/lumina";
-const i = t(e, {
-  "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "_messages:,actionMode,allowUsingObjectIdStat,aria:,autoDestroyDisabled,autoDisposeChart,autoInverseDataLabelTextColor,chartIndex,chartLimits:,chartWillRender:,commonStrings:,cursorRange,dataLabelFormatter:,disableAutoTheming,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"],
+const o = t(e, {
+  "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "_messages:,actionMode,allowUsingObjectIdStat,aria:,autoDestroyDisabled,autoDisposeChart,autoInverseDataLabelTextColor,chartIndex,chartLimits:,chartWillRender:,commonStrings:,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableAutoTheming,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:,selectionManager:,selectionTheme:,setTimeBinningInfoWhenNotProvided,showUIMessages,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,syncViewSelection,timeZone,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,destroy,exportAsCSV,exportAsImage,loadModel,notify,refresh,resetZoom,switchSelection;applySelectionFromSelectionManager"],
   "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "_messages:,actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,commonStrings:,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"],
@@ -30,8 +30,8 @@ const i = t(e, {
   "arcgis-charts-config-guide-popover": [() => import("./components/arcgis-charts-config-guide-popover/customElement.js"), "messageOverrides:,open,placement,referenceElement:,selectedElement:;reposition"],
   "arcgis-charts-config-guides": [() => import("./components/arcgis-charts-config-guides/customElement.js"), "calculatedMinMaxBounds:,enableXAxisGuide,enableYAxisGuide,messageOverrides:,model:,open,timeZone"],
   "arcgis-charts-config-guides-type-popover": [() => import("./components/arcgis-charts-config-guides-type-popover/customElement.js"), "enableXAxisGuide,enableYAxisGuide,messageOverrides:,open,placement,referenceElement:;reposition"],
-  "arcgis-charts-config-heat-chart": [() => import("./components/arcgis-charts-config-heat-chart/customElement.js"), "chartData:,layer:,model:,page,usePopupTemplateFieldsInfo"],
-  "arcgis-charts-config-heat-chart-data": [() => import("./components/arcgis-charts-config-heat-chart-data/customElement.js"), "chartData:,layerFieldsInfo:,messageOverrides:,model:,open"],
+  "arcgis-charts-config-heat-chart": [() => import("./components/arcgis-charts-config-heat-chart/customElement.js"), "layer:,model:,page,usePopupTemplateFieldsInfo"],
+  "arcgis-charts-config-heat-chart-data": [() => import("./components/arcgis-charts-config-heat-chart-data/customElement.js"), "layerFieldsInfo:,messageOverrides:,model:,open"],
   "arcgis-charts-config-heat-chart-popover": [() => import("./components/arcgis-charts-config-heat-chart-popover/customElement.js"), "colorRamps:,contentKind,headingTitle,isFlipped,layerFieldsInfo:,messageOverrides:,model:,open,referenceElement:,selectedContent;reposition"],
   "arcgis-charts-config-histogram": [() => import("./components/arcgis-charts-config-histogram/customElement.js"), "calculatedMinMaxBounds:,chartData:,layer:,model:,page,seriesColor:,usePopupTemplateFieldsInfo"],
   "arcgis-charts-config-histogram-data": [() => import("./components/arcgis-charts-config-histogram-data/customElement.js"), "countValue,layerFieldsInfo:,maxValue,meanValue,medianValue,messageOverrides:,minValue,model:,nullsValue,open,selectedOverlaySymbolType,standardDevValue,sumValue"],
@@ -52,10 +52,10 @@ const i = t(e, {
   "arcgis-charts-config-scatter-plot": [() => import("./components/arcgis-charts-config-scatter-plot/customElement.js"), "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,r2,usePopupTemplateFieldsInfo"],
   "arcgis-charts-config-scatter-plot-data": [() => import("./components/arcgis-charts-config-scatter-plot-data/customElement.js"), "isTableLayer,layerFieldsInfo:,messageOverrides:,model:,r2"],
   "arcgis-charts-config-scatter-plot-popover": [() => import("./components/arcgis-charts-config-scatter-plot-popover/customElement.js"), "contentKind,headingTitle,layerFieldsInfo:,messageOverrides:,open,placement,referenceElement:,selectedContent;reposition"],
-  "arcgis-charts-config-select-chart-type-popover": [() => import("./components/arcgis-charts-config-select-chart-type-popover/customElement.js"), "headerTitle,layerId,messageOverrides:,open,popoverPlacement,referenceElement:,selectedModelType;reposition"],
+  "arcgis-charts-config-select-chart-type-popover": [() => import("./components/arcgis-charts-config-select-chart-type-popover/customElement.js"), "headerTitle,layerId,layerType,messageOverrides:,open,popoverPlacement,referenceElement:,selectedModelType;reposition"],
   "arcgis-charts-config-view-charts": [() => import("./components/arcgis-charts-config-view-charts/customElement.js"), "disableEditing,layer:,messageOverrides:,modelList:,noGroup,selectedChartId"],
-  "arcgis-charts-info-modal": [() => import("./components/arcgis-charts-info-modal/customElement.js"), "curtainColor:,heading,message,showErrorModalInfo,showLoader,spinnerColor:"]
+  "arcgis-charts-info-modal": [() => import("./components/arcgis-charts-info-modal/customElement.js"), "calciteThemeApplied,enableAutoTheming,heading,loaderColors:,message,showLoader"]
 });
 export {
-  i as defineCustomElements
+  o as defineCustomElements
 };

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

@@ -5,13 +5,15 @@ import type { ChartConfig } from "../../utils/types/index.js";
 
 export class BarChartModel extends SerialChartModel {
   /**
-   * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets whether to hide oversized data labels of the side-by-side series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
   /**
-   * Gets whether to hide oversized stacked labels of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets whether to hide oversized stacked labels of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
@@ -37,14 +39,13 @@ export class BarChartModel extends SerialChartModel {
    * Sets whether to hide oversized stacked labels of the series based on the series index.
    *
    * @param hide - The value for hiding oversized stacked labels.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. When not provided all the series will be updated.
    */
-  setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
+  setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex?: number): void;
   /**
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.BarChart>>): Promise<void>;
 }

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

@@ -26,17 +26,21 @@ export class BoxPlotModel extends BoxPlotModelSuperclass {
   /**
    * 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;
   /** The category field for the box plot. */
   accessor category: string;
-  /** The color of the boxes when showing mean lines. Only applicable when mean lines are shown. */
+  /**
+   * The color of the boxes when showing mean lines.
+   *
+   * Only applicable when mean lines are shown.
+   */
   accessor meanLinesBoxColor: Color | undefined;
   /** The numeric fields array for the box plot. */
   get numericFields(): string[];
   set numericFields(value: string[] | string);
-  /** The list of category's values for custom sort */
+  /** The list of category values for custom sort. */
   accessor orderByList: string[];
   /** The order of the series array by returning an array of series ids. */
   accessor orderOfSeries: string[];
@@ -107,9 +111,15 @@ export class BoxPlotModel extends BoxPlotModelSuperclass {
   /** Resets the series styling to the default styling. */
   resetSeriesStyling(): void;
   /**
-   * Sets the data filter for the bar chart.
+   * Sets the data filter for the box plot.
    *
    * @param newDataFilter - The new data filter.
+   * @example
+   * ```typescript
+   * chartModel.setDataFilters({
+   *    where: "population > 100000",
+   * });
+   * ```
    */
   setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
   /**
@@ -117,6 +127,10 @@ export class BoxPlotModel extends BoxPlotModelSuperclass {
    *
    * @param newColor - The new color for the series.
    * @param seriesIndex - The index of the series.
+   * @example
+   * ```typescript
+   * chartModel.setSeriesColor([100, 100, 100, 255], 1);
+   * ```
    */
   setSeriesColor(newColor: Color | undefined, seriesIndex: number): void;
   /**
@@ -155,14 +169,9 @@ export class BoxPlotModel extends BoxPlotModelSuperclass {
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.BoxPlot>>): Promise<void>;
-  /**
-   * Updates the series based on the layer filter.
-   *
-   * @async **This method is `async` and must be awaited for the changes to take effect.*
-   */
+  /** Updates the series based on the layer filter. */
   updateSeriesFromLayerFilter(): Promise<void>;
 }
 declare const BoxPlotModelSuperclass: typeof ChartModel & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText & typeof ModelWithYGuides & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithRotatedState & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes

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

@@ -27,7 +27,6 @@ export abstract class ChartModelBase extends EventTarget {
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params - The parameters to be used to set up the chart model.
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   abstract setup(params: ModelParams<ChartConfig>): Promise<void>;
   /** Can be awaited to allow any pending async updates to complete. */

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

@@ -9,56 +9,64 @@ import type { ChartConfig } from "../../utils/types/index.js";
 
 export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
   /**
-   * Specify the color of the filled area for line chart.
+   * Gets 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 seriesIndex - The index of the series.
    */
   getAreaColor(seriesIndex: number): Color | undefined;
   /**
-   * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets whether to hide oversized data labels of the side-by-side series based on the series index. '
+   *
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
   /**
-   * Gets whether to hide oversized data labels of the stacked series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets whether to hide oversized data labels of the stacked series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
   /**
-   * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the line style of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
   /**
-   * Gets the line width of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the line width of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesLineWidth(seriesIndex: number): number | undefined;
   /**
-   * Gets the marker color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the marker color of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesMarkerColor(seriesIndex: number): Color | undefined;
   /**
-   * Gets the marker size of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the marker size of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesMarkerSize(seriesIndex: number): number | undefined;
   /**
-   * Gets the marker style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the marker style of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesMarkerStyle(seriesIndex: number): RESTSimpleMarkerSymbolStyle | undefined;
   /**
-   * Specify whether the line series should show area.
+   * Indicate whether the area is visible for the line series.
    *
    * @param seriesIndex - The index of the series.
    */
@@ -84,7 +92,7 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    */
   setAreaColor(color: Color | undefined, seriesIndex: number): void;
   /**
-   * Specify whether the line series should show area.
+   * Specify whether the area should be visible for the line series.
    * **Note:** This method will only work if the series is a line chart series.
    *
    * @param visible - `true` if the line series should show area, `false` otherwise.
@@ -175,7 +183,6 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.ComboBarLineChart>>): Promise<void>;
 }

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

@@ -28,20 +28,32 @@ export class GaugeModel extends GaugeModelSuperclass {
   accessor endAngle: number;
   /**
    * Gets the index of the feature to be rendered.
-   * - This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
-   * - For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)
+   * - For statistic gauge, this property will be ignored.
+   * - For feature based gauge, if this property is not present, the first feature will be used (`featureIndex = 0`).
    */
   get featureIndex(): number | undefined;
   set featureIndex(value: number | null | undefined);
   /** Data field used for the gauge. */
   accessor field: string;
   /**
-   * Type of Gauge chart, like `FeatureGauge` and `StatisticGauge`.
+   * Type of gauge
+   * - `featureGauge` indicates that the gauge is based on a specific feature from the layer.
+   * - `statisticGauge` indicates that the gauge is based on a statistic value calculated from the layer's features.
    *
-   * **Note**: When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
+   * **Note**: When this property is not specified, it will be defaulted to `statisticGauge`.
    */
   get gaugeSubType(): GaugeChartSubTypes;
-  /** Content symbol for the inner label. */
+  /**
+   * Content symbol for the inner label.
+   *
+   * @example
+   * ```typescript
+   * gaugeModel.innerLabelContent = {
+   *   type: "esriTS",
+   *   text: "Inner label",
+   * };
+   * ```
+   */
   accessor innerLabelContent: WebChartTextSymbol | undefined;
   /** Whether the inner label is visible. */
   accessor innerLabelVisible: boolean;
@@ -57,7 +69,17 @@ export class GaugeModel extends GaugeModelSuperclass {
   accessor needleInnerRadius: number | null | undefined;
   /** Start width of the gauge's needle. */
   accessor needleStartWidth: number | null | undefined;
-  /** Symbol of the gauge's needle. */
+  /**
+   * Symbol of the gauge's needle.
+   *
+   * @example
+   * ```typescript
+   * gaugeModel.needleSymbol = {
+   *   type: "esriSFS",
+   *   color: [255, 0, 0, 255],
+   * };
+   * ```
+   */
   accessor needleSymbol: ISimpleFillSymbol | undefined;
   /** Visibility of the gauge's needle. */
   accessor needleVisibility: boolean;
@@ -69,13 +91,12 @@ export class GaugeModel extends GaugeModelSuperclass {
   accessor valueConversion: ValueConversion | undefined;
   /** Generate the proper chart title given the current config. */
   generateChartTitle(): string;
-  /** Removes the existing feature index from the config object */
+  /** Removes the existing feature index from the config object. */
   removeFeatureIndex(): void;
   /**
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.Gauge>>): Promise<void>;
 }

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

@@ -1,35 +1,46 @@
 import type { ModelParams } from "../interfaces/chart-interfaces.js";
 import type { ModelTypes, SerialChartDataSortingKinds, HeatChartDataSortingKinds } from "../interfaces/common.js";
 import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
+import type { SupportedRasterLayer } from "../../interfaces.js";
 import type { WebChartCalendarDatePartsBinning, WebChartHeatChartEmptyCell, WebChartHeatChartGradient, WebChartNullCategory } from "../../spec/web-chart.js";
 import type { WebChartStatisticType, WebChartClassBreakTypes, WebChartHeatChartHeatRulesTypes, WebChartHeatChartViewTypes, WebChartLegendPositions, WebChartNullPolicyTypes, WebChartStackedKinds } from "../../spec/chart-object-literals.js";
-import type { ISimpleFillSymbol } from "../../spec/rest-js-types.js";
+import type { ISimpleFillSymbol, ISimpleLineSymbol } from "../../spec/rest-js-types.js";
 import type { ChartConfig } from "../../utils/types/index.js";
 
 export class HeatChartModel extends SerialChartModel {
-  /** The aggregation type for the heat chart. Must be one of the values allowed by WebChartStatisticType. */
+  /** The aggregation type for the heat chart. */
   accessor aggregationType: WebChartStatisticType;
-  /** Bin temporal data for heat chart (not supported) */
+  /**
+   * Bin temporal data for heat chart (not supported)
+   *
+   * @internal
+   */
   accessor binTemporalData: boolean;
   /**
-   * The number of class breaks used by the heat chart
+   * The number of class breaks used by the heat chart.
    *
    * @default 5
    */
   accessor breaksCount: number;
-  /** The class breaks method used by the heat chart */
+  /**
+   * The classification method to be used for the heat chart.
+   * `equal-interval` - Divides the range of values into equal-sized intervals.
+   * `quantile` - Divides the range of values into intervals that contain an equal number of features.
+   * `natural-breaks` - Identifies natural groupings of values in the data by minimizing the variance within classes and maximizing the variance between classes.
+   * `manual` - Allows you to manually specify the class breaks.
+   */
   accessor classificationMethod: WebChartClassBreakTypes | undefined;
-  /** The heat charts empty cell config */
+  /** The heat chart's empty cell configuration. */
   accessor emptyCell: WebChartHeatChartEmptyCell | undefined;
-  /** The heat charts empty cell symbol */
+  /** The heat chart's empty cell symbol. */
   accessor emptyCellSymbol: ISimpleFillSymbol | undefined;
-  /** The heat charts empty cell text */
+  /** The heat chart's empty cell text. */
   accessor emptyCellText: string | undefined;
   /**
    * The first day of the week used for date-based bins.
    *
-   * - `1` = Monday
-   * - `7` = Sunday
+   * - `1`: Monday
+   * - `7`: Sunday
    */
   accessor firstDayOfWeek: number | undefined;
   /**
@@ -52,58 +63,102 @@ export class HeatChartModel extends SerialChartModel {
    * ```
    */
   accessor gradientRules: WebChartHeatChartGradient | undefined;
-  /** The grid line color used by the heat chart */
+  /** The grid line color used by the heat chart. */
   accessor gridLineColor: number[] | undefined;
-  /** The grid line width used by the heat chart */
+  /** The grid line width used by the heat chart. */
   accessor gridLineWidth: number | undefined;
-  /** The heat rules type used by the heat chart */
+  /**
+   * The heat rules type used by the heat chart.
+   * `gradient`: A gradient of colors is applied to the cells based on their values, with the range of colors determined by the minimum and maximum values in the data.
+   * `renderer`: A class break renderer is used to apply specific colors to cells based on defined value ranges, allowing for more customized visualizations.
+   */
   accessor heatRulesType: WebChartHeatChartHeatRulesTypes | undefined;
-  /** The hide empty rows and columns setting used by the heat chart */
+  /** Hide the empty rows and columns in the heat chart. */
   accessor hideEmptyRowsAndColumns: boolean | undefined;
-  /** The heat charts include leap day flag that is only honored when day of month is used */
+  /** Whether to include leap day (February 29) in the heat chart when using "day of month" temporal binning. */
   accessor includeLeapDay: boolean | undefined;
-  /** The heat charts legend's position */
+  /** The layer associated with the heat chart model. */
+  get layer(): Exclude<SerialChartModel["layer"], SupportedRasterLayer>;
+  /** The heat chart's legend position. */
   accessor legendPosition: WebChartLegendPositions;
   /**
    * The null category for heat chart (not supported)
    *
-   * @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
+   * @internal
    */
   accessor nullCategory: WebChartNullCategory;
-  /** The heat charts null policy */
-  accessor nullPolicy: WebChartNullPolicyTypes | 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.
+   * The heat chart's null policy.
+   * `null`: Treat null values as null.
+   * `zero`: Treat null values as zero.
    */
+  accessor nullPolicy: WebChartNullPolicyTypes | undefined;
+  /** Heat chart only supports one numeric field, if there are multiple numeric fields provided in the array, only the first one will be used and the rest will be ignored. */
   accessor numericFields: string[];
-  /** The heat chart's rotatedState (not supported) */
+  /**
+   * The heat chart's rotatedState (not supported)
+   *
+   * @internal
+   */
   accessor rotatedState: boolean;
-  /** The name of the series that is used by the heat chart */
+  /**
+   * The name of the series that is used by the heat chart.
+   *
+   * @internal
+   */
   accessor seriesName: string | undefined;
-  /** Split-by field is not used by heat chart */
+  /**
+   * Split-by field not supported for heat charts.
+   *
+   * @internal
+   */
   accessor splitByField: string;
-  /** The heat chart's stacked type (not supported) */
+  /**
+   * The heat chart's stacked type (not supported)
+   *
+   * @internal
+   */
   accessor stackedType: WebChartStackedKinds | undefined;
   /**
    * The calendar view type for the heat chart.
+   * `SingleCalendarView` - A single calendar view showing all data in one calendar.
+   * `SequentialCalendarViews` - Multiple sequential calendar views (e.g., years).
    *
-   * **NOTE**: This property is only applicable to the Calendar heat chart.
+   * **Note**: This is only applicable for calendar heat charts (when `xAxisField` and `yAxisField` are date fields).
    */
   accessor viewType: WebChartHeatChartViewTypes | undefined;
-  /** The x temporal binning used by the heat chart */
+  /**
+   * The x axis temporal binning used by the heat chart.
+   *
+   * @example
+   * ```ts
+   * heatChartModel.xTemporalBinning = {
+   *   type: WebChartTypes.CalendarDateParts,
+   *   unit: WebChartCalendarDatePartsUnits.MonthOfYear,
+   * };
+   * ```
+   */
   accessor xTemporalBinning: WebChartCalendarDatePartsBinning | undefined;
-  /** The y axis field used by the heat chart */
+  /** The y axis field used by the heat chart. */
   accessor yAxisField: string;
-  /** The y temporal binning used by the heat chart */
+  /**
+   * The y axis temporal binning used by the heat chart.
+   *
+   * @example
+   * ```ts
+   * heatChartModel.yTemporalBinning = {
+   *   type: WebChartTypes.CalendarDateParts,
+   *   unit: WebChartCalendarDatePartsUnits.DayOfMonth,
+   * };
+   * ```
+   */
   accessor yTemporalBinning: WebChartCalendarDatePartsBinning | undefined;
   /** Generate the proper chart title given the current config. */
   generateChartTitle(): string;
   /** Generate the proper y-axis title given the current config. */
   generateYAxisTitle(): string;
+  /** Gets the grid lines symbol. Contains styling information such as line width, line style, and line color. */
+  getGridLinesSymbol(): ISimpleLineSymbol | undefined;
   /** Gets the sort order for the bar chart. */
   getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
   /**
@@ -123,34 +178,50 @@ export class HeatChartModel extends SerialChartModel {
    *
    * @param _assign
    * @param _seriesIndex
+   * @internal
    */
   setAssignToSecondValueAxis(_assign: boolean, _seriesIndex: number): void;
   /**
-   * setSortOrder is not used by heat chart; instead use setXAxisSortOrder for the x axis and setYAxisSortOrder for the y axis
+   * Sets the grid lines symbol. Contains styling information such as line width, line style, and line color.
+   *
+   * @param linesSymbol - The grid lines symbol.
+   * @example
+   * ```ts
+   * heatChartModel.setGridLinesSymbol({
+   *  type: "esriSLS",
+   *  style: "esriSLSDash",
+   *  color: [255, 100, 100, 255],
+   *  width: 3,
+   * });
+   * ```
+   */
+  setGridLinesSymbol(linesSymbol: ISimpleLineSymbol | undefined): void;
+  /**
+   * setSortOrder is not used by heat chart; instead use setXAxisSortOrder for the x axis and setYAxisSortOrder for the y axis.
    *
    * @param _newSortOrder
    * @param _orderByList
+   * @internal
    */
   setSortOrder(_newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, _orderByList?: string[]): void;
   /**
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.HeatChart>>): Promise<void>;
   /**
    * Sets the sort order on the x axis for the heat chart.
    *
-   * @param newSortOrder - | "Desc" | "customSort"}  newSortOrder The new sort order.
-   * @param orderByList - orderByList The list of category's values to order by.
+   * @param newSortOrder - The new sort order.
+   * @param orderByList - The list of category's values to order by.
    */
   setXAxisSortOrder(newSortOrder: HeatChartDataSortingKinds, orderByList?: string[]): void;
   /**
    * Sets the sort order on the y axis for heat chart.
    *
-   * @param newSortOrder - | "Desc" | "customSort"}  newSortOrder The new sort order.
-   * @param orderByList - orderByList The list of category's values to order by.
+   * @param newSortOrder - The new sort order.
+   * @param orderByList - The list of category's values to order by.
    */
   setYAxisSortOrder(newSortOrder: HeatChartDataSortingKinds, orderByList?: string[]): void;
 }

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

@@ -24,9 +24,24 @@ import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
 export class HistogramModel extends HistogramModelSuperclass {
   /** Number of bins used to create the histogram. */
   accessor binCount: number;
-  /** Fill symbol used for the bins in the histogram. */
+  /**
+   * Fill symbol used for the bins in the histogram.
+   *
+   * @example
+   * ```ts
+   * histogramModel.binSymbol = {
+   *  style: "esriSFSForwardDiagonal",
+   *  color: [0, 255, 0, 100],
+   * };
+   * ```
+   */
   accessor binSymbol: ISimpleFillSymbol;
-  /** Data transformation type used in the histogram. */
+  /**
+   * Data transformation type used in the histogram.
+   * `none`: No data transformation is applied to the histogram.
+   * `logarithmic`: Data is transformed using logarithm function. It can only be
+   * `squareRoot`: Data is transformed using square root function. It can only be applied to numbers greater than or equal to zero.
+   */
   accessor dataTransformationType: WebChartDataTransformations;
   /** Line symbol used for the mean overlay in the histogram. */
   accessor meanSymbol: ISimpleLineSymbol;
@@ -36,7 +51,7 @@ export class HistogramModel extends HistogramModelSuperclass {
   accessor normalDistSymbol: ISimpleLineSymbol;
   /** Numeric field used to create the histogram to visualize the frequency distribution of its values. */
   accessor numericField: string;
-  /** Chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**. */
+  /** Chart overlays for the histogram: **mean**, **median**, **standardDeviation** and **comparisonDistribution**. */
   accessor seriesOverlays: HistogramOverlays | undefined;
   /** Whether the mean overlay is shown in the histogram. */
   accessor showMeanOverlay: boolean;
@@ -54,7 +69,6 @@ export class HistogramModel extends HistogramModelSuperclass {
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.Histogram>>): Promise<void>;
 }

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

@@ -1,15 +1,15 @@
 import type { ModelTypes } from "./common.js";
-import type { SupportedLayer } from "../../interfaces.js";
+import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
 import type { ChartConfig } from "../../utils/types/index.js";
-import type { IFeatureLayer } from "../../spec/rest-js-types.js";
+import type { IFeatureLayer, IImageServiceLayer, ITiledImageServiceLayer } from "../../spec/rest-js-types.js";
 import type { WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from "../../spec/web-chart.js";
 
 /** Parameters for creating a chart model. */
 export type ModelParams<T extends ChartConfig> = {
   /** Layer instance associated with the chart. */
-  layer?: SupportedLayer;
+  layer?: SupportedLayer | SupportedRasterLayer;
   /** Layer description to be used when the `layer` property is not set. */
-  iLayer?: IFeatureLayer;
+  iLayer?: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer;
   /** Chart config object to be edited. If not provided, a new config will be created using default values. */
   config?: T;
 };