@geoscene/charts-components 5.0.19

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

@@ -0,0 +1,189 @@
+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 { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
+import type { WebChartTypes } from "../../spec/chart-object-literals.js";
+import type { RESTSimpleLineSymbolStyle, RESTSimpleMarkerSymbolStyle } from "../../spec/rest-js-object-literals.js";
+import type { Color } from "../../spec/rest-js-types.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+
+export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
+  /**
+   * Gets the color of the filled area for line chart.
+   * **Note:** `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getAreaColor(seriesIndex: number): Color | undefined;
+  /**
+   * Gets whether to hide oversized data labels of the side-by-side series based on the series index. '
+   *
+   * If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
+  /**
+   * Gets whether to hide oversized data labels of the stacked series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
+  /**
+   * Gets the line style of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
+  /**
+   * Gets the line width of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesLineWidth(seriesIndex: number): number | undefined;
+  /**
+   * Gets the marker color of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesMarkerColor(seriesIndex: number): Color | undefined;
+  /**
+   * Gets the marker size of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesMarkerSize(seriesIndex: number): number | undefined;
+  /**
+   * Gets the marker style of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesMarkerStyle(seriesIndex: number): RESTSimpleMarkerSymbolStyle | undefined;
+  /**
+   * Indicate whether the area is visible for the line series.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  isAreaVisible(seriesIndex: number): boolean;
+  /**
+   * Specify whether line segments of the series should be smoothed.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  isLineSmoothed(seriesIndex: number): boolean;
+  /**
+   * Indicate whether to show or hide the markers/bullets of the line series.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  isMarkerVisible(seriesIndex: number): boolean;
+  /**
+   * Specify the color of the filled area for line chart.
+   * **Note:** This method will only work if the series is a line chart series.
+   *
+   * @param color - The color of the filled area for line chart.
+   * @param seriesIndex - The index of the series.
+   */
+  setAreaColor(color: Color | undefined, seriesIndex: number): void;
+  /**
+   * Specify whether the area should be visible for the line series.
+   * **Note:** This method will only work if the series is a line chart series.
+   *
+   * @param visible - `true` if the line series should show area, `false` otherwise.
+   * @param seriesIndex - The index of the series.
+   */
+  setAreaVisible(visible: boolean, seriesIndex: number): void;
+  /**
+   * Specify whether line segments of the series should be smoothed.
+   * **Note:** This method will only work if the series is a line chart series.
+   *
+   * @param smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+   * @param seriesIndex - The index of the series.
+   */
+  setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
+  /**
+   * Indicate whether to show or hide the markers/bullets of the line series.
+   * **Note:** This method will only work if the series is a line chart series.
+   *
+   * @param visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+   * @param seriesIndex - The index of the series.
+   */
+  setMarkerVisible(visible: boolean, seriesIndex: number): void;
+  /**
+   * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
+   *
+   * **Note:** This method will only work if the series is a bar chart series.
+   *
+   * @param hide - The value for hiding oversized labels.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
+  /**
+   * Sets whether to hide oversized data labels of the stacked series based on the series index.
+   * **Note:** This method will only work if the series is a bar chart series.
+   *
+   * @param hide - The value for hiding oversized stacked labels.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
+  /**
+   * Sets the line style of the series based on the series index.
+   * **Note**: This method will only work if the series is a line chart series.
+   *
+   * @param newStyle - The new style for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesLineStyle(newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number): void;
+  /**
+   * Sets the line width of the series based on the series index.
+   * **Note**: This method will only work if the series is a line chart series.
+   *
+   * @param newWidth - The new width for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
+  /**
+   * Sets the marker color of the series based on the series index.
+   * **Note**: This method will only work if the series is a line chart series.
+   *
+   * @param newColor - The new color for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesMarkerColor(newColor: Color | undefined, seriesIndex: number): void;
+  /**
+   * Sets the marker size of the series based on the series index.
+   * **Note:** This method will only work if the series is a line chart series.
+   *
+   * @param newSize - The new size for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesMarkerSize(newSize: number | undefined, seriesIndex: number): void;
+  /**
+   * Sets the marker style of the series based on the series index.
+   * **Note:** This method will only work if the series is a line chart series.
+   *
+   * @param newStyle - The new style for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesMarkerStyle(newStyle: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex: number): void;
+  /**
+   * Changes the chart series type at the specified index from bar to line and vice-versa.
+   *
+   * @param seriesIndex - The index of the series to update.
+   * @param seriesType - The new chart series type to apply.
+   */
+  setSeriesType(seriesIndex: number, seriesType: WebChartTypes): 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.ComboBarLineChart>>): Promise<void>;
+}
+declare const ComboBarLineChartModelSuperclass: typeof SerialChartModel & typeof WithNegativeValuesStackedToBaseline

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

@@ -0,0 +1,103 @@
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes } from "../interfaces/common.js";
+import type { WithAxisLabelsSymbol } from "../properties/axes/axis-labels-symbol.js";
+import type { WithAxisLinesSymbol } from "../properties/axes/axis-lines-symbol.js";
+import type { WithXBounds } from "../properties/axes/x-axis/x-bounds.js";
+import type { WithXAxisLabelsVisibility } from "../properties/axes/x-axis/x-axis-labels-visibility.js";
+import type { WithXAxisTitleSymbol } from "../properties/axes/x-axis/x-axis-title-symbol.js";
+import type { WithXAxisTitleText } from "../properties/axes/x-axis/x-axis-title-text.js";
+import type { WithXAxisTitleVisibility } from "../properties/axes/x-axis/x-axis-title-visibility.js";
+import type { WithGenerateXAxisTitle } from "../properties/axes/x-axis/generate-x-axis-title.js";
+import type { ValueConversion, WebChartTextSymbol } from "../../spec/web-chart.js";
+import type { GaugeChartSubTypes, WebChartStatisticType } from "../../spec/chart-object-literals.js";
+import type { ISimpleFillSymbol } from "../../spec/rest-js-types.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
+
+export class GaugeModel extends GaugeModelSuperclass {
+  /**
+   * Aggregation type used for the gauge.
+   *
+   * Must be one of the values allowed by `WebChartStatisticType`, excluding `"no_aggregation"`.
+   */
+  accessor aggregationType: WebChartStatisticType;
+  /** Whether axis ticks are visible. */
+  accessor axisTickVisibility: boolean;
+  /** End angle of the gauge. */
+  accessor endAngle: number;
+  /**
+   * Gets the index of the feature to be rendered.
+   * - For statistic gauge, this property will be ignored.
+   * - For feature based gauge, if this property is not present, the first feature will be used (`featureIndex = 0`).
+   */
+  get featureIndex(): number | undefined;
+  set featureIndex(value: number | null | undefined);
+  /** Data field used for the gauge. */
+  accessor field: string;
+  /**
+   * Type of gauge
+   * - `featureGauge` indicates that the gauge is based on a specific feature from the layer.
+   * - `statisticGauge` indicates that the gauge is based on a statistic value calculated from the layer's features.
+   *
+   * **Note**: When this property is not specified, it will be defaulted to `statisticGauge`.
+   */
+  get gaugeSubType(): GaugeChartSubTypes;
+  /**
+   * Content symbol for the inner label.
+   *
+   * @example
+   * ```typescript
+   * gaugeModel.innerLabelContent = {
+   *   type: "esriTS",
+   *   text: "Inner label",
+   * };
+   * ```
+   */
+  accessor innerLabelContent: WebChartTextSymbol | undefined;
+  /** Whether the inner label is visible. */
+  accessor innerLabelVisible: boolean;
+  /** Inner radius of the gauge. */
+  accessor innerRadius: number;
+  /** Labels increment for the gauge. */
+  accessor labelsIncrement: number | undefined;
+  /** Whether to display the pin for the gauge's needle. */
+  accessor needleDisplayPin: boolean;
+  /** End width of the gauge's needle. */
+  accessor needleEndWidth: number | null | undefined;
+  /** Inner radius of the gauge's needle. */
+  accessor needleInnerRadius: number | null | undefined;
+  /** Start width of the gauge's needle. */
+  accessor needleStartWidth: number | null | undefined;
+  /**
+   * Symbol of the gauge's needle.
+   *
+   * @example
+   * ```typescript
+   * gaugeModel.needleSymbol = {
+   *   type: "esriSFS",
+   *   color: [255, 0, 0, 255],
+   * };
+   * ```
+   */
+  accessor needleSymbol: ISimpleFillSymbol | undefined;
+  /** Visibility of the gauge's needle. */
+  accessor needleVisibility: boolean;
+  /** Whether to only show the first and last axis labels. */
+  accessor onlyShowFirstAndLastLabels: boolean;
+  /** Start angle of the gauge. */
+  accessor startAngle: number;
+  /** Conversion to apply to the gauge value. */
+  accessor valueConversion: ValueConversion | undefined;
+  /** Generate the proper chart title given the current config. */
+  generateChartTitle(): string;
+  /** Removes the existing feature index from the config object. */
+  removeFeatureIndex(): void;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.Gauge>>): Promise<void>;
+}
+declare const GaugeModelSuperclass: typeof ChartModel & typeof ModelWithXGuides & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText

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

@@ -0,0 +1,224 @@
+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 { 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. */
+  accessor aggregationType: WebChartStatisticType;
+  /**
+   * Bin temporal data for heat chart (not supported)
+   *
+   * @internal
+   */
+  accessor binTemporalData: boolean;
+  /**
+   * The number of class breaks used by the heat chart.
+   *
+   * @default 5
+   */
+  accessor breaksCount: number;
+  /**
+   * 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 chart's empty cell configuration. */
+  accessor emptyCell: WebChartHeatChartEmptyCell | undefined;
+  /** The heat chart's empty cell symbol. */
+  accessor emptyCellSymbol: ISimpleFillSymbol | undefined;
+  /** 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
+   */
+  accessor firstDayOfWeek: number | undefined;
+  /**
+   * Set the gradient rules for the heat chart, which define how data values map to colors.
+   *
+   * @example
+   * In this example, we set the gradient rules for the heat chart to use a color gradient from light blue to red, with specific colors for values outside the defined range.
+   *
+   * ```js
+   * heatChartModel.gradientRules = {
+   *   colorList: [
+   *     [200, 225, 255, 255],
+   *     [220, 0, 0, 255],
+   *   ],
+   *   minValue: 100,
+   *   maxValue: 250,
+   *   outsideRangeLowerColor: [0, 255, 255, 255],
+   *   outsideRangeUpperColor: [0, 30, 30, 255],
+   * };
+   * ```
+   */
+  accessor gradientRules: WebChartHeatChartGradient | undefined;
+  /** The grid line color used by the heat chart. */
+  accessor gridLineColor: number[] | undefined;
+  /** The grid line width used by the heat chart. */
+  accessor gridLineWidth: number | undefined;
+  /**
+   * 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;
+  /** Hide the empty rows and columns in the heat chart. */
+  accessor hideEmptyRowsAndColumns: boolean | undefined;
+  /** Whether to include leap day (February 29) in the heat chart when using "day of month" temporal binning. */
+  accessor includeLeapDay: boolean | undefined;
+  /** The heat chart's legend position. */
+  accessor legendPosition: WebChartLegendPositions;
+  /**
+   * The null category for heat chart (not supported)
+   *
+   * @internal
+   */
+  accessor nullCategory: WebChartNullCategory;
+  /**
+   * 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)
+   *
+   * @internal
+   */
+  accessor rotatedState: boolean;
+  /**
+   * The name of the series that is used by the heat chart.
+   *
+   * @internal
+   */
+  accessor seriesName: string | undefined;
+  /**
+   * Split-by field not supported for heat charts.
+   *
+   * @internal
+   */
+  accessor splitByField: string;
+  /**
+   * 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 is only applicable for calendar heat charts (when `xAxisField` and `yAxisField` are date fields).
+   */
+  accessor viewType: WebChartHeatChartViewTypes | undefined;
+  /**
+   * 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. */
+  accessor yAxisField: string;
+  /**
+   * The y axis temporal binning used by the heat chart.
+   *
+   * @example
+   * ```ts
+   * heatChartModel.yTemporalBinning = {
+   *   type: WebChartTypes.CalendarDateParts,
+   *   unit: WebChartCalendarDatePartsUnits.DayOfMonth,
+   * };
+   * ```
+   */
+  accessor yTemporalBinning: WebChartCalendarDatePartsBinning | undefined;
+  /** Generate the proper chart title given the current config. */
+  generateChartTitle(): string;
+  /** Generate the proper y-axis title given the current config. */
+  generateYAxisTitle(): string;
+  /** Gets the grid lines symbol. Contains styling information such as line width, line style, and line color. */
+  getGridLinesSymbol(): ISimpleLineSymbol | undefined;
+  /** Gets the sort order for the bar chart. */
+  getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
+  /**
+   * Get the sort order on the x axis for the heat chart.
+   *
+   * @returns {"Asc" | "Desc" | "customSort"}
+   */
+  getXAxisSortOrder(): HeatChartDataSortingKinds;
+  /**
+   * Gets the sort order for on the y axis for heat chart.
+   *
+   * @returns {"Asc" | "Desc" | "customSort"}
+   */
+  getYAxisSortOrder(): HeatChartDataSortingKinds;
+  /**
+   * The heat chart's second axis (not supported)
+   *
+   * @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.
+   *
+   * @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
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.HeatChart>>): Promise<void>;
+  /**
+   * Sets the sort order on the x axis for the heat chart.
+   *
+   * @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 - 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

@@ -0,0 +1,75 @@
+import type { ModelTypes } from "../interfaces/common.js";
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ChartModel } from "../chart-model/chart-model.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 { WithXBounds } from "../properties/axes/x-axis/x-bounds.js";
+import type { WithXAxisLabelsVisibility } from "../properties/axes/x-axis/x-axis-labels-visibility.js";
+import type { WithXAxisTitleSymbol } from "../properties/axes/x-axis/x-axis-title-symbol.js";
+import type { WithXAxisTitleText } from "../properties/axes/x-axis/x-axis-title-text.js";
+import type { WithXAxisTitleVisibility } from "../properties/axes/x-axis/x-axis-title-visibility.js";
+import type { WithGenerateXAxisTitle } from "../properties/axes/x-axis/generate-x-axis-title.js";
+import type { WithAxisLabelsSymbol } from "../properties/axes/axis-labels-symbol.js";
+import type { WithAxisLinesSymbol } from "../properties/axes/axis-lines-symbol.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { HistogramOverlays } from "../../spec/web-chart.js";
+import type { WebChartDataTransformations } from "../../spec/chart-object-literals.js";
+import type { ISimpleFillSymbol, ISimpleLineSymbol } from "../../spec/rest-js-types.js";
+import type { ModelWithMultiAxes } from "../mixins/model-with-multi-axes.js";
+import type { ModelWithLegend } from "../mixins/model-with-legend.js";
+import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
+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.
+   *
+   * @example
+   * ```ts
+   * histogramModel.binSymbol = {
+   *  style: "esriSFSForwardDiagonal",
+   *  color: [0, 255, 0, 100],
+   * };
+   * ```
+   */
+  accessor binSymbol: ISimpleFillSymbol;
+  /**
+   * 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;
+  /** Line symbol used for the median overlay in the histogram. */
+  accessor medianSymbol: ISimpleLineSymbol;
+  /** Line symbol used for the normal distribution overlay in the histogram. */
+  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 histogram: **mean**, **median**, **standardDeviation** and **comparisonDistribution**. */
+  accessor seriesOverlays: HistogramOverlays | undefined;
+  /** Whether the mean overlay is shown in the histogram. */
+  accessor showMeanOverlay: boolean;
+  /** Whether the median overlay is shown in the histogram. */
+  accessor showMedianOverlay: boolean;
+  /** Whether the normal distribution overlay is shown in the histogram. */
+  accessor showNormalDistOverlay: boolean;
+  /** Whether the standard deviation overlay is shown in the histogram. */
+  accessor showStandardDevOverlay: boolean;
+  /** Line symbol used for the standard deviation overlay in the histogram. */
+  accessor standardDevSymbol: ISimpleLineSymbol;
+  /** Generate the proper chart title given the current config. */
+  generateChartTitle(): string;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.Histogram>>): Promise<void>;
+}
+declare const HistogramModelSuperclass: typeof ChartModel & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText & typeof ModelWithYGuides & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes

package/dist/model/index.d.ts

@@ -0,0 +1,18 @@
+export type * from "./chart-model/chart-model";
+export type * from "./chart-model/utils/types";
+export type * from "./bar-chart-model/bar-chart-model";
+export type * from "./box-plot-model/box-plot-model";
+export type * from "./gauge-model/gauge-model";
+export type * from "./histogram-model/histogram-model";
+export type * from "./line-chart-model/line-chart-model";
+export type * from "./radar-chart-model/radar-chart-model";
+export type * from "./pie-chart-model/pie-chart-model";
+export type * from "./pie-chart-model/pie-chart-legend-model";
+export type * from "./scatterplot-model/scatterplot-model";
+export type * from "./serial-chart-model/serial-chart-model";
+export type * from "./combo-bar-line-chart-model/combo-bar-line-chart-model";
+export type * from "./interfaces/chart-interfaces";
+export * from "./interfaces/common";
+export * from "./shared/type-guards";
+export * from "./shared/setup-utils";
+

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

@@ -0,0 +1,21 @@
+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 { WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from "../../spec/web-chart.js";
+
+/** Parameters for creating a chart model. */
+export type ModelParams<T extends ChartConfig> = {
+  /** Layer instance associated with the chart. */
+  layer?: SupportedLayer;
+  /** Layer description to be used when the `layer` property is not set. */
+  iLayer?: IFeatureLayer;
+  /** Chart config object to be edited. If not provided, a new config will be created using default values. */
+  config?: T;
+};
+
+/** Type alias for the supported serial chart config. */
+export type SerialChartConfig = ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.HeatChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
+
+/** Type alias for the supported serial chart series. */
+export type SerialChartSeries = WebChartBarChartSeries | WebChartHeatChartSeries | WebChartLineChartSeries | WebChartRadarChartSeries;