@arcgis/charts-components 4.34.0-next.142 → 4.34.0-next.144

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

@@ -4,11 +4,6 @@ import { ModelParams } from '../interfaces/chart-interfaces';
 import { LayerInfo, ModelTypes } from '../interfaces/common';
 import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
 export declare class BarChartModel extends SerialChartModel {
-    /**
-     * Common strings used in the model.
-     * @category Private
-     */
-    private commonStrings;
     /**
      * Current configuration used for the bar chart.
      */
@@ -16,7 +11,7 @@ export declare class BarChartModel extends SerialChartModel {
     protected _chartType: "barSeries";
     protected layerInfo: LayerInfo;
     setup(params: ModelParams<ChartConfig<typeof ModelTypes.BarChart>>): Promise<void>;
-    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * 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.

package/dist/model/box-plot-model/box-plot-model.d.ts

@@ -1,8 +1,8 @@
 import { ChartConfig, XYChartTypes } from '../../utils';
-import { Color, RESTSimpleLineSymbolStyle, WebChart } from '../../spec';
+import { Color, RESTSimpleLineSymbolStyle, WebChart, WebChartDataFilters } from '../../spec';
 import { ChartModel } from '../chart-model/chart-model';
 import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes, BoxPlotDataSortingKinds } from '../interfaces/common';
+import { ModelTypes, BoxPlotDataSortingKinds } from '../interfaces/common';
 import { ModelWithColorMatch, ModelWithDataLabels, ModelWithLegend, ModelWithMultiAxes, ModelWithRotation, ModelWithTooltips, ModelWithYGuides } from '../mixins';
 export declare class BoxPlotModel extends ChartModel {
     /**
@@ -10,18 +10,21 @@ export declare class BoxPlotModel extends ChartModel {
      */
     protected _config: ChartConfig<typeof ModelTypes.BoxPlot, WebChart>;
     protected _chartType: XYChartTypes;
-    protected layerInfo: LayerInfo;
     /**
-     * Specifies whether the model supports custom sort.
-     * @default true
-     * @readonly
+     * Internal storage of the category field for the chart.
+     * @category Protected
      */
-    static supportsCustomSort: boolean;
+    protected _category: string;
     /**
-     * Common strings used in the model.
-     * @category Private
+     * Internal storage of the split-by field for the chart.
+     * @category Protected
+     */
+    protected _splitByField: string;
+    /**
+     * Internal storage of the numeric fields for the chart.
+     * @category Protected
      */
-    private commonStrings;
+    protected _numericFields: string[];
     /**
      * The previous mean lines box color. We save this so that we can recover the color previously set if the user toggles mean lines off and then back on.
      * @category Private
@@ -29,60 +32,30 @@ export declare class BoxPlotModel extends ChartModel {
     private previousMeanLinesBoxColor;
     setup(params: ModelParams<ChartConfig<typeof ModelTypes.BoxPlot>>): Promise<void>;
     /**
-     * Gets the category field for the box plot.
-     * @returns {string}
+     * The category field for the box plot.
      */
-    getCategory(): string;
+    get category(): string;
+    set category(newCategory: string);
     /**
-     * Sets the category field for the box plot.
-     * @param {string} newCategory The new category field.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     * The numeric fields array for the box plot.
      */
-    setCategory(newCategory: string): Promise<void>;
+    get numericFields(): string[];
+    set numericFields(newNumericFields: string[] | string);
     /**
-     * Gets the numeric fields array for the box plot.
-     * @returns {string[]}
+     * The split-by field for the box plot.
      */
-    getNumericFields(): string[];
+    get splitByField(): string;
+    set splitByField(newSplitByField: string);
     /**
-     * Sets the numeric field or numeric fields array for the box plot.
-     * @param {string[] | string} newNumericFields The new numeric field or numeric fields array.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     * Whether outliers are shown.
      */
-    setNumericFields(newNumericFields: string[] | string): Promise<void>;
+    get showOutliers(): boolean;
+    set showOutliers(newShowOutliersState: boolean);
     /**
-     * Gets the split-by field for the box plot.
-     * @returns {string}
-     */
-    getSplitByField(): string;
-    /**
-     * Sets the split-by field for the box plot.
-     * @param {string} newSplitByField The new split-by field.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     * Whether values are standardized as z-scores.
      */
-    setSplitByField(newSplitByField: string): Promise<void>;
-    /**
-     * Gets whether outliers are shown.
-     * @returns {boolean}
-     */
-    getShowOutliers(): boolean;
-    /**
-     * Sets whether outliers are shown.
-     * @param {boolean} newShowOutliersState The new show outliers state.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
-     */
-    setShowOutliers(newShowOutliersState: boolean): Promise<void>;
-    /**
-     * Gets whether values are standardized as z-scores.
-     * @returns {boolean}
-     */
-    getStandardizeValues(): boolean;
-    /**
-     * Sets whether values are standardized as z-scores.
-     * @param {boolean} newStandardizeValuesState The new standardize values state.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
-     */
-    setStandardizeValues(newStandardizeValuesState: boolean): Promise<void>;
+    get standardizeValues(): boolean;
+    set standardizeValues(newStandardizeValuesState: boolean);
     /**
      * Gets the sort order of the box plot data.
      * @returns {"xAxisAsc" | "xAxisDesc"| "meanAsc" | "meanDesc" | "medianAsc" | "medianDesc" | "customSort"}
@@ -100,45 +73,59 @@ export declare class BoxPlotModel extends ChartModel {
      */
     getCustomSortValues(): Promise<string[]>;
     /**
-     * Gets the list of category's values for custom sort
-     * @returns {string[]}
+     * Sets the data filter for the bar chart.
+     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
      */
-    getOrderByList(): string[];
+    setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
     /**
-     * Sets the list of category's values for custom sort
-     * @param {string[]} newOrderByList The new list of category's values
+     * The list of category's values for custom sort
      */
-    setOrderByList(newOrderByList: string[]): void;
+    get orderByList(): string[];
+    set orderByList(newOrderByList: string[]);
     /**
      * Updates the series based on the layer filter.
      * @async **This method is `async` and must be awaited for the changes to take effect.*
      */
     updateSeriesFromLayerFilter(): Promise<void>;
     /**
-     * Gets whether mean lines are shown.
-     * @returns {boolean | undefined}
+     * Whether mean lines are shown.
      */
-    getShowMeanLines(): boolean | undefined;
+    get showMeanLines(): boolean | undefined;
+    set showMeanLines(newShowMeanLines: boolean | undefined);
     /**
-     * Sets whether mean lines are shown.
-     * @param {boolean | undefined} newShowMeanLines The new show mean lines state.
+     * The color of the boxes when showing mean lines. Only applicable when mean lines are shown.
      */
-    setShowMeanLines(newShowMeanLines: boolean | undefined): Promise<void>;
+    get meanLinesBoxColor(): Color | undefined;
+    set meanLinesBoxColor(newColor: Color | undefined);
     /**
-     * Gets the color of the boxes when showing mean lines. Only applicable when mean lines are shown.
-     * @returns {Color | undefined}
+     * Sets up the local props based on the current config.
+     * @category Protected
+     */
+    protected setupLocalProps(): void;
+    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
+    /**
+     * Resets the config to the default config
      */
-    getMeanLinesBoxColor(): Color | undefined;
+    resetConfig(): void;
     /**
-     * Sets the color of the boxes when showing mean lines. Only applicable when mean lines are shown.
-     * @param {Color | undefined} newColor The new color.
+     * Determines if we can rebuild the series synchronously.
+     * We can call the build new series function synchronously when either is true:
+     * - there is no split-by field
+     * - there are multiple numeric fields
+     * @category Protected
      */
-    setMeanLinesBoxColor(newColor: Color | undefined): void;
-    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    protected canUseSynchronousSeriesRebuild(): boolean;
     /**
-     * Resets the config to the default config
+     * Processes the series rebuild.
+     * If multiple async setters are called in succession, this function will only rebuild the series once after all setters have been called.
+     * @category Protected
+     * @async
+     */
+    protected processSeriesRebuild(): Promise<void>;
+    /**
+     * Gets the properties needed to build a new series array.
      */
-    resetConfig(): Promise<void>;
+    private getBuildNewSeriesProps;
     /**
      * Gets the name 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.
@@ -200,15 +187,10 @@ export declare class BoxPlotModel extends ChartModel {
      */
     setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
     /**
-     * Gets the order of the series array by returning an array of series ids.
-     * @returns {string[]}
-     */
-    getOrderOfSeries(): string[];
-    /**
-     * Sets the order of the series array by providing an array of series ids.
-     * @param {string[]} newOrder The new order of the series array.
+     * The order of the series array by returning an array of series ids.
      */
-    setOrderOfSeries(newOrder: string[]): void;
+    get orderOfSeries(): string[];
+    set orderOfSeries(newOrder: string[]);
     /**
      * Moves a series from one index in the series array to another.
      * @param {number} fromIndex Index to move the series from.
@@ -216,12 +198,11 @@ export declare class BoxPlotModel extends ChartModel {
      */
     moveSeries(fromIndex: number, toIndex: number): void;
     /**
-     * Get the index of the box plot series in the series array in config object when show mean is true.
+     * The index of the box plot series in the series array in config object when show mean is true.
      *
      * **NOTE**: There is only one box plot series when show mean is true. The function returns '-1' if show mean is false.
-     * @param config - config object
      */
-    getBoxPlotSeriesIndexWhenMeanLinesShown(): number;
+    get boxPlotSeriesIndexWhenMeanLinesShown(): number;
     /**
      * Move the custom sort values in-place for the order by list in the config.
      *
@@ -232,10 +213,8 @@ export declare class BoxPlotModel extends ChartModel {
     moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
     /**
      * Generate the proper chart title given the current config.
-     *
-     * @returns {string}
      */
-    generateChartTitle(): Promise<string>;
+    generateChartTitle(): string;
     /**
      * Generate the proper x-axis title given the current config.
      *
@@ -244,10 +223,8 @@ export declare class BoxPlotModel extends ChartModel {
     generateXAxisTitle(): string;
     /**
      * Generate the proper y-axis title given the current config.
-     *
-     * @returns {string}
      */
-    generateYAxisTitle(): Promise<string>;
+    generateYAxisTitle(): string;
     /**
      * Resets the series styling to the default styling.
      */

package/dist/model/box-plot-model/utils/box-plot-data.d.ts

@@ -20,6 +20,7 @@ export declare const getNumericFields: (config: BoxPlotConfig) => string[];
  * @param props.numericFields
  * @param props.config
  * @param props.layerInfo
+ * @param props.commonStrings
  */
 export declare const buildNewSeries: (props: {
     splitByField: string;
@@ -27,6 +28,7 @@ export declare const buildNewSeries: (props: {
     category: string;
     config: BoxPlotConfig;
     layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
 }) => Promise<void>;
 /**
  * Gets whether the values are standardized.
@@ -36,25 +38,16 @@ export declare const getStandardizeValues: (config: BoxPlotConfig) => boolean;
  * Gets the proper Y-axis title label based on the chart configuration.
  * @param {BoxPlotConfig} config - The box plot config
  * @param {LayerInfo} layerInfo - The layer info
+ * @param {CommonStrings} commonStrings - The common strings
  */
-export declare function getYAxisTitleLabel(config: BoxPlotConfig, layerInfo: LayerInfo): Promise<string>;
+export declare function getYAxisTitleLabel(config: BoxPlotConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
 /**
  * Generates the proper chart title given the current config.
  * @param {BoxPlotConfig} config - The box plot config
  * @param {LayerInfo} layerInfo - The layer info
+ * @param {CommonStrings} commonStrings - The common strings
  */
-export declare function getChartTitle(config: BoxPlotConfig, layerInfo: LayerInfo): Promise<string>;
-/**
- * Sets the category field by updating the config accordingly.
- */
-export declare const setCategory: (newCategory: string, config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
-/**
- * set the numeric fields in the config object
- * @param newNumericFields - new numeric fields
- * @param config - box plot config object
- * @param layerInfo - layer info
- */
-export declare const setNumericFields: (newNumericFields: string[], config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+export declare function getChartTitle(config: BoxPlotConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
 /**
  * Gets the default series name.
  * @param props.series - The series to get the name for
@@ -68,10 +61,6 @@ export declare const getDefaultSeriesName: (props: {
     layerInfo: LayerInfo;
     commonStrings: CommonStrings;
 }) => string;
-/**
- * Sets the split-by field by updating the config accordingly.
- */
-export declare const setSplitByField: (newSplitByField: string, config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
 /**
  * Gets whether the outliers are shown.
  * @param config
@@ -79,15 +68,22 @@ export declare const setSplitByField: (newSplitByField: string, config: BoxPlotC
 export declare const getShowOutliers: (config: BoxPlotConfig) => boolean;
 /**
  * Sets whether the outliers are shown.
- * @param newShowOutliers
- * @param config
- * @param layerInfo
  */
-export declare const setShowOutliers: (newShowOutliers: boolean, config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+export declare const setShowOutliers: (props: {
+    newShowOutliers: boolean;
+    config: BoxPlotConfig;
+    layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
+}) => void;
 /**
  * Sets whether the values are standardized.
  */
-export declare const setStandardizeValues: (newStandardizeValues: boolean, config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+export declare const setStandardizeValues: (props: {
+    newStandardizeValues: boolean;
+    config: BoxPlotConfig;
+    layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
+}) => void;
 /**
  * Gets the sort order.
  */
@@ -103,13 +99,19 @@ export declare const setSortOrderKind: (newSortOrderKind: BoxPlotDataSortingKind
 export declare const getShowMeanLines: (config: BoxPlotConfig) => boolean;
 /**
  * Sets whether the mean lines are shown. Rebuilds the series array.
- * @param newShowMeanLines Whether to show the mean lines
- * @param config The config to update
- * @param previousMeanLinesBoxColor The previous color of the boxes when mean lines were enabled
+ * @param props.newShowMeanLines Whether to show the mean lines
+ * @param props.config The config to update
+ * @param props.commonStrings The common strings to use
+ * @param props.previousMeanLinesBoxColor The previous color of the boxes when mean lines were enabled
  */
-export declare const setShowMeanLines: (newShowMeanLines: boolean | undefined, config: BoxPlotConfig, previousMeanLinesBoxColor?: Color) => Promise<{
+export declare const setShowMeanLines: (props: {
+    newShowMeanLines?: boolean;
+    config: BoxPlotConfig;
+    commonStrings: CommonStrings;
+    previousMeanLinesBoxColor?: Color;
+}) => {
     previousMeanLinesBoxColor: Color | undefined;
-}>;
+};
 /**
  * Get the order by list from the config. The order by list is only used when the sort order kind is custom sort.
  * @param  {ChartConfig<typeof ModelTypes.BoxPlot>} config - The chart config.
@@ -131,3 +133,7 @@ export declare const setOrderByList: (values: string[], config: ChartConfig<type
  * @returns string[] - The custom sort values.
  */
 export declare const getCustomSortValues: (config: ChartConfig<typeof ModelTypes.BoxPlot>, layerInfo: LayerInfo) => Promise<string[]>;
+/**
+ * Determines whether to use the split-by field based on the current category and numeric fields.
+ */
+export declare const shouldUseSplitBy: (category: string, numericFields: string[], splitByField: string) => boolean;