@arcgis/charts-components 5.0.0-next.98 → 5.1.0-next.0

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

@@ -0,0 +1,81 @@
+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 {
+  constructor(...args: any[]);
+  /** 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,255 +1,28 @@
-import { Color, IDrawingInfo, LegendItemVisibility, NumberFormatOptions, WebChartDataFilters, WebChartTextSymbol } from '../../spec';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ChartConfig, ChartSubType, ChartTypes, CommonStrings } from '../../utils';
-import { SupportedLayer } from '../../interfaces';
-export declare abstract class ChartModel 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>;
-    /**
-     * 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>;
-    /**
-     * The current chart configuration object.
-     */
-    get config(): ChartConfig;
-    set config(config: ChartConfig);
-    /**
-     * The chart type.
-     */
-    get chartType(): typeof this._chartType;
-    /**
-     * The associated layer.
-     */
-    get layer(): SupportedLayer | undefined;
-    /**
-     * The chart ID.
-     */
-    get chartId(): string | undefined;
-    set chartId(id: string | undefined);
-    /**
-     * The version of the chart configuration.
-     */
-    get version(): string | undefined;
-    /**
-     * The chart title text.
-     */
-    get titleText(): string;
-    set titleText(title: string);
-    /**
-     * The chart subtitle text.
-     */
-    get subtitleText(): string;
-    set subtitleText(subtitle: string);
-    /**
-     * The chart description text.
-     */
-    get descriptionText(): string;
-    set descriptionText(description: string);
-    /**
-     * Whether or not the chart title is visible.
-     * `true`: Chart title is visible.
-     * `false`: Chart title is hidden.
-     * **Note:** Even if the title is visible, it may not be displayed if the title text is empty.
-     */
-    get chartTitleVisibility(): boolean;
-    set chartTitleVisibility(visibility: boolean);
-    /**
-     * Whether or not the chart subtitle is visible.
-     * `true`: Chart subtitle is visible.
-     * `false`: Chart subtitle is hidden.
-     * **Note:** Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.
-     */
-    get chartSubtitleVisibility(): boolean;
-    set chartSubtitleVisibility(visibility: boolean);
-    /**
-     * Whether or not the chart description is visible.
-     * `true`: Description is visible.
-     * `false`: Description is hidden.
-     * **Note:** Even if the description is visible, it may not be displayed if the description text is empty.
-     */
-    get descriptionVisibility(): boolean;
-    set descriptionVisibility(visibility: boolean);
-    /**
-     * The chart renderer.
-     */
-    get chartRenderer(): IDrawingInfo["renderer"] | undefined;
-    set chartRenderer(renderer: IDrawingInfo["renderer"]);
-    /**
-     * The title text symbol. Contains styling information such as font, color, and symbol style.
-     */
-    get titleSymbol(): WebChartTextSymbol | undefined;
-    set titleSymbol(titleSymbol: WebChartTextSymbol | undefined);
-    /**
-     * The subtitle text symbol. Contains styling information such as font, color, and symbol style.
-     */
-    get subtitleSymbol(): WebChartTextSymbol | undefined;
-    set subtitleSymbol(subtitleSymbol: WebChartTextSymbol | undefined);
-    /**
-     * The description text symbol. Contains styling information such as font, color, and symbol style.
-     */
-    get descriptionSymbol(): WebChartTextSymbol | undefined;
-    set descriptionSymbol(descriptionSymbol: WebChartTextSymbol | undefined);
-    /**
-     * The background color of the chart.
-     */
-    get backgroundColor(): Color | undefined;
-    set backgroundColor(backgroundColor: Color | undefined);
-    /**
-     * Gets the visibility of a series.
-     *
-     * @param seriesIndex The series index
-     */
-    getSeriesVisibility(seriesIndex: number): boolean;
-    /**
-     * Sets the visibility of a series.
-     *
-     * @param props - Visibility options for the series.
-     */
-    setSeriesVisibility(props: LegendItemVisibility): void;
-    /**
-     * Gets the series ID for a given series index.
-     * If the series index is out of bounds, this function will return `undefined`.
-     *
-     * @param seriesIndex - The index of the series.
-     */
-    getSeriesId(seriesIndex: number): string | undefined;
-    /**
-     * Gets the series index for a given series ID.
-     * If the series ID is not found, this function will return `undefined`.
-     *
-     * @param seriesId - The ID of the series.
-     */
-    getSeriesIndex(seriesId: string): number | undefined;
-    /**
-     * The length of the series array.
-     */
-    get seriesLength(): number;
-    /**
-     * The chart sub type of the series.
-     */
-    get chartSubType(): ChartSubType;
-    /**
-     * Gets the data tooltip value format for a series.
-     *
-     * If the series index is out of bounds or the series list is empty, this function will return `undefined`.
-     *
-     * @param seriesIndex - The index of the series to retrieve the value format for.
-     */
-    getDataTooltipValueFormat(seriesIndex: number): NumberFormatOptions | undefined;
-    /**
-     * Sets the data tooltip value format for a series.
-     *
-     * @param seriesIndex - The index of the series to set the value format for.
-     * @param valueFormat - The value format to set.
-     */
-    setDataTooltipValueFormat(seriesIndex: number, valueFormat: NumberFormatOptions | undefined): void;
-    /**
-     * Whether to fetch `null` values for them to be counted or displayed as categories on the chart.
-     */
-    get fetchNULLValues(): boolean;
-    set fetchNULLValues(fetchNULLValues: boolean);
-    /**
-     * The split-by values for the chart.
-     */
-    get splitByValues(): string[];
-    /**
-     * Gets the data filter for the bar chart.
-     */
-    getDataFilters(): WebChartDataFilters | undefined;
-    /**
-     * Sets the data filter for the chart.
-     *
-     * @param newDataFilters - The new data filter.
-     */
-    setDataFilters(newDataFilters: WebChartDataFilters | undefined): 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 { 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 ChartModelSuperclass {}
+declare const ChartModelSuperclass: typeof ChartModelBase & typeof WithDataFilters & typeof WithSplitByValues & typeof WithFetchNULLValues & typeof WithSeriesDataTooltipValueFormat & typeof WithChartSubType & typeof WithSeriesLength & typeof WithSeriesIndex & typeof WithSeriesId & typeof WithSeriesVisibility & typeof WithBackgroundColor & typeof WithChartRenderer & typeof WithDescriptionVisibility & typeof WithChartSubtitleVisibility & typeof WithChartTitleVisibility & typeof WithDescriptionSymbol & typeof WithDescriptionText & typeof WithSubtitleSymbol & typeof WithSubtitleText & typeof WithVersion & typeof WithTitleSymbol & typeof WithTitleText & typeof WithChartId & typeof WithLayer & typeof WithConfig

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

@@ -1,15 +1,10 @@
-import { ChartConfig } from '../../../utils';
-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>;
+};