@arcgis/charts-components 5.0.0-next.11 → 5.0.0-next.110

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

@@ -1,114 +1,197 @@
-import { WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartLegendPositions } from '../../../spec';
+import { ISimpleFillSymbol, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartNullPolicyTypes, WebHeatChart, WebChartLegendPositions, WebChartStatisticType } from '../../../spec';
 import { ChartConfig } from '../../../utils';
 import { LayerInfo, ModelTypes } from '../../interfaces/common';
-type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
+type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebHeatChart>;
 /**
  * Sets the x field
- * @param xField The numeric field
- * @param config The heat chart config
- * @param layerInfo The layer info
+ * @param xField - The numeric field
+ * @param config - The heat chart config
+ * @param layerInfo - The layer info
  */
 export declare const setXField: (props: {
-    xField?: string;
+    xField: string;
     config: HeatChartConfig;
     layerInfo: LayerInfo;
 }) => void;
 /**
  * Gets the x field
- * @param config the heat chart config
+ * @param config - the heat chart config
  */
-export declare const getXField: (config: HeatChartConfig) => string | undefined;
+export declare const getXField: (config: HeatChartConfig) => string;
+/**
+ * Gets the hide empty rows and columns setting
+ * @param config - The heat chart config
+ */
+export declare const getHideEmptyRowsAndColumns: (config: HeatChartConfig) => boolean | undefined;
+/**
+ * Sets the hide empty rows and columns setting
+ * @param config - The heat chart config
+ * @param hideEmptyRowsAndColumns - The hide empty rows and columns setting
+ */
+export declare const setHideEmptyRowsAndColumns: (config: HeatChartConfig, hideEmptyRowsAndColumns: boolean | undefined) => void;
 /**
  * Sets the heat rule type
- * @param config the chart config
- * @param heatRulesTypes the heat rules types
+ * @param config - the chart config
+ * @param heatRulesType - the heat rules type
  */
-export declare const setHeatRulesType: (config: HeatChartConfig, heatRulesTypes?: WebChartHeatChartHeatRulesTypes) => void;
+export declare const setHeatRulesType: (config: HeatChartConfig, heatRulesType?: WebChartHeatChartHeatRulesTypes) => void;
 /**
  * Gets the heat rule type
- * @param config the chart config
+ * @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
+ * @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
+ * @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
+ * @param yField - The numeric field
+ * @param config - The heat chart config
+ * @param layerInfo - The layer info
  */
 export declare const setYField: (props: {
-    yField?: string;
+    yField: string;
     config: HeatChartConfig;
     layerInfo: LayerInfo;
 }) => void;
 /**
  * Gets the y field
- * @param config the heat chart config
+ * @param config - the heat chart config
  */
-export declare const getYField: (config: HeatChartConfig) => string | undefined;
+export declare const getYField: (config: HeatChartConfig) => string;
 /**
  * Sets x binning
- * @param binning the x binning
- * @param config The heat chart config
+ * @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
+ * @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
+ * @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
+ * @param config - the heat chart config
  */
 export declare const getYTemporalBinning: (config: HeatChartConfig) => WebChartCalendarDatePartsBinning | undefined;
+/**
+ * Set the order by list in the config. The order by list is only used when the sort order kind is custom sort.
+ * @param values - The order by values
+ * @param config - The heat chart config
+ */
+export declare const setHeatChartOrderByList: (values: string[], config: HeatChartConfig) => void;
 /**
  * Sets the grid line width
- * @param width the grid line width
- * @param config The heat chart config
+ * @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
+ * @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
+ * @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
+ * @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
+ * @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
+ * @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;
+/**
+ * Gets the null policy
+ * @param config - the heat chart config
+ */
+export declare const getNullPolicy: (config: HeatChartConfig) => WebChartNullPolicyTypes | undefined;
+/**
+ * Sets the null policy for the query
+ * @param nullPolicy - the null policy
+ * @param config - The heat chart config
+ */
+export declare const setNullPolicy: (nullPolicy: WebChartNullPolicyTypes | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the empty cell text
+ * @param config - the heat chart config
+ */
+export declare const getEmptyCellText: (config: HeatChartConfig) => string | undefined;
+/**
+ * Sets the empty cell text
+ * @param text - the text
+ * @param config - The heat chart config
+ */
+export declare const setEmptyCellText: (text: string | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets include leap day flag
+ * @param config - the heat chart config
+ */
+export declare const getIncludeLeapDay: (config: HeatChartConfig) => boolean | undefined;
+/**
+ * Sets the include leap day flag
+ * @param include - the include leap day flag
+ * @param config - The heat chart config
+ */
+export declare const setIncludeLeapDay: (include: boolean | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the empty cell symbol
+ * @param config - the heat chart config
+ */
+export declare const getEmptyCellSymbol: (config: HeatChartConfig) => ISimpleFillSymbol | undefined;
+/**
+ * Sets the empty cell symbol
+ * @param symbol - the symbol
+ * @param config - The heat chart config
+ */
+export declare const setEmptyCellSymbol: (symbol: ISimpleFillSymbol | undefined, config: HeatChartConfig) => void;
 export {};

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

@@ -79,14 +79,10 @@ export declare class HistogramModel extends ChartModel {
     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">;

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

@@ -1,6 +1,7 @@
 import { ChartConfig } from '../../utils';
-import { IFeatureLayer, SupportedLayer, WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
+import { IFeatureLayer, WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
 import { ModelTypes } from './common';
+import { SupportedLayer } from '../../interfaces';
 /**
  * Parameters for creating a chart model.
  */

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

@@ -1,4 +1,5 @@
-import { IField, SupportedLayer, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '../../spec';
+import { SupportedLayer } from '../../interfaces';
+import { IField, 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';
@@ -28,6 +29,12 @@ export declare const BoxPlotDataSortingKinds: {
     readonly customSort: "customSort";
 };
 export type BoxPlotDataSortingKinds = (typeof BoxPlotDataSortingKinds)[keyof typeof BoxPlotDataSortingKinds];
+export declare const HeatChartDataSortingKinds: {
+    readonly Asc: "Asc";
+    readonly Desc: "Desc";
+    readonly customSort: "customSort";
+};
+export type HeatChartDataSortingKinds = (typeof HeatChartDataSortingKinds)[keyof typeof HeatChartDataSortingKinds];
 export declare const PieChartDataSortingKinds: {
     readonly labelAsc: "labelAsc";
     readonly labelDesc: "labelDesc";

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

@@ -11,7 +11,6 @@ export declare class LineChartModel extends SerialChartModel {
     protected _config: ChartConfig<typeof ModelTypes.LineChart, WebChart>;
     /**
      * Default series for the line chart. Used in resetting the series styling.
-     * @category Protected
      */
     protected defaultSeries: WebChartLineChartSeries | undefined;
     protected _chartType: "lineSeries";
@@ -20,7 +19,6 @@ export declare class LineChartModel extends SerialChartModel {
     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(): void;
     /**
@@ -29,7 +27,6 @@ export declare class LineChartModel extends SerialChartModel {
     resetSeriesStyling(): void;
     /**
      * Returns whether the series styling is able to be reset.
-     * @returns {boolean}
      */
     resetAvailable(): boolean;
 }

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.
-     * @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.
      *
-     * 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}
+     * @param seriesIndex - The index of the series.
      */
     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 stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+     * @param seriesIndex - The index of the series.
      */
     setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
 }

package/dist/model/mixins/model-with-basic-x-axis.d.ts

@@ -6,6 +6,11 @@ export declare abstract class ModelWithBasicXAxis extends ChartModel {
      */
     get xAxisTitleText(): string;
     set xAxisTitleText(newXAxisTitleText: string);
+    /**
+     * Whether the x-axis labels are visible.
+     */
+    get xAxisLabelsVisibility(): boolean;
+    set xAxisLabelsVisibility(newXAxisLabelsVisibility: boolean);
     /**
      * Whether the x-axis title is visible.
      * true: X-axis title is visible.
@@ -40,8 +45,6 @@ export declare abstract class ModelWithBasicXAxis extends ChartModel {
     set axisLinesSymbol(newAxisLinesSymbol: ISimpleLineSymbol | undefined);
     /**
      * Generate the proper x-axis title from the current config.
-     *
-     * @returns {string}
      */
     abstract generateXAxisTitle(): string;
 }

package/dist/model/mixins/model-with-guides.d.ts

@@ -4,117 +4,124 @@ import { GuideOrientation } from '../interfaces/common';
 export declare abstract class ModelWithGuides extends ChartModel {
     /**
      * The guide labels text symbol (font, color, style).
-     * @returns {WebChartTextSymbol | undefined}
      */
     get guideLabelsSymbol(): WebChartTextSymbol | undefined;
     set guideLabelsSymbol(newGuideLabelsSymbol: WebChartTextSymbol | undefined);
     /**
      * Gets whether a guide is visible.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {boolean}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideVisibility(index?: number, orientation?: GuideOrientation): boolean;
     /**
-     * Sets whether a guide is visible
-     * @param {boolean} visible New visibility to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     * Sets whether a guide is visible.
+     *
+     * @param visible - New visibility to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideVisibility(visible: boolean, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the start value of a guide.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {Date | number | string | null}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideStart(index?: number, orientation?: GuideOrientation): Date | number | string | null;
     /**
      * Sets the start value of a guide.
-     * @param {Date | number | string | null} start New start value to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param start - New start value to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideStart(start: Date | number | string | null, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the end value of a guide.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {Date | number | string | null}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideEnd(index?: number, orientation?: GuideOrientation): Date | number | string | null | undefined;
     /**
      * Sets the end value of a guide.
-     * @param {Date | number | string | null | undefined} end New end value to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param end - New end value to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideEnd(end: Date | number | string | null | undefined, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the name of a guide.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {string | undefined}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideName(index?: number, orientation?: GuideOrientation): string | undefined;
     /**
      * Sets the name of a guide.
-     * @param {string} name New name to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param name - New name to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideName(name: string, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the guide label text.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {string | undefined}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideLabelText(index?: number, orientation?: GuideOrientation): string | undefined;
     /**
      * Sets the guide label text.
-     * @param {string} labelText New label text to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param labelText - New label text to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideLabelText(labelText: string, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets whether the guide should be rendered above the other chart elements.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {boolean}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideAbove(index?: number, orientation?: GuideOrientation): boolean;
     /**
      * Sets whether the guide should be rendered above the other chart elements.
-     * @param {boolean} above New above boolean to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param above New above boolean to set.
+     * @param index Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation Default `y`. The axis orientation of the guide.
      */
     setGuideAbove(above: boolean, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the guide style.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {ISimpleFillSymbol | ISimpleLineSymbol | undefined}
+     *
+     * @param index Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation Default `y`. The axis orientation of the guide.
      */
     getGuideStyle(index?: number, orientation?: GuideOrientation): ISimpleFillSymbol | ISimpleLineSymbol | undefined;
     /**
      * Sets the guide style.
-     * @param {ISimpleFillSymbol | ISimpleLineSymbol} style New style to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param style New style to set.
+     * @param index Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation Default `y`. The axis orientation of the guide.
      */
     setGuideStyle(style: ISimpleFillSymbol | ISimpleLineSymbol, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets whether the tooltip text color should be reversed for a guide.
+     *
      * @param index - The index of the guide in the list of guides for the given axis orientation.
      * @param orientation - The axis orientation of the guide.
-     * @returns {boolean}
      */
     getTooltipReverseColor(index: number, orientation?: GuideOrientation): boolean;
     /**
      * Sets whether the tooltip text color should be reversed for a guide.
+     *
      * @param reverseColor - New reverseColor boolean to set.
      * @param index - The index of the guide in the list of guides for the given axis orientation.
      * @param orientation - The axis orientation of the guide.