@arcgis/charts-components 5.0.0-next.99 → 5.0.1

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

@@ -1,20 +1,7 @@
-import { ChartConfig } from '../../utils';
-import { ChartModelBase } from '../chart-model/chart-model-base';
-/**
- * Gets the chart ID from the config.
- */
-export declare const getChartId: (config: ChartConfig) => string | undefined;
-/**
- * Sets the chart ID in the config.
- */
-export declare const setChartId: (id: string | undefined, config: ChartConfig) => void;
-/**
- * Adds getter/setter support for the chart identifier.
- */
-export declare abstract class WithChartId extends ChartModelBase {
-    /**
-     * The chart ID.
-     */
-    get chartId(): string | undefined;
-    set chartId(id: string | undefined);
-}
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds getter/setter support for the chart identifier. */
+export abstract class WithChartId extends ChartModelBase {
+  /** The chart ID. */
+  accessor chartId: string | undefined;
+}

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

@@ -1,21 +1,52 @@
-import { IDrawingInfo } from '../../spec';
-import { ChartConfig } from '../../utils/types';
-import { ChartModelBase } from '../chart-model/chart-model-base';
-/**
- * Gets the chart renderer from the config.
- */
-export declare const getChartRenderer: (config: ChartConfig) => IDrawingInfo["renderer"] | undefined;
-/**
- * Sets the chart renderer on the config.
- */
-export declare const setChartRenderer: (renderer: IDrawingInfo["renderer"] | undefined, config: ChartConfig) => void;
-/**
- * Adds support for working with chart renderer.
- */
-export declare abstract class WithChartRenderer extends ChartModelBase {
-    /**
-     * The chart renderer.
-     */
-    get chartRenderer(): IDrawingInfo["renderer"] | undefined;
-    set chartRenderer(renderer: IDrawingInfo["renderer"]);
-}
+import type { IDrawingInfo } from "../../spec/rest-js-types.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart renderer. */
+export abstract class WithChartRenderer extends ChartModelBase {
+  /**
+   * The chart renderer.
+   *
+   * @example
+   * In this example, we set the chartRenderer for a class-break heat chart.
+   * ```ts
+   * heatChartModel.chartRenderer = {
+   *    "type": "classBreaks",
+   *    "field": "arcgis_charts_heat_chart_value",
+   *    "classBreakInfos": [
+   *        {
+   *          "label": "70 - 145",
+   *          "classMinValue": 70,
+   *          "classMaxValue": 145,
+   *          "symbol": {
+   *            "type": "esriSFS",
+   *            "color": [
+   *              212,
+   *              227,
+   *              255,
+   *              255
+   *            ],
+   *            "style": "esriSFSSolid"
+   *          }
+   *        },
+   *        {
+   *          "label": "146 - 250",
+   *          "classMinValue": 146,
+   *          "classMaxValue": 250,
+   *          "symbol": {
+   *            "type": "esriSFS",
+   *            "color": [
+   *              43,
+   *              108,
+   *              240,
+   *              255
+   *            ],
+   *            "style": "esriSFSSolid"
+   *          }
+   *        }
+   *    ]
+   *  };
+   * ```
+   */
+  get chartRenderer(): IDrawingInfo["renderer"] | undefined;
+  set chartRenderer(value: IDrawingInfo["renderer"]);
+}

package/dist/model/properties/chart-sub-type.d.ts

@@ -1,15 +1,8 @@
-import { ChartConfig, ChartSubType } from '../../utils';
-import { ChartModelBase } from '../chart-model/chart-model-base';
-/**
- * Gets the chart sub type for the current series configuration.
- */
-export declare const getSeriesChartSubType: (config: ChartConfig) => ChartSubType;
-/**
- * Adds support for reading the chart sub type.
- */
-export declare abstract class WithChartSubType extends ChartModelBase {
-    /**
-     * The chart sub type of the series.
-     */
-    get chartSubType(): ChartSubType;
-}
+import type { ChartSubType } from "../../utils/misc/interfaces.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for reading the chart sub type. */
+export abstract class WithChartSubType extends ChartModelBase {
+  /** The chart sub type of the series. */
+  get chartSubType(): ChartSubType;
+}

package/dist/model/properties/color-match.d.ts

@@ -0,0 +1,12 @@
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for matching colors between the chart and its data source. */
+export abstract class WithColorMatch extends ChartModelBase {
+  /**
+   * Whether the chart should attempt to match the data source's colors.
+   *
+   * `true`: Attempt to match the data source's colors.
+   * `false`: Use the colors defined in the config.
+   */
+  accessor colorMatch: boolean;
+}

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

@@ -1,12 +1,8 @@
-import { ChartModelBase } from '../chart-model/chart-model-base';
-import { ChartConfig } from '../../utils';
-/**
- * Adds getter/setter support for the chart configuration object.
- */
-export declare abstract class WithConfig extends ChartModelBase {
-    /**
-     * The current chart configuration object.
-     */
-    get config(): ChartConfig;
-    set config(config: ChartConfig);
-}
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+
+/** Adds getter/setter support for the chart configuration object. */
+export abstract class WithConfig extends ChartModelBase {
+  /** The current chart configuration object. */
+  accessor config: ChartConfig;
+}

package/dist/model/properties/data-filters.d.ts

@@ -1,26 +1,14 @@
-import { WebChartDataFilters } from '../../spec';
-import { ChartConfig } from '../../utils';
-import { ChartModelBase } from '../chart-model/chart-model-base';
-/**
- * Get the data filter from the config.
- */
-export declare const getDataFilters: (config: ChartConfig) => WebChartDataFilters | undefined;
-/**
- * Set the data filter in the config.
- */
-export declare const setDataFilters: (dataFilter: WebChartDataFilters | undefined, config: ChartConfig) => void;
-/**
- * Adds support for working with chart data filters.
- */
-export declare abstract class WithDataFilters extends ChartModelBase {
-    /**
-     * 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>;
-}
+import type { WebChartDataFilters } from "../../spec/web-chart.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart data filters. */
+export abstract class WithDataFilters extends ChartModelBase {
+  /** 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>;
+}

package/dist/model/properties/data-labels/data-labels-symbol.d.ts

@@ -0,0 +1,8 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+import type { WebChartTextSymbol } from "../../../spec/web-chart.js";
+
+/** Adds support for working with the data labels symbol. */
+export abstract class WithDataLabelsSymbol extends ChartModelBase {
+  /** Data labels text symbol (font, color, style). */
+  accessor dataLabelsSymbol: WebChartTextSymbol | undefined;
+}

package/dist/model/properties/data-labels/data-labels-visibility.d.ts

@@ -0,0 +1,7 @@
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with the data labels visibility. */
+export abstract class WithDataLabelsVisibility extends ChartModelBase {
+  /** Whether data labels are visible. */
+  accessor dataLabelsVisibility: boolean;
+}

package/dist/model/properties/data-tooltip-value-format.d.ts

@@ -1,34 +1,21 @@
-import { NumberFormatOptions, WebChartSeriesType } from '../../spec';
-import { ChartModelBase } from '../chart-model/chart-model-base';
-/**
- * Gets the data tooltip value format for a series from the chart series collection.
- */
-export declare const getDataTooltipValueFormat: (series: WebChartSeriesType[], seriesIndex: number) => NumberFormatOptions | undefined;
-/**
- * Sets the data tooltip value format for a series in the chart series collection.
- */
-export declare const setDataTooltipValueFormat: (props: {
-    series: WebChartSeriesType[];
-    seriesIndex: number;
-    valueFormat: NumberFormatOptions | undefined;
-}) => void;
-/**
- * Adds support for working with data tooltip value formats.
- */
-export declare abstract class WithSeriesDataTooltipValueFormat extends ChartModelBase {
-    /**
-     * 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;
-}
+import type { NumberFormatOptions } from "../../spec/web-chart.js";
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with data tooltip value formats. */
+export abstract class WithSeriesDataTooltipValueFormat extends ChartModelBase {
+  /**
+   * 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;
+}

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

@@ -1,21 +1,8 @@
-import { WebChartTextSymbol } from '../../../spec/web-chart';
-import { ChartConfig } from '../../../utils/types';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets the description text symbol from the chart config.
- */
-export declare const getDescriptionSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the description text symbol in the chart config.
- */
-export declare const setDescriptionSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Adds support for working with chart description symbols.
- */
-export declare abstract class WithDescriptionSymbol extends ChartModelBase {
-    /**
-     * The description text symbol. Contains styling information such as font, color, and symbol style.
-     */
-    get descriptionSymbol(): WebChartTextSymbol | undefined;
-    set descriptionSymbol(descriptionSymbol: 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 description symbols. */
+export abstract class WithDescriptionSymbol extends ChartModelBase {
+  /** The description text symbol. Contains styling information such as font, color, and symbol style. */
+  accessor descriptionSymbol: WebChartTextSymbol | undefined;
+}

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

@@ -1,17 +1,6 @@
-import { ChartConfig } from '../../../utils';
-import { ChartModelBase } from '../../chart-model/chart-model-base';
-/**
- * Gets the description text from the chart config.
- */
-export declare const getDescriptionText: (config: ChartConfig) => string;
-/**
- * Sets the description text on the chart config.
- */
-export declare const setDescriptionText: (descriptionText: string, config: ChartConfig) => void;
-/**
- * Adds support for working with chart description text.
- */
-export declare abstract class WithDescriptionText extends ChartModelBase {
-    get descriptionText(): string;
-    set descriptionText(description: string);
-}
+import type { ChartModelBase } from "../../chart-model/chart-model-base.js";
+
+/** Adds support for working with chart description text. */
+export abstract class WithDescriptionText extends ChartModelBase {
+  accessor descriptionText: string;
+}

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

@@ -1,26 +1,11 @@
-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.
+   *
+   * **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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,22 @@
+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';
-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[];
+}