@arcgis/charts-components 5.2.0-next.9 → 5.2.0-next.91

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

@@ -3,18 +3,208 @@ import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.
 import type { ModelParams } from "../interfaces/chart-interfaces.js";
 import type { ModelTypes } from "../interfaces/common.js";
 import type { WithNegativeValuesStackedToBaseline } from "../properties/series/negative-values-stacked-to-baseline.js";
+import type { WebChartTextSymbol } from "../../spec/web-chart.js";
+import type { WebChartRadarChartAxisLabelsOrientation, WebChartLabelBehavior } from "../../spec/chart-object-literals.js";
 import type { ModelWithLineMarkerStyling } from "../mixins/model-with-line-marker-styling.js";
 
 export class RadarChartModel extends RadarChartModelSuperclass {
+  /** The radar axis labels orientation. */
+  accessor axisLabelsOrientation: WebChartRadarChartAxisLabelsOrientation;
+  /** The circular-axis field for the radar chart. */
+  accessor circularAxisField: string;
+  /** Whether the circular-axis labels are visible. */
+  accessor circularAxisLabelsVisibility: boolean;
+  /** Circular-axis title text symbol (font, color, style). */
+  accessor circularAxisTitleSymbol: WebChartTextSymbol | undefined;
+  /** The circular-axis title text. */
+  accessor circularAxisTitleText: string;
+  /** Whether the circular-axis title is visible. */
+  accessor circularAxisTitleVisibility: boolean;
+  /** Visibility of the circular line of the cursor's crosshair. */
+  accessor cursorCrosshairCircularLineVisibility: boolean;
+  /**
+   * Visibility of the horizontal line of the cursor's crosshair.
+   *
+   * @deprecated since 5.2. Use [cursorCrosshairCircularLineVisibility](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#cursorCrosshairCircularLineVisibility) instead. This property will be removed from `RadarChartModel` in 6.0.
+   */
+  accessor cursorCrosshairHorizontalLineVisibility: boolean;
+  /** Visibility of the radial line of the cursor's crosshair. */
+  accessor cursorCrosshairRadialLineVisibility: boolean;
+  /**
+   * Visibility of the vertical line of the cursor's crosshair.
+   *
+   * @deprecated since 5.2. Use [cursorCrosshairRadialLineVisibility](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#cursorCrosshairRadialLineVisibility) instead. This property will be removed from `RadarChartModel` in 6.0.
+   */
+  accessor cursorCrosshairVerticalLineVisibility: boolean;
+  /**
+   * Maximum bound set for the circular axis.
+   *
+   * `null` indicates no explicit maximum.
+   */
+  accessor maxCircularBound: number | null;
+  /**
+   * Maximum bound set for the x-axis.
+   *
+   * @deprecated since 5.2. Use [maxCircularBound](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#maxCircularBound) instead. This property will be removed from `RadarChartModel` in 6.0.
+   */
+  accessor maxXBound: number | null;
+  /**
+   * Minimum bound set for the circular axis.
+   *
+   * `null` indicates no explicit minimum.
+   */
+  accessor minCircularBound: number | null;
+  /**
+   * Minimum bound set for the x-axis.
+   *
+   * @deprecated since 5.2. Use [minCircularBound](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#minCircularBound) instead. This property will be removed from `RadarChartModel` in 6.0.
+   */
+  accessor minXBound: number | null;
+  /**
+   * The x-axis field for the chart.
+   *
+   * @deprecated since 5.2. Use [circularAxisField](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#circularAxisField) instead. This property will be removed from `RadarChartModel` in 6.0.
+   */
+  accessor xAxisField: string;
+  /**
+   * Whether the x-axis labels are visible.
+   *
+   * @deprecated since 5.2. Use [circularAxisLabelsVisibility](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#circularAxisLabelsVisibility) instead. This property will be removed from `RadarChartModel` in 6.0.
+   */
+  accessor xAxisLabelsVisibility: boolean;
+  /**
+   * X-axis title text symbol (font, color, style).
+   *
+   * @deprecated since 5.2. Use [circularAxisTitleSymbol](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#circularAxisTitleSymbol) instead. This property will be removed from `RadarChartModel` in 6.0.
+   */
+  accessor xAxisTitleSymbol: WebChartTextSymbol | undefined;
+  /**
+   * The x-axis title text.
+   *
+   * @deprecated since 5.2. Use [circularAxisTitleText](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#circularAxisTitleText) instead. This property will be removed from `RadarChartModel` in 6.0.
+   */
+  accessor xAxisTitleText: string;
+  /**
+   * Whether the x-axis title is visible.
+   *
+   * @deprecated since 5.2. Use [circularAxisTitleVisibility](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#circularAxisTitleVisibility) instead. This property will be removed from `RadarChartModel` in 6.0.
+   */
+  accessor xAxisTitleVisibility: boolean;
+  /**
+   * Adds a circular-axis guide.
+   *
+   * @param name - The name of the guide.
+   * @param index - The index to insert the new guide in the list of circular-axis guides. If left `undefined`, the guide is appended to the end of the list.
+   */
+  addCircularAxisGuide(name: string, index?: number): void;
+  /**
+   * Adds a radial-axis guide.
+   *
+   * @param name - The name of the guide.
+   * @param index - The index to insert the new guide in the list of radial-axis guides. If left `undefined`, the guide is appended to the end of the list.
+   */
+  addRadialAxisGuide(name: string, index?: number): void;
+  /**
+   * Adds an X-axis guide.
+   *
+   * @deprecated since 5.2. Use [addCircularAxisGuide](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#addCircularAxisGuide) instead. This method will be removed from `RadarChartModel` in 6.0.
+   * @param name - The name of the guide.
+   * @param index - The index to insert the new guide in the list of X-axis guides. If left `undefined`, the guide is appended to the end of the list.
+   */
+  addXAxisGuide(name: string, index?: number): void;
+  /**
+   * Adds a Y-axis guide.
+   *
+   * @deprecated since 5.2. Use [addRadialAxisGuide](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#addRadialAxisGuide) instead. This method will be removed from `RadarChartModel` in 6.0.
+   * @param name - The name of the guide.
+   * @param index - The index to insert the new guide in the list of Y-axis guides. If left `undefined`, the guide is appended to the end of the list.
+   */
+  addYAxisGuide(name: string, index?: number): void;
+  /**
+   * Deletes a circular-axis guide.
+   *
+   * @param index - The index of the guide to delete in the list of circular-axis guides. If left `undefined`, the last guide in the list is deleted.
+   */
+  deleteCircularAxisGuide(index?: number): void;
+  /**
+   * Deletes a radial-axis guide.
+   *
+   * @param index - The index of the guide to delete in the list of radial-axis guides. If left `undefined`, the last guide in the list is deleted.
+   */
+  deleteRadialAxisGuide(index?: number): void;
+  /**
+   * Deletes an X-axis guide.
+   *
+   * @deprecated since 5.2. Use [deleteCircularAxisGuide](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#deleteCircularAxisGuide) instead. This method will be removed from `RadarChartModel` in 6.0.
+   * @param index - The index of the guide to delete in the list of X-axis guides. If left `undefined`, the last guide in the list is deleted.
+   */
+  deleteXAxisGuide(index?: number): void;
+  /**
+   * Deletes a Y-axis guide.
+   *
+   * @deprecated since 5.2. Use [deleteRadialAxisGuide](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#deleteRadialAxisGuide) instead. This method will be removed from `RadarChartModel` in 6.0.
+   * @param index - The index of the guide to delete in the list of Y-axis guides. If left `undefined`, the last guide in the list is deleted.
+   */
+  deleteYAxisGuide(index?: number): void;
+  /** Generate the proper circular-axis title from the current config. */
+  generateCircularAxisTitle(): string;
+  /** Generate the proper radial-axis title given the current config. */
+  generateRadialAxisTitle(): string;
+  /**
+   * Generate the proper x-axis title from the current config.
+   *
+   * @deprecated since 5.2. Use [generateCircularAxisTitle](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#generateCircularAxisTitle) instead. This method will be removed from `RadarChartModel` in 6.0.
+   */
+  generateXAxisTitle(): string;
+  /**
+   * Generate the proper y-axis title given the current config.
+   *
+   * @deprecated since 5.2. Use [generateRadialAxisTitle](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#generateRadialAxisTitle) instead. This method will be removed from `RadarChartModel` in 6.0.
+   */
+  generateYAxisTitle(): string;
+  /** Get the default circular-axis title text. */
+  getDefaultCircularAxisTitleText(): string;
+  /**
+   * Get the default x-axis title text.
+   *
+   * @deprecated since 5.2. Use [getDefaultCircularAxisTitleText](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#getDefaultCircularAxisTitleText) instead. This method will be removed from `RadarChartModel` in 6.0.
+   */
+  getDefaultXAxisTitleText(): string;
+  /**
+   * Gets the horizontal axis labels behavior for the chart.
+   *
+   * @deprecated since 5.2. This method has no effect on the radar-axis labels Use [axisLabelsOrientation](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#axisLabelsOrientation) instead. This method will be removed from `RadarChartModel` in 6.0.
+   */
+  getHorizontalAxisLabelsBehavior(): WebChartLabelBehavior;
+  /**
+   * Gets the vertical axis labels behavior for the chart.
+   *
+   * @deprecated since 5.2. This method does not configure radar-axis labels and has no replacement. It will be removed from `RadarChartModel` in 6.0.
+   */
+  getVerticalAxisLabelsBehavior(): WebChartLabelBehavior;
   /** Returns whether the series styling is able to be reset. */
   resetAvailable(): boolean;
   /** Resets the series styling to the default styling. */
   resetSeriesStyling(): void;
+  /**
+   * Sets the horizontal axis labels behavior for the chart.
+   *
+   * @deprecated since 5.2. This method has no effect on the radar-axis labels Use [axisLabelsOrientation](https://developers.arcgis.com/javascript/latest/references/charts-components/model/radar-chart-model/radar-chart-model/#axisLabelsOrientation) instead. This method will be removed from `RadarChartModel` in 6.0.
+   * @param horizontalBehavior - The behavior for the horizontal axis labels.
+   */
+  setHorizontalAxisLabelsBehavior(horizontalBehavior: WebChartLabelBehavior): void;
   /**
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.RadarChart>>): Promise<void>;
+  /**
+   * Sets the vertical axis labels behavior for the chart.
+   *
+   * @deprecated since 5.2. This method does not configure radar-axis labels and has no replacement. It will be removed from `RadarChartModel` in 6.0.
+   * @param verticalBehavior - The behavior for the vertical axis labels.
+   */
+  setVerticalAxisLabelsBehavior(verticalBehavior: WebChartLabelBehavior): void;
 }
 declare const RadarChartModelSuperclass: typeof SerialChartModel & typeof ModelWithLineMarkerStyling & typeof WithNegativeValuesStackedToBaseline

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

@@ -63,6 +63,7 @@ export abstract class SerialChartModel extends SerialChartModelSuperclass {
   /**
    * Gets whether the series should be assigned to the second value axis.
    *
+   * @deprecated since 5.2. Use [getSeriesToSecondaryYAxis](https://developers.arcgis.com/javascript/latest/references/charts-components/model/serial-chart-model/serial-chart-model/#getSeriesToSecondaryYAxis) instead.
    * @param seriesIndex - The index of the series.
    */
   getAssignToSecondValueAxis(seriesIndex: number): boolean;
@@ -83,6 +84,12 @@ export abstract class SerialChartModel extends SerialChartModelSuperclass {
    * @param seriesIndex - The index of the series.
    */
   getSeriesName(seriesIndex: number): string | undefined;
+  /**
+   * Gets whether the series should be assigned to the secondary y-axis.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesToSecondaryYAxis(seriesIndex: number): boolean;
   /** Gets the sort order for the bar chart. */
   getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
   /**
@@ -100,9 +107,12 @@ export abstract class SerialChartModel extends SerialChartModelSuperclass {
    * @param toIndex - Index to move the series to.
    */
   moveSeries(fromIndex: number, toIndex: number): void;
+  /** Rebuilds the series based on the current configuration. */
+  rebuildSeries(): Promise<void>;
   /**
    * Sets whether the series should be assigned to the second value axis.
    *
+   * @deprecated since 5.2. Use [setSeriesToSecondaryYAxis](https://developers.arcgis.com/javascript/latest/references/charts-components/model/serial-chart-model/serial-chart-model/#setSeriesToSecondaryYAxis) instead.
    * @param assign - The value for the setting.
    * @param seriesIndex - The index of the series.
    */
@@ -133,6 +143,18 @@ export abstract class SerialChartModel extends SerialChartModelSuperclass {
    * @param seriesIndex - The index of the series.
    */
   setSeriesName(name: string, seriesIndex: number): void;
+  /**
+   * Sets whether the series should be assigned to the secondary y-axis.
+   *
+   * @param assign - The value for the setting.
+   * @param seriesIndex - The index of the series.
+   * @example
+   * ```ts
+   * chartModel.setSeriesToSecondaryYAxis(true, 0); // Assigns the first series to the secondary y-axis
+   * chartModel.setSeriesToSecondaryYAxis(false, 1); // Removes the second series from the secondary y-axis
+   * ```
+   */
+  setSeriesToSecondaryYAxis(assign: boolean, seriesIndex: number): void;
   /**
    * Sets the sort order for the bar chart.
    *
@@ -140,7 +162,11 @@ 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. */
+  /**
+   * Updates the series based on the layer filter.
+   *
+   * @deprecated since 5.2. Use [rebuildSeries](https://developers.arcgis.com/javascript/latest/references/charts-components/model/serial-chart-model/serial-chart-model/#rebuildSeries) instead.
+   */
   updateSeriesFromLayerFilter(): void;
 }
 declare const SerialChartModelSuperclass: typeof ChartModel & typeof WithTimeZone & 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,4 +1,4 @@
-import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
+import type { ChartLayerInput } from "../../interfaces.js";
 import type { IFeatureLayer, IImageServiceLayer, ITiledImageServiceLayer } from "../../spec/rest-js-types.js";
 import type { CommonStrings } from "../../utils/localization/interfaces.js";
 import type { ChartConfig } from "../../utils/types/index.js";
@@ -33,7 +33,7 @@ export type CreateModelProps<T extends ModelTypes> = (ILayerAndSourcelessConfig<
  * A new model of the specified type will be created using default values.
  */
 export type LayerAndType<T extends ModelTypes> = {
-  layer: SupportedLayer | SupportedRasterLayer;
+  layer: ChartLayerInput;
   chartType: T;
 };
 
@@ -53,7 +53,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 | SupportedRasterLayer;
+  layer: ChartLayerInput;
   config: ChartConfig<T>;
 };
 

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

@@ -12,7 +12,7 @@ import type { PieChartLegendModel } from "../pie-chart-model/pie-chart-legend-mo
 import type { PieChartModel } from "../pie-chart-model/pie-chart-model.js";
 import type { ScatterplotModel } from "../scatterplot-model/scatterplot-model.js";
 import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
-import type { WebChart } from "../../spec/web-chart.js";
+import type { WebChart, WebChartNullCategory } from "../../spec/web-chart.js";
 import type { ModelWithMultiAxes } from "../mixins/model-with-multi-axes.js";
 import type { ModelWithLineMarkerStyling } from "../mixins/model-with-line-marker-styling.js";
 import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
@@ -22,41 +22,42 @@ 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";
+import type { ChartModelWrapper } from "../chart-model/chart-model-wrapper.js";
 
 /**
  * Determines if the provided model or config is a `ChartModel`.
  *
  * @param model - The model to check.
  */
-export function isChartModel(model: ChartModel | WebChart | undefined): model is ChartModel;
+export function isChartModel(model: ChartModelBase | ChartModelWrapper | WebChart | undefined): model is ChartModel;
 
 /**
  * Determines if the provided `model` is of type `BarChartModel`.
  *
  * @param model - The model to check.
  */
-export function isBarChartModel(model: ChartModelBase | undefined): model is BarChartModel;
+export function isBarChartModel(model: ChartModelBase | ChartModelWrapper | undefined): model is BarChartModel;
 
 /**
  * Determines if the provided `model` is of type `LineChartModel`.
  *
  * @param model - The model to check.
  */
-export function isLineChartModel(model: ChartModelBase | undefined): model is LineChartModel;
+export function isLineChartModel(model: ChartModelBase | ChartModelWrapper | 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;
+export function isRadarChartModel(model: ChartModelBase | ChartModelWrapper | undefined): model is RadarChartModel;
 
 /**
  * Determines if the provided `model` is of type `ComboBarLineChartModel`.
  *
  * @param model - The model to check.
  */
-export function isComboBarLineChartModel(model: ChartModelBase | undefined): model is ComboBarLineChartModel;
+export function isComboBarLineChartModel(model: ChartModelBase | ChartModelWrapper | undefined): model is ComboBarLineChartModel;
 
 /**
  * Determines if the provided `model` is of type `SerialChartModel`.
@@ -64,102 +65,103 @@ export function isComboBarLineChartModel(model: ChartModelBase | undefined): mod
  *
  * @param model - The model to check.
  */
-export function isSerialChartModel(model: ChartModelBase | undefined): model is SerialChartModel;
+export function isSerialChartModel(model: ChartModelBase | ChartModelWrapper | undefined): model is SerialChartModel;
 
 /**
  * Determines if the provided `model` is of type `PieChartModel`.
  *
  * @param model - The model to check.
  */
-export function isPieChartModel(model: ChartModelBase | undefined): model is PieChartModel;
+export function isPieChartModel(model: ChartModelBase | ChartModelWrapper | undefined): model is PieChartModel;
 
 /**
  * Determines if the provided `model` is of type `BoxPlotModel`.
  *
  * @param model - The model to check.
  */
-export function isBoxPlotModel(model: ChartModelBase | undefined): model is BoxPlotModel;
+export function isBoxPlotModel(model: ChartModelBase | ChartModelWrapper | undefined): model is BoxPlotModel;
 
 /**
  * Determines if the provided `model` is of type `ScatterplotModel`.
  *
  * @param model - The model to check.
  */
-export function isScatterplotModel(model: ChartModelBase | undefined): model is ScatterplotModel;
+export function isScatterplotModel(model: ChartModelBase | ChartModelWrapper | undefined): model is ScatterplotModel;
 
 /**
  * Determines if the provided `model` is of type `HistogramModel`.
  *
  * @param model - The model to check.
  */
-export function isHistogramModel(model: ChartModelBase | undefined): model is HistogramModel;
+export function isHistogramModel(model: ChartModelBase | ChartModelWrapper | undefined): model is HistogramModel;
 
 /**
  * Determines if the provided `model` is of type `HeatChartModel`.
  *
  * @param model - The model to check.
  */
-export function isHeatChartModel(model: ChartModelBase | undefined): model is HeatChartModel;
+export function isHeatChartModel(model: ChartModelBase | ChartModelWrapper | undefined): model is HeatChartModel;
 
 /**
  * Determines if the provided `model` is of type `GaugeModel`.
  *
  * @param model - The model to check.
  */
-export function isGaugeModel(model: ChartModelBase | undefined): model is GaugeModel;
+export function isGaugeModel(model: ChartModelBase | ChartModelWrapper | undefined): model is GaugeModel;
 
 /**
  * Type guard for ModelWithMultiAxes
  *
  * @param model
  */
-export function isModelWithMultiAxes(model: ChartModel | undefined): model is ModelWithMultiAxes;
+export function isModelWithMultiAxes(model: ChartModel | ChartModelWrapper | undefined): model is ModelWithMultiAxes;
 
 /**
  * Type guard for ModelWithLineMarkerStyling
  *
  * @param model
  */
-export function isModelWithLineMarkerStyling(model: ChartModel | undefined): model is ModelWithLineMarkerStyling;
+export function isModelWithLineMarkerStyling(model: ChartModel | ChartModelWrapper | undefined): model is ModelWithLineMarkerStyling;
 
 /**
  * Type guard for ModelWithTooltips
  *
  * @param model
  */
-export function isModelWithTooltips(model: ChartModel | undefined): model is ModelWithTooltips;
+export function isModelWithTooltips(model: ChartModel | ChartModelWrapper | undefined): model is ModelWithTooltips;
 
 /**
  * Determines if the provided `model` is of type `ModelWithGuides`.
  *
  * @param model - The model to check.
  */
-export function isModelWithGuides(model: ChartModel | undefined): model is ModelWithGuides;
+export function isModelWithGuides(model: ChartModel | ChartModelWrapper | undefined): model is ModelWithGuides;
 
 /**
  * Determines if the provided `model` is of type `ModelWithXGuides`.
  *
  * @param model - The model to check.
  */
-export function isModelWithXGuides(model: ChartModel | undefined): model is ModelWithXGuides;
+export function isModelWithXGuides(model: ChartModel | ChartModelWrapper | undefined): model is ModelWithXGuides;
 
 /**
  * Determines if the provided `model` is of type `ModelWithYGuides`.
  *
  * @param model - The model to check.
  */
-export function isModelWithYGuides(model: ChartModel | undefined): model is ModelWithYGuides;
+export function isModelWithYGuides(model: ChartModel | ChartModelWrapper | undefined): model is ModelWithYGuides;
 
 /**
  * Determines if the provided `model` is of type `ModelWithLegend`.
  *
  * @param model - The model to check.
  */
-export function isModelWithLegend(model: ChartModel | undefined): model is ModelWithLegend;
+export function isModelWithLegend(model: ChartModel | ChartModelWrapper | undefined): model is ModelWithLegend;
 
 /**
  * Determines if the provided `model` is of type `PieChartLegendModel`.
  *
+ * @deprecated since 5.2. Use [isPieChartModel](https://developers.arcgis.com/javascript/latest/references/charts-components/model/shared/type-guards/#isPieChartModel) instead. This function will be removed in 6.0.
  * @param model - The model to check.
  */
 export function isPieChartLegendModel(model: ChartModel | undefined): model is PieChartLegendModel;
@@ -169,7 +171,14 @@ export function isPieChartLegendModel(model: ChartModel | undefined): model is P
  *
  * @param model - The model to check.
  */
-export function isModelWithTemporalBinning(model: ChartModel | undefined): model is ModelWithTemporalBinning;
+export function isModelWithTemporalBinning(model: ChartModel | ChartModelWrapper | undefined): model is ModelWithTemporalBinning;
+
+/**
+ * Determines if the provided `model` supports rounded corners.
+ *
+ * @param model - The model to check.
+ */
+export function isModelWithRoundCorners(model: ChartModelBase | ChartModelWrapper | undefined): model is BarChartModel | ComboBarLineChartModel;
 
 /**
  * Determines if the provided model's type matches the `type` argument.
@@ -177,4 +186,11 @@ export function isModelWithTemporalBinning(model: ChartModel | undefined): model
  * @param model - The model to check.
  * @param type
  */
-export function isModelOfType<T extends ModelTypes | undefined>(model: ChartModel | undefined, type: T): model is ModelOfType<T>;
+export function isModelOfType<T extends ModelTypes | undefined>(model: ChartModel | undefined, type: T): model is ModelOfType<T>;
+
+/**
+ * Determines if the provided model has a `nullCategory` property,
+ *
+ * @param model - | undefined} model  The model to check.
+ */
+export function isModelWithNullCategory(model: ChartModel | undefined): model is SerialChartModel & { nullCategory: WebChartNullCategory; };

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

@@ -27,6 +27,7 @@ export const WebChartTypes: {
     readonly Buffer: "buffer";
     readonly SizePolicy: "sizeScale";
     readonly CalendarDateParts: "calendarDateParts";
+    readonly HistogramBin: "histogramBin";
 };
 
 export type WebChartTypes = (typeof WebChartTypes)[keyof typeof WebChartTypes];

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

@@ -1,4 +1,4 @@
-import type { WebChartTemporalBinningUnits } from "./chart-object-literals.js";
+import type { WebChartTemporalBinningUnits, WebChartTypes } from "./chart-object-literals.js";
 import type { Color, IExtent, ISimpleLineSymbol, ISymbol, SimpleFillSymbolStyle, SimpleLineSymbolStyle, SimpleMarkerSymbolStyle } from "./rest-js-types.js";
 
 /** JSON representation of the color object. */
@@ -28,7 +28,7 @@ export type IRendererSymbol = ISymbol
 
 export type WebChartDataItemColor = Color | RGBArray | RGBObject | string;
 
-export type WebChartDataItemValue = Date | IExtent | IRendererSymbol | number[] | string[] | WebChartDataItem[] | WebChartDataItemColor | boolean | number | string | null | undefined;
+export type WebChartDataItemValue = (number | string)[] | Date | IExtent | IRendererSymbol | number[] | string[] | WebChartDataItem[] | WebChartDataItemColor | boolean | number | string | null | undefined;
 
 /** JSON representation of a typical data item. */
 export type WebChartDataItem = Record<string, WebChartDataItemValue>;
@@ -47,6 +47,13 @@ export interface WebChartHeatChartDataItem {
   heatChartAxesData?: WebHeatChartAxesData;
 }
 
+export interface WebChartGaugeChartDataItem {
+  dataItems: WebChartDataItem[];
+  calculatedAxisMinimum?: number;
+  calculatedAxisMaximum?: number;
+  gaugeValue?: number;
+}
+
 /** JSON representation of the processed data for a scatterplot trend line. */
 export interface ScatterplotTrendLineData {
   r2?: number;
@@ -81,10 +88,15 @@ export interface WebChartGenericDataItem {
   timeIntervalInfo?: TimeIntervalInfo;
   /** Indicates whether the server limit has been reached when fetching data. */
   serverLimitReached?: boolean;
+  /** Indicates whether the chart limit has been reached when fetching data. */
+  chartLimitsReached?: boolean;
 }
 
 /** JSON representation of a histogram bin. */
 export interface WebChartBin {
+  /** Identifier of a bin to simplify distinction between a WebChartBin and a WebChartDataItem */
+  type: typeof WebChartTypes.HistogramBin;
+  /** The bin count */
   count: number;
   /** Minimum value in the bin. */
   minValue: number;
@@ -94,6 +106,8 @@ export interface WebChartBin {
   symbol?: WebChartDataItem;
   /** Whether this is the last bin. */
   isLastBin?: boolean;
+  /** Unique ids associated to each bin */
+  arcgisChartsUniqueIds?: (number | string)[];
 }
 
 /** JSON representation of the processed data for a histogram. */
@@ -112,6 +126,6 @@ export interface WebChartHistogramDataItem {
   bins: WebChartBin[];
 }
 
-export type WebChartDataTypes = WebChartBoxPlotDataItem | WebChartGenericDataItem | WebChartHeatChartDataItem | WebChartHistogramDataItem | WebChartScatterplotDataItem;
+export type WebChartDataTypes = WebChartBoxPlotDataItem | WebChartGaugeChartDataItem | WebChartGenericDataItem | WebChartHeatChartDataItem | WebChartHistogramDataItem | WebChartScatterplotDataItem;
 
 export type RGBArray = [number, number, number];

package/dist/spec/rest-js-types.d.ts

@@ -71,7 +71,16 @@ export interface IGeometry {
   spatialReference?: ISpatialReference;
 }
 
-/** @internal */
+/**
+ * A simple point geometry, with spatial reference defined.
+ *
+ * `IPoint` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IPoint } from "@esri/arcgis-rest-routing";
+ * import { IPoint } from "@esri/arcgis-rest-geocoding";
+ * ```
+ */
 export interface IPoint extends IHasZM, IGeometry {
   x: number;
   y: number;
@@ -90,7 +99,7 @@ export interface ILocation {
   z?: number;
 }
 
-/** @internal */
+/** Polyline geometry. */
 export interface IPolyline extends IHasZM, IGeometry {
   paths: Position[][];
 }
@@ -103,12 +112,12 @@ export interface IPolylineWithCurves extends IHasZM, IGeometry {
   curvePaths: (JsonCurve | Position)[][];
 }
 
-/** @internal */
+/** Polygon geometry. */
 export interface IPolygon extends IHasZM, IGeometry {
   rings: Position[][];
 }
 
-/** @internal */
+/** Polygon geometry with curves. */
 export interface IPolygonWithCurves extends IHasZM, IGeometry {
   curveRings: (JsonCurve | Position)[][];
 }
@@ -1367,7 +1376,6 @@ export interface IBingLayer extends ILayer {
   portalUrl?: string;
 }
 
-/** @internal */
 export interface IImageServiceLayer extends ILayer, ISupportsTime {
   /** An array of bandIds that are visible, can specify bands to export or rearrange band order(from image service). */
   bandIds?: number[];
@@ -1748,7 +1756,7 @@ export interface IOpenStreetMapLayer extends ILayer {
   type?: "OpenStreetMap";
 }
 
-/** @internal */
+/** Tiled image service layer definition. */
 export interface ITiledImageServiceLayer extends ILayer {
   /** Applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
   isReference?: boolean;
@@ -1758,7 +1766,7 @@ export interface ITiledImageServiceLayer extends ILayer {
   refreshInterval?: number;
 }
 
-/** @internal */
+/** Web Coverage Service (WCS) layer definition. */
 export interface IWCSLayer extends ILayer {
   /** Applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
   isReference?: boolean;
@@ -1935,7 +1943,13 @@ export interface ICsvLayer extends ILayer {
   type?: "CSV";
 }
 
-/** @internal */
+/**
+ * Feature layers can be created by referencing a layer from either a map service or a feature service or by specifying a feature collection object.
+ * Use a map service if you just want to retrieve geometries and attributes from the server and symbolize them yourself. Use a feature service if
+ * you want to take advantage of symbols from the service's source map document. Also, use a feature service if you plan on doing editing with the
+ * feature layer. Feature layers honor any feature templates configured in the source map document. Feature collection objects are used to create
+ * a feature layer based on the supplied definition.
+ */
 export interface IFeatureLayer extends ILayer, ISupportsTime {
   /** A comma-separated string listing which editing operations are allowed on an editable feature service. */
   capabilities?: string;