@arcgis/charts-components 4.34.0-next.16 → 4.34.0-next.160

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

@@ -0,0 +1,97 @@
+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 {
+}

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

@@ -0,0 +1,136 @@
+import { WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartLegendPositions, WebChartStatisticType } from '../../../spec';
+import { ChartConfig } from '../../../utils';
+import { LayerInfo, ModelTypes } from '../../interfaces/common';
+type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
+/**
+ * Sets the x field
+ * @param xField The numeric field
+ * @param config The heat chart config
+ * @param layerInfo The layer info
+ */
+export declare const setXField: (props: {
+    xField: string;
+    config: HeatChartConfig;
+    layerInfo: LayerInfo;
+}) => void;
+/**
+ * Gets the x field
+ * @param config the heat chart config
+ */
+export declare const getXField: (config: HeatChartConfig) => string;
+/**
+ * Sets the heat rule type
+ * @param config the chart config
+ * @param heatRulesTypes the heat rules types
+ */
+export declare const setHeatRulesType: (config: HeatChartConfig, heatRulesTypes?: WebChartHeatChartHeatRulesTypes) => void;
+/**
+ * Gets the heat rule type
+ * @param config the chart config
+ */
+export declare const getHeatRulesType: (config: HeatChartConfig) => WebChartHeatChartHeatRulesTypes | undefined;
+/**
+ * Sets the gradient rules
+ * @param config the chart config
+ * @param gradientRules the gradient rules
+ */
+export declare const setGradientRules: (config: HeatChartConfig, gradientRules?: WebChartHeatChartGradient) => void;
+/**
+ * Gets the gradient rules
+ * @param config the chart config
+ */
+export declare const getGradientRules: (config: HeatChartConfig) => WebChartHeatChartGradient | undefined;
+/**
+ * Sets the y field
+ * @param yField The numeric field
+ * @param config The heat chart config
+ * @param layerInfo The layer info
+ */
+export declare const setYField: (props: {
+    yField: string;
+    config: HeatChartConfig;
+    layerInfo: LayerInfo;
+}) => void;
+/**
+ * Gets the y field
+ * @param config the heat chart config
+ */
+export declare const getYField: (config: HeatChartConfig) => string;
+/**
+ * Sets x binning
+ * @param binning the x binning
+ * @param config The heat chart config
+ */
+export declare const setXTemporalBinning: (binning: WebChartCalendarDatePartsBinning | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the x binning
+ * @param config the heat chart config
+ */
+export declare const getXTemporalBinning: (config: HeatChartConfig) => WebChartCalendarDatePartsBinning | undefined;
+/**
+ * Sets y binning
+ * @param binning the y binning
+ * @param config The heat chart config
+ */
+export declare const setYTemporalBinning: (binning: WebChartCalendarDatePartsBinning | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the y binning
+ * @param config the heat chart config
+ */
+export declare const getYTemporalBinning: (config: HeatChartConfig) => WebChartCalendarDatePartsBinning | undefined;
+/**
+ * Sets the grid line width
+ * @param width the grid line width
+ * @param config The heat chart config
+ */
+export declare const setGridLineWidth: (width: number | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the grid line width
+ * @param config the heat chart config
+ */
+export declare const getGridLineWidth: (config: HeatChartConfig) => number | undefined;
+/**
+ * Sets the grid line color
+ * @param color the grid line color
+ * @param config The heat chart config
+ */
+export declare const setGridLineColor: (newColor: number[] | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the grid line width
+ * @param config the heat chart config
+ */
+export declare const getGridLineColor: (config: HeatChartConfig) => import('../../..').Color | undefined;
+/**
+ * Sets the legend position
+ * @param position the legend position
+ * @param config The heat chart config
+ */
+export declare const setLegendPosition: (position: WebChartLegendPositions, config: HeatChartConfig) => void;
+/**
+ * Gets the legend position
+ * @param config the heat chart config
+ */
+export declare const getLegendPosition: (config: HeatChartConfig) => WebChartLegendPositions;
+/**
+ * Gets the numericField from the query
+ * @param config The heat chart config
+ */
+export declare const getNumericField: (config: HeatChartConfig) => string | undefined;
+/**
+ * Sets the numericField for the query
+ * @param field the field
+ * @param config The heat chart config
+ */
+export declare const setNumericField: (field: string, config: HeatChartConfig) => void;
+/**
+ * Gets the aggregationType from the query
+ * @param config the heat chart config
+ */
+export declare const getAggregationType: (config: HeatChartConfig) => "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile-continuous" | "percentile-discrete" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate";
+/**
+ * Sets the aggregationType for the query
+ * @param aggregationType the aggregation type
+ * @param config The heat chart config
+ */
+export declare const setAggregationType: (aggregationType: WebChartStatisticType, config: HeatChartConfig) => void;
+export {};

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

@@ -1,9 +1,9 @@
 import { ChartConfig, XYChartTypes } from '../../utils';
-import { WebChart, WebChartDataTransformations, ISimpleFillSymbol, ISimpleLineSymbol, HistogramOverlays } from '@arcgis/charts-spec';
+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, ModelWithXYAxes, ModelWithTooltips } from '../mixins';
+import { ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides, ModelWithLegend, ModelWithTooltips, ModelWithMultiAxes } from '../mixins';
 export declare class HistogramModel extends ChartModel {
     /**
      * Current configuration used for the histogram.
@@ -13,136 +13,83 @@ export declare class HistogramModel extends ChartModel {
     protected layerInfo: LayerInfo;
     setup(params: ModelParams<ChartConfig<typeof ModelTypes.Histogram>>): Promise<void>;
     /**
-     * Gets numeric field. This is the field used to create a histogram to visualize the frequency distribution of its values.
-     * @returns {string}
-     */
-    getNumericField(): string;
-    /**
-     * Sets numeric field. This is the field used to create a histogram to visualize the frequency distribution of its values.
-     * @param {string} numericField
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
-     */
-    setNumericField(numericField: string): Promise<void>;
-    /**
-     * Gets the number of bins used to create the histogram.
-     * @returns {number}
-     */
-    getBinCount(): number;
-    /**
-     * Sets the number of bins used to create the histogram.
-     * @param {number} binCount
-     */
-    setBinCount(binCount: number): void;
-    /**
-     * Gets the fill symbol used for the bins in the histogram.
-     * @returns {ISimpleFillSymbol}
-     */
-    getBinSymbol(): ISimpleFillSymbol;
-    /**
-     * Sets the fill symbol used for the bins in the histogram.
-     * @param {ISimpleFillSymbol} symbol
-     */
-    setBinSymbol(symbol: ISimpleFillSymbol): void;
-    /**
-     * Gets the data transformation type used in the histogram.
-     * @returns {WebChartDataTransformations}
+     * Numeric field used to create the histogram to visualize the frequency distribution of its values.
      */
-    getDataTransformationType(): WebChartDataTransformations;
+    get numericField(): string;
+    set numericField(numericField: string);
     /**
-     * Sets the data transformation type used in the histogram.
-     * @param {WebChartDataTransformations} dataTransformationType
+     * Number of bins used to create the histogram.
      */
-    setDataTransformationType(dataTransformationType: WebChartDataTransformations): void;
+    get binCount(): number;
+    set binCount(binCount: number);
     /**
-     * Gets the line symbol used for the mean overlay in the histogram.
-     * @returns {ISimpleLineSymbol}
+     * Fill symbol used for the bins in the histogram.
      */
-    getMeanSymbol(): ISimpleLineSymbol;
+    get binSymbol(): ISimpleFillSymbol;
+    set binSymbol(symbol: ISimpleFillSymbol);
     /**
-     * Sets the line symbol used for the mean overlay in the histogram.
-     * @param {ISimpleLineSymbol} symbol
+     * Data transformation type used in the histogram.
      */
-    setMeanSymbol(symbol: ISimpleLineSymbol): void;
+    get dataTransformationType(): WebChartDataTransformations;
+    set dataTransformationType(dataTransformationType: WebChartDataTransformations);
     /**
-     * Gets the line symbol used for the median overlay in the histogram.
-     * @returns {ISimpleLineSymbol}
+     * Line symbol used for the mean overlay in the histogram.
      */
-    getMedianSymbol(): ISimpleLineSymbol;
+    get meanSymbol(): ISimpleLineSymbol;
+    set meanSymbol(symbol: ISimpleLineSymbol);
     /**
-     * Sets the line symbol used for the median overlay in the histogram.
-     * @param {ISimpleLineSymbol} symbol
+     * Line symbol used for the median overlay in the histogram.
      */
-    setMedianSymbol(symbol: ISimpleLineSymbol): void;
+    get medianSymbol(): ISimpleLineSymbol;
+    set medianSymbol(symbol: ISimpleLineSymbol);
     /**
-     * Gets the line symbol used for the normal distribution overlay in the histogram.
-     * @returns {ISimpleLineSymbol}
+     * Line symbol used for the normal distribution overlay in the histogram.
      */
-    getNormalDistSymbol(): ISimpleLineSymbol;
+    get normalDistSymbol(): ISimpleLineSymbol;
+    set normalDistSymbol(symbol: ISimpleLineSymbol);
     /**
-     * Sets the line symbol used for the normal distribution overlay in the histogram.
-     * @param {ISimpleLineSymbol} symbol
+     * Line symbol used for the standard deviation overlay in the histogram.
      */
-    setNormalDistSymbol(symbol: ISimpleLineSymbol): void;
+    get standardDevSymbol(): ISimpleLineSymbol;
+    set standardDevSymbol(symbol: ISimpleLineSymbol);
     /**
-     * Gets the line symbol used for the standard deviation overlay in the histogram.
-     * @returns {ISimpleLineSymbol}
+     * Whether the normal distribution overlay is shown in the histogram.
      */
-    getStandardDevSymbol(): ISimpleLineSymbol;
+    get showNormalDistOverlay(): boolean;
+    set showNormalDistOverlay(show: boolean);
     /**
-     * Sets the line symbol used for the standard deviation overlay in the histogram.
-     * @param {ISimpleLineSymbol} symbol
+     * Whether the mean overlay is shown in the histogram.
      */
-    setStandardDevSymbol(symbol: ISimpleLineSymbol): void;
+    get showMeanOverlay(): boolean;
+    set showMeanOverlay(show: boolean);
     /**
-     * Gets whether the normal distribution overlay is shown in the histogram.
-     * @returns {boolean}
+     * Whether the median overlay is shown in the histogram.
      */
-    getShowNormalDistOverlay(): boolean;
+    get showMedianOverlay(): boolean;
+    set showMedianOverlay(show: boolean);
     /**
-     * Sets whether to show the normal distribution overlay for the histogram.
-     * @param {boolean} show
+     * Whether the standard deviation overlay is shown in the histogram.
      */
-    setShowNormalDistOverlay(show: boolean): void;
+    get showStandardDevOverlay(): boolean;
+    set showStandardDevOverlay(show: boolean);
     /**
-     * Gets whether the mean overlay is shown in the histogram.
-     * @returns {boolean}
+     * Chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
      */
-    getShowMeanOverlay(): boolean;
+    get seriesOverlays(): HistogramOverlays | undefined;
+    set seriesOverlays(overlays: HistogramOverlays | undefined);
     /**
-     * Sets whether to show the mean overlay for the histogram.
-     * @param {boolean} show
-     */
-    setShowMeanOverlay(show: boolean): void;
-    /**
-     * Gets whether the median overlay is shown in the histogram.
-     * @returns {boolean}
-     */
-    getShowMedianOverlay(): boolean;
-    /**
-     * Sets whether to show the median overlay for the histogram.
-     * @param {boolean} show
-     */
-    setShowMedianOverlay(show: boolean): void;
-    /**
-     * Gets whether the standard deviation overlay is shown in the histogram.
-     * @returns {boolean}
-     */
-    getShowStandardDevOverlay(): boolean;
-    /**
-     * Sets whether to show the standard deviation overlay for the histogram.
-     * @param {boolean} show
-     */
-    setShowStandardDevOverlay(show: boolean): void;
-    /**
-     * Get the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
+     * Generate the proper chart title given the current config.
+     *
+     * @returns {string}
      */
-    getSeriesOverlay(): HistogramOverlays | undefined;
+    generateChartTitle(): string;
     /**
-     * Set the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
-     * @param overlays The overlays
+     * Generate the proper x-axis title given the current config.
+     *
+     * @returns {string}
      */
-    setSeriesOverlays(overlays: HistogramOverlays): void;
-    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    generateXAxisTitle(): string;
+    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
 }
-export interface HistogramModel extends ModelWithXYAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides {
+export interface HistogramModel extends ModelWithMultiAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides {
 }

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

@@ -1,6 +1,10 @@
-import { HistogramOverlays, ISimpleFillSymbol, ISimpleLineSymbol, WebChartDataTransformations } from '@arcgis/charts-spec';
-import { HistogramConfig } from '../../../utils';
+import { HistogramOverlays, ISimpleFillSymbol, ISimpleLineSymbol, WebChartDataTransformations } from '../../../spec';
+import { CommonStrings, HistogramConfig } from '../../../utils';
 import { LayerInfo } from '../../interfaces/common';
+/**
+ * Generate the proper chart title given the current config.
+ */
+export declare function getChartTitle(config: HistogramConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
 /**
  * Gets the numeric field from the config
  * @param config The histogram config
@@ -10,8 +14,15 @@ export declare const getNumericField: (config: HistogramConfig) => string;
  * Sets the numeric field in the config
  * @param numericField The numeric field
  * @param config The histogram config
+ * @param layerInfo The layer info
+ * @param commonStrings The common strings
  */
-export declare const setNumericField: (numericField: string, config: HistogramConfig, layerInfo: LayerInfo) => Promise<void>;
+export declare const setNumericField: (props: {
+    numericField: string;
+    config: HistogramConfig;
+    layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
+}) => void;
 /**
  * Gets the data transformation type from the config
  * @param config The histogram config
@@ -97,7 +108,7 @@ export declare const setStandardDevSymbol: (symbol: ISimpleLineSymbol, config: H
 export declare const getShowNormalDistOverlay: (config: HistogramConfig) => boolean;
 /**
  * Sets the show normal distribution overlay in the config
- * @param show Wheter to show the normal distribution overlay
+ * @param show Whether to show the normal distribution overlay
  * @param config The histogram config
  */
 export declare const setShowNormalDistOverlay: (show: boolean, config: HistogramConfig) => void;
@@ -144,4 +155,4 @@ export declare const getSeriesOverlays: (config: HistogramConfig) => HistogramOv
  * @param overlays The overlays
  * @param config The histogram config
  */
-export declare const setSeriesOverlays: (overlays: HistogramOverlays, config: HistogramConfig) => void;
+export declare const setSeriesOverlays: (overlays: HistogramOverlays | undefined, config: HistogramConfig) => void;

package/dist/model/index.d.ts

@@ -8,7 +8,7 @@ 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 './scatter-plot-model/scatter-plot-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';

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

@@ -1,5 +1,5 @@
 import { ChartConfig } from '../../utils';
-import { IFeatureLayer, SupportedLayer, WebChartBarChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '@arcgis/charts-spec';
+import { IFeatureLayer, SupportedLayer, WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
 import { ModelTypes } from './common';
 /**
  * Parameters for creating a chart model.
@@ -21,8 +21,8 @@ export type ModelParams<T extends ChartConfig> = {
 /**
  * Type alias for the supported serial chart config.
  */
-export type SerialChartConfig = ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
+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 | WebChartLineChartSeries | WebChartRadarChartSeries;
+export type SerialChartSeries = WebChartBarChartSeries | WebChartHeatChartSeries | WebChartLineChartSeries | WebChartRadarChartSeries;

package/dist/model/interfaces/common.d.ts

@@ -1,14 +1,15 @@
-import { IField, SupportedLayer, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '@arcgis/charts-spec';
+import { IField, SupportedLayer, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '../../spec';
+import { SupportedChartSeries } from '../../utils';
 import { BarChartModel } from '../bar-chart-model/bar-chart-model';
 import { BoxPlotModel } from '../box-plot-model/box-plot-model';
+import { ComboBarLineChartModel } from '../combo-bar-line-chart-model/combo-bar-line-chart-model';
+import { GaugeModel } from '../gauge-model/gauge-model';
 import { HistogramModel } from '../histogram-model/histogram-model';
 import { LineChartModel } from '../line-chart-model/line-chart-model';
 import { PieChartModel } from '../pie-chart-model/pie-chart-model';
-import { ScatterplotModel } from '../scatter-plot-model/scatter-plot-model';
-import { GaugeModel } from '../gauge-model/gauge-model';
-import { ComboBarLineChartModel } from '../combo-bar-line-chart-model/combo-bar-line-chart-model';
 import { RadarChartModel } from '../radar-chart-model/radar-chart-model';
-import { SupportedChartSeries } from '../../utils';
+import { ScatterplotModel } from '../scatterplot-model/scatterplot-model';
+export declare const customSortString = "customSort";
 export declare const SerialChartDataSortingKinds: {
     readonly xAxisAsc: "xAxisAsc";
     readonly xAxisDesc: "xAxisDesc";
@@ -96,7 +97,6 @@ export declare const GuideOrientation: {
 export type GuideOrientation = (typeof GuideOrientation)[keyof typeof GuideOrientation];
 export interface SplitByFieldInfos {
     categoriesArray: (number | string)[];
-    fieldName: string;
     splitByFieldType: string | undefined;
     numericalField: string;
 }
@@ -131,8 +131,9 @@ export declare const ModelTypes: {
     readonly Histogram: "histogram";
     readonly Gauge: "gauge";
     readonly RadarChart: "radarChart";
+    readonly HeatChart: "heatChart";
 };
 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 : SupportedChartSeries;
-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 : 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 : BarChartModel;
+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;
+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;

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

@@ -1,15 +1,10 @@
 import { ChartConfig } from '../../utils';
-import { WebChart, WebChartLineChartSeries } from '@arcgis/charts-spec';
+import { WebChart, WebChartLineChartSeries } from '../../spec';
 import { ModelParams } from '../interfaces/chart-interfaces';
 import { LayerInfo, ModelTypes } from '../interfaces/common';
 import { ModelWithBaselineStacking, ModelWithLineMarkerStyling } from '../mixins';
 import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
 export declare class LineChartModel extends SerialChartModel {
-    /**
-     * Common strings used in the model.
-     * @category Private
-     */
-    private commonStrings;
     /**
      * Current configuration used for the line chart.
      */
@@ -22,12 +17,12 @@ export declare class LineChartModel extends SerialChartModel {
     protected _chartType: "lineSeries";
     protected layerInfo: LayerInfo;
     setup(params: ModelParams<ChartConfig<typeof ModelTypes.LineChart>>): Promise<void>;
-    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Initializes the default series for the line chart. Used in resetting the series styling.
      * @category Private
      */
-    protected initDefaultSeries(): Promise<void>;
+    protected initDefaultSeries(): void;
     /**
      * Resets the series styling to the default styling.
      */

package/dist/model/mixins/index.d.ts

@@ -1,7 +1,6 @@
 export * from './model-with-color-match';
 export * from './model-with-legend';
 export * from './model-with-basic-x-axis';
-export * from './model-with-xy-axes';
 export * from './model-with-tooltips';
 export * from './model-with-rotation';
 export * from './model-with-data-labels';
@@ -11,3 +10,4 @@ export * from './model-with-y-guides';
 export * from './model-with-temporal-binning';
 export * from './model-with-line-marker-styling';
 export * from './model-with-baseline-stacking';
+export * from './model-with-multi-axes';

package/dist/model/mixins/model-with-baseline-stacking.d.ts

@@ -5,23 +5,17 @@ export declare abstract class ModelWithBaselineStacking extends ChartModel {
     protected _config: ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
     /**
      * Specify how negative values are treated in stacked series.
+     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
      * @param {number} seriesIndex - The index of the series.
-     *
-     * NOTE: If true, negative values will be stacked on the base line.
-     * If false, negative values will be stacked in relation to their previous values in the stack.
-     *
      * @default true
      * @returns {boolean}
      */
     isNegativeValuesStackedToBaseline(seriesIndex: number): boolean;
     /**
      * Specify how negative values are treated in stacked series.
-     * @param {boolean} props.stackedToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
-     *
-     * NOTE: If true, negative values will be stacked on the base line.
-     * If false, negative values will be stacked in relation to their previous values in the stack.
-     *
+     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
+     * @param {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
 }