@arcgis/charts-components 5.1.0-next.13 → 5.1.0-next.131

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

@@ -1,35 +1,48 @@
 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, 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 name of the color ramp used by the heat chart. */
+  accessor colorRampName: string | undefined;
+  /** 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,53 +65,100 @@ 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 */
+  /**
+   * Whether the color ramp is flipped for the heat chart,
+   * which means the colors will be reversed (e.g., if the original color ramp goes from light to dark, flipping it will make it go from dark to light).
+   */
+  accessor isColorRampFlipped: boolean;
+  /** 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) */
-  accessor rotatedState: boolean;
-  /** The name of the series that is used by the heat chart */
+  /**
+   * The heat chart's rotated state (not supported)
+   *
+   * @internal
+   */
+  accessor rotated: boolean;
+  /**
+   * 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;
@@ -125,40 +185,50 @@ export class HeatChartModel extends SerialChartModel {
    *
    * @param _assign
    * @param _seriesIndex
+   * @internal
    */
   setAssignToSecondValueAxis(_assign: boolean, _seriesIndex: number): void;
   /**
    * 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
+   * 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,17 +1,20 @@
-import type { ModelTypes } from "./common.js";
-import type { SupportedLayer } from "../../interfaces.js";
-import type { ChartConfig } from "../../utils/types/index.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 { WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from "../../spec/web-chart.js";
+import type { CommonStrings } from "../../utils/localization/interfaces.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { ModelTypes } from "./common.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;
+  /** t9n error strings */
+  commonStrings?: CommonStrings;
 };
 
 /** Type alias for the supported serial chart config. */

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";
@@ -7,6 +7,7 @@ import type { BarChartModel } from "../bar-chart-model/bar-chart-model.js";
 import type { BoxPlotModel } from "../box-plot-model/box-plot-model.js";
 import type { ComboBarLineChartModel } from "../combo-bar-line-chart-model/combo-bar-line-chart-model.js";
 import type { GaugeModel } from "../gauge-model/gauge-model.js";
+import type { HeatChartModel } from "../heat-chart-model/heat-chart-model.js";
 import type { HistogramModel } from "../histogram-model/histogram-model.js";
 import type { LineChartModel } from "../line-chart-model/line-chart-model.js";
 import type { PieChartModel } from "../pie-chart-model/pie-chart-model.js";
@@ -140,7 +141,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. */
@@ -164,6 +165,7 @@ export type ModelTypes = (typeof ModelTypes)[keyof typeof ModelTypes];
 
 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;
 
-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;
+export type ModelOfType<T> = T extends typeof ModelTypes.BarChart ? BarChartModel : 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 ? HeatChartModel : never;

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

@@ -1,9 +1,9 @@
+import type { ChartConfig } from "../../utils/types/index.js";
 import type { ModelParams } from "../interfaces/chart-interfaces.js";
 import type { ModelTypes } from "../interfaces/common.js";
-import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
-import type { WithNegativeValuesStackedToBaseline } from "../properties/series/negative-values-stacked-to-baseline.js";
-import type { ChartConfig } from "../../utils/types/index.js";
 import type { ModelWithLineMarkerStyling } from "../mixins/model-with-line-marker-styling.js";
+import type { WithNegativeValuesStackedToBaseline } from "../properties/series/negative-values-stacked-to-baseline.js";
+import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
 
 export class LineChartModel extends LineChartModelSuperclass {
   /** Returns whether the series styling is able to be reset. */
@@ -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

@@ -1,20 +1,20 @@
+import type { WebChartStatisticType } from "../../spec/chart-object-literals.js";
+import type { Color, ISimpleLineSymbol } from "../../spec/rest-js-types.js";
+import type { WebChartPieChartGroupSlice, WebChartPieChartSlice } from "../../spec/web-chart.js";
+import type { ChartConfig } from "../../utils/types/index.js";
 import type { ChartModel } from "../chart-model/chart-model.js";
 import type { ModelParams } from "../interfaces/chart-interfaces.js";
 import type { ModelTypes, PieChartDataSortingKinds, PieChartSlicesDisplay, PieChartDataModes } from "../interfaces/common.js";
+import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
 import type { WithColorMatch } from "../properties/color-match.js";
-import type { WithDataLabelsVisibility } from "../properties/data-labels/data-labels-visibility.js";
 import type { WithDataLabelsSymbol } from "../properties/data-labels/data-labels-symbol.js";
+import type { WithDataLabelsVisibility } from "../properties/data-labels/data-labels-visibility.js";
 import type { PieChartLegendModel } from "./pie-chart-legend-model.js";
-import type { ChartConfig } from "../../utils/types/index.js";
-import type { WebChartPieChartGroupSlice, WebChartPieChartSlice } from "../../spec/web-chart.js";
-import type { WebChartStatisticType } from "../../spec/chart-object-literals.js";
-import type { Color, ISimpleLineSymbol } from "../../spec/rest-js-types.js";
-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;
 }