@arcgis/charts-components 5.0.0-next.16 → 5.0.0-next.161

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

@@ -1,97 +1,156 @@
-import { WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartStatisticType, WebChartLegendPositions } from '../../spec';
-import { ChartConfig } from '../../utils';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ModelWithDataLabels, ModelWithTooltips } from '../mixins';
-import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
-export type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
-export declare class HeatChartModel extends SerialChartModel {
-    generateChartTitle(): string;
-    /**
-     * Current configuration used for the Heat chart.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
-    protected _chartType: "heatSeries";
-    protected layerInfo: LayerInfo;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.HeatChart>>): Promise<void>;
-    /**
-     * The x axis field used by the heat chart
-     */
-    get xAxisField(): string;
-    set xAxisField(xField: string);
-    /**
-     * The y axis field used by the heat chart
-     */
-    get yAxisField(): string;
-    set yAxisField(yAxisField: string);
-    /**
-     * The x temporal binning used by the heat chart
-     */
-    get xTemporalBinning(): WebChartCalendarDatePartsBinning | undefined;
-    set xTemporalBinning(binning: WebChartCalendarDatePartsBinning | undefined);
-    /**
-     * The y temporal binning used by the heat chart
-     */
-    get yTemporalBinning(): WebChartCalendarDatePartsBinning | undefined;
-    set yTemporalBinning(binning: WebChartCalendarDatePartsBinning | undefined);
-    /**
-     * The grid line width used by the heat chart
-     */
-    get gridLineWidth(): number | undefined;
-    set gridLineWidth(width: number | undefined);
-    /**
-     * The grid line color used by the heat chart
-     */
-    get gridLineColor(): number[] | undefined;
-    set gridLineColor(color: number[] | undefined);
-    /**
-     * The name of the series that is used by the heat chart
-     */
-    get seriesName(): string | undefined;
-    set seriesName(seriesName: string | undefined);
-    /**
-     * The heat rules type used by the heat chart
-     */
-    get heatRulesType(): WebChartHeatChartHeatRulesTypes | undefined;
-    set heatRulesType(heatRulesTypes: WebChartHeatChartHeatRulesTypes | undefined);
-    /**
-     * The grandient rules used by the heat chart
-     */
-    get gradientRules(): WebChartHeatChartGradient | undefined;
-    set gradientRules(gradientRule: WebChartHeatChartGradient | 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.
-     */
-    get numericFields(): string[];
-    set numericFields(fields: string[]);
-    /**
-     * The aggregation type for the heat chart. Must be one of the values allowed by WebChartStatisticType.
-     */
-    get aggregationType(): WebChartStatisticType;
-    set aggregationType(aggregationType: WebChartStatisticType);
-    /**
-     * Split-by field is not used by heat chart
-     */
-    get splitByField(): string;
-    set splitByField(_: string);
-    /**
-     * The heat charts legend's title (not supported yet)
-     */
-    set legendTitleText(_: string);
-    get legendPosition(): WebChartLegendPositions;
-    /**
-     * The heat charts legend's position
-     */
-    set legendPosition(position: WebChartLegendPositions);
-    /**
-     * The heat chart's rotatedState (not supported)
-     */
-    set rotatedState(_: boolean);
-    /**
-     * Generates the default config for the heat chart
-     */
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-}
-export interface HeatChartModel extends ModelWithTooltips, ModelWithDataLabels {
-}
+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 } 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. */
+  accessor aggregationType: WebChartStatisticType;
+  /** Bin temporal data for heat chart (not supported) */
+  accessor binTemporalData: boolean;
+  /**
+   * The number of class breaks used by the heat chart
+   *
+   * @default 5
+   */
+  accessor breaksCount: number;
+  /** The class breaks method used by the heat chart */
+  accessor classificationMethod: WebChartClassBreakTypes | undefined;
+  /** The heat charts empty cell config */
+  accessor emptyCell: WebChartHeatChartEmptyCell | undefined;
+  /** The heat charts empty cell symbol */
+  accessor emptyCellSymbol: ISimpleFillSymbol | undefined;
+  /** The heat charts 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 */
+  accessor heatRulesType: WebChartHeatChartHeatRulesTypes | undefined;
+  /** The hide empty rows and columns setting used by the heat chart */
+  accessor hideEmptyRowsAndColumns: boolean | undefined;
+  /** The heat charts include leap day flag that is only honored when day of month is used */
+  accessor includeLeapDay: boolean | undefined;
+  /** The heat charts legend's 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
+   */
+  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.
+   */
+  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 */
+  accessor seriesName: string | undefined;
+  /** Split-by field is not used by heat chart */
+  accessor splitByField: string;
+  /** The heat chart's stacked type (not supported) */
+  accessor stackedType: WebChartStackedKinds | undefined;
+  /**
+   * The calendar view type for the heat chart.
+   *
+   * **NOTE**: This property is only applicable to the Calendar heat chart.
+   */
+  accessor viewType: WebChartHeatChartViewTypes | undefined;
+  /** The x temporal binning used by the heat chart */
+  accessor xTemporalBinning: WebChartCalendarDatePartsBinning | undefined;
+  /** The y axis field used by the heat chart */
+  accessor yAxisField: string;
+  /** The y temporal binning used by the heat chart */
+  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 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
+   */
+  setAssignToSecondValueAxis(_assign: boolean, _seriesIndex: number): void;
+  /**
+   * setSortOrder is not used by heat chart; instead use setXAxisSortOrder for the x axis and setYAxisSortOrder for the y axis
+   *
+   * @param _newSortOrder
+   * @param _orderByList
+   */
+  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.
+   */
+  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.
+   */
+  setYAxisSortOrder(newSortOrder: HeatChartDataSortingKinds, orderByList?: string[]): void;
+}

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

@@ -1,95 +1,61 @@
-import { ChartConfig, XYChartTypes } from '../../utils';
-import { WebChart, WebChartDataTransformations, ISimpleFillSymbol, ISimpleLineSymbol, HistogramOverlays } from '../../spec';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { ChartModel } from '../chart-model/chart-model';
-import { ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides, ModelWithLegend, ModelWithTooltips, ModelWithMultiAxes } from '../mixins';
-export declare class HistogramModel extends ChartModel {
-    /**
-     * Current configuration used for the histogram.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.Histogram, WebChart>;
-    protected _chartType: XYChartTypes;
-    protected layerInfo: LayerInfo;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.Histogram>>): Promise<void>;
-    /**
-     * Numeric field used to create the histogram to visualize the frequency distribution of its values.
-     */
-    get numericField(): string;
-    set numericField(numericField: string);
-    /**
-     * Number of bins used to create the histogram.
-     */
-    get binCount(): number;
-    set binCount(binCount: number);
-    /**
-     * Fill symbol used for the bins in the histogram.
-     */
-    get binSymbol(): ISimpleFillSymbol;
-    set binSymbol(symbol: ISimpleFillSymbol);
-    /**
-     * Data transformation type used in the histogram.
-     */
-    get dataTransformationType(): WebChartDataTransformations;
-    set dataTransformationType(dataTransformationType: WebChartDataTransformations);
-    /**
-     * Line symbol used for the mean overlay in the histogram.
-     */
-    get meanSymbol(): ISimpleLineSymbol;
-    set meanSymbol(symbol: ISimpleLineSymbol);
-    /**
-     * Line symbol used for the median overlay in the histogram.
-     */
-    get medianSymbol(): ISimpleLineSymbol;
-    set medianSymbol(symbol: ISimpleLineSymbol);
-    /**
-     * Line symbol used for the normal distribution overlay in the histogram.
-     */
-    get normalDistSymbol(): ISimpleLineSymbol;
-    set normalDistSymbol(symbol: ISimpleLineSymbol);
-    /**
-     * Line symbol used for the standard deviation overlay in the histogram.
-     */
-    get standardDevSymbol(): ISimpleLineSymbol;
-    set standardDevSymbol(symbol: ISimpleLineSymbol);
-    /**
-     * Whether the normal distribution overlay is shown in the histogram.
-     */
-    get showNormalDistOverlay(): boolean;
-    set showNormalDistOverlay(show: boolean);
-    /**
-     * Whether the mean overlay is shown in the histogram.
-     */
-    get showMeanOverlay(): boolean;
-    set showMeanOverlay(show: boolean);
-    /**
-     * Whether the median overlay is shown in the histogram.
-     */
-    get showMedianOverlay(): boolean;
-    set showMedianOverlay(show: boolean);
-    /**
-     * Whether the standard deviation overlay is shown in the histogram.
-     */
-    get showStandardDevOverlay(): boolean;
-    set showStandardDevOverlay(show: boolean);
-    /**
-     * Chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
-     */
-    get seriesOverlays(): HistogramOverlays | undefined;
-    set seriesOverlays(overlays: HistogramOverlays | undefined);
-    /**
-     * Generate the proper chart title given the current config.
-     *
-     * @returns {string}
-     */
-    generateChartTitle(): string;
-    /**
-     * Generate the proper x-axis title given the current config.
-     *
-     * @returns {string}
-     */
-    generateXAxisTitle(): string;
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-}
-export interface HistogramModel extends ModelWithMultiAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides {
+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. */
+  accessor binSymbol: ISimpleFillSymbol;
+  /** Data transformation type used in the histogram. */
+  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 series. Histogram supports 4 overlays: **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
+   * @async **This method is `async` and must be awaited for the changes to take effect.**
+   */
+  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

@@ -1,17 +1,18 @@
-export type * from './chart-model/chart-model.js';
-export type * from './chart-model/utils/types.js';
-export type * from './bar-chart-model/bar-chart-model.js';
-export type * from './box-plot-model/box-plot-model.js';
-export type * from './gauge-model/gauge-model.js';
-export type * from './histogram-model/histogram-model.js';
-export type * from './line-chart-model/line-chart-model.js';
-export type * from './radar-chart-model/radar-chart-model.js';
-export type * from './pie-chart-model/pie-chart-model.js';
-export type * from './pie-chart-model/pie-chart-legend-model.js';
-export type * from './scatterplot-model/scatterplot-model.js';
-export type * from './serial-chart-model/serial-chart-model.js';
-export type * from './combo-bar-line-chart-model/combo-bar-line-chart-model.js';
-export type * from './interfaces/chart-interfaces.js';
-export * from './interfaces/common.js';
-export * from './shared/type-guards.js';
-export * from './shared/setup-utils.js';
+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

@@ -1,28 +1,21 @@
-import { ChartConfig } from '../../utils';
-import { IFeatureLayer, SupportedLayer, WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
-import { ModelTypes } from './common';
-/**
- * Parameters for creating a chart model.
- */
+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;
+  /** 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.
- */
+
+/** 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;
+
+/** Type alias for the supported serial chart series. */
+export type SerialChartSeries = WebChartBarChartSeries | WebChartHeatChartSeries | WebChartLineChartSeries | WebChartRadarChartSeries;