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

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

@@ -1,4 +1,4 @@
-import type { SupportedLayer } from "../../interfaces.js";
+import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
 import type { WebChartTypes } from "../../spec/chart-object-literals.js";
 import type { IField } from "../../spec/rest-js-types.js";
 import type { WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries } from "../../spec/web-chart.js";
@@ -140,7 +140,7 @@ export interface PieSeriesDisplayOptions {
 
 export interface LayerInfo {
   /** Layer used for this bar chart. */
-  layer: SupportedLayer;
+  layer: SupportedLayer | SupportedRasterLayer;
   /** Fields information for the layer. */
   layerFieldsInfo: IField[];
   /** Object ID field name for the layer. */
@@ -162,8 +162,11 @@ export const ModelTypes: {
 
 export type ModelTypes = (typeof ModelTypes)[keyof typeof ModelTypes];
 
+/** @internal */
 export type ModelTypeToSeriesType<T extends ModelTypes> = T extends typeof ModelTypes.BarChart ? WebChartBarChartSeries : T extends typeof ModelTypes.LineChart ? WebChartLineChartSeries : T extends typeof ModelTypes.ComboBarLineChart ? WebChartBarChartSeries | WebChartLineChartSeries : T extends typeof ModelTypes.BoxPlot ? WebChartBoxPlotSeries | WebChartLineChartSeries : T extends typeof ModelTypes.PieChart ? WebChartPieChartSeries : T extends typeof ModelTypes.Scatterplot ? WebChartScatterplotSeries : T extends typeof ModelTypes.Histogram ? WebChartHistogramSeries : T extends typeof ModelTypes.Gauge ? WebChartGaugeSeries : T extends typeof ModelTypes.RadarChart ? WebChartRadarChartSeries : T extends typeof ModelTypes.HeatChart ? WebChartHeatChartSeries : SupportedChartSeries;
 
+/** @internal */
 export type SeriesTypeToChartType<T extends SupportedChartSeries> = T extends WebChartBarChartSeries ? typeof WebChartTypes.BarSeries : T extends WebChartLineChartSeries ? typeof WebChartTypes.LineSeries : T extends WebChartBoxPlotSeries ? typeof WebChartTypes.BoxPlotSeries : T extends WebChartPieChartSeries ? typeof WebChartTypes.PieSeries : T extends WebChartScatterplotSeries ? typeof WebChartTypes.ScatterSeries : T extends WebChartHistogramSeries ? typeof WebChartTypes.HistogramSeries : T extends WebChartGaugeSeries ? typeof WebChartTypes.GaugeSeries : T extends WebChartRadarChartSeries ? typeof WebChartTypes.RadarSeries : T extends WebChartHeatChartSeries ? typeof WebChartTypes.HeatSeries : never;
 
+/** @internal */
 export type ModelOfType<T> = T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterplotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : T extends typeof ModelTypes.HeatChart ? never : BarChartModel;

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

@@ -14,7 +14,6 @@ export class LineChartModel extends LineChartModelSuperclass {
    * 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.LineChart>>): Promise<void>;
 }

package/dist/model/mixins/model-with-guides.d.ts

@@ -108,6 +108,17 @@ export abstract class ModelWithGuides extends ChartModel {
    * @param style - New style to set.
    * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
    * @param orientation - Default `y`. The axis orientation of the guide.
+   * @example
+   * ```ts
+   * chartModel.setGuideStyle(
+   *  {
+   *     type: "esriSLS",
+   *     color: [0, 200, 0, 255],
+   *     width: 2,
+   *   },
+   *   1,
+   * );
+   * ```
    */
   setGuideStyle(style: ISimpleFillSymbol | ISimpleLineSymbol, index?: number, orientation?: GuideOrientation): void;
   /**

package/dist/model/mixins/model-with-legend.d.ts

@@ -5,7 +5,7 @@ import type { WebChartTextSymbol } from "../../spec/web-chart.js";
 export abstract class ModelWithLegend extends ChartModel {
   /** Maximum legend height. */
   accessor legendMaxHeight: number | undefined;
-  /** Legend position: top, bottom, left, or right. */
+  /** Legend position: `top`, `bottom`, `left`, or `right`. */
   accessor legendPosition: WebChartLegendPositions;
   /** Whether legend markers are rounded. */
   accessor legendRoundMarker: boolean;
@@ -15,20 +15,8 @@ export abstract class ModelWithLegend extends ChartModel {
   accessor legendTitleSymbol: WebChartTextSymbol | undefined;
   /** The legend title text. */
   accessor legendTitleText: string;
-  /**
-   * Whether the legend title is visible.
-   *
-   * `true`: Legend title is visible.
-   *
-   * `false`: Legend title is hidden.
-   */
+  /** Whether the legend title is visible. */
   accessor legendTitleVisibility: boolean;
-  /**
-   * Whether the legend title is visible.
-   *
-   * `true`: Legend title is visible.
-   *
-   * `false`: Legend title is hidden.
-   */
+  /** Whether the legend title is visible. */
   accessor legendVisibility: boolean;
 }

package/dist/model/mixins/model-with-temporal-binning.d.ts

@@ -6,19 +6,19 @@ export abstract class ModelWithTemporalBinning extends ChartModel {
    * Policy which tells the chart how to handle null values.
    *
    * `null`: Break the bar where null values are present.
-   *
    * `zero`: Treats null values as zero.
-   *
-   * `interpolate`: Bar series: same effect as `null` - Line series: connects the lines across null values.
+   * `interpolate`:
+   *   - Bar series: same effect as `null`
+   *   - Line series: connects the lines across null values.
    */
   accessor nullPolicy: WebChartNullPolicyTypes | undefined;
-  /** Time interval size for a temporal bar/line chart. */
+  /** Time interval size for a temporal bar chart or line chart. */
   accessor temporalBinningSize: number | undefined;
-  /** Time interval units for a temporal bar/line chart. */
+  /** Time interval units for a temporal bar chart or line chart. */
   accessor temporalBinningUnit: WebChartTemporalBinningUnits | undefined;
-  /** Time aggregation type for a temporal bar/line chart. */
+  /** Time aggregation type for a temporal bar chart or line chart. */
   accessor timeAggregationType: WebChartTimeAggregationTypes | undefined;
-  /** Whether to trim incomplete time intervals for a temporal bar/line chart. */
+  /** Whether to trim incomplete time intervals for a temporal bar chart or line chart. */
   accessor trimIncompleteTimeInterval: boolean | undefined;
   /** Resets the time interval to default for a temporal line chart. */
   resetTimeInterval(): void;

package/dist/model/mixins/model-with-tooltips.d.ts

@@ -3,15 +3,15 @@ import type { ChartModel } from "../chart-model/chart-model.js";
 export abstract class ModelWithTooltips extends ChartModel {
   /**
    * Gets the setting of the `dataTooltipReverseColor` property.
-   * - If the seriesIndex is provided, the dataTooltipReverseColor for that series will be returned. Otherwise, the same property of the first series will be returned.
-   * - If the dataTooltipReverseColor is not set on the series, the default value of `false` will be returned.
+   * - If the `seriesIndex` is provided, the `dataTooltipReverseColor` for that series will be returned. Otherwise, the same property of the first series will be returned.
+   * - If the `dataTooltipReverseColor` is not set on the series, the default value of `false` will be returned.
    *
    * @param seriesIndex - The index of the series.
    */
   getDataTooltipReverseColor(seriesIndex?: number): boolean;
   /**
    * Gets the visibility of the data tooltips.
-   * - If the seriesIndex is provided, the visibility for that series will be returned. Otherwise, the visibility of the first series will be returned.
+   * - If the `seriesIndex` is provided, the visibility for that series will be returned. Otherwise, the visibility of the first series will be returned.
    * - If the visibility is not set on the series, the default value of `true` will be returned.
    *
    * @param seriesIndex - The index of the series.
@@ -19,7 +19,7 @@ export abstract class ModelWithTooltips extends ChartModel {
   getDataTooltipVisibility(seriesIndex?: number): boolean;
   /**
    * Sets the setting of the `dataTooltipReverseColor` property.
-   * - If the seriesIndex is provided, the reverse color will be set for that series only. Otherwise, the reverse color will be set for all series.
+   * - If the `seriesIndex` is provided, the reverse color will be set for that series only. Otherwise, the reverse color will be set for all series.
    *
    * @param reverseColor - Indicator of whether to reverse the color.
    * @param seriesIndex - The index of the series to set the reverse color.
@@ -27,7 +27,7 @@ export abstract class ModelWithTooltips extends ChartModel {
   setDataTooltipReverseColor(reverseColor: boolean, seriesIndex?: number): void;
   /**
    * Sets the visibility of the data tooltips.
-   * - If the seriesIndex is provided, the visibility will be set for that series only. Otherwise, the visibility will be set for all series.
+   * - If the `seriesIndex` is provided, the visibility will be set for that series only. Otherwise, the visibility will be set for all series.
    *
    * @param visibility - The visibility of the data tooltips.
    * @param seriesIndex - The index of the series to set the visibility.

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

@@ -13,25 +13,25 @@ export abstract class PieChartLegendModel extends PieChartLegendModelSuperclass
   /**
    * Gets the setting for the display of numerical value in the legend items.
    *
-   * **Note**: This setting is only applicable to pie charts.
+   * **Note**: Only applicable to pie charts.
    */
   getDisplayNumericValue(): boolean;
   /**
    * Gets the setting for the display of percentage in the legend items.
    *
-   * **Note**: This setting is only applicable to pie charts.
+   * **Note**: Only applicable to pie charts.
    */
   getDisplayPercentage(): boolean;
   /**
    * Gets the maximum width in pixel for the legend item labels.
    *
-   * **Note**: This setting is only applicable to pie charts.
+   * **Note**: Only applicable to pie charts.
    */
   getLabelMaxWidth(): number;
   /**
    * Sets the setting for the display of numerical value in the legend items.
    *
-   * **Note**: This setting is only applicable to pie charts.
+   * **Note**: Only applicable to pie charts.
    *
    * @param displayNumericValue - The setting for the display of numerical value in the legend items
    */
@@ -39,7 +39,7 @@ export abstract class PieChartLegendModel extends PieChartLegendModelSuperclass
   /**
    * Sets the setting for the display of percentage in the legend items.
    *
-   * **Note**: This setting is only applicable to pie charts.
+   * **Note**: Only applicable to pie charts.
    *
    * @param displayPercentage - The setting for the display of percentage in the legend items
    */
@@ -47,7 +47,7 @@ export abstract class PieChartLegendModel extends PieChartLegendModelSuperclass
   /**
    * Sets the maximum width in pixel for the legend item labels.
    *
-   * **Note**: This setting is only applicable to pie charts.
+   * **Note**: Only applicable to pie charts.
    *
    * @param labelMaxWidth - The maximum width in pixel for the legend item labels
    */

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

@@ -14,7 +14,7 @@ import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
 export class PieChartModel extends PieChartModelSuperclass {
   /** Aggregation type for the pie chart. */
   accessor aggregationType: WebChartStatisticType;
-  /** Align data labels setting for the pie chart. */
+  /** Align the data labels on the left or right side of the chart instead of the default position around the chart. */
   accessor alignDataLabels: boolean | undefined;
   /** Category field for the pie chart. */
   accessor category: string;
@@ -48,6 +48,7 @@ export class PieChartModel extends PieChartModelSuperclass {
   accessor displayNumericValueOnTooltip: boolean;
   /**
    * Whether to display the percentage on the data label.
+   *
    * **Note:** If the setting is not found in the config, it will default to `true`.
    */
   accessor displayPercentageOnDataLabel: boolean;
@@ -57,7 +58,7 @@ export class PieChartModel extends PieChartModelSuperclass {
    * **Note**: If the setting is not found in the config, it will default to `true`.
    */
   accessor displayPercentageOnTooltip: boolean;
-  /** Display type for the pie chart slices. Specifies whether to display the slices as a percentage, value, or both. */
+  /** Display type for the pie chart slices. Specifies whether to display the slices as a `percentage`, `value`, or `both`. */
   accessor displayType: PieChartSlicesDisplay;
   /** End angle of the pie chart. */
   accessor endAngle: number | null | undefined;
@@ -70,7 +71,8 @@ export class PieChartModel extends PieChartModelSuperclass {
   /** Character limit for the slice labels. */
   accessor labelCharacterLimit: number | null;
   /**
-   * The pie chart data mode (Category or Fields).
+   * The pie chart data mode.
+   *
    * `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.
    */
@@ -80,7 +82,14 @@ export class PieChartModel extends PieChartModelSuperclass {
   set numericFields(value: string[] | string);
   /** Optimize data labels overlapping setting for the pie chart. */
   accessor optimizeDataLabelsOverlapping: boolean | undefined;
-  /** List of category's values for custom sort */
+  /**
+   * List of category's values for custom sort.
+   *
+   * @example
+   * ```ts
+   * pieChartModel.orderByList = ["Field1", "Field2", "Field3"];
+   * ```
+   */
   accessor orderByList: string[];
   /** Order of the slice array by returning an array of slice ids */
   accessor orderOfSlices: string[] | undefined;
@@ -184,7 +193,6 @@ export class PieChartModel extends PieChartModelSuperclass {
    * 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.PieChart>>): Promise<void>;
 }

package/dist/model/properties/axes/x-axis/max-x-bound.d.ts

@@ -2,6 +2,10 @@ import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
 
 /** Adds support for configuring the maximum x-axis bound. */
 export abstract class WithMaxXBound extends ChartModelBase {
-  /** Maximum bound set for the x-axis. Null indicates no explicit maximum. */
+  /**
+   * Maximum bound set for the x-axis.
+   *
+   * `null` indicates no explicit maximum.
+   */
   accessor maxXBound: number | null;
 }

package/dist/model/properties/axes/x-axis/min-x-bound.d.ts

@@ -2,6 +2,10 @@ import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
 
 /** Adds support for configuring the minimum x-axis bound. */
 export abstract class WithMinXBound extends ChartModelBase {
-  /** Minimum bound set for the x-axis. Null indicates no explicit minimum. */
+  /**
+   * Minimum bound set for the x-axis.
+   *
+   * `null` indicates no explicit minimum.
+   */
   accessor minXBound: number | null;
 }

package/dist/model/properties/axes/x-axis/x-axis-title-visibility.d.ts

@@ -4,8 +4,8 @@ import type { ChartModelBase } from "../../../chart-model/chart-model-base.js";
 export abstract class WithXAxisTitleVisibility extends ChartModelBase {
   /**
    * Whether the x-axis title is visible.
-   * true: X-axis title is visible.
-   * false: X-axis title is hidden.
+   * `true`: X-axis title is visible.
+   * `false`: X-axis title is hidden.
    */
   accessor xAxisTitleVisibility: boolean;
 }

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

@@ -3,7 +3,50 @@ import type { ChartModelBase } from "../chart-model/chart-model-base.js";
 
 /** Adds support for working with chart renderer. */
 export abstract class WithChartRenderer extends ChartModelBase {
-  /** The chart renderer. */
+  /**
+   * The chart renderer.
+   *
+   * @example
+   * In this example, we set the chartRenderer for a class-break heat chart.
+   * ```ts
+   * heatChartModel.chartRenderer = {
+   *    "type": "classBreaks",
+   *    "field": "arcgis_charts_heat_chart_value",
+   *    "classBreakInfos": [
+   *        {
+   *          "label": "70 - 145",
+   *          "classMinValue": 70,
+   *          "classMaxValue": 145,
+   *          "symbol": {
+   *            "type": "esriSFS",
+   *            "color": [
+   *              212,
+   *              227,
+   *              255,
+   *              255
+   *            ],
+   *            "style": "esriSFSSolid"
+   *          }
+   *        },
+   *        {
+   *          "label": "146 - 250",
+   *          "classMinValue": 146,
+   *          "classMaxValue": 250,
+   *          "symbol": {
+   *            "type": "esriSFS",
+   *            "color": [
+   *              43,
+   *              108,
+   *              240,
+   *              255
+   *            ],
+   *            "style": "esriSFSSolid"
+   *          }
+   *        }
+   *    ]
+   *  };
+   * ```
+   */
   get chartRenderer(): IDrawingInfo["renderer"] | undefined;
   set chartRenderer(value: IDrawingInfo["renderer"]);
 }

package/dist/model/properties/color-match.d.ts

@@ -6,7 +6,6 @@ export abstract class WithColorMatch extends ChartModelBase {
    * Whether the chart should attempt to match the data source's colors.
    *
    * `true`: Attempt to match the data source's colors.
-   *
    * `false`: Use the colors defined in the config.
    */
   accessor colorMatch: boolean;

package/dist/model/properties/data-labels/data-labels-visibility.d.ts

@@ -2,9 +2,6 @@ import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
 
 /** Adds support for working with the data labels visibility. */
 export abstract class WithDataLabelsVisibility extends ChartModelBase {
-  /**
-   * Whether data labels are visible.
-   * true: visible, false: hidden.
-   */
+  /** Whether data labels are visible. */
   accessor dataLabelsVisibility: boolean;
 }

package/dist/model/properties/description/description-visibility.d.ts

@@ -5,10 +5,6 @@ export abstract class WithDescriptionVisibility extends ChartModelBase {
   /**
    * 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.
    */
   accessor descriptionVisibility: boolean;

package/dist/model/properties/layer.d.ts

@@ -1,8 +1,8 @@
-import type { SupportedLayer } from "../../interfaces.js";
+import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
 import type { ChartModelBase } from "../chart-model/chart-model-base.js";
 
 /** Adds getter support for the associated layer reference. */
 export abstract class WithLayer extends ChartModelBase {
   /** The chart model's layer. */
-  get layer(): SupportedLayer | undefined;
+  get layer(): SupportedLayer | SupportedRasterLayer | undefined;
 }

package/dist/model/properties/subtitle/subtitle-visibility.d.ts

@@ -5,10 +5,6 @@ export abstract class WithChartSubtitleVisibility extends ChartModelBase {
   /**
    * 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.
    */
   accessor chartSubtitleVisibility: boolean;

package/dist/model/properties/title/title-visibility.d.ts

@@ -5,10 +5,6 @@ export abstract class WithChartTitleVisibility extends ChartModelBase {
   /**
    * 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.
    */
   accessor chartTitleVisibility: boolean;

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

@@ -14,7 +14,6 @@ export class RadarChartModel extends RadarChartModelSuperclass {
    * 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.RadarChart>>): Promise<void>;
 }

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

@@ -23,9 +23,9 @@ import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
 
 export class ScatterplotModel extends ScatterplotModelSuperclass {
   /**
-   * Additional tooltip display fields.
+   * Add an additional field to display for scatterplot tooltips.
    *
-   * **NOTE**: Only numeric fields are supported.
+   * **Note**: Only numeric fields are supported.
    */
   get additionalTooltipField(): string[] | string;
   set additionalTooltipField(value: string[] | string | undefined);
@@ -33,7 +33,7 @@ export class ScatterplotModel extends ScatterplotModelSuperclass {
   accessor fixedMarkerSymbol: ISimpleMarkerSymbol;
   /** Line symbol for the linear trend line. */
   accessor linearTrendSymbol: ISimpleLineSymbol;
-  /** Chart overlays. The scatterplot implements only 1 overlay, **trendLine**. */
+  /** Trendline overlay for the scatterplot. */
   accessor seriesOverlays: ScatterplotOverlays | undefined;
   /** Whether the linear trend line is shown. */
   accessor showLinearTrend: boolean;
@@ -51,7 +51,6 @@ export class ScatterplotModel extends ScatterplotModelSuperclass {
    * 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.Scatterplot>>): Promise<void>;
 }

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

@@ -23,18 +23,18 @@ import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
 import type { ModelWithTemporalBinning } from "../mixins/model-with-temporal-binning.js";
 
 export abstract class SerialChartModel extends SerialChartModelSuperclass {
-  /** The aggregation type for the bar chart. Must be one of the values allowed by `WebChartStatisticType`. */
+  /** The aggregation type for the chart. */
   accessor aggregationType: WebChartStatisticType;
   /**
    * Whether temporal binning is enabled for all series in the config.
+   *
    * **Note:** Setting this prop removes any existing temporal binning settings if `value` is set to `false`.
    */
   accessor binTemporalData: boolean;
   /**
-   * The null category configuration of the bar chart.
+   * The null category configuration of the chart.
    *
-   * @requires
-   * the following to be set on the model for the null category to be applied:
+   * 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
    */
@@ -42,15 +42,15 @@ export abstract class SerialChartModel extends SerialChartModelSuperclass {
   /** The numeric fields array for the chart. */
   get numericFields(): string[];
   set numericFields(value: string[] | string);
-  /** The list of custom sort values for custom sort */
+  /** The list of values for custom sort. */
   accessor orderByList: string[];
   /** The split-by field for the chart. */
   accessor splitByField: string;
   /**
-   * How the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
+   * How the bars (lines) should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
    * when multiple attributes/fields corresponding to the same set of classes are to be visualized.
    *
-   * **Note**: Currently this property is only used for bar and line series.
+   * **Note**: Currently this property is only used for bar charts and line charts.
    */
   accessor stackedType: WebChartStackedKinds | undefined;
   /** The x-axis field for the chart. */
@@ -139,11 +139,7 @@ export abstract class SerialChartModel extends SerialChartModelSuperclass {
    * @param orderByList - The list of category's values to order by.
    */
   setSortOrder(newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, orderByList?: string[]): void;
-  /**
-   * Updates the series based on the layer filter.
-   *
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
-   */
-  updateSeriesFromLayerFilter(): Promise<void>;
+  /** Updates the series based on the layer filter. */
+  updateSeriesFromLayerFilter(): void;
 }
 declare const SerialChartModelSuperclass: typeof ChartModel & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText & typeof ModelWithTemporalBinning & typeof ModelWithYGuides & typeof ModelWithXGuides & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithRotatedState & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes

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

@@ -1,6 +1,6 @@
 import type { ModelOfType, ModelTypes } from "../interfaces/common.js";
-import type { SupportedLayer } from "../../interfaces.js";
-import type { IFeatureLayer } from "../../spec/rest-js-types.js";
+import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
+import type { IFeatureLayer, IImageServiceLayer, ITiledImageServiceLayer } from "../../spec/rest-js-types.js";
 import type { ChartConfig } from "../../utils/types/index.js";
 
 /**
@@ -8,6 +8,13 @@ import type { ChartConfig } from "../../utils/types/index.js";
  * Various combinations of properties `layer`, `iLayer`, `chartType`, and `config` are supported.
  *
  * @param props - The properties used to set up the chart.
+ * @example
+ * ```ts
+ * const chartModel = await createModel({
+ *  layer: myLayer,
+ *  chartType: "gauge",
+ * });
+ * ```
  */
 export function createModel<T extends ModelTypes>(props: CreateModelProps<T>): Promise<ModelOfType<T>>;
 
@@ -23,7 +30,7 @@ export type CreateModelProps<T extends ModelTypes> = ILayerAndSourcelessConfig<T
  * A new model of the specified type will be created using default values.
  */
 export type LayerAndType<T extends ModelTypes> = {
-  layer: SupportedLayer;
+  layer: SupportedLayer | SupportedRasterLayer;
   chartType: T;
 };
 
@@ -33,7 +40,7 @@ export type LayerAndType<T extends ModelTypes> = {
  * A new model of the specified type will be created using default values.
  */
 export type ILayerAndType<T extends ModelTypes> = {
-  iLayer: IFeatureLayer;
+  iLayer: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer;
   chartType: T;
 };
 
@@ -43,7 +50,7 @@ export type ILayerAndType<T extends ModelTypes> = {
  * The `config` is considered "sourceless" since its `iLayer` property is not required.
  */
 export type LayerAndSourcelessConfig<T extends ModelTypes> = {
-  layer: SupportedLayer;
+  layer: SupportedLayer | SupportedRasterLayer;
   config: ChartConfig<T>;
 };
 
@@ -53,7 +60,7 @@ export type LayerAndSourcelessConfig<T extends ModelTypes> = {
  * The `config` is considered "sourceless" since its `iLayer` property is not required.
  */
 export type ILayerAndSourcelessConfig<T extends ModelTypes> = {
-  iLayer: IFeatureLayer;
+  iLayer: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer;
   config: ChartConfig<T>;
 };
 

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

@@ -21,6 +21,7 @@ import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
 import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
 import type { ModelWithLegend } from "../mixins/model-with-legend.js";
 import type { ModelWithTemporalBinning } from "../mixins/model-with-temporal-binning.js";
+import type { RadarChartModel } from "../radar-chart-model/radar-chart-model.js";
 
 /**
  * Determines if the provided model or config is a `ChartModel`.
@@ -43,6 +44,13 @@ export function isBarChartModel(model: ChartModelBase | undefined): model is Bar
  */
 export function isLineChartModel(model: ChartModelBase | undefined): model is LineChartModel;
 
+/**
+ * Determines if the provided `model` is of type `RadarChartModel`.
+ *
+ * @param model - The model to check.
+ */
+export function isRadarChartModel(model: ChartModelBase | undefined): model is RadarChartModel;
+
 /**
  * Determines if the provided `model` is of type `ComboBarLineChartModel`.
  *

package/dist/model.js

@@ -1,21 +1,21 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import { B as e, C as i, F as t, G as o, H as r, L as l, M as d, a as M, P as h, b as n, S as C, T as g, c as m } from "./chunks/common.js";
-import { a as p, f as u, i as y, c as K, k as P, j as W, h as c, b as x, u as L, o as B, r as D, m as G, l as T, t as f, n as F, p as H, q as b, s as k, e as O, g as j, d as q } from "./chunks/type-guards.js";
-import { c as X } from "./chunks/setup-utils.js";
+import { B as e, C as i, F as t, G as o, H as r, L as d, M as l, P as M, a as h, b as n, S as C, T as g, c as m } from "./chunks/common.js";
+import { i as p, a as u, b as y, c as K, d as P, e as W, f as c, g as x, h as L, j as B, k as D, l as G, m as T, n as f, o as F, p as H, q as b, r as k, s as O, t as j, u as q, v } from "./chunks/type-guards.js";
+import { c as R } from "./chunks/setup-utils.js";
 export {
   e as BoxPlotDataSortingKinds,
   i as ColorFormatKeys,
   t as FormatKeys,
   o as GuideOrientation,
   r as HeatChartDataSortingKinds,
-  l as LineFormatKeys,
-  d as ModelTypes,
+  d as LineFormatKeys,
+  l as ModelTypes,
   M as PieChartDataModes,
   h as PieChartDataSortingKinds,
   n as PieChartSlicesDisplay,
   C as SerialChartDataSortingKinds,
   g as TextFormatKeys,
-  X as createModel,
+  R as createModel,
   m as customSortString,
   p as isBarChartModel,
   u as isBoxPlotModel,
@@ -36,6 +36,7 @@ export {
   b as isModelWithYGuides,
   k as isPieChartLegendModel,
   O as isPieChartModel,
-  j as isScatterplotModel,
-  q as isSerialChartModel
+  j as isRadarChartModel,
+  q as isScatterplotModel,
+  v as isSerialChartModel
 };