@arcgis/charts-components 5.0.0-next.135 → 5.0.0-next.137

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

@@ -1,244 +1,215 @@
-import { ChartModel } from '../chart-model/chart-model';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { ModelTypes, BoxPlotDataSortingKinds } from '../interfaces/common';
-import { ModelWithLegend, ModelWithMultiAxes, ModelWithTooltips, ModelWithYGuides } from '../mixins';
-import { WithAxisLabelsSymbol } from '../properties/axes/axis-labels-symbol';
-import { WithAxisLinesSymbol } from '../properties/axes/axis-lines-symbol';
-import { WithXBounds } from '../properties/axes/x-axis/x-bounds';
-import { WithXAxisLabelsVisibility } from '../properties/axes/x-axis/x-axis-labels-visibility';
-import { WithXAxisTitleSymbol } from '../properties/axes/x-axis/x-axis-title-symbol';
-import { WithXAxisTitleText } from '../properties/axes/x-axis/x-axis-title-text';
-import { WithXAxisTitleVisibility } from '../properties/axes/x-axis/x-axis-title-visibility';
-import { WithGenerateXAxisTitle } from '../properties/axes/x-axis/generate-x-axis-title';
-import { WithColorMatch } from '../properties/color-match';
-import { WithRotatedState } from '../properties/rotated-state';
-import { WithDataLabelsVisibility } from '../properties/data-labels/data-labels-visibility';
-import { WithDataLabelsSymbol } from '../properties/data-labels/data-labels-symbol';
-import { MixinInstances } from '../shared/utils';
-import { WebChart, WebChartDataFilters } from '../../spec/web-chart';
-import { Color } from '../../spec/rest-js-types';
-import { RESTSimpleLineSymbolStyle } from '../../spec/rest-js-object-literals';
-import { ChartConfig } from '../../utils/types/index';
-import { XYChartTypes } from '../../utils/misc/index';
-export declare class BoxPlotModel extends ChartModel {
-    /**
-     * Current configuration used for the box plot chart.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.BoxPlot, WebChart>;
-    protected _chartType: XYChartTypes;
-    /**
-     * Internal storage of the category field for the chart.
-     */
-    protected _category: string;
-    /**
-     * Internal storage of the split-by field for the chart.
-     */
-    protected _splitByField: string;
-    /**
-     * Internal storage of the numeric fields for the chart.
-     */
-    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.
-     */
-    private previousMeanLinesBoxColor;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.BoxPlot>>): Promise<void>;
-    /**
-     * The category field for the box plot.
-     */
-    get category(): string;
-    set category(newCategory: string);
-    /**
-     * The numeric fields array for the box plot.
-     */
-    get numericFields(): string[];
-    set numericFields(newNumericFields: string[] | string);
-    /**
-     * The split-by field for the box plot.
-     */
-    get splitByField(): string;
-    set splitByField(newSplitByField: string);
-    /**
-     * Whether outliers are shown.
-     */
-    get showOutliers(): boolean;
-    set showOutliers(newShowOutliersState: boolean);
-    /**
-     * Whether values are standardized as z-scores.
-     */
-    get standardizeValues(): boolean;
-    set standardizeValues(newStandardizeValuesState: boolean);
-    /**
-     * Gets the sort order of the box plot data.
-     */
-    getSortOrder(): BoxPlotDataSortingKinds;
-    /**
-     * Sets the sort order of the box plot data.
-     *
-     * @param newSortOrder - The new sort order.
-     * @param orderByList - The new list of category's values for custom sort.
-     */
-    setSortOrder(newSortOrder: BoxPlotDataSortingKinds, orderByList?: string[]): void;
-    /**
-     * Gets the list of the category values for the chart.
-     */
-    getCustomSortValues(): Promise<string[]>;
-    /**
-     * Sets the data filter for the bar chart.
-     *
-     * @param newDataFilter - The new data filter.
-     */
-    setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
-    /**
-     * The list of category's values for custom sort
-     */
-    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>;
-    /**
-     * Whether mean lines are shown.
-     */
-    get showMeanLines(): boolean | undefined;
-    set showMeanLines(newShowMeanLines: boolean | undefined);
-    /**
-     * The color of the boxes when showing mean lines. Only applicable when mean lines are shown.
-     */
-    get meanLinesBoxColor(): Color | undefined;
-    set meanLinesBoxColor(newColor: Color | undefined);
-    /**
-     * Sets up the local props based on the current config.
-     */
-    protected setupLocalProps(): void;
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-    /**
-     * Resets the config to the default config
-     */
-    resetConfig(): void;
-    /**
-     * 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
-     */
-    protected canUseSynchronousSeriesRebuild(): boolean;
-    /**
-     * 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.
-     * @async
-     */
-    protected processSeriesRebuild(): Promise<void>;
-    /**
-     * Gets the properties needed to build a new series array.
-     */
-    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 seriesIndex - The index of the series.
-     */
-    getSeriesName(seriesIndex: number): string | undefined;
-    /**
-     * Sets name of the series based on the series index.
-     *
-     * @param newName - The new name for the series.
-     * @param seriesIndex - The index of the series.
-     */
-    setSeriesName(newName: string, seriesIndex: number): void;
-    /**
-     * Gets the color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     *
-     * @param seriesIndex - The index of the series.
-     */
-    getSeriesColor(seriesIndex: number): Color | undefined;
-    /**
-     * Sets the color of the series based on the series index.
-     *
-     * @param newColor - The new color for the series.
-     * @param seriesIndex - The index of the series.
-     */
-    setSeriesColor(newColor: Color | undefined, seriesIndex: number): void;
-    /**
-     * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     *
-     * **Note**: Only applicable when mean lines are shown.
-     *
-     * @param seriesIndex - The index of the series.
-     */
-    getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
-    /**
-     * Sets the line style of the series based on the series index.
-     *
-     * **Note**: Only applicable when mean lines are shown.
-     *
-     * @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`.
-     *
-     * **Note**: Only applicable when mean lines are shown.
-     *
-     * @param seriesIndex - The index of the series.
-     */
-    getSeriesLineWidth(seriesIndex: number): number | undefined;
-    /**
-     * Sets the line width of the series based on the series index.
-     *
-     * **Note**: Only applicable when mean lines are shown.
-     *
-     * @param newWidth - The new width for the series.
-     * @param seriesIndex - The index of the series.
-     */
-    setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
-    /**
-     * The order of the series array by returning an array of series ids.
-     */
-    get orderOfSeries(): string[];
-    set orderOfSeries(newOrder: string[]);
-    /**
-     * Moves a series from one index in the series array to another.
-     *
-     * @param fromIndex - Index to move the series from.
-     * @param toIndex - Index to move the series to.
-     */
-    moveSeries(fromIndex: number, toIndex: number): void;
-    /**
-     * 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.
-     */
-    get boxPlotSeriesIndexWhenMeanLinesShown(): number;
-    /**
-     * Move the custom sort values in-place for the order by list in the config.
-     *
-     * **Note**: This method should be only used when the sort order is set to `BoxPlotDataSortingKinds.customSort`.
-     * @param fromIndex - The index to move the custom sort item from.
-     * @param toIndex - The index to move the category item to.
-     */
-    moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
-    /**
-     * Generate the proper chart title given the current config.
-     */
-    generateChartTitle(): string;
-    /**
-     * Generate the proper y-axis title given the current config.
-     */
-    generateYAxisTitle(): string;
-    /**
-     * Resets the series styling to the default styling.
-     */
-    resetSeriesStyling(): void;
-    /**
-     * Returns whether the series styling is able to be reset.
-     */
-    resetAvailable(): boolean;
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes, BoxPlotDataSortingKinds } from "../interfaces/common.js";
+import type { WithAxisLabelsSymbol } from "../properties/axes/axis-labels-symbol.js";
+import type { WithAxisLinesSymbol } from "../properties/axes/axis-lines-symbol.js";
+import type { WithXBounds } from "../properties/axes/x-axis/x-bounds.js";
+import type { WithXAxisLabelsVisibility } from "../properties/axes/x-axis/x-axis-labels-visibility.js";
+import type { WithXAxisTitleSymbol } from "../properties/axes/x-axis/x-axis-title-symbol.js";
+import type { WithXAxisTitleText } from "../properties/axes/x-axis/x-axis-title-text.js";
+import type { WithXAxisTitleVisibility } from "../properties/axes/x-axis/x-axis-title-visibility.js";
+import type { WithGenerateXAxisTitle } from "../properties/axes/x-axis/generate-x-axis-title.js";
+import type { WithColorMatch } from "../properties/color-match.js";
+import type { WithRotatedState } from "../properties/rotated-state.js";
+import type { WithDataLabelsVisibility } from "../properties/data-labels/data-labels-visibility.js";
+import type { WithDataLabelsSymbol } from "../properties/data-labels/data-labels-symbol.js";
+import type { MixinInstances } from "../shared/utils.js";
+import type { WebChart, WebChartDataFilters } from "../../spec/web-chart.js";
+import type { Color } from "../../spec/rest-js-types.js";
+import type { RESTSimpleLineSymbolStyle } from "../../spec/rest-js-object-literals.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { XYChartTypes } from "../../utils/misc/index.js";
+import type { ModelWithMultiAxes as ModelWithMultiAxes2 } from "../mixins/model-with-multi-axes.js";
+import type { ModelWithLegend as ModelWithLegend2 } from "../mixins/model-with-legend.js";
+import type { ModelWithTooltips as ModelWithTooltips2 } from "../mixins/model-with-tooltips.js";
+import type { ModelWithYGuides as ModelWithYGuides2 } from "../mixins/model-with-y-guides.js";
+
+export class BoxPlotModel extends ChartModel {
+  /** Internal storage of the category field for the chart. */
+  protected _category: string;
+  protected _chartType: XYChartTypes;
+  /** Current configuration used for the box plot chart. */
+  protected _config: ChartConfig<typeof ModelTypes.BoxPlot, WebChart>;
+  /** Internal storage of the numeric fields for the chart. */
+  protected _numericFields: string[];
+  /**
+   * Internal storage of the split-by field for the chart.
+   *
+   * @default ""
+   */
+  protected _splitByField: string;
+  /**
+   * 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.
+   */
+  get boxPlotSeriesIndexWhenMeanLinesShown(): number;
+  /** The category field for the box plot. */
+  accessor category: string;
+  /** The color of the boxes when showing mean lines. Only applicable when mean lines are shown. */
+  accessor meanLinesBoxColor: Color | undefined;
+  /** The numeric fields array for the box plot. */
+  get numericFields(): string[];
+  set numericFields(value: string[] | string);
+  /** The list of category's values for custom sort */
+  accessor orderByList: string[];
+  /** The order of the series array by returning an array of series ids. */
+  accessor orderOfSeries: string[];
+  /** Whether mean lines are shown. */
+  accessor showMeanLines: boolean | undefined;
+  /** Whether outliers are shown. */
+  accessor showOutliers: boolean;
+  /** The split-by field for the box plot. */
+  accessor splitByField: string;
+  /** Whether values are standardized as z-scores. */
+  accessor standardizeValues: boolean;
+  /**
+   * 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
+   */
+  protected canUseSynchronousSeriesRebuild(): boolean;
+  /** Generate the proper chart title given the current config. */
+  generateChartTitle(): string;
+  protected generateDefaultConfig(): Omit<ChartConfig<"boxPlot", WebChart>, "iLayer">;
+  /** Generate the proper y-axis title given the current config. */
+  generateYAxisTitle(): string;
+  /** Gets the list of the category values for the chart. */
+  getCustomSortValues(): Promise<string[]>;
+  /**
+   * Gets the color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesColor(seriesIndex: number): Color | undefined;
+  /**
+   * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * **Note**: Only applicable when mean lines are shown.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
+  /**
+   * Gets the line width of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * **Note**: Only applicable when mean lines are shown.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesLineWidth(seriesIndex: number): number | undefined;
+  /**
+   * Gets the name of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesName(seriesIndex: number): string | undefined;
+  /** Gets the sort order of the box plot data. */
+  getSortOrder(): BoxPlotDataSortingKinds;
+  /**
+   * Move the custom sort values in-place for the order by list in the config.
+   *
+   * **Note**: This method should be only used when the sort order is set to `BoxPlotDataSortingKinds.customSort`.
+   *
+   * @param fromIndex - The index to move the custom sort item from.
+   * @param toIndex - The index to move the category item to.
+   */
+  moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
+  /**
+   * Moves a series from one index in the series array to another.
+   *
+   * @param fromIndex - Index to move the series from.
+   * @param toIndex - Index to move the series to.
+   */
+  moveSeries(fromIndex: number, toIndex: number): void;
+  /**
+   * 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.
+   *
+   * @async
+   */
+  protected processSeriesRebuild(): Promise<void>;
+  /** Returns whether the series styling is able to be reset. */
+  resetAvailable(): boolean;
+  /** Resets the config to the default config */
+  resetConfig(): void;
+  /** Resets the series styling to the default styling. */
+  resetSeriesStyling(): void;
+  /**
+   * Sets the data filter for the bar chart.
+   *
+   * @param newDataFilter - The new data filter.
+   */
+  setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
+  /**
+   * Sets the color of the series based on the series index.
+   *
+   * @param newColor - The new color for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesColor(newColor: Color | undefined, seriesIndex: number): void;
+  /**
+   * Sets the line style of the series based on the series index.
+   *
+   * **Note**: Only applicable when mean lines are shown.
+   *
+   * @param newStyle - The new style for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesLineStyle(newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number): void;
+  /**
+   * Sets the line width of the series based on the series index.
+   *
+   * **Note**: Only applicable when mean lines are shown.
+   *
+   * @param newWidth - The new width for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
+  /**
+   * Sets name of the series based on the series index.
+   *
+   * @param newName - The new name for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesName(newName: string, seriesIndex: number): void;
+  /**
+   * Sets the sort order of the box plot data.
+   *
+   * @param newSortOrder - The new sort order.
+   * @param orderByList - The new list of category's values for custom sort.
+   */
+  setSortOrder(newSortOrder: BoxPlotDataSortingKinds, orderByList?: string[]): void;
+  /** @param params */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.BoxPlot>>): Promise<void>;
+  /** Sets up the local props based on the current config. */
+  protected setupLocalProps(): void;
+  /**
+   * 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>;
 }
-declare const boxPlotMixins: readonly [typeof ModelWithMultiAxes, typeof ModelWithLegend, typeof ModelWithTooltips, typeof WithColorMatch, typeof WithRotatedState, typeof WithDataLabelsVisibility, typeof WithDataLabelsSymbol, typeof ModelWithYGuides, typeof WithXAxisTitleText, typeof WithXAxisLabelsVisibility, typeof WithXAxisTitleVisibility, typeof WithXBounds, typeof WithXAxisTitleSymbol, typeof WithAxisLabelsSymbol, typeof WithAxisLinesSymbol, typeof WithGenerateXAxisTitle];
-export interface BoxPlotModel extends MixinInstances<typeof boxPlotMixins> {
-}
-export {};
+
+export interface BoxPlotModel extends MixinInstances<typeof boxPlotMixins> {}
+
+export const boxPlotMixins: readonly [
+    typeof ModelWithMultiAxes2,
+    typeof ModelWithLegend2,
+    typeof ModelWithTooltips2,
+    typeof WithColorMatch,
+    typeof WithRotatedState,
+    typeof WithDataLabelsVisibility,
+    typeof WithDataLabelsSymbol,
+    typeof ModelWithYGuides2,
+    typeof WithXAxisTitleText,
+    typeof WithXAxisLabelsVisibility,
+    typeof WithXAxisTitleVisibility,
+    typeof WithXBounds,
+    typeof WithXAxisTitleSymbol,
+    typeof WithAxisLabelsSymbol,
+    typeof WithAxisLinesSymbol,
+    typeof WithGenerateXAxisTitle
+];