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

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

@@ -1,21 +1,8 @@
-import { WebChartTextSymbol } from '../../../spec';
-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,11 @@
-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.
+   *
+   * **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';
-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,11 @@
-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.
+   *
+   * **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;
+}

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

@@ -1,34 +1,20 @@
-import { WebChart, WebChartRadarChartSeries } from '../../spec';
-import { ChartConfig } from '../../utils';
-import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { ModelWithBaselineStacking, ModelWithLineMarkerStyling } from '../mixins';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-export declare class RadarChartModel extends SerialChartModel {
-    /**
-     * Current configuration used for the Radar chart.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.RadarChart, WebChart>;
-    /**
-     * Default series for the radar chart. Used in resetting the series styling.
-     */
-    protected defaultSeries: WebChartRadarChartSeries | undefined;
-    protected _chartType: "radarSeries";
-    protected layerInfo: LayerInfo;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.RadarChart>>): Promise<void>;
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-    /**
-     * Initializes the default series for the radar chart. Used in resetting the series styling.
-     */
-    protected initDefaultSeries(): void;
-    /**
-     * Resets the series styling to the default styling.
-     */
-    resetSeriesStyling(): void;
-    /**
-     * Returns whether the series styling is able to be reset.
-     */
-    resetAvailable(): boolean;
-}
-export interface RadarChartModel extends ModelWithBaselineStacking, ModelWithLineMarkerStyling {
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes } from "../interfaces/common.js";
+import type { WithNegativeValuesStackedToBaseline } from "../properties/series/negative-values-stacked-to-baseline.js";
+import type { ModelWithLineMarkerStyling } from "../mixins/model-with-line-marker-styling.js";
+
+export class RadarChartModel extends RadarChartModelSuperclass {
+  /** Returns whether the series styling is able to be reset. */
+  resetAvailable(): boolean;
+  /** Resets the series styling to the default styling. */
+  resetSeriesStyling(): void;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.RadarChart>>): Promise<void>;
 }
+declare const RadarChartModelSuperclass: typeof SerialChartModel & typeof ModelWithLineMarkerStyling & typeof WithNegativeValuesStackedToBaseline

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

@@ -1,72 +1,57 @@
-import { ISimpleLineSymbol, ISimpleMarkerSymbol, WebChart, SizePolicy, ScatterplotOverlays } from '../../spec';
-import { ChartConfig, XYChartTypes } from '../../utils';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ChartModel } from '../chart-model/chart-model';
-import { ModelWithColorMatch, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides, ModelWithLegend, ModelWithMultiAxes, ModelWithTooltips } from '../mixins';
-export declare class ScatterplotModel extends ChartModel {
-    /**
-     * Current configuration used for the scatterplot.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.Scatterplot, WebChart>;
-    protected _chartType: XYChartTypes;
-    protected layerInfo: LayerInfo;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.Scatterplot>>): Promise<void>;
-    /**
-     * X-axis field.
-     */
-    get xAxisField(): string;
-    set xAxisField(fieldName: string);
-    /**
-     * Y-axis field.
-     */
-    get yAxisField(): string;
-    set yAxisField(fieldName: string);
-    /**
-     * Whether the linear trend line is shown.
-     */
-    get showLinearTrend(): boolean;
-    set showLinearTrend(show: boolean);
-    /**
-     * Line symbol for the linear trend line.
-     */
-    get linearTrendSymbol(): ISimpleLineSymbol;
-    set linearTrendSymbol(symbol: ISimpleLineSymbol);
-    /**
-     * Marker symbol used for the scatterplot points when using a fixed symbol (i.e. no size policy is set).
-     */
-    get fixedMarkerSymbol(): ISimpleMarkerSymbol;
-    set fixedMarkerSymbol(symbol: ISimpleMarkerSymbol);
-    /**
-     * Size policy for the scatterplot points. This is used to scale the size of the marker symbol based on a given field.
-     */
-    get sizePolicy(): SizePolicy | undefined;
-    set sizePolicy(sizePolicy: SizePolicy | undefined);
-    /**
-     * Chart overlays. The scatterplot implements only 1 overlay, **trendLine**.
-     */
-    get seriesOverlays(): ScatterplotOverlays | undefined;
-    set seriesOverlays(overlays: ScatterplotOverlays | undefined);
-    /**
-     * Additional tooltip display fields.
-     *
-     * **NOTE**: Only numeric fields are supported.
-     */
-    get additionalTooltipField(): string[] | string;
-    set additionalTooltipField(fields: string[] | string | undefined);
-    /**
-     * Generate the proper chart title given the current config.
-     */
-    generateChartTitle(): string;
-    /**
-     * Generate the proper x-axis title given the current config.
-     */
-    generateXAxisTitle(): string;
-    /**
-     * Generate the proper y-axis title given the current config.
-     */
-    generateYAxisTitle(): string;
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-}
-export interface ScatterplotModel extends ModelWithMultiAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides {
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes } from "../interfaces/common.js";
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { WithColorMatch } from "../properties/color-match.js";
+import type { WithDataLabelsVisibility } from "../properties/data-labels/data-labels-visibility.js";
+import type { WithDataLabelsSymbol } from "../properties/data-labels/data-labels-symbol.js";
+import type { WithAxisLabelsSymbol } from "../properties/axes/axis-labels-symbol.js";
+import type { WithAxisLinesSymbol } from "../properties/axes/axis-lines-symbol.js";
+import type { WithXBounds } from "../properties/axes/x-axis/x-bounds.js";
+import type { WithXAxisLabelsVisibility } from "../properties/axes/x-axis/x-axis-labels-visibility.js";
+import type { WithXAxisTitleSymbol } from "../properties/axes/x-axis/x-axis-title-symbol.js";
+import type { WithXAxisTitleText } from "../properties/axes/x-axis/x-axis-title-text.js";
+import type { WithXAxisTitleVisibility } from "../properties/axes/x-axis/x-axis-title-visibility.js";
+import type { WithGenerateXAxisTitle } from "../properties/axes/x-axis/generate-x-axis-title.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { ScatterplotOverlays, SizePolicy } from "../../spec/web-chart.js";
+import type { ISimpleLineSymbol, ISimpleMarkerSymbol } from "../../spec/rest-js-types.js";
+import type { ModelWithMultiAxes } from "../mixins/model-with-multi-axes.js";
+import type { ModelWithLegend } from "../mixins/model-with-legend.js";
+import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
+import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
+import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
+
+export class ScatterplotModel extends ScatterplotModelSuperclass {
+  /**
+   * Add an additional field to display for scatterplot tooltips.
+   *
+   * **Note**: Only numeric fields are supported.
+   */
+  get additionalTooltipField(): string[] | string;
+  set additionalTooltipField(value: string[] | string | undefined);
+  /** Marker symbol used for the scatterplot points when using a fixed symbol (i.e. no size policy is set). */
+  accessor fixedMarkerSymbol: ISimpleMarkerSymbol;
+  /** Line symbol for the linear trend line. */
+  accessor linearTrendSymbol: ISimpleLineSymbol;
+  /** Trendline overlay for the scatterplot. */
+  accessor seriesOverlays: ScatterplotOverlays | undefined;
+  /** Whether the linear trend line is shown. */
+  accessor showLinearTrend: boolean;
+  /** Size policy for the scatterplot points. This is used to scale the size of the marker symbol based on a given field. */
+  accessor sizePolicy: SizePolicy | undefined;
+  /** X-axis field. */
+  accessor xAxisField: string;
+  /** Y-axis field. */
+  accessor yAxisField: string;
+  /** Generate the proper chart title given the current config. */
+  generateChartTitle(): string;
+  /** Generate the proper y-axis title given the current config. */
+  generateYAxisTitle(): string;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.Scatterplot>>): Promise<void>;
 }
+declare const ScatterplotModelSuperclass: typeof ChartModel & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText & typeof ModelWithYGuides & typeof ModelWithXGuides & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes