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

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

@@ -0,0 +1,185 @@
+import { SerialChartTypes } from '@arcgis/charts-shared-utils';
+import { ChartModel } from '../chart-model/customElement.js';
+import { Color, RESTStatisticType, WebChartDataFilters, WebChartStackedKinds } from '@arcgis/charts-spec';
+import { SerialChartDataSortingKinds } from '../interfaces/common';
+import { ModelWithColorMatch, ModelWithDataLabels, ModelWithLegend, ModelWithTooltips, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithXYAxes, ModelWithYGuides } from '../mixins';
+export declare abstract class SerialChartModel extends ChartModel {
+    /**
+     * Current chart type.
+     * @category Protected
+     */
+    protected _chartType: SerialChartTypes;
+    /**
+     * Gets the x-axis field for the chart.
+     * @returns {string}
+     */
+    getXAxisField(): string;
+    /**
+     * Sets the x-axis field for the chart.
+     * @param {string} newXAxisField The new x-axis field.
+     */
+    setXAxisField(newXAxisField: string): Promise<void>;
+    /**
+     * Gets the aggregation type for the bar chart.
+     * @returns {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | "no_aggregation"}
+     */
+    getAggregationType(): RESTStatisticType;
+    /**
+     * Sets the aggregation type for the chart.
+     * @param {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | "no_aggregation"} newAggregationType The new aggregation type. Must be one of the values allowed by `RESTStatisticType`.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setAggregationType(newAggregationType: RESTStatisticType): Promise<void>;
+    /**
+     * Gets whether the series should be assigned to the second value axis.
+     * @param seriesIndex - The index of the series.
+     * @returns {boolean}
+     */
+    getAssignToSecondValueAxis(seriesIndex: number): boolean;
+    /**
+     * Sets whether the series should be assigned to the second value axis.
+     * @param assign - The value for the setting.
+     * @param seriesIndex - The index of the series.
+     */
+    setAssignToSecondValueAxis(assign: boolean, seriesIndex: number): void;
+    /**
+     * Gets the split-by field for the chart.
+     * @returns {string}
+     */
+    getSplitByField(): string;
+    /**
+     * Sets the split-by field for the chart.
+     * @param {string} newSplitByField The new split-by field.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setSplitByField(newSplitByField: string): Promise<void>;
+    /**
+     * Gets the numeric fields array for the chart.
+     * @returns {string[]}
+     */
+    getNumericFields(): string[];
+    /**
+     * Sets the numeric field or numeric fields array for the chart.
+     * @param {string | string[]} newNumericFields The new numeric field string or numeric fields array.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setNumericFields(newNumericFields: string[] | string): Promise<void>;
+    /**
+     * Gets the data filter for the bar chart.
+     * @returns {WebChartDataFilters | undefined}
+     */
+    getDataFilter(): WebChartDataFilters | undefined;
+    /**
+     * Sets the data filter for the bar chart.
+     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
+     */
+    setDataFilter(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
+    /**
+     * Gets the list of the category values for the chart.
+     * @returns {string[]}
+     */
+    getCustomSortValues(): Promise<string[]>;
+    /**
+     * Gets the sort order for the bar chart.
+     * @returns {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}
+     */
+    getSortOrder(): SerialChartDataSortingKinds;
+    /**
+     * Sets the sort order for the bar chart.
+     * @param {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc"}  newSortOrder The new sort order.
+     * @param {string[]} orderByList The list of category's values to order by.
+     */
+    setSortOrder(newSortOrder: SerialChartDataSortingKinds, orderByList?: string[]): void;
+    /**
+     * Gets the list of custom sort values for custom sort
+     * @returns {string[]}
+     */
+    getOrderByList(): string[];
+    /**
+     * Sets the list of custom sort values for custom sort
+     * @param {string[]} newOrderByList The new list of custom sort values
+     */
+    setOrderByList(newOrderByList: string[]): void;
+    /**
+     * Updates the series based on the layer filter.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    updateSeriesFromLayerFilter(): Promise<void>;
+    /**
+     * Gets the name of the series based on the series index.
+     * If the index is out of bounds, it will return `undefined`.
+     * @param {number} seriesIndex The index of the series.
+     * @returns {string | undefined}
+     */
+    getSeriesName(seriesIndex: number): string | undefined;
+    /**
+     * Sets name of the series based on the series index.
+     * @param {string} name The name for the series.
+     * @param {number} seriesIndex The index of the series.
+     */
+    setSeriesName(name: string, seriesIndex: number): void;
+    /**
+     * Gets the color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+     * @param {number} seriesIndex The index of the series.
+     * @returns {Color | undefined}
+     */
+    getSeriesColor(seriesIndex: number): Color | undefined;
+    /**
+     * Sets the color of the series based on the series index.
+     * @param {Color | undefined} newColor The new color for the series.
+     * @param {number} seriesIndex The index of the series.
+     */
+    setSeriesColor(newColor: Color | undefined, seriesIndex: number): void;
+    /**
+     * Gets the order of the series array by returning an array of series ids.
+     * @returns {string[]}
+     */
+    getOrderOfSeries(): string[];
+    /**
+     * Sets the order of the series array by providing an array of series ids.
+     * @param {string[]} newOrder The new order of the series array.
+     */
+    setOrderOfSeries(newOrder: string[]): void;
+    /**
+     * Gets how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
+     * when multiple attributes/fields corresponding to the same set of classes are to be visualized.
+     *
+     * Currently this property is only used for bar and line series.
+     *
+     * @default sideBySide
+     *
+     * @returns {WebChartStackedKinds | undefined}
+     */
+    getStackedType(): WebChartStackedKinds | undefined;
+    /**
+     * Sets how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
+     * when multiple attributes/fields corresponding to the same set of classes are to be visualized.
+     *
+     * Currently this property is only used for bar and line series.
+     *
+     * @param {WebChartStackedKinds | undefined} newStackedType The new stacked type.
+     *
+     * @default sideBySide
+     */
+    setStackedType(newStackedType: WebChartStackedKinds | undefined): Promise<void>;
+    /**
+     * Moves a series from one index in the series array to another.
+     * @param {number} fromIndex Index to move the series from.
+     * @param {number} toIndex Index to move the series to.
+     */
+    moveSeries(fromIndex: number, toIndex: number): void;
+    /**
+     * Moves the custom sort values in-place for the order by list in the config.
+     *
+     * NOTE: This method should be only used when the sort order is set to `SerialChartDataSortingKinds.customSort`.
+     * @param {number} fromIndex The index to move the custom sort value from.
+     * @param {number} toIndex The index to move the custom sort value to.
+     */
+    moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
+    /**
+     * Resets the config to the default config
+     */
+    protected resetConfig(): Promise<void>;
+}
+export interface SerialChartModel extends ModelWithXYAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithRotation, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides, ModelWithTemporalBinning {
+}

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

@@ -0,0 +1,162 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { WebChartDataFilters, RESTStatisticType } from '@arcgis/charts-spec';
+import { SerialChartSeries } from '../../interfaces/chart-interfaces';
+import { LayerInfo, SerialChartDataSortingKinds } from '../../interfaces/common';
+/**
+ * Generate default series value
+ * @param {number | undefined } props.seriesIndex - The series index.
+ * @param {ChartConfig<SerialChartSeries>} props.config - The chart config.
+ * @param {LayerInfo | undefined} props.layerInfo - The layer info.
+ *
+ * @returns {WebChartBarChartSeries | WebChartLineChartSeries}
+ */
+export declare function getDefaultSeriesValue(props: {
+    seriesIndex?: number;
+    config: ChartConfig<SerialChartSeries>;
+    layerInfo?: LayerInfo | undefined;
+}): Promise<SerialChartSeries>;
+/**
+ * Gets the proper chart title given the current config.
+ * @param {ChartConfig<SerialChartSeries>} config - The chart config.
+ * @param {LayerInfo} layerInfo - The layer info.
+ * @returns {string}
+ */
+export declare function getChartTitle(config: ChartConfig<SerialChartSeries>, layerInfo: LayerInfo): Promise<string>;
+/**
+ * Gets the aggregation type.
+ * @param {ChartConfig} config
+ * @returns {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | undefined}
+ */
+export declare const getAggregationType: (config: ChartConfig) => RESTStatisticType;
+/**
+ * Set the aggregation type by updating the config accordingly.
+ * @param {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | "no_aggregation"} newAggregationType - The new aggregation type.
+ * @param {ChartConfig<SerialChartSeries>} config - The chart config.
+ * @param {LayerInfo} layerInfo - The layer info.
+ */
+export declare const setAggregationType: (newAggregationType: RESTStatisticType, config: ChartConfig<SerialChartSeries>, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * Gets the split-by field.
+ * @param {ChartConfig} config
+ * @returns {string}
+ */
+export declare const getSplitByField: (config: ChartConfig) => string;
+/**
+ * Set the split-by field by updating the config accordingly.
+ * @param {string} newSplitByField - The new split-by field.
+ * @param {ChartConfig<SerialChartSeries>} config - The chart config.
+ * @param {LayerInfo} layerInfo - The layer info.
+ */
+export declare const setSplitByField: (newSplitByField: string, config: ChartConfig<SerialChartSeries>, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * Gets the numeric fields.
+ * @param {ChartConfig<SerialChartSeries>} config
+ */
+export declare const getNumericFields: (config: ChartConfig<SerialChartSeries>) => string[];
+/**
+ * Sets the category field by updating the config accordingly.
+ * @param {string[]} newNumericFields - The new numeric fields.
+ * @param {ChartConfig<SerialChartSeries>} config - The chart config.
+ * @param {LayerInfo} layerInfo - The layer info.
+ */
+export declare const setNumericFields: (newNumericFields: string[], config: ChartConfig<SerialChartSeries>, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * Set the x-axis field by updating the config accordingly.
+ * @param {string} newXAxisField - The new x-axis field.
+ * @param {ChartConfig} config - The chart config.
+ * @param {LayerInfo} layerInfo - The layer info.
+ */
+export declare const setXAxisField: (newXAxisField: string, config: ChartConfig<SerialChartSeries>, layerInfo: LayerInfo | undefined) => Promise<void>;
+/**
+ * Gets the sort order kind.
+ */
+export declare const getSortOrderKind: (config: ChartConfig) => SerialChartDataSortingKinds;
+/**
+ * Build a series array based on a list of numeric fields and aggregation type,
+ * when the chart has no category field.
+ * @param {string[]} props.numericFields - The numeric fields to include in the series.
+ * @param {RESTStatisticType} props.aggregationType - The type of aggregation to use.
+ * @param {ChartConfig<SerialChartSeries>} props.config - The chart configuration.
+ * @param {LayerInfo} props.layerInfo - Information about the data layer.
+ */
+export declare function buildSeriesFromFields(props: {
+    numericFields: string[];
+    aggregationType: RESTStatisticType;
+    config: ChartConfig<SerialChartSeries>;
+    layerInfo: LayerInfo;
+}): Promise<SerialChartSeries[]>;
+/**
+ * Build a series array based on a list of numeric fields and aggregation type.
+ * @param {string[]} props.numericFields - The numeric fields to include in the series.
+ * @param {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | "no_aggregation"} props.aggregationType - The type of aggregation to use.
+ * @param {ChartConfig<SerialChartSeries>} props.config - The chart configuration.
+ * @param {LayerInfo} props.layerInfo - Information about the data layer.
+ */
+export declare function buildSeriesUsingNumericFields(props: {
+    numericFields: string[];
+    aggregationType: RESTStatisticType;
+    config: ChartConfig<SerialChartSeries>;
+    layerInfo: LayerInfo;
+}): Promise<SerialChartSeries[]>;
+/**
+ * Build a series array based on a split-by field and aggregation type.
+ * @param {string} props.splitByField - The split-by field.
+ * @param {string[]} props.numericFields - The numeric fields to include in the series.
+ * @param {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate" | "no_aggregation"} props.aggregationType - The type of aggregation to use.
+ * @param {ChartConfig<SerialChartSeries>} props.config - The chart configuration.
+ */
+export declare function buildSeriesUsingSplitByField(props: {
+    splitByField: string;
+    numericFields: string[];
+    aggregationType: RESTStatisticType;
+    config: ChartConfig<SerialChartSeries>;
+    layerInfo: LayerInfo;
+}): Promise<SerialChartSeries[]>;
+/**
+ * Builds a new series array based on the provided properties.
+ * @param props.splitByField - The field to split the data by.
+ * @param props.numericFields - The numeric fields to include in the series.
+ * @param props.aggregationType - The type of aggregation to use.
+ * @param props.config - The chart configuration.
+ * @param props.layerInfo - Information about the data layer.
+ */
+export declare const buildNewSeries: (props: {
+    splitByField: string;
+    numericFields: string[];
+    aggregationType: RESTStatisticType;
+    config: ChartConfig<SerialChartSeries>;
+    layerInfo: LayerInfo;
+}) => Promise<void>;
+/**
+ * Get the default series name.
+ * @param {ChartConfig} config - The chart config.
+ * @param {number} seriesIndex - The series index.
+ * @param {LayerInfo} layerInfo - The layer info.
+ */
+export declare const getDefaultSeriesName: (config: ChartConfig<SerialChartSeries>, seriesIndex: number, layerInfo: LayerInfo) => Promise<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[]} values - The order by list.
+ * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
+ */
+export declare const setOrderByList: (values: string[], config: ChartConfig) => void;
+/**
+ * Get the data filter from the config.
+ * @param  {ChartConfig} config - The chart config.
+ * @returns WebChartDataFilters | undefined - The data filter.
+ */
+export declare const getDataFilter: (config: ChartConfig) => WebChartDataFilters | undefined;
+/**
+ * Set the data filter in the config.
+ * @param  {WebChartDataFilters | undefined} dataFilter - The data filter.
+ * @param  {ChartConfig} config - The chart config.
+ */
+export declare const setDataFilter: (dataFilter: WebChartDataFilters | undefined, config: ChartConfig) => void;
+/**
+ * Get the custom sort values from the config.
+ * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
+ * @param  {LayerInfo} layerInfo - The layer info.
+ *
+ * @returns string[] - The custom sort values.
+ */
+export declare const getCustomSortValues: (config: ChartConfig, layerInfo: LayerInfo | undefined) => Promise<string[]>;

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

@@ -0,0 +1,84 @@
+import { Color, WebChartStackedKinds } from '@arcgis/charts-spec';
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { SerialChartSeries } from '../../interfaces/chart-interfaces';
+import { LayerInfo } from '../../interfaces/common';
+/**
+ * Gets the setting for whether to assign the series to the second value axis.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
+ * @returns boolean
+ */
+export declare const getAssignToSecondValueAxis: (seriesIndex: number, config: ChartConfig) => boolean;
+/**
+ * Sets the setting for whether to assign the series to the second value axis.
+ * @param assign The boolean value to set.
+ * @param seriesIndex The index of the series.
+ * @param config The chart configuration.
+ */
+export declare const setAssignToSecondValueAxis: (assign: boolean, seriesIndex: number, config: ChartConfig) => void;
+/**
+ * Gets the name of the series for the provided index.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig} config - The chart configuration.
+ * @returns {string | undefined}
+ */
+export declare const getSeriesName: (seriesIndex: number, config: ChartConfig) => string | undefined;
+/**
+ * Sets the name of the series for the provided index.
+ * @param {string} newName - The new name for the series.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig} config - The chart configuration.
+ */
+export declare const setSeriesName: (newName: string, seriesIndex: number, config: ChartConfig) => void;
+/**
+ * Gets the color of the series for the provided index.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig} config - The chart configuration.
+ * @returns {Color | undefined}
+ */
+export declare const getSeriesColor: (seriesIndex: number, config: ChartConfig) => Color | undefined;
+/**
+ * Sets the color of the series for the provided index.
+ * @param {Color | undefined} newColor - The new color for the series.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig} config - The chart configuration.
+ */
+export declare const setSeriesColor: (newColor: Color | undefined, seriesIndex: number, config: ChartConfig) => void;
+/**
+ * Gets the list of series IDs in the order they appear in the chart config.
+ * @param {ChartConfig} config - The chart configuration.
+ * @returns {WebChartTypes | undefined}
+ */
+export declare const getOrderOfSeries: (config: ChartConfig) => string[];
+/**
+ * Updates the order of the series in the chart config.
+ * @param {string[]} newSeriesOrder - The new order of the series.
+ * @param {ChartConfig} config - The chart configuration.
+ */
+export declare const setOrderOfSeries: (newSeriesOrder: string[], config: ChartConfig) => void;
+/**
+ * Gets how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
+ * when multiple attributes/fields corresponding to the same set of classes are to be visualized.
+ *
+ * Currently this property is only used for bar and line series.
+ *
+ * @param {ChartConfig<SerialChartSeries>} config - The chart configuration.
+ * @default sideBySide
+ */
+export declare const getStackedType: (config: ChartConfig<SerialChartSeries>) => WebChartStackedKinds | undefined;
+/**
+ * Sets how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
+ * when multiple attributes/fields corresponding to the same set of classes are to be visualized.
+ *
+ * Currently this property is only used for bar and line series.
+ *
+ * @param {ChartConfig<SerialChartSeries>} props.config - The chart configuration.
+ * @param {WebChartStackedKinds | undefined} props.newStackedType - The new stacked type.
+ * @param {LayerInfo | undefined} props.layerInfo - The layer information.
+ * @default sideBySide
+ */
+export declare const setStackedType: (props: {
+    newStackedType: WebChartStackedKinds | undefined;
+    config: ChartConfig<SerialChartSeries>;
+    layerInfo: LayerInfo | undefined;
+}) => Promise<void>;

package/dist/model/shared/axes.d.ts

@@ -0,0 +1,105 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { CategoryFormatOptions, DateTimeFormatOptions, NumberFormatOptions, WebChart, WebChartAxis, RESTStatisticType } from '@arcgis/charts-spec';
+import { LayerInfo } from '../interfaces/common';
+/**
+ * Updates the axis config with the provided title text. Provides a default title object if one does not exist.
+ * @param axisConfig - the axis configuration
+ * @param title - the title text
+ * @param axisIndex - the index of the axis
+ */
+export declare function updateAxisTitle(config: WebChart, axisIndex: number, title: string): void;
+/**
+ * Gets the proper Y-axis title label based on the chart configuration.
+ */
+export declare function getYAxisTitleLabel(props: {
+    config: WebChart | undefined;
+    layerInfo: LayerInfo;
+    numericFields: string[];
+    aggregationType: RESTStatisticType;
+}): Promise<string>;
+/**
+ * Get the axes of the chart
+ * @param config - the config object
+ */
+export declare const getAxes: (config: WebChart) => WebChartAxis[] | undefined;
+export declare const getAxis: (config: WebChart, axisIndex: number) => Promise<WebChartAxis>;
+export declare const setAxis: (config: WebChart, axis: WebChartAxis, axisIndex: number) => void;
+/**
+ * Get the maximum or minimum bound of the axis
+ * @param config - the config object
+ * @param axisIndex - the index of the axis
+ * @param isMax - whether it is the max bound or not
+ */
+export declare const getAxisBound: (config: WebChart, axisIndex: number, isMax: boolean) => number;
+/**
+ * Set the axis bound
+ * @param config - the config object
+ * @param value - the value to set
+ * @param axisIndex - the index of the axis
+ * @param isMax - whether it is the max bound
+ */
+export declare const setAxisBound: (config: WebChart, value: number | null, axisIndex: number, isMax: boolean) => Promise<void>;
+/**
+ * Get the maximum bound for the y-axis
+ * @param config - the config object
+ */
+export declare const getMaxYBound: (config: ChartConfig) => number;
+/**
+ * Set the maximum Y bound
+ * @param config - the config object
+ * @param newMaxYBound - the value to set
+ */
+export declare const setMaxYBound: (config: ChartConfig, newMaxYBound: number | null) => Promise<void>;
+/**
+ * Get the minimum bound for the y-axis
+ * @param config - the config object
+ */
+export declare const getMinYBound: (config: ChartConfig) => number;
+/**
+ * Set the minimum Y bound
+ * @param config - the config object
+ * @param newMinYBound - the value to set
+ */
+export declare const setMinYBound: (config: ChartConfig, newMinYBound: number | null) => Promise<void>;
+/**
+ * Get the maximum bound for the x-axis
+ * @param config - the config object
+ */
+export declare const getMaxXBound: (config: ChartConfig) => number;
+/**
+ * Set the maximum X bound
+ * @param config - the config object
+ * @param newMaxXBound - the value to set
+ */
+export declare const setMaxXBound: (config: ChartConfig, newMaxXBound: number | null) => Promise<void>;
+/**
+ * Get the minimum bound for the x-axis
+ * @param config - the config object
+ */
+export declare const getMinXBound: (config: ChartConfig) => number;
+/**
+ * Set the minimum X bound
+ * @param config - the config object
+ * @param newMinXBound - the value to set
+ */
+export declare const setMinXBound: (config: ChartConfig, newMinXBound: number | null) => Promise<void>;
+/**
+ * Get the valueFormat of the x-axis
+ * @param config
+ * @returns
+ */
+export declare const getXAxisValueFormat: (config: ChartConfig) => CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
+export declare const setXAxisValueFormat: (config: ChartConfig, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions) => Promise<void>;
+/**
+ * Get the valueFormat of the y-axis
+ * @param config - the config object
+ */
+export declare const getYAxisValueFormat: (config: ChartConfig) => NumberFormatOptions | undefined;
+export declare const setYAxisValueFormat: (config: ChartConfig, valueFormat?: NumberFormatOptions) => Promise<void>;
+/**
+ * Set the integer only values in the axis
+ * @param config - the config object
+ * @param axisIndex - the index of the axis
+ * @param integerOnlyValues - the value to set
+ */
+export declare const setIntegerOnlyValuesInAxis: (config: WebChart, axisIndex: number, integerOnlyValues: boolean) => void;

package/dist/model/shared/data.d.ts

@@ -0,0 +1,37 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { WebChartBarChartSeries, WebChartLineChartSeries } from '@arcgis/charts-spec';
+import { SerialChartDataSortingKinds } from '../interfaces/common';
+/**
+ * Get the sort order kind for the bar and line chart
+ * @param {ChartConfig<WebChartBarChartSeries | WebChartLineChartSeries>} config - the chart configuration
+ *
+ * @returns {SerialChartDataSortingKinds}
+ */
+export declare const getSortOrderKindForBarLineChart: (config: ChartConfig<WebChartBarChartSeries | WebChartLineChartSeries>) => SerialChartDataSortingKinds;
+/**
+ * Check if custom sort is enabled based on the chart type.
+ * @param {ChartConfig<WebChartBarChartSeries | WebChartBoxPlotSeries | WebChartLineChartSeries | WebChartPieChartSeries>} config - The chart config.
+ * @returns {boolean} - True if custom sort is enabled, otherwise false.
+ */
+export declare const isCustomSortEnabled: (config: ChartConfig) => boolean;
+/**
+ * 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 | WebChartBoxPlotSeries | WebChartLineChartSeries | WebChartPieChartSeries>} config - The chart config.
+ *
+ * @returns string[] - The order by list.
+ */
+export declare const getOrderByList: (config: ChartConfig) => string[];
+/**
+ * Set the sort order kind for the bar and line chart
+ * @param {SerialChartDataSortingKinds} newSortOrderKind - the new sort order kind
+ * @param {ChartConfig} config - the chart configuration
+ * @param {string[] | undefined} orderByList - the list of fields to order by
+ */
+export declare const setSortOrderKind: (newSortOrderKind: SerialChartDataSortingKinds, config: ChartConfig, orderByList?: string[]) => void;
+/**
+ * Gets the x-axis field.
+ * @param {ChartConfig} config - The chart config.
+ * @returns {string}
+ */
+export declare const getXAxisField: (config: ChartConfig) => string;

package/dist/model/shared/series.d.ts

@@ -0,0 +1,5 @@
+import { RESTSimpleLineSymbolStyle, WebChartLineChartSeries, WebChartRadarChartSeries } from '@arcgis/charts-spec';
+export declare const getLineStyleFromSeries: (series: WebChartLineChartSeries | WebChartRadarChartSeries) => RESTSimpleLineSymbolStyle | undefined;
+export declare const setLineStyleToSeries: (newStyle: RESTSimpleLineSymbolStyle | undefined, series: WebChartLineChartSeries | WebChartRadarChartSeries) => void;
+export declare const getLineWidthFromSeries: (series: WebChartLineChartSeries | WebChartRadarChartSeries) => number | undefined;
+export declare const setLineWidthToSeries: (newWidth: number | undefined, series: WebChartLineChartSeries | WebChartRadarChartSeries) => void;

package/dist/model/shared/setup-utils.d.ts

@@ -0,0 +1,14 @@
+import { ChartTypes } from '@arcgis/charts-shared-utils';
+import { SupportedLayer, WebChart } from '@arcgis/charts-spec';
+import { ModelOfType } from '../interfaces/common';
+/**
+ * Creates chart model to use for config interaction.
+ * @param props.layer The layer to use for the model.
+ * @param props.chartType The chart type to create.
+ * @param props.config Optional starting config for the model.
+ */
+export declare function createModel<T extends ChartTypes | undefined>(props: {
+    layer: SupportedLayer;
+    chartType: T;
+    config?: WebChart;
+}): Promise<ModelOfType<T> | undefined>;