@arcgis/charts-components 5.0.0-next.98 → 5.1.0-next.0

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

@@ -1,126 +1,91 @@
-import { GaugeChartSubTypes, ISimpleFillSymbol, WebChartStatisticType, ValueConversion, WebChartTextSymbol, WebGaugeChart } from '../../spec';
-import { ChartTypes, ChartConfig } from '../../utils';
-import { ChartModel } from '../chart-model/chart-model';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ModelWithBasicXAxis, ModelWithXGuides } from '../mixins';
-export declare class GaugeModel extends ChartModel {
-    /**
-     * Generate the proper chart title given the current config.
-     */
-    generateChartTitle(): string;
-    /**
-     * Current configuration used for the histogram.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.Gauge, WebGaugeChart>;
-    protected layerInfo: LayerInfo;
-    protected _chartType: ChartTypes;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.Gauge>>): Promise<void>;
-    /**
-     * Data field used for the gauge.
-     */
-    get field(): string;
-    set field(field: string);
-    /**
-     * Aggregation type used for the gauge.
-     *
-     * Must be one of the values allowed by `WebChartStatisticType`, excluding `"no_aggregation"`.
-     */
-    get aggregationType(): WebChartStatisticType;
-    set aggregationType(aggregationType: WebChartStatisticType);
-    /**
-     * Inner radius of the gauge.
-     */
-    get innerRadius(): number;
-    set innerRadius(innerRadius: number);
-    /**
-     * Start angle of the gauge.
-     */
-    get startAngle(): number;
-    set startAngle(startAngle: number);
-    /**
-     * End angle of the gauge.
-     */
-    get endAngle(): number;
-    set endAngle(endAngle: number);
-    /**
-     * Conversion to apply to the gauge value.
-     */
-    get valueConversion(): ValueConversion | undefined;
-    set valueConversion(valueConversion: ValueConversion | undefined);
-    /**
-     * Gets the index of the feature to be rendered.
-     * - This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
-     * - For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)
-     */
-    get featureIndex(): number | undefined;
-    set featureIndex(featureIndex: number | null | undefined);
-    /**
-     * Removes the existing feature index from the config object
-     */
-    removeFeatureIndex(): void;
-    /**
-     * Type of Gauge chart, like `FeatureGauge` and `StatisticGauge`.
-     *
-     * **Note**: When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
-     */
-    get gaugeSubType(): GaugeChartSubTypes;
-    /**
-     * Visibility of the gauge's needle.
-     */
-    get needleVisibility(): boolean;
-    set needleVisibility(visible: boolean);
-    /**
-     * Symbol of the gauge's needle.
-     */
-    get needleSymbol(): ISimpleFillSymbol | undefined;
-    set needleSymbol(needleSymbol: ISimpleFillSymbol | undefined);
-    /**
-     * Start width of the gauge's needle.
-     */
-    get needleStartWidth(): number | null | undefined;
-    set needleStartWidth(width: number | null | undefined);
-    /**
-     * End width of the gauge's needle.
-     */
-    get needleEndWidth(): number | null | undefined;
-    set needleEndWidth(width: number | null | undefined);
-    /**
-     * Inner radius of the gauge's needle.
-     */
-    get needleInnerRadius(): number | null | undefined;
-    set needleInnerRadius(innerRadius: number | null | undefined);
-    /**
-     * Whether to display the pin for the gauge's needle.
-     */
-    get needleDisplayPin(): boolean;
-    set needleDisplayPin(displayPin: boolean);
-    /**
-     * Whether the inner label is visible.
-     */
-    get innerLabelVisible(): boolean;
-    set innerLabelVisible(visible: boolean);
-    /**
-     * Content symbol for the inner label.
-     */
-    get innerLabelContent(): WebChartTextSymbol | undefined;
-    set innerLabelContent(innerLabelContent: WebChartTextSymbol | undefined);
-    /**
-     * Whether axis ticks are visible.
-     */
-    get axisTickVisibility(): boolean;
-    set axisTickVisibility(visibile: boolean);
-    /**
-     * Labels increment for the gauge.
-     */
-    get labelsIncrement(): number | undefined;
-    set labelsIncrement(increment: number | undefined);
-    /**
-     * Whether to only show the first and last axis labels.
-     */
-    get onlyShowFirstAndLastLabels(): boolean;
-    set onlyShowFirstAndLastLabels(showOnlyFirstAndLastLabels: boolean);
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-}
-export interface GaugeModel extends ModelWithBasicXAxis, ModelWithXGuides {
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { LayerInfo, 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, WebGaugeChart } 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 { ChartTypes } from "../../utils/misc/index.js";
+import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
+
+export class GaugeModel extends GaugeModelSuperclass {
+  /** Chart type. */
+  protected _chartType: ChartTypes;
+  /** Current configuration used for the histogram. */
+  protected _config: ChartConfig<typeof ModelTypes.Gauge, WebGaugeChart>;
+  /**
+   * 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.
+   * - This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
+   * - 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 chart, like `FeatureGauge` and `StatisticGauge`.
+   *
+   * **Note**: When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
+   */
+  get gaugeSubType(): GaugeChartSubTypes;
+  /** Content symbol for the 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;
+  /** Grouping of layer-related properties to be passed to external function more compactly. */
+  protected layerInfo: LayerInfo;
+  /** 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. */
+  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;
+  /** A function that generates the default config object when creating a new chart. */
+  protected generateDefaultConfig(): Omit<ChartConfig<"gauge", WebGaugeChart>, "iLayer">;
+  /** 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
+   * @async **This method is `async` and must be awaited for the changes to take effect.**
+   */
+  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

@@ -1,156 +1,157 @@
-import { ISimpleFillSymbol, WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartLegendPositions, WebChartNullCategory, WebChartNullPolicyTypes, WebChartStackedKinds, WebChartStatisticType, WebHeatChart } from '../../spec';
-import { ChartConfig } from '../../utils';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes, SerialChartDataSortingKinds, HeatChartDataSortingKinds } 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, WebHeatChart>;
-    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 hide empty rows and columns setting used by the heat chart
-     */
-    get hideEmptyRowsAndColumns(): boolean | undefined;
-    set hideEmptyRowsAndColumns(hideEmptyRowsAndColumns: boolean | 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);
-    get nullPolicy(): WebChartNullPolicyTypes | undefined;
-    /**
-     * The heat charts null policy
-     */
-    set nullPolicy(policy: WebChartNullPolicyTypes | undefined);
-    getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
-    /**
-     * setSortOrder is not used by heat chart; instead use setXAxisSortOrder for the x axis and setYAxisSortOrder for the y axis
-     */
-    setSortOrder(_newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, _orderByList?: string[]): void;
-    /**
-     * Get the sort order on the x axis for the heat chart.
-     * @returns {"Asc" | "Desc" | "customSort"}
-     */
-    getXAxisSortOrder(): HeatChartDataSortingKinds;
-    /**
-     * Sets the sort order on the x axis for the heat chart.
-     * @param {"Asc" | "Desc" | "customSort"}  newSortOrder The new sort order.
-     * @param {string[]} orderByList The list of category's values to order by.
-     */
-    setXAxisSortOrder(newSortOrder: HeatChartDataSortingKinds, orderByList?: string[]): void;
-    /**
-     * Gets the sort order for on the y axis for heat chart.
-     * @returns {"Asc" | "Desc" | "customSort"}
-     */
-    getYAxisSortOrder(): HeatChartDataSortingKinds;
-    /**
-     * Sets the sort order on the y axis for heat chart.
-     * @param {"Asc" | "Desc" | "customSort"}  newSortOrder The new sort order.
-     * @param {string[]} orderByList The list of category's values to order by.
-     */
-    setYAxisSortOrder(newSortOrder: HeatChartDataSortingKinds, orderByList?: string[]): void;
-    get emptyCellText(): string | undefined;
-    /**
-     * The heat charts empty cell text
-     */
-    set emptyCellText(text: string | undefined);
-    get emptyCellSymbol(): ISimpleFillSymbol | undefined;
-    /**
-     * The heat charts empty cell symbol
-     */
-    set emptyCellSymbol(symbol: ISimpleFillSymbol | undefined);
-    /**
-     * The heat chart's second axis (not supported)
-     */
-    setAssignToSecondValueAxis(_assign: boolean, _seriesIndex: number): void;
-    /**
-     * The heat chart's stacked type (not supported)
-     */
-    set stackedType(_stackedType: WebChartStackedKinds | undefined);
-    /**
-     * Bin temporal data for heat chart (not supported)
-     */
-    set binTemporalData(_: boolean);
-    /**
-     * The null category for heat chart (not supported)
-     */
-    set nullCategory(_: WebChartNullCategory);
-    /**
-     * 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 { LayerInfo, ModelTypes, SerialChartDataSortingKinds, HeatChartDataSortingKinds } from "../interfaces/common.js";
+import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
+import type { WebChartCalendarDatePartsBinning, WebChartHeatChartEmptyCell, WebChartHeatChartGradient, WebChartNullCategory, WebHeatChart } 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 {
+  /** Current chart type. */
+  protected _chartType: "heatSeries";
+  /** Current configuration used for the Heat chart. */
+  protected _config: ChartConfig<typeof ModelTypes.HeatChart, WebHeatChart>;
+  /** 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;
+  /**
+   * 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;
+  /** Grouping of layer-related properties to be passed to external function more compactly. */
+  protected layerInfo: LayerInfo;
+  /** 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;
+  /** Generates the default config for the heat chart */
+  protected generateDefaultConfig(): Omit<ChartConfig<"heatChart", WebHeatChart>, "iLayer">;
+  /** 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;
+}