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

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

@@ -1,7 +1,7 @@
 import { Color, IDrawingInfo, LegendItemVisibility, NumberFormatOptions, SupportedLayer, WebChartDataFilters, WebChartTextSymbol } from '../../spec';
 import { ModelParams } from '../interfaces/chart-interfaces';
 import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ChartConfig, ChartSubType, ChartTypes } from '../../utils';
+import { ChartConfig, ChartSubType, ChartTypes, CommonStrings } from '../../utils';
 export declare abstract class ChartModel extends EventTarget {
     /**
      * Current configuration used for the chart.
@@ -12,26 +12,32 @@ export declare abstract class ChartModel extends EventTarget {
      * Grouping of layer-related properties to be passed to external function more compactly.
      * @category Protected
      */
-    protected layerInfo: LayerInfo | undefined;
+    protected layerInfo: LayerInfo;
+    /**
+     * Common strings used in the model.
+     * @category Protected
+     */
+    protected commonStrings: CommonStrings;
     /**
      * Chart Type
      * @category Protected
      */
     protected _chartType: ChartTypes;
     /**
-     * Function that resolves the setup promise.
+     * List of setters (either props or methods) that have been changed and will require an async series rebuild.
      * @category Protected
      */
-    protected resolveSetup?: () => void;
+    protected dirtyAsyncSetters: string[];
     /**
-     * Data store object that can be used to store any data needed for the chart.
+     * Whether or not an async series update is currently in progress.
+     * @category Protected
      */
-    dataStore: any;
+    protected asyncConfigUpdateInProgress: boolean;
     /**
-     * Whether this chart type supports custom sort.
-     * Default: false (no custom sort).
+     * Function that resolves the setup promise.
+     * @category Protected
      */
-    static supportsCustomSort: boolean;
+    protected resolveSetup?: () => void;
     /**
      * Completes the async setup process for the chart model. Must be called before using the model.
      * @param {ModelParams} params The parameters to be used to set up the chart model.
@@ -41,39 +47,34 @@ export declare abstract class ChartModel extends EventTarget {
     /**
      * Checks if the current chart model is for the same chart as another chart model.
      * @param {ChartModel | undefined} otherModel The other chart model to compare to.
-     * @returns {boolean}
      */
     isSameChartAs(otherModel: ChartModel | undefined): boolean;
     /**
-     * Gets the current chart configuration object.
-     * @returns {ChartConfig}
+     * Generate the proper chart title from the current config.
      */
-    getConfig(): ChartConfig;
+    abstract generateChartTitle(): string;
     /**
-     * Sets the chart configuration object.
-     * @param {ChartConfig} config The configuration object.
+     * Data store object that can be used to store any data needed for the chart.
      */
-    setConfig(config: ChartConfig): void;
+    dataStore: any;
     /**
-     * Gets the chart type.
-     * @returns {ChartTypes}
+     * The current chart configuration object.
      */
-    getChartType(): typeof this._chartType;
+    get config(): ChartConfig;
+    set config(config: ChartConfig);
     /**
-     * Gets the associated layer.
-     * @returns {SupportedLayer | undefined}
+     * The chart type.
      */
-    getLayer(): SupportedLayer | undefined;
+    get chartType(): typeof this._chartType;
     /**
-     * Gets the chart id.
-     * @returns {string | undefined}
+     * The associated layer.
      */
-    getChartId(): string | undefined;
+    get layer(): SupportedLayer | undefined;
     /**
-     * Sets the chart id.
-     * @param {string} id
+     * The chart ID.
      */
-    setChartId(id: string): void;
+    get chartId(): string | undefined;
+    set chartId(id: string | undefined);
     /**
      * Promise that resolves when the setup process is complete.
      *
@@ -81,168 +82,84 @@ export declare abstract class ChartModel extends EventTarget {
      */
     setupFinished: Promise<void>;
     /**
-     * Generate the proper chart title from the current config.
-     *
-     * @returns {string}
+     * The version of the chart configuration.
      */
-    abstract generateChartTitle(): Promise<string>;
+    get version(): string | undefined;
     /**
-     * Gets the version of the chart configuration.
-     * @returns {string}
+     * The chart title text.
+     * @type {string}
      */
-    getVersion(): string;
+    get titleText(): string;
+    set titleText(title: string);
     /**
-     * Gets the chart title text.
+     * The chart subtitle text.
      * @returns {string}
      */
-    getTitleText(): string;
+    get subtitleText(): string;
+    set subtitleText(subtitle: string);
     /**
-     * Sets the chart title text.
-     * @param {string} title The title text.
+     * The chart description text.
      */
-    setTitleText(title: string): void;
+    get descriptionText(): string;
+    set descriptionText(description: string);
     /**
-     * Gets the chart subtitle text.
-     * @returns {string}
-     */
-    getSubtitleText(): string;
-    /**
-     * Sets the chart subtitle text.
-     * @param {string} subtitle The subtitle text.
-     */
-    setSubtitleText(subtitle: string): void;
-    /**
-     * Gets the chart description text.
-     * @returns {string}
-     */
-    getDescriptionText(): string;
-    /**
-     * Sets the chart description text.
-     * @param {string} description The description text.
-     */
-    setDescriptionText(description: string): void;
-    /**
-     * Gets whether or not the chart title is visible.
+     * Whether or not the chart title is visible.
      *
      * `true`: Chart title is visible.
      *
      * `false`: Chart title is hidden.
      *
-     * @returns {boolean}
-     *
-     * **Note: Even if the title is visible, it may not be displayed if the title text is empty.**
-     */
-    getChartTitleVisibility(): boolean;
-    /**
-     * Sets whether or not the chart title is visible.
-     *
-     * `true`: Show chart title.
-     *
-     * `false`: Hide chart title.
-     *
-     * @param {boolean} visibility The visibility state of the chart title.
-     *
      * **Note: Even if the title is visible, it may not be displayed if the title text is empty.**
      */
-    setChartTitleVisibility(visibility: boolean): void;
+    get chartTitleVisibility(): boolean;
+    set chartTitleVisibility(visibility: boolean);
     /**
-     * Gets whether or not the chart subtitle is visible.
+     * Whether or not the chart subtitle is visible.
      *
      * `true`: Chart subtitle is visible.
      *
      * `false`: Chart subtitle is hidden.
      *
-     * @returns {boolean}
-     *
      * **Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.**
      */
-    getChartSubtitleVisibility(): boolean;
+    get chartSubtitleVisibility(): boolean;
+    set chartSubtitleVisibility(visibility: boolean);
     /**
-     * Sets whether or not the chart subtitle is visible.
-     *
-     * `true`: Show chart subtitle.
-     *
-     * `false`: Hide chart subtitle.
-     *
-     * @param {boolean} visibility The visibility state of the chart subtitle.
-     *
-     * **Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.**
-     */
-    setChartSubtitleVisibility(visibility: boolean): void;
-    /**
-     * Gets whether or not the chart description is visible.
+     * Whether or not the chart description is visible.
      *
      * `true`: Description is visible.
      *
      * `false`: Description is hidden.
      *
-     * @returns {boolean}
-     *
-     * **Note: Even if the description is visible, it may not be displayed if the description text is empty.**
-     */
-    getDescriptionVisibility(): boolean;
-    /**
-     * Sets whether or not the chart description is visible.
-     *
-     * `true`: Show description.
-     *
-     * `false`: Hide description.
-     *
-     * @param {boolean} visibility The visibility state of the description.
-     *
      * **Note: Even if the description is visible, it may not be displayed if the description text is empty.**
      */
-    setDescriptionVisibility(visibility: boolean): void;
-    /**
-     * Gets the chart renderer.
-     * @returns {IDrawingInfo["renderer"] | undefined} The chart renderer if defined, otherwise undefined.
-     */
-    getChartRenderer(): IDrawingInfo["renderer"] | undefined;
-    /**
-     * Sets the chart renderer.
-     * @param renderer The chart renderer to set.
-     */
-    setChartRenderer(renderer: IDrawingInfo["renderer"]): void;
+    get descriptionVisibility(): boolean;
+    set descriptionVisibility(visibility: boolean);
     /**
-     * Gets the title text symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
+     * The chart renderer.
      */
-    getTitleSymbol(): WebChartTextSymbol | undefined;
+    get chartRenderer(): IDrawingInfo["renderer"] | undefined;
+    set chartRenderer(renderer: IDrawingInfo["renderer"]);
     /**
-     * Sets the title text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} titleSymbol The title symbol.
+     * The title text symbol. Contains styling information such as font, color, and symbol style.
      */
-    setTitleSymbol(titleSymbol: WebChartTextSymbol | undefined): void;
+    get titleSymbol(): WebChartTextSymbol | undefined;
+    set titleSymbol(titleSymbol: WebChartTextSymbol | undefined);
     /**
-     * Gets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
+     * The subtitle text symbol. Contains styling information such as font, color, and symbol style.
      */
-    getSubtitleSymbol(): WebChartTextSymbol | undefined;
+    get subtitleSymbol(): WebChartTextSymbol | undefined;
+    set subtitleSymbol(subtitleSymbol: WebChartTextSymbol | undefined);
     /**
-     * Sets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} subtitleSymbol The title symbol.
+     * The description text symbol. Contains styling information such as font, color, and symbol style.
      */
-    setSubtitleSymbol(subtitleSymbol: WebChartTextSymbol | undefined): void;
+    get descriptionSymbol(): WebChartTextSymbol | undefined;
+    set descriptionSymbol(descriptionSymbol: WebChartTextSymbol | undefined);
     /**
-     * Gets the description text symbol. Contains styling information such as font, color, and symbol style.
-     * @returns {WebChartTextSymbol | undefined}
+     * The background color of the chart.
      */
-    getDescriptionSymbol(): WebChartTextSymbol | undefined;
-    /**
-     * Sets the description text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} descriptionSymbol The description symbol.
-     */
-    setDescriptionSymbol(descriptionSymbol: WebChartTextSymbol | undefined): void;
-    /**
-     * Gets the background color of the chart.
-     * @returns {Color | undefined}
-     */
-    getBackgroundColor(): Color | undefined;
-    /**
-     * Sets the background color of the chart.
-     * @param {Color | undefined} backgroundColor The background color.
-     */
-    setBackgroundColor(backgroundColor: Color | undefined): void;
+    get backgroundColor(): Color | undefined;
+    set backgroundColor(backgroundColor: Color | undefined);
     /**
      * Gets the visibility of a series.
      * @param seriesIndex The series index
@@ -277,15 +194,13 @@ export declare abstract class ChartModel extends EventTarget {
      */
     getSeriesIndex(seriesId: string): number | undefined;
     /**
-     * Gets the length of the series array.
-     * @returns {number}
+     * The length of the series array.
      */
-    getSeriesLength(): number;
+    get seriesLength(): number;
     /**
-     * Gets the chart sub type of the series.
-     * @returns {ChartSubType}
+     * The chart sub type of the series.
      */
-    getChartSubType(): ChartSubType;
+    get chartSubType(): ChartSubType;
     /**
      * Gets the data tooltip value format for a series.
      *
@@ -303,42 +218,14 @@ export declare abstract class ChartModel extends EventTarget {
      */
     setDataTooltipValueFormat(seriesIndex: number, valueFormat: NumberFormatOptions | undefined): void;
     /**
-     * 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.
-     */
-    setFetchNULLValues(fetchNULLValues: boolean): void;
-    /**
-     * Gets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
-     *
-     * @returns {boolean} Boolean value indicates whether NULL values will be fetched.
-     */
-    getFetchNULLValues(): boolean;
-    /**
-     * Gets the split-by values for the chart.
-     * @returns {string[]}
-     */
-    getSplitByValues(): string[];
-    /**
-     * Get the sort order kind.
-     * Only called if `supportsCustomSort` is true.
-     */
-    protected getSortOrderKind(): string;
-    /**
-     * Get custom sort values.
-     * Only called if `supportsCustomSort` is true.
-     */
-    getCustomSortValues(): Promise<string[]>;
-    /**
-     * Set sort order kind.
-     * Only called if `supportsCustomSort` is true.
+     * Whether to fetch `null` values for them to be counted or displayed as categories on the chart.
      */
-    setSortOrderKind(_sortOrder: string, _orderByList: string[]): void;
+    get fetchNULLValues(): boolean;
+    set fetchNULLValues(fetchNULLValues: boolean);
     /**
-     * Check if the given sort order is a 'custom sort'.
-     * Only called if `supportsCustomSort` is true.
+     * The split-by values for the chart.
      */
-    protected isSortOrderCustomSort(sortOrder: string): boolean;
+    get splitByValues(): string[];
     /**
      * Gets the data filter for the bar chart.
      * @returns {WebChartDataFilters | undefined}
@@ -352,12 +239,12 @@ export declare abstract class ChartModel extends EventTarget {
      * Emits a config update event.
      * @category Protected
      */
-    protected emitConfigUpdate(functionCalled: string): void;
+    protected emitConfigUpdate(setterName: string): void;
     /**
      * A function that generates the default config object when creating a new chart.
      * @category Protected
      */
-    protected abstract generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    protected abstract generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * A function that loads the config based on the provided props.
      * @category Protected
@@ -366,4 +253,9 @@ export declare abstract class ChartModel extends EventTarget {
      * @param params.config The config object to be loaded.
      */
     protected loadConfigFromLayer<T extends ModelTypes>(params: ModelParams<ChartConfig<T>>): Promise<void>;
+    /**
+     * Guards a setter from being called while an async config update is in progress so that the value being set is not overwritten by the async config update.
+     * @param setter The setter callback to call after setup or async config update is finished.
+     */
+    protected guardSetterFromAsyncOverwrite(setter: (() => Promise<void>) | (() => void)): Promise<void>;
 }

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

@@ -5,9 +5,9 @@ import { ModelTypes } from '../../interfaces/common';
  */
 export type ModelConfigChangePayload<T extends ModelTypes = ModelTypes> = {
     /**
-     * Name of the function that was called which triggered the change.
+     * Name of the setter (either prop or method) which triggered the change.
      */
-    functionCalled: string;
+    setterName: string;
     /**
      * New chart config.
      */

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

@@ -15,15 +15,15 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     protected defaultSeries: WebChartLineChartSeries | undefined;
     protected _chartType: "comboLineAndBarSeries";
     protected layerInfo: LayerInfo;
-    getConfig(): typeof this._config;
+    get config(): typeof this._config;
     setup(params: ModelParams<ChartConfig<typeof ModelTypes.ComboBarLineChart>>): Promise<void>;
-    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    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(): Promise<void>;
-    setSeriesType(seriesIndex: number, seriesType: WebChartTypes): Promise<void>;
+    protected initDefaultSeries(): void;
+    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.