@arcgis/charts-components 4.33.0-next.106 → 4.33.0-next.108

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

@@ -19,10 +19,10 @@ export declare class HistogramModel extends ChartModel {
     getNumericField(): string;
     /**
      * Sets numeric field. This is the field used to create a histogram to visualize the frequency distribution of its values.
-     * @param {string} newNumericField
+     * @param {string} numericField
      * @async **This method is `async` and must be awaited for the changes to take effect.**
      */
-    setNumericField(newNumericField: string): Promise<void>;
+    setNumericField(numericField: string): Promise<void>;
     /**
      * Gets the number of bins used to create the histogram.
      * @returns {number}
@@ -30,19 +30,19 @@ export declare class HistogramModel extends ChartModel {
     getBinCount(): number;
     /**
      * Sets the number of bins used to create the histogram.
-     * @param {number} newBinCount
+     * @param {number} binCount
      */
-    setBinCount(newBinCount: number): void;
+    setBinCount(binCount: number): void;
     /**
-     * Gets the fill color used for the bins in the histogram.
+     * Gets the fill symbol used for the bins in the histogram.
      * @returns {ISimpleFillSymbol}
      */
-    getBinColor(): ISimpleFillSymbol;
+    getBinSymbol(): ISimpleFillSymbol;
     /**
-     * Sets the fill color used for the bins in the histogram.
-     * @param {ISimpleFillSymbol} newBinColor
+     * Sets the fill symbol used for the bins in the histogram.
+     * @param {ISimpleFillSymbol} symbol
      */
-    setBinColor(newBinColor: ISimpleFillSymbol): void;
+    setBinSymbol(symbol: ISimpleFillSymbol): void;
     /**
      * Gets the data transformation type used in the histogram.
      * @returns {WebChartDataTransformations}
@@ -50,98 +50,98 @@ export declare class HistogramModel extends ChartModel {
     getDataTransformationType(): WebChartDataTransformations;
     /**
      * Sets the data transformation type used in the histogram.
-     * @param {WebChartDataTransformations} newDataTransformationType
+     * @param {WebChartDataTransformations} dataTransformationType
      */
-    setDataTransformationType(newDataTransformationType: WebChartDataTransformations): void;
+    setDataTransformationType(dataTransformationType: WebChartDataTransformations): void;
     /**
-     * Gets the line color used for the mean overlay in the histogram.
+     * Gets the line symbol used for the mean overlay in the histogram.
      * @returns {ISimpleLineSymbol}
      */
-    getMeanColor(): ISimpleLineSymbol;
+    getMeanSymbol(): ISimpleLineSymbol;
     /**
-     * Sets the line color used for the mean overlay in the histogram.
-     * @param {ISimpleLineSymbol} newMeanColor
+     * Sets the line symbol used for the mean overlay in the histogram.
+     * @param {ISimpleLineSymbol} symbol
      */
-    setMeanColor(newMeanColor: ISimpleLineSymbol): void;
+    setMeanSymbol(symbol: ISimpleLineSymbol): void;
     /**
-     * Gets the line color used for the median overlay in the histogram.
+     * Gets the line symbol used for the median overlay in the histogram.
      * @returns {ISimpleLineSymbol}
      */
-    getMedianColor(): ISimpleLineSymbol;
+    getMedianSymbol(): ISimpleLineSymbol;
     /**
-     * Sets the line color used for the median overlay in the histogram.
-     * @param {ISimpleLineSymbol} newMedianColor
+     * Sets the line symbol used for the median overlay in the histogram.
+     * @param {ISimpleLineSymbol} symbol
      */
-    setMedianColor(newMedianColor: ISimpleLineSymbol): void;
+    setMedianSymbol(symbol: ISimpleLineSymbol): void;
     /**
-     * Gets the line color used for the normal distribution overlay in the histogram.
+     * Gets the line symbol used for the normal distribution overlay in the histogram.
      * @returns {ISimpleLineSymbol}
      */
-    getNormalDistColor(): ISimpleLineSymbol;
+    getNormalDistSymbol(): ISimpleLineSymbol;
     /**
-     * Sets the line color used for the normal distribution overlay in the histogram.
-     * @param {ISimpleLineSymbol} newNormalDistColor
+     * Sets the line symbol used for the normal distribution overlay in the histogram.
+     * @param {ISimpleLineSymbol} symbol
      */
-    setNormalDistColor(newNormalDistColor: ISimpleLineSymbol): void;
+    setNormalDistSymbol(symbol: ISimpleLineSymbol): void;
     /**
-     * Gets the line color used for the standard deviation overlay in the histogram.
+     * Gets the line symbol used for the standard deviation overlay in the histogram.
      * @returns {ISimpleLineSymbol}
      */
-    getStandardDevColor(): ISimpleLineSymbol;
+    getStandardDevSymbol(): ISimpleLineSymbol;
     /**
-     * Sets the line color used for the standard deviation overlay in the histogram.
-     * @param {ISimpleLineSymbol} newStandardDevColor
+     * Sets the line symbol used for the standard deviation overlay in the histogram.
+     * @param {ISimpleLineSymbol} symbol
      */
-    setStandardDevColor(newStandardDevColor: ISimpleLineSymbol): void;
+    setStandardDevSymbol(symbol: ISimpleLineSymbol): void;
     /**
      * Gets whether the normal distribution overlay is shown in the histogram.
      * @returns {boolean}
      */
     getShowNormalDistOverlay(): boolean;
     /**
-     * Sets whether the normal distribution overlay is shown in the histogram.
-     * @param {boolean} newShowNormalDistOverlay
+     * Sets whether to show the normal distribution overlay for the histogram.
+     * @param {boolean} show
      */
-    setShowNormalDistOverlay(newShowNormalDistOverlay: boolean): void;
+    setShowNormalDistOverlay(show: boolean): void;
     /**
      * Gets whether the mean overlay is shown in the histogram.
      * @returns {boolean}
      */
     getShowMeanOverlay(): boolean;
     /**
-     * Sets whether the mean overlay is shown in the histogram.
-     * @param {boolean} newShowMeanOverlay
+     * Sets whether to show the mean overlay for the histogram.
+     * @param {boolean} show
      */
-    setShowMeanOverlay(newShowMeanOverlay: boolean): void;
+    setShowMeanOverlay(show: boolean): void;
     /**
      * Gets whether the median overlay is shown in the histogram.
      * @returns {boolean}
      */
     getShowMedianOverlay(): boolean;
     /**
-     * Sets whether the median overlay is shown in the histogram.
-     * @param {boolean} newShowMedianOverlay
+     * Sets whether to show the median overlay for the histogram.
+     * @param {boolean} show
      */
-    setShowMedianOverlay(newShowMedianOverlay: boolean): void;
+    setShowMedianOverlay(show: boolean): void;
     /**
      * Gets whether the standard deviation overlay is shown in the histogram.
      * @returns {boolean}
      */
     getShowStandardDevOverlay(): boolean;
     /**
-     * Sets whether the standard deviation overlay is shown in the histogram.
-     * @param {boolean} newShowStandardDevOverlay
+     * Sets whether to show the standard deviation overlay for the histogram.
+     * @param {boolean} show
      */
-    setShowStandardDevOverlay(newShowStandardDevOverlay: boolean): void;
+    setShowStandardDevOverlay(show: boolean): void;
     /**
      * Get the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
      */
     getSeriesOverlay(): HistogramOverlays | undefined;
     /**
      * Set the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
-     * @param newOverlays - the new overlays
+     * @param overlays The overlays
      */
-    setSeriesOverlays(newSeriesOverlay: HistogramOverlays): void;
+    setSeriesOverlays(overlays: HistogramOverlays): void;
     protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
 }
 export interface HistogramModel extends ModelWithXYAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides {

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

@@ -2,146 +2,146 @@ import { HistogramOverlays, ISimpleFillSymbol, ISimpleLineSymbol, WebChartDataTr
 import { HistogramConfig } from '../../../utils';
 import { LayerInfo } from '../../interfaces/common';
 /**
- * get the numeric field from the config
- * @param config - the histogram config
+ * Gets the numeric field from the config
+ * @param config The histogram config
  */
 export declare const getNumericField: (config: HistogramConfig) => string;
 /**
- * set the numeric field in the config
- * @param newNumericField - the new numeric field
- * @param config - the histogram config
+ * Sets the numeric field in the config
+ * @param numericField The numeric field
+ * @param config The histogram config
  */
-export declare const setNumericField: (newNumericField: string, config: HistogramConfig, layerInfo: LayerInfo) => Promise<void>;
+export declare const setNumericField: (numericField: string, config: HistogramConfig, layerInfo: LayerInfo) => Promise<void>;
 /**
- * get the data transformation type from the config
- * @param config - the histogram config
+ * Gets the data transformation type from the config
+ * @param config The histogram config
  */
 export declare const getDataTransformationType: (config: HistogramConfig) => WebChartDataTransformations;
 /**
- * set the data transformation type in the config
- * @param newDataTransformationType - the new data transformation type
- * @param config - the histogram config
+ * Sets the data transformation type in the config
+ * @param dataTransformationType The data transformation type
+ * @param config The histogram config
  */
-export declare const setDataTransformationType: (newDataTransformationType: WebChartDataTransformations, config: HistogramConfig) => void;
+export declare const setDataTransformationType: (dataTransformationType: WebChartDataTransformations, config: HistogramConfig) => void;
 /**
- * get the bin count from the config
+ * Gets the bin count from the config
  * @param config the histogram config
  * @returns the bin count
  */
 export declare const getBinCount: (config: HistogramConfig) => number;
 /**
- * set the bin count in the config
- * @param newBinCount - the new bin count
- * @param config - the histogram config
+ * Sets the bin count in the config
+ * @param binCount The bin count
+ * @param config The histogram config
  */
-export declare const setBinCount: (newBinCount: number, config: HistogramConfig) => void;
+export declare const setBinCount: (binCount: number, config: HistogramConfig) => void;
 /**
- * get the bin color from the config
- * @param config - the histogram config
+ * Gets the bin symbol from the config
+ * @param config The histogram config
  */
-export declare const getBinColor: (config: HistogramConfig) => ISimpleFillSymbol;
+export declare const getBinSymbol: (config: HistogramConfig) => ISimpleFillSymbol;
 /**
- * set the bin color in the config
- * @param newBinColor - the new bin color
- * @param config - the histogram config
+ * Sets the bin symbol in the config
+ * @param symbol The bin symbol
+ * @param config The histogram config
  */
-export declare const setBinColor: (newBinColor: ISimpleFillSymbol, config: HistogramConfig) => void;
+export declare const setBinSymbol: (symbol: ISimpleFillSymbol, config: HistogramConfig) => void;
 /**
- * get the normal distribution color from the config
- * @param config - the histogram config
+ * Gets the normal distribution symbol from the config
+ * @param config The histogram config
  */
-export declare const getNormalDistColor: (config: HistogramConfig) => ISimpleLineSymbol;
+export declare const getNormalDistSymbol: (config: HistogramConfig) => ISimpleLineSymbol;
 /**
- * set the normal distribution color in the config
- * @param newNormalDistColor - the new normal distribution color
- * @param config - the histogram config
+ * Sets the normal distribution symbol in the config
+ * @param symbol The normal distribution symbol
+ * @param config The histogram config
  */
-export declare const setNormalDistColor: (newNormalDistColor: ISimpleLineSymbol, config: HistogramConfig) => void;
+export declare const setNormalDistSymbol: (symbol: ISimpleLineSymbol, config: HistogramConfig) => void;
 /**
- * get the mean color from the config
- * @param config - the histogram config
+ * Gets the mean symbol from the config
+ * @param config The histogram config
  */
-export declare const getMeanColor: (config: HistogramConfig) => ISimpleLineSymbol;
+export declare const getMeanSymbol: (config: HistogramConfig) => ISimpleLineSymbol;
 /**
- * set the mean color in the config
- * @param newMeanColor - the new mean color
- * @param config - the histogram config
+ * Sets the mean symbol in the config
+ * @param symbol The mean symbol
+ * @param config The histogram config
  */
-export declare const setMeanColor: (newMeanColor: ISimpleLineSymbol, config: HistogramConfig) => void;
+export declare const setMeanSymbol: (symbol: ISimpleLineSymbol, config: HistogramConfig) => void;
 /**
- * get the median color from the config
- * @param config - the histogram config
+ * Gets the median symbol from the config
+ * @param config The histogram config
  */
-export declare const getMedianColor: (config: HistogramConfig) => ISimpleLineSymbol;
+export declare const getMedianSymbol: (config: HistogramConfig) => ISimpleLineSymbol;
 /**
- * set the median color in the config
- * @param newMedianColor - the new median color
- * @param config - the histogram config
+ * Sets the median symbol in the config
+ * @param symbol The median symbol
+ * @param config The histogram config
  */
-export declare const setMedianColor: (newMedianColor: ISimpleLineSymbol, config: HistogramConfig) => void;
+export declare const setMedianSymbol: (symbol: ISimpleLineSymbol, config: HistogramConfig) => void;
 /**
- * get the standard deviation color from the config
- * @param config - the histogram config
+ * Gets the standard deviation symbol from the config
+ * @param config The histogram config
  */
-export declare const getStandardDevColor: (config: HistogramConfig) => ISimpleLineSymbol;
+export declare const getStandardDevSymbol: (config: HistogramConfig) => ISimpleLineSymbol;
 /**
- * set the standard deviation color in the config
- * @param newStandardDevColor - the new standard deviation color
- * @param config - the histogram config
+ * Sets the standard deviation symbol in the config
+ * @param symbol The standard deviation symbol
+ * @param config The histogram config
  */
-export declare const setStandardDevColor: (newStandardDevColor: ISimpleLineSymbol, config: HistogramConfig) => void;
+export declare const setStandardDevSymbol: (symbol: ISimpleLineSymbol, config: HistogramConfig) => void;
 /**
- * get the show normal distribution overlay from the config
- * @param config - the histogram config
+ * Gets the show normal distribution overlay setting from the config
+ * @param config The histogram config
  */
 export declare const getShowNormalDistOverlay: (config: HistogramConfig) => boolean;
 /**
- * set the show normal distribution overlay in the config
- * @param newShowNormalDistOverlay - the new show normal distribution overlay
- * @param config - the histogram config
+ * Sets the show normal distribution overlay in the config
+ * @param show Wheter to show the normal distribution overlay
+ * @param config The histogram config
  */
-export declare const setShowNormalDistOverlay: (newShowNormalDistOverlay: boolean, config: HistogramConfig) => void;
+export declare const setShowNormalDistOverlay: (show: boolean, config: HistogramConfig) => void;
 /**
- * get the show mean overlay from the config
- * @param config - the histogram config
+ * Gets the show mean overlay setting from the config
+ * @param config The histogram config
  */
 export declare const getShowMeanOverlay: (config: HistogramConfig) => boolean;
 /**
- * set the show mean overlay in the config
- * @param newShowMeanOverlay - the new show mean overlay
- * @param config - the histogram config
+ * Sets the show mean overlay in the config
+ * @param show Whether to show the mean overlay
+ * @param config The histogram config
  */
-export declare const setShowMeanOverlay: (newShowMeanOverlay: boolean, config: HistogramConfig) => void;
+export declare const setShowMeanOverlay: (show: boolean, config: HistogramConfig) => void;
 /**
- * get the show median overlay from the config
- * @param config - the histogram config
+ * Gets the show median overlay setting from the config
+ * @param config The histogram config
  */
 export declare const getShowMedianOverlay: (config: HistogramConfig) => boolean;
 /**
- * set the show median overlay in the config
- * @param newShowMedianOverlay - the new show median overlay
- * @param config - the histogram config
+ * Sets the show median overlay in the config
+ * @param show Whether to show the median overlay
+ * @param config The histogram config
  */
-export declare const setShowMedianOverlay: (newShowMedianOverlay: boolean, config: HistogramConfig) => void;
+export declare const setShowMedianOverlay: (show: boolean, config: HistogramConfig) => void;
 /**
- * get the show standard deviation overlay from the config
- * @param config - the histogram config
+ * Gets the show standard deviation overlay setting from the config
+ * @param config The histogram config
  */
 export declare const getShowStandardDevOverlay: (config: HistogramConfig) => boolean;
 /**
- * set the show standard deviation overlay in the config
- * @param newShowStandardDevOverlay - the new show standard deviation overlay
- * @param config - the histogram config
+ * Sets the show standard deviation overlay in the config
+ * @param show Whether to show standard deviation overlay
+ * @param config The histogram config
  */
-export declare const setShowStandardDevOverlay: (newShowStandardDevOverlay: boolean, config: HistogramConfig) => void;
+export declare const setShowStandardDevOverlay: (show: boolean, config: HistogramConfig) => void;
 /**
- * Get the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
- * @param config - the histogram config
+ * Gets the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
+ * @param config The histogram config
  */
 export declare const getSeriesOverlays: (config: HistogramConfig) => HistogramOverlays | undefined;
 /**
- * Set the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
- * @param newOverlays - the new overlays
- * @param config - the histogram config
+ * Sets the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
+ * @param overlays The overlays
+ * @param config The histogram config
  */
-export declare const setSeriesOverlays: (newOverlays: HistogramOverlays, config: HistogramConfig) => void;
+export declare const setSeriesOverlays: (overlays: HistogramOverlays, config: HistogramConfig) => void;

package/dist/model/mixins/model-with-xy-axes.d.ts

@@ -1,5 +1,5 @@
 import { XYChartTypes } from '../../utils';
-import { CategoryFormatOptions, DateTimeFormatOptions, NumberFormatOptions, WebChartAxisScrollBar, WebChartTextSymbol, ISimpleLineSymbol, WebChartLabelBehavior } from '@arcgis/charts-spec';
+import { CategoryFormatOptions, DateTimeFormatOptions, NumberFormatOptions, WebChartAxisScrollBar, WebChartTextSymbol, ISimpleLineSymbol, WebChartLabelBehavior, WebChartCursorCrosshair } from '@arcgis/charts-spec';
 import { ModelWithBasicXAxis } from './model-with-basic-x-axis';
 export declare abstract class ModelWithXYAxes extends ModelWithBasicXAxis {
     protected _chartType: XYChartTypes;
@@ -269,4 +269,52 @@ export declare abstract class ModelWithXYAxes extends ModelWithBasicXAxis {
      * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
      */
     setIntegerOnlyValues(integerOnlyValues: boolean, axisIndex: number): void;
+    /**
+     * Gets the visibility of the horizontal line of the cursor's crosshair.
+     * @returns {boolean}
+     * @remarks if the cursor crosshair or its horizontal line visibility is not set, the default value of `false` will be returned.
+     */
+    getCursorCrosshairHorizontalLineVisibility(): boolean;
+    /**
+     * Sets the visibility of the horizontal line of the cursor's crosshair.
+     * @param visibility The visibility to set for the cursor's crosshair horizontal line
+     * @remarks if the cursor crosshair is not set, it will be created with the default values.
+     */
+    setCursorCrosshairHorizontalLineVisibility(visibility: boolean): void;
+    /**
+     * Gets the visibility of the vertical line of the cursor's crosshair.
+     * @returns {boolean}
+     * @remarks if the cursor crosshair or its vertical line visibility is not set, the default value of `false` will be returned.
+     */
+    getCursorCrosshairVerticalLineVisibility(): boolean;
+    /**
+     * Sets the visibility of the vertical line of the cursor's crosshair.
+     * @param visibility The visibility to set for the cursor's crosshair vertical line
+     * @remarks if the cursor crosshair is not set, it will be created with the default values.
+     */
+    setCursorCrosshairVerticalLineVisibility(visibility: boolean): void;
+    /**
+     * Gets the style of the cursor's crosshair from the chart config.
+     * @param config The chart configuration
+     * @returns {boolean}
+     */
+    getCursorCrosshairStyle(): ISimpleLineSymbol | undefined;
+    /**
+     * Sets the style of the cursor's crosshair in the chart config.
+     * @param style The style to set for the cursor's crosshair
+     * @param config The chart configuration
+     */
+    setCursorCrosshairStyle(style: ISimpleLineSymbol): void;
+    /**
+     * Gets the cursor crosshair from the chart config.
+     * @param config The chart configuration object
+     * @returns {WebChartCursorCrosshair | undefined}
+     */
+    getCursorCrosshair(): WebChartCursorCrosshair | undefined;
+    /**
+     * Sets the cursor crosshair in the chart config.
+     * @param cursorCrosshair The cursor crosshair to set
+     * @param config The chart configuration object
+     */
+    setCursorCrosshair(cursorCrosshair: WebChartCursorCrosshair): void;
 }