@arcgis/charts-components 4.33.0-next.94 → 4.33.0-next.96

package/dist/model/pie-chart-model/utils/pie-chart-data.d.ts

@@ -0,0 +1,73 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { WebChartPieChartSeries, RESTStatisticType } from '@arcgis/charts-spec';
+import { LayerInfo, PieChartDataModes, PieChartDataSortingKinds } from '../../interfaces/common';
+/**
+ * Gets the category field.
+ */
+export declare const getCategory: (config: ChartConfig<WebChartPieChartSeries>) => string;
+/**
+ * Gets the sort order kind.
+ */
+export declare const getSortOrderKind: (config: ChartConfig<WebChartPieChartSeries>, mode: PieChartDataModes) => PieChartDataSortingKinds;
+/**
+ * Gets the numeric fields.
+ */
+export declare const getNumericFields: (config: ChartConfig<WebChartPieChartSeries>) => string[];
+/**
+ * Gets the aggregation type.
+ */
+export declare const getAggregationType: (config: ChartConfig<WebChartPieChartSeries>, mode: PieChartDataModes) => RESTStatisticType;
+/**
+ * Sets the sort order by updating the config accordingly.
+ */
+export declare const setSortOrderKind: (props: {
+    newSortOrderKind: PieChartDataSortingKinds;
+    config: ChartConfig<WebChartPieChartSeries>;
+    orderByList?: string[];
+}) => void;
+/**
+ * Sets the category field by updating the config accordingly.
+ */
+export declare const setCategory: (props: {
+    newCategory: string;
+    config: ChartConfig<WebChartPieChartSeries>;
+    layerInfo: LayerInfo | undefined;
+    mode: PieChartDataModes;
+}) => Promise<void>;
+/**
+ * Sets the aggregation type by updating the config accordingly.
+ */
+export declare const setAggregationType: (props: {
+    newAggregationType: RESTStatisticType;
+    config: ChartConfig<WebChartPieChartSeries>;
+    layerInfo: LayerInfo;
+    mode: PieChartDataModes;
+}) => Promise<void>;
+/**
+ * Sets the numeric fields by updating the config accordingly.
+ */
+export declare const setNumericFields: (props: {
+    newNumericFields: string[] | string;
+    config: ChartConfig<WebChartPieChartSeries>;
+    layerInfo: LayerInfo | undefined;
+    mode: PieChartDataModes;
+}) => Promise<void>;
+/**
+ * Get the order by list from the config. The order by list is only used when the sort order kind is custom sort.
+ * @param  {ChartConfig<WebChartBarChartSeries>} config - The chart config.
+ * @param  {PieChartDataModes} mode - The chart mode.
+ *
+ * @returns string[] - The order by list.
+ */
+export declare const getOrderByList: (config: ChartConfig<WebChartPieChartSeries>, mode: PieChartDataModes) => string[];
+/**
+ * Set the order by list in the config. The order by list is only used when the sort order kind is custom sort.
+ * @param  {string[]} props.values - The order by list.
+ * @param  {ChartConfig<WebChartBarChartSeries>} props.config - The chart config.
+ * @param  {PieChartDataModes} props.mode - The chart mode.
+ */
+export declare const setOrderByList: (props: {
+    values: string[];
+    config: ChartConfig<WebChartPieChartSeries>;
+    mode: PieChartDataModes;
+}) => void;

package/dist/model/pie-chart-model/utils/pie-chart-legend.d.ts

@@ -0,0 +1,49 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+/**
+ * Gets the display of numerical value setting for the legend items from the chart config.
+ * @param config The chart configuration object
+ * @returns {boolean}
+ * @remarks
+ * This setting is only applicable to pie charts.
+ */
+export declare const getDisplayNumericValue: (config: ChartConfig) => boolean;
+/**
+ * Sets the display of numerical value setting for the legend items in the chart config.
+ * @param displayNumericValue The setting for the display of numerical value in the legend
+ * @param config The chart configuration object
+ * @remarks
+ * This setting is only applicable to pie charts.
+ */
+export declare const setDisplayNumericValue: (displayNumericValue: boolean, config: ChartConfig) => void;
+/**
+ * Gets the display of percentage setting for the legend items from the chart config.
+ * @param config The chart configuration object
+ * @returns {boolean}
+ * @remarks
+ * This setting is only applicable to pie charts.
+ */
+export declare const getDisplayPercentage: (config: ChartConfig) => boolean;
+/**
+ * Sets the display of percentage setting for the legend items in the chart config.
+ * @param displayPercentage The setting for the display of percentage in the legend
+ * @param config The chart configuration object
+ * @remarks
+ * This setting is only applicable to pie charts.
+ */
+export declare const setDisplayPercentage: (displayPercentage: boolean, config: ChartConfig) => void;
+/**
+ * Gets the maximum width in pixel for the legend item labels from the chart config.
+ * @param config The chart configuration object
+ * @returns {number}
+ * @remarks
+ * This setting is only applicable to pie charts.
+ */
+export declare const getLabelMaxWidth: (config: ChartConfig) => number;
+/**
+ * Sets the maximum width in pixel for the legend item labels in the chart config.
+ * @param displayPercentage The maximum width in pixel for the legend item labels
+ * @param config The chart configuration object
+ * @remarks
+ * This setting is only applicable to pie charts.
+ */
+export declare const setLabelMaxWidth: (labelMaxWidth: number, config: ChartConfig) => void;

package/dist/model/pie-chart-model/utils/pie-chart-series.d.ts

@@ -0,0 +1,212 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { ISimpleLineSymbol, WebChartPieChartSeries } from '@arcgis/charts-spec';
+import { PieChartSlicesDisplay } from '../../interfaces/common';
+/**
+ * Gets the inner radius size of the pie chart.
+ * @param config The chart configuration.
+ * @returns {number | null | undefined}
+ */
+export declare const getInnerRadiusSize: (config: ChartConfig<WebChartPieChartSeries>) => number | null | undefined;
+/**
+ * Sets the inner radius size of the pie chart.
+ * @param radius The inner radius size for the pie chart.
+ * @param config The chart configuration.
+ */
+export declare const setInnerRadiusSize: (radius: number, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the label character limit from the chart config.
+ * @param config The chart configuration.
+ * @returns {number | null | undefined}
+ */
+export declare const getLabelCharacterLimit: (config: ChartConfig<WebChartPieChartSeries>) => number | null | undefined;
+/**
+ * Sets the label character limit for the pie chart.
+ * @param characterLimit The character limit for the labels.
+ * @param config The chart configuration.
+ */
+export declare const setLabelCharacterLimit: (characterLimit: number | null, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the start angle of the pie chart.
+ * @param config The chart configuration.
+ * @returns {number | null | undefined}
+ */
+export declare const getStartAngle: (config: ChartConfig<WebChartPieChartSeries>) => number | null | undefined;
+/**
+ * Sets the start angle of the pie chart.
+ * @param angle The start angle for the pie chart.
+ * @param config The chart configuration.
+ */
+export declare const setStartAngle: (angle: number, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the end angle of the pie chart.
+ * @param config The chart configuration.
+ * @returns {number | null | undefined}
+ */
+export declare const getEndAngle: (config: ChartConfig<WebChartPieChartSeries>) => number | null | undefined;
+/**
+ * Sets the end angle of the pie chart.
+ * @param angle The end angle for the pie chart.
+ * @param config The chart configuration.
+ */
+export declare const setEndAngle: (angle: number, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the display numeric value on tooltip setting from the chart config.
+ * @param config The chart configuration.
+ * @returns {boolean}
+ * @remarks If the setting is not found in the config, it will default to `true`.
+ */
+export declare const getDisplayNumericValueOnTooltip: (config: ChartConfig<WebChartPieChartSeries>) => boolean;
+/**
+ * Sets the display numeric value on tooltip setting in the chart config.
+ * @param display The boolean value to set the displayNumericValueOnTooltip to
+ * @param config The chart configuration.
+ */
+export declare const setDisplayNumericValueOnTooltip: (display: boolean, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the display percentage on tooltip setting from the chart config.
+ * @param config The chart configuration.
+ * @returns {boolean}
+ * @remarks If the setting is not found in the config, it will default to `true`.
+ */
+export declare const getDisplayPercentageOnTooltip: (config: ChartConfig<WebChartPieChartSeries>) => boolean;
+/**
+ * Sets the display percentage on tooltip setting in the chart config.
+ * @param display The boolean value to set the displayPercentageOnTooltip to
+ * @param config The chart configuration.
+ */
+export declare const setDisplayPercentageOnTooltip: (display: boolean, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the prefix for the slice values in the chart config.
+ * @param config The chart configuration.
+ * @returns {string | undefined}
+ */
+export declare const getValuePrefix: (config: ChartConfig<WebChartPieChartSeries>) => string | undefined;
+/**
+ * Set the prefix for the slice values in the chart config.
+ * @param prefix The prefix to set for the values in the chart config.
+ * @param config The chart configuration.
+ */
+export declare const setValuePrefix: (prefix: string, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the suffix for the slice values in the chart config.
+ * @param config The chart configuration.
+ * @returns {string | undefined}
+ */
+export declare const getValueSuffix: (config: ChartConfig<WebChartPieChartSeries>) => string | undefined;
+/**
+ * Sets the suffix for the slice values in the chart config.
+ * @param suffix The suffix to set for the slice values in the chart config.
+ * @param config The chart configuration.
+ */
+export declare const setValueSuffix: (suffix: string, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the prefix for the slice percentage values in the chart config.
+ * @param config The chart configuration.
+ * @returns {string | undefined}
+ */
+export declare const getPercentagePrefix: (config: ChartConfig<WebChartPieChartSeries>) => string | undefined;
+/**
+ * Sets the prefix for the slice percentage values in the chart config.
+ * @param prefix The prefix to set for the slice percentage values in the chart config.
+ * @param config The chart configuration.
+ */
+export declare const setPercentagePrefix: (prefix: string, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the suffix for the slice percentage values in the chart config.
+ * @param config The chart configuration.
+ * @returns {string | undefined}
+ */
+export declare const getPercentageSuffix: (config: ChartConfig<WebChartPieChartSeries>) => string | undefined;
+/**
+ * Sets the suffix for the slice percentage values in the chart config.
+ * @param suffix The suffix to set for the slice percentage values in the chart config.
+ * @param config The chart configuration.
+ */
+export declare const setPercentageSuffix: (suffix: string, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the display type for the slices in the pie chart.
+ * @param config The chart configuration.
+ * @returns {PieChartSlicesDisplay}
+ */
+export declare const getDisplayType: (config: ChartConfig<WebChartPieChartSeries>) => PieChartSlicesDisplay;
+/**
+ * Sets the display type for the slices in the pie chart.
+ * @param type The display type for the slices in the pie chart.
+ * @param config The chart configuration.
+ */
+export declare const setDisplayType: (type: PieChartSlicesDisplay, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the setting for aligning the data labels in the chart config.
+ * @param config The chart configuration.
+ * @returns {boolean}
+ * @remarks If the setting is not found in the config, it will default to `false`.
+ */
+export declare const getAlignDataLabels: (config: ChartConfig<WebChartPieChartSeries>) => boolean;
+/**
+ * Sets the setting for aligning the data labels in the chart config.
+ * @param align The boolean value to set the alignDataLabels to
+ * @param config The chart configuration.
+ */
+export declare const setAlignDataLabels: (align: boolean, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the data labels offset from the chart config.
+ * @param config The chart configuration.
+ * @returns {number}
+ * @remarks If the setting is not found in the config, it will default to `10`.
+ */
+export declare const getDataLabelsOffset: (config: ChartConfig<WebChartPieChartSeries>) => number;
+/**
+ * Sets the data labels offset in the chart config.
+ * @param offset The offset to set for the data labels in the chart config.
+ * @param config The chart configuration.
+ */
+export declare const setDataLabelsOffset: (offset: number, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the decimal places limit from the chart config.
+ * @param config The chart configuration.
+ * @returns {number | undefined}
+ */
+export declare const getDecimalPlaces: (config: ChartConfig<WebChartPieChartSeries>) => number | undefined;
+/**
+ * Sets the decimal places limit for numeric value and percent value formats in the chart config.
+ * @param decimalPlaces The decimal places limit to set in the chart config.
+ * @param config The chart configuration.
+ */
+export declare const setDecimalPlaces: (decimalPlaces: number, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the setting for optimizing data labels overlapping in the chart config.
+ * @param config The chart configuration.
+ * @returns {boolean}
+ * @remarks If the setting is not found in the config, it will default to `false`.
+ */
+export declare const getOptimizeDataLabelsOverlapping: (config: ChartConfig<WebChartPieChartSeries>) => boolean;
+/**
+ * Sets the setting for optimizing data labels overlapping in the chart config.
+ * @param optimize The boolean value to set the optimizeDataLabelsOverlapping to
+ * @param config The chart configuration.
+ */
+export declare const setOptimizeDataLabelsOverlapping: (optimize: boolean, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the ticks' visible setting from the chart config.
+ * @param config - The chart configuration.
+ * @returns {boolean}
+ */
+export declare const getTicksVisibility: (config: ChartConfig<WebChartPieChartSeries>) => boolean;
+/**
+ * Sets the ticks' visible setting in the chart config.
+ * @param visibility - The visibility setting for the ticks.
+ * @param config - The chart configuration.
+ */
+export declare const setTicksVisibility: (visibility: boolean, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the ticks' symbol from the chart config.
+ * @param config The chart configuration.
+ * @returns {ISimpleLineSymbol | undefined}
+ */
+export declare const getTicksSymbol: (config: ChartConfig<WebChartPieChartSeries>) => ISimpleLineSymbol | undefined;
+/**
+ * Sets the ticks' symbol in the chart config.
+ * @param config The chart configuration.
+ * @param linesSymbol The ticks' symbol to set.
+ */
+export declare const setTicksSymbol: (linesSymbol: ISimpleLineSymbol | undefined, config: ChartConfig<WebChartPieChartSeries>) => void;

package/dist/model/pie-chart-model/utils/pie-chart-slices.d.ts

@@ -0,0 +1,104 @@
+import { WebChartPieChartGroupSlice, WebChartPieChartSeries, WebChartPieChartSlice, Color } from '@arcgis/charts-spec';
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+export declare const getOriginalName: (sliceIndex: number, config: ChartConfig<WebChartPieChartSeries>) => Date | number | string | null | undefined;
+/**
+ * Gets the name of the slice
+ * @param sliceIndex The index of the slice
+ * @param config The chart configuration
+ * @returns {string | undefined}
+ */
+export declare const getName: (sliceIndex: number, config: ChartConfig<WebChartPieChartSeries>) => string | undefined;
+/**
+ * Sets the name of the slice
+ * @param name The name of the slice
+ * @param sliceIndex The index of the slice to set the name
+ * @param config The chart configuration
+ */
+export declare const setName: (name: string, sliceIndex: number, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the color of the slice
+ * @param sliceIndex The index of the slice
+ * @param config The chart configuration
+ * @returns {Color | undefined}
+ */
+export declare const getColor: (sliceIndex: number, config: ChartConfig<WebChartPieChartSeries>) => Color | undefined;
+/**
+ * Sets the color of the slice
+ * @param color The color to set
+ * @param sliceIndex The index of the slice to set the color
+ * @param config The chart configuration
+ */
+export declare const setColor: (color: Color | undefined, sliceIndex: number, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets original values of the slice
+ * @param config The chart configuration
+ * @returns {string[] | undefined}
+ */
+export declare const getOrderOfSlices: (config: ChartConfig<WebChartPieChartSeries>) => string[] | undefined;
+/**
+ * Sets the slices in the order specified
+ * @param sliceOrder The slice order
+ * @param config The chart configuration
+ */
+export declare const setOrderOfSlices: (sliceOrder: string[], config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the grouping of slices
+ * @param config The chart configuration
+ * @returns {WebChartPieChartGroupSlice | undefined}
+ */
+export declare const getSliceGrouping: (config: ChartConfig<WebChartPieChartSeries>) => WebChartPieChartGroupSlice | undefined;
+/**
+ * Sets the grouping of slices
+ * @param sliceGrouping The slice grouping
+ * @param config The chart configuration
+ */
+export declare const setSliceGrouping: (sliceGrouping: WebChartPieChartGroupSlice | undefined, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the grouping threshold
+ * @param config The chart configuration
+ * @returns {number | undefined}
+ */
+export declare const getGroupingThreshold: (config: ChartConfig<WebChartPieChartSeries>) => number | undefined;
+/**
+ * Sets the grouping threshold
+ * @param groupingThreshold The grouping threshold
+ * @param config The chart configuration
+ */
+export declare const setGroupingThreshold: (groupingThreshold: number, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the slices of the pie chart
+ * @param config The chart configuration
+ * @returns {WebChartPieChartSlice[] | undefined}
+ */
+export declare const getSlices: (config: ChartConfig<WebChartPieChartSeries>) => WebChartPieChartSlice[] | undefined;
+/**
+ * Sets the slices of the pie chart
+ * @param slices The slices to set
+ * @param config The chart configuration
+ */
+export declare const setSlices: (slices: WebChartPieChartSlice[] | undefined, config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Resets the slices of the pie chart
+ * @param config The chart configuration
+ */
+export declare const resetSlices: (config: ChartConfig<WebChartPieChartSeries>) => void;
+/**
+ * Gets the slice id
+ * @param sliceIndex The index of the slice
+ * @param config The chart configuration
+ * @returns {string | undefined}
+ */
+export declare const getSliceId: (sliceIndex: number, config: ChartConfig<WebChartPieChartSeries>) => string | undefined;
+/**
+ * Gets the slice index
+ * @param sliceId The slice id
+ * @param config The chart configuration
+ * @returns {number | undefined}
+ */
+export declare const getSliceIndex: (sliceId: string, config: ChartConfig<WebChartPieChartSeries>) => number | undefined;
+/**
+ * Gets the number of slices in a pie chart
+ * @param config The chart configuration
+ * @returns {number}
+ */
+export declare const getSlicesLength: (config: ChartConfig<WebChartPieChartSeries>) => number;

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

@@ -0,0 +1,37 @@
+import { WebChart, WebChartRadarChartSeries } from '@arcgis/charts-spec';
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { SerialChartModel } from '../serial-chart-model/customElement.js';
+import { ModelParams } from '../interfaces/chart-interfaces';
+import { ModelWithBaselineStacking, ModelWithLineMarkerStyling } from '../mixins';
+import { LayerInfo } from '../interfaces/common';
+export declare class RadarChartModel extends SerialChartModel {
+    /**
+     * Current configuration used for the Radar chart.
+     */
+    protected _config: ChartConfig<WebChartRadarChartSeries, WebChart>;
+    /**
+     * Default series for the radar chart. Used in resetting the series styling.
+     * @category Protected
+     */
+    protected defaultSeries: WebChartRadarChartSeries | undefined;
+    protected _chartType: "radarSeries";
+    protected layerInfo: LayerInfo;
+    setup(params: ModelParams<ChartConfig<WebChartRadarChartSeries>>): Promise<void>;
+    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    /**
+     * Initializes the default series for the radar chart. Used in resetting the series styling.
+     * @category Private
+     */
+    protected initDefaultSeries(): Promise<void>;
+    /**
+     * Resets the series styling to the default styling.
+     */
+    resetSeriesStyling(): Promise<void>;
+    /**
+     * Returns whether the series styling is able to be reset.
+     * @returns {boolean}
+     */
+    resetAvailable(): Promise<boolean>;
+}
+export interface RadarChartModel extends ModelWithBaselineStacking, ModelWithLineMarkerStyling {
+}

package/dist/model/scatter-plot-model/scatter-plot-model.d.ts

@@ -0,0 +1,89 @@
+import { ISimpleLineSymbol, ISimpleMarkerSymbol, WebChartScatterPlotSeries, WebChart, SizePolicy, ScatterPlotOverlays } from '@arcgis/charts-spec';
+import { ChartConfig, XYChartTypes } from '@arcgis/charts-shared-utils';
+import { ModelParams } from '../interfaces/chart-interfaces';
+import { LayerInfo } from '../interfaces/common';
+import { ChartModel } from '../chart-model/customElement.js';
+import { ModelWithColorMatch, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides, ModelWithLegend, ModelWithXYAxes, ModelWithTooltips } from '../mixins';
+export declare class ScatterPlotModel extends ChartModel {
+    /**
+     * Current configuration used for the scatterplot.
+     */
+    protected _config: ChartConfig<WebChartScatterPlotSeries, WebChart>;
+    protected _chartType: XYChartTypes;
+    protected layerInfo: LayerInfo;
+    setup(params: ModelParams<ChartConfig<WebChartScatterPlotSeries>>): Promise<void>;
+    /**
+     * Gets the x-axis field.
+     * @returns {string}
+     */
+    getXAxisField(): string;
+    /**
+     * Sets the x-axis field.
+     * @param {string} newXAxisField
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setXAxisField(newXAxisField: string): Promise<void>;
+    /**
+     * Gets the y-axis field.
+     * @returns {string}
+     */
+    getYAxisField(): string;
+    /**
+     * Sets the y-axis field.
+     * @param {string} newYAxisField
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setYAxisField(newYAxisField: string): Promise<void>;
+    /**
+     * Gets whether the linear trend line is shown.
+     * @returns {boolean}
+     */
+    getShowLinearTrend(): boolean;
+    /**
+     * Sets whether the linear trend line is shown.
+     * @param {boolean} newShowLinearTrendState
+     */
+    setShowLinearTrend(newShowLinearTrendState: boolean): void;
+    /**
+     * Gets the line symbol for the linear trend line.
+     * @returns {ISimpleLineSymbol}
+     */
+    getLinearTrendSymbol(): ISimpleLineSymbol;
+    /**
+     * Sets the line symbol for the linear trend line.
+     * @param {ISimpleLineSymbol} newLinearTrendSymbol
+     */
+    setLinearTrendSymbol(newLinearTrendSymbol: ISimpleLineSymbol): void;
+    /**
+     * Gets the marker symbol used for the scatter plot points when using a fixed symbol (i.e. no size policy is set).
+     * @returns {ISimpleMarkerSymbol}
+     */
+    getFixedMarkerSymbol(): ISimpleMarkerSymbol;
+    /**
+     * Sets the marker symbol used for the scatter plot points when using a fixed symbol (i.e. no size policy is set).
+     * @param {ISimpleMarkerSymbol} newFixedMarkerSymbol
+     */
+    setFixedMarkerSymbol(newFixedMarkerSymbol: ISimpleMarkerSymbol): void;
+    /**
+     * Gets the size policy for the scatter plot points. This is used to scale the size of the marker symbol based on a given field.
+     * @returns {SizePolicy | undefined}
+     */
+    getSizePolicy(): SizePolicy | undefined;
+    /**
+     * Sets the size policy for the scatter plot points. This is used to scale the size of the marker symbol based on a given field.
+     * @param {SizePolicy | undefined} newSizePolicy
+     */
+    setSizePolicy(newSizePolicy: SizePolicy | undefined): void;
+    /**
+     * Get the chart overlays. The scatter plot implements only 1 overlay, **trendLine**.
+     */
+    getSeriesOverlays(): ScatterPlotOverlays | undefined;
+    /**
+     * Set the chart overlays. The scatter plot implements only 1 overlay, **trendLine**.
+     * @param {ScatterPlotOverlays} newSeriesOverlays - the new overlays
+     */
+    setSeriesOverlays(newSeriesOverlays: ScatterPlotOverlays): void;
+    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+}
+export interface ScatterPlotModel extends ModelWithXYAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides {
+}

package/dist/model/scatter-plot-model/utils/scatter-plot-data.d.ts

@@ -0,0 +1,88 @@
+import { SizePolicy, ISimpleMarkerSymbol, ISimpleLineSymbol, ScatterPlotOverlays } from '@arcgis/charts-spec';
+import { ScatterPlotConfig } from '@arcgis/charts-shared-utils';
+import { LayerInfo } from '../../interfaces/common';
+/**
+ * get the x-axis field from the config
+ * @param config - the scatter plot config
+ */
+export declare const getXAxisField: (config: ScatterPlotConfig) => string;
+/**
+ * get the y-axis field from the config
+ * @param config - the scatter plot config
+ */
+export declare const getYAxisField: (config: ScatterPlotConfig) => string;
+/**
+ * set the x-axis field name in the config
+ * @param newXAxisField - the x-axis field name
+ * @param config - the scatter plot config
+ * @param layerInfo - the layer info
+ */
+export declare const setXAxisField: (newXAxisField: string, config: ScatterPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * set the y-axis field in the config
+ * @param newYAxisField - the y-axis field name
+ * @param config - the scatter plot config
+ * @param layerInfo - the layer info
+ */
+export declare const setYAxisField: (newYAxisField: string, config: ScatterPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * get fixed marker symbol from the config
+ * @param config - the scatter plot config
+ */
+export declare const getFixedMarkerSymbol: (config: ScatterPlotConfig) => ISimpleMarkerSymbol;
+/**
+ * set the fixed marker symbol in the config
+ * @param newFixedMarkerSymbol - the fixed marker symbol
+ * @param config - the scatter plot config
+ */
+export declare const setFixedMarkerSymbol: (newFixedMarkerSymbol: ISimpleMarkerSymbol, config: ScatterPlotConfig) => void;
+/**
+ * get the show linear trend option from the config
+ * @param config - the scatter plot config
+ */
+export declare const getShowLinearTrend: (config: ScatterPlotConfig) => boolean;
+/**
+ * get linear trend symbol from the config
+ * @param config - the scatter plot config
+ */
+export declare const getLinearTrendSymbol: (config: ScatterPlotConfig) => ISimpleLineSymbol;
+/**
+ * set the linear trend option in the config
+ * @param newLinearTrendSymbol - the linear trend symbol
+ * @param config - the scatter plot config
+ */
+export declare const setLinearTrendSymbol: (newLinearTrendSymbol: ISimpleLineSymbol, config: ScatterPlotConfig) => void;
+/**
+ * Set the visibility of the linear trend line in the scatter plot config
+ * @param newVisibility - the new visibility of the linear trend line
+ * @param config - the scatter plot config
+ */
+export declare const setLinearTrendLineVisibility: (newVisibility: boolean, config: ScatterPlotConfig) => void;
+/**
+ * set show linear trend in the config
+ * @param newShowLinearTrend - determines whether to show linear trend line or not
+ * @param config - the scatter plot config
+ */
+export declare const setShowLinearTrend: (newShowLinearTrend: boolean, config: ScatterPlotConfig) => void;
+/**
+ * get the size policy from the config
+ * @param config - the scatter plot config
+ */
+export declare const getSizePolicy: (config: ScatterPlotConfig) => SizePolicy | undefined;
+/**
+ * set the size policy in the config
+ * @param newSizePolicy - the new size policy
+ * @param config - the scatter plot config
+ */
+export declare const setSizePolicy: (newSizePolicy: SizePolicy | undefined, config: ScatterPlotConfig) => void;
+/**
+ * Get the chart overlays. The scatter plot implements only 1 overlay, **trendLine**.
+ * @param {ScatterPlotConfig} config - the scatter plot config
+ */
+export declare const getSeriesOverlays: (config: ScatterPlotConfig) => ScatterPlotOverlays | undefined;
+/**
+ * Set the chart overlays. The scatter plot implements only 1 overlay, **trendLine**.
+ * @param {ScatterPlotOverlays} newOverlays - the new overlays
+ * @param {ScatterPlotConfig} config - the scatter plot config
+ */
+export declare const setSeriesOverlays: (newOverlays: ScatterPlotOverlays, config: ScatterPlotConfig) => void;