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

package/dist/model/properties/description/description-visibility.d.ts

@@ -1,26 +1,15 @@
-import { ChartConfig } from '../../../utils/types';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets whether the chart description is visible.
- */
-export declare const getDescriptionVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets whether the chart description is visible.
- */
-export declare const setDescriptionVisibility: (visibility: boolean, config: ChartConfig) => void;
-/**
- * Adds support for working with chart description visibility.
- */
-export declare abstract class WithDescriptionVisibility extends ChartModelBase {
-    /**
-     * 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);
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart description visibility. */
+export abstract class WithDescriptionVisibility extends ChartModelBase {
+  /**
+   * 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.
+   */
+  accessor descriptionVisibility: boolean;
+}

package/dist/model/properties/fetch-null-values.d.ts

@@ -1,20 +1,7 @@
-import { ChartModelBase } from '../chart-model/chart-model-base';
-import { ChartConfig } from '../../utils';
-/**
- * Sets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
- */
-export declare const setFetchNULLValues: (fetchNULLValues: boolean, config: ChartConfig) => void;
-/**
- * Gets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
- */
-export declare const getFetchNULLValues: (config: ChartConfig) => boolean;
-/**
- * Adds support for working with the fetch NULL values flag.
- */
-export declare abstract class WithFetchNULLValues extends ChartModelBase {
-    /**
-     * Whether to fetch `null` values for them to be counted or displayed as categories on the chart.
-     */
-    get fetchNULLValues(): boolean;
-    set fetchNULLValues(fetchNULLValues: boolean);
-}
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with the fetch NULL values flag. */
+export abstract class WithFetchNULLValues extends ChartModelBase {
+  /** Whether to fetch `null` values for them to be counted or displayed as categories on the chart. */
+  accessor fetchNULLValues: boolean;
+}

package/dist/model/properties/layer.d.ts

@@ -1,11 +1,8 @@
-import { SupportedLayer } from '../../interfaces';
-import { ChartModelBase } from '../chart-model/chart-model-base';
-/**
- * Adds getter support for the associated layer reference.
- */
-export declare abstract class WithLayer extends ChartModelBase {
-    /**
-     * The chart model's layer.
-     */
-    get layer(): SupportedLayer | undefined;
-}
+import type { SupportedLayer } from "../../interfaces.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds getter support for the associated layer reference. */
+export abstract class WithLayer extends ChartModelBase {
+  /** The chart model's layer. */
+  get layer(): SupportedLayer | undefined;
+}

package/dist/model/properties/rotated-state.d.ts

@@ -1,24 +1,7 @@
-import { ChartConfig } from '../../utils/types';
-import { ChartModelBase } from '../chart-model/chart-model-base';
-/**
- * Type guard for model `WithRotatedState`.
- */
-export declare function isModelWithRotatedState(model: ChartModelBase | undefined): model is WithRotatedState;
-/**
- * Whether the chart is rotated.
- */
-export declare const getRotatedState: (config: ChartConfig) => boolean;
-/**
- * Whether the chart is rotated.
- */
-export declare const setRotatedState: (rotated: boolean, config: ChartConfig) => void;
-/**
- * Adds support for working with the chart rotated state.
- */
-export declare abstract class WithRotatedState extends ChartModelBase {
-    /**
-     * Whether the chart is rotated.
-     */
-    get rotatedState(): boolean;
-    set rotatedState(rotated: boolean);
-}
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with the chart rotated state. */
+export abstract class WithRotatedState extends ChartModelBase {
+  /** Whether the chart is rotated. */
+  accessor rotatedState: boolean;
+}

package/dist/model/properties/series/negative-values-stacked-to-baseline.d.ts

@@ -1,44 +1,22 @@
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-import { ChartConfig } from '../../../utils';
-/**
- * Type guard for model `WithNegativeValuesStackedToBaseline`
- */
-export declare function isModelWithNegativeValuesStackedToBaseline(model: ChartModelBase | undefined): model is WithNegativeValuesStackedToBaseline;
-/**
- * Specify how negative values are treated in stacked series.
- *
- * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
- */
-export declare const isNegativeValuesStackedToBaseline: (seriesIndex: number, config: ChartConfig) => boolean;
-/**
- * Specify how negative values are treated in stacked series.
- *
- * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
- */
-export declare const setNegativeValuesStackedToBaseline: (props: {
-    stackNegativeValuesToBaseline: boolean;
-    seriesIndex: number;
-    config: ChartConfig;
-}) => void;
-/**
- * Adds support for configuring whether negative values stack against the baseline.
- */
-export declare abstract class WithNegativeValuesStackedToBaseline extends ChartModelBase {
-    /**
-     * Specify how negative values are treated in stacked series.
-     *
-     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
-     *
-     * @param seriesIndex - The index of the series.
-     */
-    isNegativeValuesStackedToBaseline(seriesIndex: number): boolean;
-    /**
-     * Specify how negative values are treated in stacked series.
-     *
-     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
-     *
-     * @param stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
-     * @param seriesIndex - The index of the series.
-     */
-    setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for configuring whether negative values stack against the baseline. */
+export abstract class WithNegativeValuesStackedToBaseline extends ChartModelBase {
+  /**
+   * Specify how negative values are treated in stacked series.
+   *
+   * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  isNegativeValuesStackedToBaseline(seriesIndex: number): boolean;
+  /**
+   * Specify how negative values are treated in stacked series.
+   *
+   * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
+   *
+   * @param stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+   * @param seriesIndex - The index of the series.
+   */
+  setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
+}

package/dist/model/properties/series/series-id.d.ts

@@ -1,19 +1,12 @@
-import { ChartConfig } from '../../../utils';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets the series ID for a given series index.
- * If the series index is out of bounds, this function will return `undefined`.
- */
-export declare const getSeriesId: (seriesIndex: number, config: ChartConfig) => string | undefined;
-/**
- * Adds support for retrieving a series ID.
- */
-export declare abstract class WithSeriesId extends ChartModelBase {
-    /**
-     * 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;
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for retrieving a series ID. */
+export abstract class WithSeriesId extends ChartModelBase {
+  /**
+   * 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;
+}

package/dist/model/properties/series/series-index.d.ts

@@ -1,19 +1,12 @@
-import { ChartConfig } from '../../../utils';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets the series index for a given series ID.
- * If the series ID is not found, this function will return `undefined`.
- */
-export declare const getSeriesIndex: (seriesId: string, config: ChartConfig) => number | undefined;
-/**
- * Adds support for retrieving a series index.
- */
-export declare abstract class WithSeriesIndex extends ChartModelBase {
-    /**
-     * 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;
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for retrieving a series index. */
+export abstract class WithSeriesIndex extends ChartModelBase {
+  /**
+   * 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;
+}

package/dist/model/properties/series/series-length.d.ts

@@ -1,15 +1,7 @@
-import { ChartConfig } from '../../../utils';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets the length of the series array from the chart config.
- */
-export declare const getSeriesLength: (config: ChartConfig) => number;
-/**
- * Adds support for reading the series length.
- */
-export declare abstract class WithSeriesLength extends ChartModelBase {
-    /**
-     * The length of the series array.
-     */
-    get seriesLength(): number;
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for reading the series length. */
+export abstract class WithSeriesLength extends ChartModelBase {
+  /** The length of the series array. */
+  get seriesLength(): number;
+}

package/dist/model/properties/series/series-visibility.d.ts

@@ -1,28 +1,18 @@
-import { LegendItemVisibility } from '../../../spec/events';
-import { ChartConfig } from '../../../utils';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets the visibility of a series from the chart config.
- */
-export declare const getSeriesVisibility: (seriesIndex: number, config: ChartConfig) => boolean;
-/**
- * Sets the visibility of a series in the chart config.
- */
-export declare const setSeriesVisibility: (props: LegendItemVisibility, config: ChartConfig) => void;
-/**
- * Adds support for working with series visibility.
- */
-export declare abstract class WithSeriesVisibility extends ChartModelBase {
-    /**
-     * 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;
-}
+import type { LegendItemVisibility } from "../../../spec/events.js";
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with series visibility. */
+export abstract class WithSeriesVisibility extends ChartModelBase {
+  /**
+   * 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;
+}

package/dist/model/properties/split-by-values.d.ts

@@ -1,15 +1,7 @@
-import { ChartModelBase } from '../chart-model/chart-model-base';
-import { ChartConfig } from '../../utils';
-/**
- * Gets the split by values from the chart config.
- */
-export declare const getSplitByValues: (config: ChartConfig) => string[];
-/**
- * Adds support for retrieving split-by values.
- */
-export declare abstract class WithSplitByValues extends ChartModelBase {
-    /**
-     * The split-by values for the chart.
-     */
-    get splitByValues(): string[];
-}
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for retrieving split-by values. */
+export abstract class WithSplitByValues extends ChartModelBase {
+  /** The split-by values for the chart. */
+  get splitByValues(): string[];
+}

package/dist/model/properties/subtitle/subtitle-symbol.d.ts

@@ -1,21 +1,8 @@
-import { WebChartTextSymbol } from '../../../spec/web-chart';
-import { ChartConfig } from '../../../utils';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets the subtitle text symbol from the chart config.
- */
-export declare const getSubtitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the subtitle text symbol in the chart config.
- */
-export declare const setSubtitleSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Adds support for working with chart subtitle symbols.
- */
-export declare abstract class WithSubtitleSymbol extends ChartModelBase {
-    /**
-     * The subtitle text symbol. Contains styling information such as font, color, and symbol style.
-     */
-    get subtitleSymbol(): WebChartTextSymbol | undefined;
-    set subtitleSymbol(subtitleSymbol: WebChartTextSymbol | undefined);
-}
+import type { WebChartTextSymbol } from "../../../spec/web-chart.js";
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart subtitle symbols. */
+export abstract class WithSubtitleSymbol extends ChartModelBase {
+  /** The subtitle text symbol. Contains styling information such as font, color, and symbol style. */
+  accessor subtitleSymbol: WebChartTextSymbol | undefined;
+}

package/dist/model/properties/subtitle/subtitle-text.d.ts

@@ -1,20 +1,7 @@
-import { ChartConfig } from '../../../utils';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets the subtitle text of the chart from the config.
- */
-export declare const getSubtitleText: (config: ChartConfig) => string;
-/**
- * Sets the subtitle text of the chart.
- */
-export declare const setSubtitleText: (subtitleText: string, config: ChartConfig) => void;
-/**
- * Adds support for working with chart subtitle text.
- */
-export declare abstract class WithSubtitleText extends ChartModelBase {
-    /**
-     * The chart subtitle text.
-     */
-    get subtitleText(): string;
-    set subtitleText(subtitle: string);
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart subtitle text. */
+export abstract class WithSubtitleText extends ChartModelBase {
+  /** The chart subtitle text. */
+  accessor subtitleText: string;
+}

package/dist/model/properties/subtitle/subtitle-visibility.d.ts

@@ -1,26 +1,15 @@
-import { ChartConfig } from '../../../utils/types';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets whether the chart subtitle is visible.
- */
-export declare const getChartSubtitleVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets whether the chart subtitle is visible.
- */
-export declare const setChartSubtitleVisibility: (visibility: boolean, config: ChartConfig) => void;
-/**
- * Adds support for working with chart subtitle visibility.
- */
-export declare abstract class WithChartSubtitleVisibility extends ChartModelBase {
-    /**
-     * 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);
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart subtitle visibility. */
+export abstract class WithChartSubtitleVisibility extends ChartModelBase {
+  /**
+   * 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.
+   */
+  accessor chartSubtitleVisibility: boolean;
+}

package/dist/model/properties/title/title-symbol.d.ts

@@ -1,21 +1,8 @@
-import { WebChartTextSymbol } from '../../../spec/web-chart';
-import { ChartConfig } from '../../../utils';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets the title text symbol from the chart config.
- */
-export declare const getTitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the title text symbol in the chart config.
- */
-export declare const setTitleSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Adds support for working with chart title symbols.
- */
-export declare abstract class WithTitleSymbol extends ChartModelBase {
-    /**
-     * The title text symbol. Contains styling information such as font, color, and symbol style.
-     */
-    get titleSymbol(): WebChartTextSymbol | undefined;
-    set titleSymbol(titleSymbol: WebChartTextSymbol | undefined);
-}
+import type { WebChartTextSymbol } from "../../../spec/web-chart.js";
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart title symbols. */
+export abstract class WithTitleSymbol extends ChartModelBase {
+  /** The title text symbol. Contains styling information such as font, color, and symbol style. */
+  accessor titleSymbol: WebChartTextSymbol | undefined;
+}

package/dist/model/properties/title/title-text.d.ts

@@ -1,20 +1,7 @@
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the title text of the chart from the config.
- */
-export declare const getTitleText: (config: ChartConfig) => string;
-/**
- * Sets the title text of the chart.
- */
-export declare const setTitleText: (titleText: string, config: ChartConfig) => void;
-/**
- * Adds support for working with chart title text.
- */
-export declare abstract class WithTitleText extends ChartModelBase {
-    /**
-     * The chart title text.
-     */
-    get titleText(): string;
-    set titleText(title: string);
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart title text. */
+export abstract class WithTitleText extends ChartModelBase {
+  /** The chart title text. */
+  accessor titleText: string;
+}

package/dist/model/properties/title/title-visibility.d.ts

@@ -1,26 +1,15 @@
-import { ChartConfig } from '../../../utils';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets whether the chart title is visible.
- */
-export declare const getChartTitleVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets whether the chart title is visible.
- */
-export declare const setChartTitleVisibility: (visibility: boolean, config: ChartConfig) => void;
-/**
- * Adds support for working with chart title visibility.
- */
-export declare abstract class WithChartTitleVisibility extends ChartModelBase {
-    /**
-     * 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);
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart title visibility. */
+export abstract class WithChartTitleVisibility extends ChartModelBase {
+  /**
+   * 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.
+   */
+  accessor chartTitleVisibility: boolean;
+}

package/dist/model/properties/version.d.ts

@@ -1,15 +1,7 @@
-import { ChartConfig } from '../../utils/types';
-import { ChartModelBase } from '../chart-model/chart-model-base';
-/**
- * Gets the version of the chart configuration.
- */
-export declare const getVersion: (config: ChartConfig) => string | undefined;
-/**
- * Adds getter support for the chart version.
- */
-export declare abstract class WithVersion extends ChartModelBase {
-    /**
-     * The version of the chart configuration.
-     */
-    get version(): string | undefined;
-}
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds getter support for the chart version. */
+export abstract class WithVersion extends ChartModelBase {
+  /** The version of the chart configuration. */
+  get version(): string | undefined;
+}