@arcgis/charts-components 5.0.0-next.9 → 5.0.0-next.91

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

@@ -2,31 +2,36 @@ import { WebChartDataFilters } from '../../../spec';
 import { ChartConfig } from '../../../utils';
 /**
  * Sets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
- * @param fetchNULLValues Whether to fetch `null` values.
- * @param config The chart config.
+ *
+ * @param fetchNULLValues - Whether to fetch `null` values.
+ * @param config - The chart config.
  */
 export declare const setFetchNULLValues: (fetchNULLValues: boolean, config: ChartConfig) => void;
 /**
  * Gets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
- * @param config The chart config.
- * @returns {boolean} Boolean value indicates whether NULL values will be fetched.
+ *
+ * @param config - The chart config.
+ * @returns Boolean value indicates whether NULL values will be fetched.
  */
 export declare const getFetchNULLValues: (config: ChartConfig) => boolean;
 /**
  * Gets the split by values from the chart config.
- * @param config The chart config.
- * @returns {string[]} An array of split by values.
+ *
+ * @param config - The chart config.
+ * @returns An array of split by values.
  */
 export declare const getSplitByValues: (config: ChartConfig) => string[];
 /**
  * Get the data filter from the config.
- * @param  {ChartConfig} config - The chart config.
- * @returns WebChartDataFilters | undefined - The data filter.
+ *
+ * @param config - The chart config.
+ * @returns The data filter.
  */
 export declare const getDataFilters: (config: ChartConfig) => WebChartDataFilters | undefined;
 /**
  * Set the data filter in the config.
- * @param  {WebChartDataFilters | undefined} dataFilter - The data filter.
- * @param  {ChartConfig} config - The chart config.
+ *
+ * @param dataFilter - The data filter.
+ * @param config - The chart config.
  */
 export declare const setDataFilters: (dataFilter: WebChartDataFilters | undefined, config: ChartConfig) => void;

package/dist/model/chart-model/utils/general.d.ts

@@ -2,23 +2,25 @@ import { IDrawingInfo } from '../../../spec';
 import { ChartConfig } from '../../../utils';
 /**
  * Gets the version of the chart configuration.
- * @returns {string}
  */
 export declare const getVersion: (config: ChartConfig) => string | undefined;
 /**
- * Gets the title text of the chart from the config
- * @param config The config object
+ * Gets the title text of the chart from the config.
+ *
+ * @param config - The config object
  */
 export declare const getTitleText: (config: ChartConfig) => string;
 /**
- * Sets the title text of the chart
- * @param titleText The title text
- * @param config The config object
+ * Sets the title text of the chart.
+ *
+ * @param titleText - The title text
+ * @param config - The config object
  */
 export declare const setTitleText: (titleText: string, config: ChartConfig) => void;
 /**
- * Gets the subtitle text of the chart from the config
- * @param config The config object
+ * Gets the subtitle text of the chart from the config.
+ *
+ * @param config - The config object
  */
 export declare const getSubtitleText: (config: ChartConfig) => string;
 /**
@@ -28,8 +30,9 @@ export declare const getSubtitleText: (config: ChartConfig) => string;
  */
 export declare const setSubtitleText: (subtitleText: string, config: ChartConfig) => void;
 /**
- * Gets the description text
- * @param config The config object
+ * Gets the description text.
+ *
+ * @param config - The config object
  */
 export declare const getDescriptionText: (config: ChartConfig) => string;
 /**
@@ -40,46 +43,53 @@ export declare const getDescriptionText: (config: ChartConfig) => string;
 export declare const setDescriptionText: (descriptionText: string, config: ChartConfig) => void;
 /**
  * Gets whether the chart title is visible.
- * @param config The config object
+ * @param config - The config object
  */
 export declare const getChartTitleVisibility: (config: ChartConfig) => boolean;
 /**
  * Sets whether to the chart title is visible.
- * @param visibility Whether or not to show the chart title
- * @param config The config object
+ *
+ * @param visibility - Whether or not to show the chart title
+ * @param config - The config object
  */
 export declare const setChartTitleVisibility: (visibility: boolean, config: ChartConfig) => void;
 /**
  * Gets whether the chart subtitle is visible.
- * @param config The config object
+ *
+ * @param config - The config object
  */
 export declare const getChartSubtitleVisibility: (config: ChartConfig) => boolean;
 /**
  * Sets whether to the chart subtitle is visible.
- * @param visibility Whether or not to show the chart subtitle
- * @param config The config object
+ *
+ * @param visibility - Whether or not to show the chart subtitle
+ * @param config - The config object
  */
 export declare const setChartSubtitleVisibility: (visibility: boolean, config: ChartConfig) => void;
 /**
  * Gets whether the description is visible.
- * @param config The config object
+ *
+ * @param config - The config object
  */
 export declare const getDescriptionVisibility: (config: ChartConfig) => boolean;
 /**
  * Sets whether the description is visible.
- * @param visibility Whether or not to show the description
- * @param config The config object
+ *
+ * @param visibility - Whether or not to show the description
+ * @param config - The config object
  */
 export declare const setDescriptionVisibility: (visibility: boolean, config: ChartConfig) => void;
 /**
  * Gets the chart renderer from the chart config.
- * @param config  The chart config
- * @returns {IDrawingInfo["renderer"] | undefined} The chart renderer if defined, otherwise undefined.
+ *
+ * @param config - The chart config
+ * @returns The chart renderer if defined, otherwise undefined.
  */
 export declare const getChartRenderer: (config: ChartConfig) => IDrawingInfo["renderer"] | undefined;
 /**
  * Sets the chart renderer in the chart config.
- * @param renderer The chart renderer to set.
- * @param config The chart config to set the renderer on.
+ *
+ * @param renderer - The chart renderer to set.
+ * @param config - The chart config to set the renderer on.
  */
 export declare const setChartRenderer: (renderer: IDrawingInfo["renderer"] | undefined, config: ChartConfig) => void;

package/dist/model/chart-model/utils/series.d.ts

@@ -18,15 +18,17 @@ export declare const getSeriesLength: (config: ChartConfig) => number;
 export declare const getSeriesVisibility: (seriesIndex: number, config: ChartConfig) => boolean;
 /**
  * Returns the data tooltip value format for a series.
- * @param  {WebChartSeriesType[]} series The chart series
- * @param {number} seriesIndex The index of the series to retrieve the value format for
+ *
+ * @param series - The chart series
+ * @param seriesIndex - The index of the series to retrieve the value format for
  */
 export declare function getDataTooltipValueFormat(series: WebChartSeriesType[], seriesIndex: number): NumberFormatOptions | undefined;
 /**
  * Sets the data tooltip value format for a series.
- * @param {WebChartSeriesType[]} props.series - The chart series
- * @param {number} props.seriesIndex - The index of the series to set the value format for
- * @param {NumberFormatOptions | undefined} props.valueFormat - The value format to set
+ *
+ * @param props.series - The chart series
+ * @param props.seriesIndex - The index of the series to set the value format for
+ * @param props.valueFormat - The value format to set
  */
 export declare function setDataTooltipValueFormat(props: {
     series: WebChartSeriesType[];

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

@@ -10,7 +10,6 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     protected _config: ChartConfig<typeof ModelTypes.ComboBarLineChart, WebChart>;
     /**
      * Default series for the line chart. Used in resetting the series styling.
-     * @category Protected
      */
     protected defaultSeries: WebChartLineChartSeries | undefined;
     protected _chartType: "comboLineAndBarSeries";
@@ -20,194 +19,184 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Initializes the default series for the combo bar-line chart. Used in resetting the series styling.
-     * @category Private
      */
     protected initDefaultSeries(): void;
+    /**
+     * Changes the chart series type at the specified index from bar to line and vice-versa.
+     *
+     * @param seriesIndex - The index of the series to update.
+     * @param seriesType - The new chart series type to apply.
+     */
     setSeriesType(seriesIndex: number, seriesType: WebChartTypes): void;
     /**
      * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {RESTSimpleLineSymbolStyle | undefined}
+     *
+     * @param seriesIndex The index of the series.
      */
     getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
     /**
      * Sets the line style of the series based on the series index.
-     * @param {RESTSimpleLineSymbolStyle | undefined} newStyle The new style for the series.
-     * @param {number} seriesIndex The index of the series.
+     * **Note**: This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * @param newStyle - The new style for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesLineStyle(newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number): void;
     /**
      * Gets the line width of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {number | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesLineWidth(seriesIndex: number): number | undefined;
     /**
      * Sets the line width of the series based on the series index.
-     * @param {number | undefined} newWidth The new width for the series.
-     * @param {number} seriesIndex The index of the series.
+     * **Note**: This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * @param newWidth - The new width for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
     /**
      * Gets the marker color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {Color | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesMarkerColor(seriesIndex: number): Color | undefined;
     /**
      * Sets the marker color of the series based on the series index.
-     * @param {Color | undefined} newColor The new color for the series.
-     * @param {number} seriesIndex The index of the series.
+     * **Note**: This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * @param newColor - The new color for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesMarkerColor(newColor: Color | undefined, seriesIndex: number): void;
     /**
      * Gets the marker style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {RESTSimpleMarkerSymbolStyle | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesMarkerStyle(seriesIndex: number): RESTSimpleMarkerSymbolStyle | undefined;
     /**
      * Sets the marker style of the series based on the series index.
-     * @param {RESTSimpleMarkerSymbolStyle | undefined} newStyle The new style for the series.
-     * @param {number} seriesIndex The index of the series.
+     * **Note:** This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * @param newStyle - The new style for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesMarkerStyle(newStyle: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex: number): void;
     /**
      * Gets the marker size of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {number | undefined}
+     * @param seriesIndex - The index of the series.
      */
     getSeriesMarkerSize(seriesIndex: number): number | undefined;
     /**
      * Sets the marker size of the series based on the series index.
-     * @param {number | undefined} newSize The new size for the series.
-     * @param {number} seriesIndex The index of the series.
+     * **Note:** This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * @param newSize - The new size for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesMarkerSize(newSize: number | undefined, seriesIndex: number): void;
     /**
      * Specify whether line segments of the series should be smoothed.
-     * @param {number} seriesIndex - The index of the series.
      *
-     * @default false
-     * @returns {boolean}
+     * @param seriesIndex - The index of the series.
      */
     isLineSmoothed(seriesIndex: number): boolean;
     /**
      * Specify whether line segments of the series should be smoothed.
-     * @param {boolean} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * **Note:** This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
-     * @default false
+     * @param smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+     * @param seriesIndex - The index of the series.
      */
     setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
     /**
      * Specify whether the line series should show area.
-     * @param {number} seriesIndex - The index of the series.
      *
-     * @default false
-     * @returns {boolean}
+     * @param seriesIndex - The index of the series.
      */
     isAreaVisible(seriesIndex: number): boolean;
     /**
      * Specify whether the line series should show area.
-     * @param {boolean} props.visible - `true` if the line series should show area, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * **Note:** This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * @param visible - `true` if the line series should show area, `false` otherwise.
+     * @param seriesIndex - The index of the series.
      */
     setAreaVisible(visible: boolean, seriesIndex: number): void;
     /**
      * Indicate whether to show or hide the markers/bullets of the line series.
-     * @param {number} seriesIndex - The index of the series.
      *
-     * @default true
-     * @returns {boolean}
+     * @param seriesIndex - The index of the series.
      */
     isMarkerVisible(seriesIndex: number): boolean;
     /**
      * Indicate whether to show or hide the markers/bullets of the line series.
-     * @param {boolean} props.visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * **Note:** This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * @param visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+     * @param seriesIndex - The index of the series.
      */
     setMarkerVisible(visible: boolean, seriesIndex: number): void;
     /**
      * Specify the color of the filled area for line chart.
-     * @param {number} seriesIndex - The index of the series.
+     * **Note:** `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
      *
-     * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
-     *
-     * @returns {Color | undefined}
+     * @param seriesIndex - The index of the series.
      */
     getAreaColor(seriesIndex: number): Color | undefined;
     /**
      * Specify the color of the filled area for line chart.
-     * @param {Color | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
+     * **Note:** This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * @param color - The color of the filled area for line chart.
+     * @param seriesIndex - The index of the series.
      */
     setAreaColor(color: Color | undefined, seriesIndex: number): void;
     /**
      * 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.
+     * **Note:** This method will only work if the series is a line chart series.
      *
-     * **NOTE:** This method will only work if the series is a line chart series.
+     * @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;
     /**
      * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {boolean | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
     /**
      * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
-     * @param {boolean} hide The value for hiding oversized labels.
-     * @param {number} seriesIndex The index of the series.
      *
-     * **NOTE:** This method will only work if the series is a bar chart series.
+     * **Note:** This method will only work if the series is a bar chart series.
+     *
+     * @param hide - The value for hiding oversized labels.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
     /**
      * Gets whether to hide oversized data labels of the stacked series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {boolean | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
     /**
      * Sets whether to hide oversized data labels of the stacked series based on the series index.
-     * @param {boolean} hide The value for hiding oversized stacked labels.
-     * @param {number} seriesIndex The index of the series.
+     * **Note:** This method will only work if the series is a bar chart series.
      *
-     * **NOTE:** This method will only work if the series is a bar chart series.
+     * @param hide - The value for hiding oversized stacked labels.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
 }

package/dist/model/decorators/model-setter.d.ts

@@ -0,0 +1,7 @@
+import { ChartModel } from '../chart-model/chart-model';
+/**
+ * Decorator for property setter in a chart model that will:
+ * - guard against async overwrite issues
+ * - emit a config update event
+ */
+export declare function modelSetter(_target: ChartModel, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;

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

@@ -7,8 +7,6 @@ import { ModelWithBasicXAxis, ModelWithXGuides } from '../mixins';
 export declare class GaugeModel extends ChartModel {
     /**
      * Generate the proper chart title given the current config.
-     *
-     * @returns {string}
      */
     generateChartTitle(): string;
     /**
@@ -52,10 +50,8 @@ export declare class GaugeModel extends ChartModel {
     set valueConversion(valueConversion: ValueConversion | undefined);
     /**
      * Gets the index of the feature to be rendered.
-     *
-     * @remarks
-     * 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)
+     * - 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);
@@ -64,9 +60,9 @@ export declare class GaugeModel extends ChartModel {
      */
     removeFeatureIndex(): void;
     /**
-     * Type of Gauge chart, like FeatureGauge and StatisticGauge.
+     * Type of Gauge chart, like `FeatureGauge` and `StatisticGauge`.
      *
-     * @remarks When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
+     * **Note**: When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
      */
     get gaugeSubType(): GaugeChartSubTypes;
     /**