@arcgis/charts-components 5.0.0-next.136 → 5.0.0-next.138

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

@@ -1,106 +1,80 @@
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ChartModel } from './chart-model';
-import { ChartConfig } from '../../utils/types/index';
-import { CommonStrings } from '../../utils/localization/interfaces';
-import { ChartTypes } from '../../utils/misc/index';
-export declare abstract class ChartModelBase extends EventTarget {
-    /**
-     * Current configuration used for the chart.
-     */
-    protected _config: ChartConfig;
-    /**
-     * Grouping of layer-related properties to be passed to external function more compactly.
-     */
-    protected layerInfo: LayerInfo;
-    /**
-     * Common strings used in the model.
-     */
-    protected commonStrings: CommonStrings;
-    /**
-     * Chart type.
-     */
-    protected _chartType: ChartTypes;
-    /**
-     * List of setters (either props or methods) that have been changed and will require an async series rebuild.
-     */
-    protected dirtyAsyncSetters: string[];
-    /**
-     * Whether or not an async series update is currently in progress.
-     */
-    protected asyncConfigUpdateInProgress: boolean;
-    /**
-     * Number of pending async updates.
-     */
-    protected pendingUpdates: number;
-    /**
-     * Function that resolves the setup promise.
-     */
-    protected resolveSetup?: () => void;
-    /**
-     * Completes the async setup process for the chart model. Must be called before using the model.
-     *
-     * @param params - The parameters to be used to set up the chart model.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
-     */
-    abstract setup(params: ModelParams<ChartConfig>): Promise<void>;
-    /**
-     * The chart type.
-     */
-    get chartType(): typeof this._chartType;
-    /**
-     * Checks if the current chart model is for the same chart as another chart model.
-     *
-     * @param otherModel - The other chart model to compare to.
-     */
-    isSameChartAs(otherModel: ChartModel | undefined): boolean;
-    /**
-     * Generate the proper chart title from the current config.
-     */
-    abstract generateChartTitle(): string;
-    /**
-     * Can be awaited to allow any pending async updates to complete.
-     * @public
-     */
-    update(): Promise<void>;
-    /**
-     * Data store object that can be used to store any data needed for the chart.
-     */
-    dataStore: any;
-    /**
-     * Promise that resolves when the setup process is complete.
-     *
-     * **Note:** This promise does not need to be awaited if the `setup` method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.
-     */
-    asyncUpdatesPromise: Promise<void>;
-    /**
-     * Emits a config update event.
-     */
-    protected emitConfigUpdate: (setterName: string) => void;
-    /**
-     * A function that generates the default config object when creating a new chart.
-     */
-    protected abstract generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-    /**
-     * A function that loads the config based on the provided props.
-     *
-     * @param params.layer - The layer to be used as the data source for the chart.
-     * @param params.iLayer - The layer description to use if the layer is not provided.
-     * @param params.config - The config object to be loaded.
-     */
-    protected loadConfigFromLayer<T extends ModelTypes>(params: ModelParams<ChartConfig<T>>): Promise<void>;
-    /**
-     * Manually block the async guard to queue up config updates until unblocked.
-     */
-    protected startAsyncUpdate(): void;
-    /**
-     * Manually unblock the async guard to allow queued config updates to proceed.
-     */
-    protected finishAsyncUpdate(): 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>;
-}
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { LayerInfo, ModelTypes } from "../interfaces/common.js";
+import type { ChartModel } from "./chart-model.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { CommonStrings } from "../../utils/localization/interfaces.js";
+import type { ChartTypes } from "../../utils/misc/index.js";
+
+export abstract class ChartModelBase extends EventTarget {
+  /** Chart type. */
+  protected _chartType: ChartTypes;
+  /** Current configuration used for the chart. */
+  protected _config: ChartConfig;
+  /**
+   * Whether or not an async series update is currently in progress.
+   *
+   * @default false
+   */
+  protected asyncConfigUpdateInProgress: boolean;
+  /**
+   * Promise that resolves when the setup process is complete.
+   *
+   * **Note:** This promise does not need to be awaited if the `setup` method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.
+   */
+  asyncUpdatesPromise: Promise<void>;
+  /** The chart type. */
+  get chartType(): ChartTypes;
+  /** Common strings used in the model. */
+  protected commonStrings: CommonStrings;
+  /** Data store object that can be used to store any data needed for the chart. */
+  dataStore: any;
+  /** List of setters (either props or methods) that have been changed and will require an async series rebuild. */
+  protected dirtyAsyncSetters: string[];
+  /** Emits a config update event. */
+  protected emitConfigUpdate: (setterName: string) => 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>;
+  /** Grouping of layer-related properties to be passed to external function more compactly. */
+  protected layerInfo: LayerInfo;
+  /**
+   * Number of pending async updates.
+   *
+   * @default 0
+   */
+  protected pendingUpdates: number;
+  /** Function that resolves the setup promise. */
+  protected resolveSetup?: () => void;
+  /** Manually unblock the async guard to allow queued config updates to proceed. */
+  protected finishAsyncUpdate(): void;
+  /** Generate the proper chart title from the current config. */
+  abstract generateChartTitle(): string;
+  /** A function that generates the default config object when creating a new chart. */
+  protected abstract generateDefaultConfig(): Omit<ChartConfig, "iLayer">;
+  /**
+   * Checks if the current chart model is for the same chart as another chart model.
+   *
+   * @param otherModel - The other chart model to compare to.
+   */
+  isSameChartAs(otherModel: ChartModel | undefined): boolean;
+  /**
+   * A function that loads the config based on the provided props.
+   *
+   * @param params - The layer to be used as the data source for the chart.
+   */
+  protected loadConfigFromLayer<T extends ModelTypes>(params: ModelParams<ChartConfig<T>>): Promise<void>;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params - The parameters to be used to set up the chart model.
+   * @async **This method is `async` and must be awaited for the changes to take effect.**
+   */
+  abstract setup(params: ModelParams<ChartConfig>): Promise<void>;
+  /** Manually block the async guard to queue up config updates until unblocked. */
+  protected startAsyncUpdate(): void;
+  /** Can be awaited to allow any pending async updates to complete. */
+  update(): Promise<void>;
+}

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

@@ -1,32 +1,57 @@
-import { MixinInstances } from '../shared/utils';
-import { WithTitleText } from '../properties/title/title-text';
-import { WithTitleSymbol } from '../properties/title/title-symbol';
-import { ChartModelBase } from './chart-model-base';
-import { WithConfig } from '../properties/config';
-import { WithLayer } from '../properties/layer';
-import { WithChartId } from '../properties/chart-id';
-import { WithVersion } from '../properties/version';
-import { WithSubtitleText } from '../properties/subtitle/subtitle-text';
-import { WithSubtitleSymbol } from '../properties/subtitle/subtitle-symbol';
-import { WithDescriptionText } from '../properties/description/description-text';
-import { WithDescriptionSymbol } from '../properties/description/description-symbol';
-import { WithChartTitleVisibility } from '../properties/title/title-visibility';
-import { WithChartSubtitleVisibility } from '../properties/subtitle/subtitle-visibility';
-import { WithDescriptionVisibility } from '../properties/description/description-visibility';
-import { WithChartRenderer } from '../properties/chart-renderer';
-import { WithBackgroundColor } from '../properties/background-color';
-import { WithSeriesVisibility } from '../properties/series/series-visibility';
-import { WithSeriesId } from '../properties/series/series-id';
-import { WithSeriesIndex } from '../properties/series/series-index';
-import { WithSeriesLength } from '../properties/series/series-length';
-import { WithChartSubType } from '../properties/chart-sub-type';
-import { WithSeriesDataTooltipValueFormat } from '../properties/data-tooltip-value-format';
-import { WithFetchNULLValues } from '../properties/fetch-null-values';
-import { WithSplitByValues } from '../properties/split-by-values';
-import { WithDataFilters } from '../properties/data-filters';
-export declare abstract class ChartModel extends ChartModelBase {
-}
-declare const chartModelMixins: readonly [typeof WithConfig, typeof WithLayer, typeof WithChartId, typeof WithTitleText, typeof WithTitleSymbol, typeof WithVersion, typeof WithSubtitleText, typeof WithSubtitleSymbol, typeof WithDescriptionText, typeof WithDescriptionSymbol, typeof WithChartTitleVisibility, typeof WithChartSubtitleVisibility, typeof WithDescriptionVisibility, typeof WithChartRenderer, typeof WithBackgroundColor, typeof WithSeriesVisibility, typeof WithSeriesId, typeof WithSeriesIndex, typeof WithSeriesLength, typeof WithChartSubType, typeof WithSeriesDataTooltipValueFormat, typeof WithFetchNULLValues, typeof WithSplitByValues, typeof WithDataFilters];
-export interface ChartModel extends MixinInstances<typeof chartModelMixins> {
-}
-export {};
+import type { MixinInstances } from "../shared/utils.js";
+import type { WithTitleText } from "../properties/title/title-text.js";
+import type { WithTitleSymbol } from "../properties/title/title-symbol.js";
+import type { ChartModelBase } from "./chart-model-base.js";
+import type { WithConfig } from "../properties/config.js";
+import type { WithLayer } from "../properties/layer.js";
+import type { WithChartId } from "../properties/chart-id.js";
+import type { WithVersion } from "../properties/version.js";
+import type { WithSubtitleText } from "../properties/subtitle/subtitle-text.js";
+import type { WithSubtitleSymbol } from "../properties/subtitle/subtitle-symbol.js";
+import type { WithDescriptionText } from "../properties/description/description-text.js";
+import type { WithDescriptionSymbol } from "../properties/description/description-symbol.js";
+import type { WithChartTitleVisibility } from "../properties/title/title-visibility.js";
+import type { WithChartSubtitleVisibility } from "../properties/subtitle/subtitle-visibility.js";
+import type { WithDescriptionVisibility } from "../properties/description/description-visibility.js";
+import type { WithChartRenderer } from "../properties/chart-renderer.js";
+import type { WithBackgroundColor } from "../properties/background-color.js";
+import type { WithSeriesVisibility } from "../properties/series/series-visibility.js";
+import type { WithSeriesId } from "../properties/series/series-id.js";
+import type { WithSeriesIndex } from "../properties/series/series-index.js";
+import type { WithSeriesLength } from "../properties/series/series-length.js";
+import type { WithChartSubType } from "../properties/chart-sub-type.js";
+import type { WithSeriesDataTooltipValueFormat } from "../properties/data-tooltip-value-format.js";
+import type { WithFetchNULLValues } from "../properties/fetch-null-values.js";
+import type { WithSplitByValues } from "../properties/split-by-values.js";
+import type { WithDataFilters } from "../properties/data-filters.js";
+
+export abstract class ChartModel extends ChartModelBase {}
+
+export interface ChartModel extends MixinInstances<typeof chartModelMixins> {}
+
+export const chartModelMixins: readonly [
+    typeof WithConfig,
+    typeof WithLayer,
+    typeof WithChartId,
+    typeof WithTitleText,
+    typeof WithTitleSymbol,
+    typeof WithVersion,
+    typeof WithSubtitleText,
+    typeof WithSubtitleSymbol,
+    typeof WithDescriptionText,
+    typeof WithDescriptionSymbol,
+    typeof WithChartTitleVisibility,
+    typeof WithChartSubtitleVisibility,
+    typeof WithDescriptionVisibility,
+    typeof WithChartRenderer,
+    typeof WithBackgroundColor,
+    typeof WithSeriesVisibility,
+    typeof WithSeriesId,
+    typeof WithSeriesIndex,
+    typeof WithSeriesLength,
+    typeof WithChartSubType,
+    typeof WithSeriesDataTooltipValueFormat,
+    typeof WithFetchNULLValues,
+    typeof WithSplitByValues,
+    typeof WithDataFilters
+];

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

@@ -1,15 +1,10 @@
-import { ChartConfig } from '../../../utils/types/index';
-import { ModelTypes } from '../../interfaces/common';
-/**
- * Payload for model config change event.
- */
+import type { ChartConfig } from "../../../utils/types/index.js";
+import type { ModelTypes } from "../../interfaces/common.js";
+
+/** Payload for model config change event. */
 export type ModelConfigChangePayload<T extends ModelTypes = ModelTypes> = {
-    /**
-     * Name of the setter (either prop or method) which triggered the change.
-     */
-    setterName: string;
-    /**
-     * New chart config.
-     */
-    config: ChartConfig<T>;
-};
+  /** Name of the setter (either prop or method) which triggered the change. */
+  setterName: string;
+  /** New chart config. */
+  config: ChartConfig<T>;
+};