@arcgis/charts-components 4.34.0-next.98 → 4.34.0

package/dist/model/mixins/model-with-multi-axes.d.ts

@@ -0,0 +1,290 @@
+import { XYChartTypes } from '../../utils';
+import { CategoryFormatOptions, DateTimeFormatOptions, NumberFormatOptions, WebChartAxisScrollBar, WebChartTextSymbol, ISimpleLineSymbol, WebChartLabelBehavior, WebChartCursorCrosshair } from '../../spec';
+import { ModelWithBasicXAxis } from './model-with-basic-x-axis';
+export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
+    protected _chartType: XYChartTypes;
+    /**
+     * Gets the title text of the specified axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @returns {string}
+     */
+    getAxisTitleText(axisIndex: number): string;
+    /**
+     * Sets the title text for the specified axis.
+     * **Note:** The title text for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param {string} titleText The title text for the axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisTitleText(titleText: string, axisIndex: number): void;
+    /**
+     * Gets the visibility of the specified axis title.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @returns {boolean}
+     */
+    getAxisTitleVisibility(axisIndex: number): boolean;
+    /**
+     * Sets the visibility of the specified axis title.
+     * **Note:** The title visibility for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param {boolean} isVisible The visibility state for the axis title.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisTitleVisibility(isVisible: boolean, axisIndex: number): void;
+    /**
+     * Gets the maximum bound for the specified axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     *@returns {number}
+     */
+    getMaxBound(axisIndex: number): number;
+    /**
+     * Sets the maximum bound for the specified axis.
+     * **Note:** The maximum bound for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param {number | null} newMaxBound The value to set as the maximum bound.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setMaxBound(newMaxBound: number | null, axisIndex: number): void;
+    /**
+     * Gets the minimum bound for the specified axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @returns {number}
+     */
+    getMinBound(axisIndex: number): number;
+    /**
+     * Sets the minimum bound for the specified axis.
+     * **Note:** The minimum bound for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param {number | null} newMinBound The value to set as the minimum bound.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setMinBound(newMinBound: number | null, axisIndex: number): void;
+    /**
+     * Gets the value format for the specified axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @returns {CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined}
+     */
+    getAxisValueFormat(axisIndex: number): CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
+    /**
+     * Sets the value format for the specified axis.
+     * **Note:** The value format for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @param {CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions} valueFormat The value format to set.
+     */
+    setAxisValueFormat(axisIndex: number, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions): void;
+    /**
+     * Gets whether logarithmic scale is enabled for the specified axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     *
+     * `true`: Logarithmic scale is enabled for the specified axis.
+     *
+     * `false`: Logarithmic scale is disabled for the specified axis.
+     *
+     * @returns {boolean}
+     */
+    getLogarithmic(axisIndex: number): boolean;
+    /**
+     * Sets whether logarithmic scale is enabled for the specified axis.
+     * `true`: Enable logarithmic scale for the specified axis.
+     * `false`: Disable logarithmic scale for the specified axis.
+     * **Note:** The logarithmic scale for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param {boolean} isLogarithmic Whether to enable logarithmic scale for the specified axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setLogarithmic(isLogarithmic: boolean, axisIndex: number): void;
+    /**
+     * Gets the scrollbar configuration for the specified axis.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @returns {WebChartAxisScrollBar | undefined}
+     */
+    getAxisScrollbar(axisIndex: number): WebChartAxisScrollBar | undefined;
+    /**
+     * Sets the scrollbar configuration for the specified axis.
+     * **Note:** The scrollbar configuration for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param {WebChartAxisScrollBar} scrollbar The scrollbar configuration to set.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisScrollbar(scrollbar: WebChartAxisScrollBar, axisIndex: number): void;
+    /**
+     * Gets the specified title text symbol. Contains styling information such as font, color, and symbol style.
+     * @param {number} axisIndex The index of the axis to get the title symbol for
+     * @returns {WebChartTextSymbol | undefined}
+     */
+    getAxisTitleSymbol(axisIndex: number): WebChartTextSymbol | undefined;
+    /**
+     * Sets the title text symbol for the specified axis. Contains styling information such as font, color, and symbol style.
+     * **Note:** The title text symbol for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param {WebChartTextSymbol | undefined} titleSymbol The title text symbol to set.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisTitleSymbol(titleSymbol: WebChartTextSymbol | undefined, axisIndex: number): void;
+    /**
+     * Gets the horizontal axis labels behavior for the chart.
+     * @returns {WebChartLabelBehavior}
+     */
+    getHorizontalAxisLabelsBehavior(): WebChartLabelBehavior;
+    /**
+     * Sets the horizontal axis labels behavior for the chart.
+     * **Note:** The horizontal axis labels behavior for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param horizontalBehavior The behavior for the horizontal axis labels.
+     */
+    setHorizontalAxisLabelsBehavior(horizontalBehavior: WebChartLabelBehavior): void;
+    /**
+     * Gets the vertical axis labels behavior for the chart.
+     * @returns {WebChartLabelBehavior}
+     */
+    getVerticalAxisLabelsBehavior(): WebChartLabelBehavior;
+    /**
+     * Sets the vertical axis labels behavior for the chart.
+     * **Note:** The vertical axis labels behavior for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param verticalBehavior The behavior for the vertical axis labels.
+     */
+    setVerticalAxisLabelsBehavior(verticalBehavior: WebChartLabelBehavior): void;
+    /**
+     * Gets the grid lines symbol. Contains styling information such as line width, line style, and line color.
+     * @returns {ISimpleLineSymbol | undefined}
+     */
+    getGridLinesSymbol(): ISimpleLineSymbol | undefined;
+    /**
+     * Sets the grid lines symbol. Contains styling information such as line width, line style, and line color.
+     * **Note:** To set the grid lines symbol for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * @param {ISimpleLineSymbol | undefined} linesSymbol The grid lines symbol.
+     * @param {number[]} axisIndices The indices of the axes to set the grid lines symbol for.
+     */
+    setGridLinesSymbol(linesSymbol: ISimpleLineSymbol | undefined, axisIndices?: number[]): void;
+    /**
+     * Get the default x-axis title text.
+     * @returns {Promise<string>}
+     */
+    getDefaultXAxisTitleText(): Promise<string>;
+    /**
+     * Gets the display zero line setting for the specified axis.
+     * @param axisIndex The index of the axis to get the display zero line for.
+     * @returns {boolean}
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * c. If the displayZeroLine is not set on the axis, the default value of `false` will be returned.
+     */
+    getDisplayZeroLine(axisIndex: number): boolean;
+    /**
+     * Sets the display zero line setting for the specified axis.
+     * @param displayZeroLine The display zero line setting for the axis.
+     * @param axisIndex The index of the axis to set the display zero line for.
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the display zero line for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     */
+    setDisplayZeroLine(displayZeroLine: boolean, axisIndex: number): void;
+    /**
+     * Gets the display cursor tooltip setting for the specified axis.
+     * @param axisIndex The index of the axis to get the display cursor tooltip for.
+     * @returns {boolean}
+     * @remarks
+     * a. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * b. If the displayCursorTooltip is not set on the axis, the default value of `false` will be returned.
+     */
+    getDisplayCursorTooltip(axisIndex: number): boolean;
+    /**
+     * Sets the display cursor tooltip setting for the specified axis.
+     * @param displayCursorTooltip The display cursor tooltip setting for the axis.
+     * @param axisIndex The index of the axis to set the display cursor tooltip for.
+     * @remarks
+     * a. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the display cursor tooltip for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     */
+    setDisplayCursorTooltip(displayCursorTooltip: boolean, axisIndex: number): void;
+    /**
+     * Gets the buffer setting for the specified axis.
+     * @param axisIndex The index of the axis
+     * @returns {boolean}
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * c. If the `buffer` is not set on the axis, the default value of `false` will be returned.
+     */
+    getBuffer(axisIndex: number): boolean;
+    /**
+     * Sets the buffer for the specified axis.
+     * @param buffer The setting for the buffer
+     * @param axisIndex The index of the axis
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the buffer for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     */
+    setBuffer(buffer: boolean, axisIndex: number): void;
+    /**
+     * Gets the tick spacing setting for the specified axis.
+     * @param axisIndex The index of the axis
+     * @returns {number}
+     * @remarks
+     * a. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     */
+    getTickSpacing(axisIndex: number): number | undefined;
+    /**
+     * Sets the tick spacing for the specified axis.
+     * @param tickSpacing The value to set for the tick spacing
+     * @param axisIndex The index of the axis
+     * @remarks
+     * a. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the tick spacing for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     */
+    setTickSpacing(tickSpacing: number, axisIndex: number): void;
+    /**
+     * Gets the integer only values setting for the specified axis.
+     * @param axisIndex The index of the axis
+     * @returns {boolean}
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * c. If the `integerOnlyValues` is not set on the axis, the default value of `false` will be returned.
+     */
+    getIntegerOnlyValues(axisIndex: number): boolean;
+    /**
+     * Sets the integer only values setting for the specified axis.
+     * @param integerOnlyValues The boolean value to set for the integer only values setting
+     * @param axisIndex The index of the axis
+     * @remarks
+     * a. This setting is only applicable to the axis of type ValueAxis.
+     * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * **Note:** To set the integer only values for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     */
+    setIntegerOnlyValues(integerOnlyValues: boolean, axisIndex: number): void;
+    /**
+     * Visibility of the horizontal line of the cursor's crosshair.
+     * @remarks if the cursor crosshair or its horizontal line visibility is not set, the default value of `false` will be returned.
+     *
+     * **Note:** To set the cursor crosshair horizontal line visibility for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     */
+    get cursorCrosshairHorizontalLineVisibility(): boolean;
+    set cursorCrosshairHorizontalLineVisibility(visibility: boolean);
+    /**
+     * Visibility of the vertical line of the cursor's crosshair.
+     * @remarks if the cursor crosshair or its vertical line visibility is not set, the default value of `false` will be returned.
+     *
+     * **Note:** To set the cursor crosshair vertical line visibility for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     */
+    get cursorCrosshairVerticalLineVisibility(): boolean;
+    set cursorCrosshairVerticalLineVisibility(visibility: boolean);
+    /**
+     * Style of the cursor's crosshair from the chart config.
+     * **Note:** To set the cursor crosshair style for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     */
+    get cursorCrosshairStyle(): ISimpleLineSymbol | undefined;
+    set cursorCrosshairStyle(style: ISimpleLineSymbol | undefined);
+    /**
+     * Cursor crosshair from the chart config.
+     * **Note:** To set the cursor crosshair for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     */
+    get cursorCrosshair(): WebChartCursorCrosshair | undefined;
+    set cursorCrosshair(cursorCrosshair: WebChartCursorCrosshair | undefined);
+    /**
+     * Generate the proper y-axis title from the current config.
+     *
+     * @returns {string}
+     */
+    abstract generateYAxisTitle(): Promise<string> | string;
+}

package/dist/model/mixins/model-with-rotation.d.ts

@@ -1,13 +1,8 @@
 import { ChartModel } from '../chart-model/chart-model';
 export declare abstract class ModelWithRotation extends ChartModel {
     /**
-     * Gets whether the chart is rotated.
-     * @returns {boolean}
+     * Whether the chart is rotated.
      */
-    getRotatedState(): boolean;
-    /**
-     * Sets whether the chart is rotated.
-     * @param {boolean} rotated
-     */
-    setRotatedState(rotated: boolean): void;
+    get rotatedState(): boolean;
+    set rotatedState(rotated: boolean);
 }

package/dist/model/mixins/model-with-temporal-binning.d.ts

@@ -1,70 +1,37 @@
-import { WebChartTimeAggregationTypes, WebChartFixedDateBinningUnits, WebChartNullPolicyTypes, WebChartCalendarBinningUnits } from '@arcgis/charts-spec';
+import { WebChartNullPolicyTypes, WebChartTemporalBinningUnits, WebChartTimeAggregationTypes } from '../../spec';
 import { ChartModel } from '../chart-model/chart-model';
 export declare abstract class ModelWithTemporalBinning extends ChartModel {
     /**
-     * Sets the time interval size for a temporal bar/line chart.
-     * @returns {number | undefined}
+     * Time interval size for a temporal bar/line chart.
      */
-    getTemporalBinningSize(): number | undefined;
+    get temporalBinningSize(): number | undefined;
+    set temporalBinningSize(newSize: number | undefined);
     /**
-     * Sets the time interval size for a temporal bar/line chart.
-     * @param {number | undefined} newSize The new time interval size.
+     * Time interval units for a temporal bar/line chart.
      */
-    setTemporalBinningSize(newSize: number | undefined): void;
+    get temporalBinningUnit(): WebChartTemporalBinningUnits | undefined;
+    set temporalBinningUnit(newUnit: WebChartTemporalBinningUnits | undefined);
     /**
-     * Gets the time interval units for a temporal bar/line chart.
-     * @returns {WebChartFixedDateBinningUnits | undefined}
+     * Time aggregation type for a temporal bar/line chart.
      */
-    getTemporalBinningUnit(): WebChartCalendarBinningUnits | WebChartFixedDateBinningUnits | undefined;
+    get timeAggregationType(): WebChartTimeAggregationTypes | undefined;
+    set timeAggregationType(newTimeAggregationType: WebChartTimeAggregationTypes | undefined);
     /**
-     * Sets the time interval units for a temporal bar/line chart.
-     * @param {WebChartFixedDateBinningUnits | undefined} newUnit The new time interval units.
+     * Whether to trim incomplete time intervals for a temporal bar/line chart.
      */
-    setTemporalBinningUnit(newUnit: WebChartFixedDateBinningUnits | undefined): void;
+    get trimIncompleteTimeInterval(): boolean | undefined;
+    set trimIncompleteTimeInterval(newTrimIncompleteTimeInterval: boolean | undefined);
     /**
-     * Gets the time aggregation type for a temporal bar/line chart.
-     * @returns {WebChartTimeAggregationTypes | undefined}
-     */
-    getTimeAggregationType(): WebChartTimeAggregationTypes | undefined;
-    /**
-     * Sets the time aggregation type for a temporal bar/line chart.
-     * @param {WebChartTimeAggregationTypes | undefined} newTimeAggregationType The new time aggregation type.
-     */
-    setTimeAggregationType(newTimeAggregationType: WebChartTimeAggregationTypes | undefined): void;
-    /**
-     * Gets whether to trim incomplete time intervals for a temporal bar/line chart.
-     * @returns {boolean | undefined}
-     */
-    getTrimIncompleteTimeInterval(): boolean | undefined;
-    /**
-     * Sets whether to trim incomplete time intervals for a temporal bar/line chart.
-     * @param {boolean | undefined} newTrimIncompleteTimeInterval The new state.
-     */
-    setTrimIncompleteTimeInterval(newTrimIncompleteTimeInterval: boolean | undefined): void;
-    /**
-     * Gets the policy which tells the chart how to handle null values.
-     *
-     * `null`: Break the bar where null values are present.
-     *
-     * `zero`: Treats null values as zero.
-     *
-     * `interpolate`: Bar series: same effect as `null` - Line series: connects the lines across null values.
-     *
-     * @return {WebChartNullPolicyTypes | undefined}
-     */
-    getNullPolicy(): WebChartNullPolicyTypes | undefined;
-    /**
-     * Sets the policy which tells the chart how to handle null values.
+     * Policy which tells the chart how to handle null values.
      *
      * `null`: Break the bar where null values are present.
      *
      * `zero`: Treats null values as zero.
      *
      * `interpolate`: Bar series: same effect as `null` - Line series: connects the lines across null values.
-     *
-     * @param {WebChartNullPolicyTypes | undefined} newNullPolicy The new null policy.
      */
-    setNullPolicy(newNullPolicy: WebChartNullPolicyTypes | undefined): void;
+    get nullPolicy(): WebChartNullPolicyTypes | undefined;
+    set nullPolicy(newNullPolicy: WebChartNullPolicyTypes | undefined);
     /**
      * Resets the time interval to default for a temporal line chart.
      */

package/dist/model/mixins/utils/axes.d.ts

@@ -1,27 +1,22 @@
 import { ChartConfig } from '../../../utils';
-import { ISimpleLineSymbol, WebChartAxisScrollBar, WebChartTextSymbol } from '@arcgis/charts-spec';
+import { ISimpleLineSymbol, WebChartAxisScrollBar, WebChartTextSymbol } from '../../../spec';
 /**
- * Gets the x-axis title symbol from the chart config.
- * @param config The chart config object
- */
-export declare const getXAxisTitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the x-axis title symbol in the chart config.
- * @param config The chart config object
- * @param symbol The symbol to set for x-axis title
- */
-export declare const setXAxisTitleSymbol: (symbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Gets the y-axis title symbol from the chart config.
- * @param config The chart config object
+ * Gets the axis title symbol for the specified axis index from the chart config.
+ * @param {ChartConfig} config The chart config object
+ * @param {number} axisIndex The index of the axis to get the title symbol for
  */
-export declare const getYAxisTitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
+export declare const getAxisTitleSymbol: (config: ChartConfig, axisIndex: number) => WebChartTextSymbol | undefined;
 /**
- * Sets the y-axis title symbol in the chart config.
- * @param config The chart config object
- * @param symbol The symbol to set for the y-axis title
+ * Sets the axis title symbol for the specified axis index in the chart config.
+ * @param  {ChartConfig} props.config The chart config object
+ * @param  {number} props.axisIndex The index of the axis to set the title symbol for
+ * @param  {WebChartTextSymbol | undefined} props.symbol The symbol to set for the axis title
  */
-export declare const setYAxisTitleSymbol: (symbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
+export declare const setAxisTitleSymbol: (props: {
+    config: ChartConfig;
+    axisIndex: number;
+    symbol: WebChartTextSymbol | undefined;
+}) => void;
 /**
  * Gets the axis labels text symbol from the chart config.
  * @param config The chart config object
@@ -53,8 +48,9 @@ export declare const getGridLinesSymbol: (config: ChartConfig) => ISimpleLineSym
  * Sets the grid lines symbol in the chart config.
  * @param config The chart config object
  * @param symbol The symbol to set for the grid lines
+ * @param axisIndices The indices of the axes to set the grid lines symbol for.
  */
-export declare const setGridLinesSymbol: (symbol: ISimpleLineSymbol | undefined, config: ChartConfig) => void;
+export declare const setGridLinesSymbol: (symbol: ISimpleLineSymbol | undefined, config: ChartConfig, axisIndices: number[]) => void;
 /**
  * Gets the title text of the axis
  * @param config The chart config object
@@ -91,7 +87,7 @@ export declare const getXLogarithmic: (config: ChartConfig) => boolean;
  * @param config The chart config object
  * @param enableXLogarithmic The value to set
  */
-export declare const setXLogarithmic: (config: ChartConfig, enableXLogarithmic: boolean) => Promise<void>;
+export declare const setXLogarithmic: (config: ChartConfig, enableXLogarithmic: boolean) => void;
 /**
  * Gets whether the Y logarithmic scale is enabled
  * @param config The chart config object
@@ -102,7 +98,7 @@ export declare const getYLogarithmic: (config: ChartConfig) => boolean;
  * @param config The config object
  * @param enableYLogarithmic The value to set
  */
-export declare const setYLogarithmic: (config: ChartConfig, enableYLogarithmic: boolean) => Promise<void>;
+export declare const setYLogarithmic: (config: ChartConfig, enableYLogarithmic: boolean) => void;
 /**
  * Gets the x-axis scrollbar configuration.
  * @param config The chart config object
@@ -158,17 +154,21 @@ export declare const setDisplayZeroLine: (config: ChartConfig, displayZeroLine:
 export declare const getDisplayCursorTooltip: (config: ChartConfig, axisIndex: number) => boolean;
 /**
  * Sets the display cursor tooltips for the specified axis.
- * @param config The chart configuration.
- * @param displayCursorTooltip - Indicator whether to display cursor tooltip.
- * @param axisIndex - The index of the axis to set the setting for.
+ * @param {ChartConfig} props.config The chart configuration.
+ * @param {boolean} props.displayCursorTooltip - Indicator whether to display cursor tooltip.
+ * @param {number} props.axisIndex - The index of the axis to set the setting for.
  * @remarks
  * a. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
  */
-export declare const setDisplayCursorTooltip: (config: ChartConfig, displayCursorTooltip: boolean, axisIndex: number) => void;
+export declare const setDisplayCursorTooltip: (props: {
+    config: ChartConfig;
+    displayCursorTooltip: boolean;
+    axisIndex: number;
+}) => void;
 /**
  * Gets the buffer setting for the specified axis.
- * @param config The chart configuration object
- * @param axisIndex The index of the axis
+ * @param {ChartConfig} config The chart configuration object
+ * @param {number} axisIndex The index of the axis
  * @returns {boolean}
  * @remarks
  * a. This setting is only applicable to the axis of type ValueAxis.
@@ -178,18 +178,22 @@ export declare const setDisplayCursorTooltip: (config: ChartConfig, displayCurso
 export declare const getBuffer: (config: ChartConfig, axisIndex: number) => boolean;
 /**
  * Sets the buffer for the specified axis.
- * @param config - The chart configuration.
- * @param buffer The setting for the buffer
- * @param axisIndex The index of the axis
+ * @param {ChartConfig} props.config - The chart configuration.
+ * @param {boolean} props.buffer The setting for the buffer
+ * @param {number} props.axisIndex The index of the axis
  * @remarks
  * a. This setting is only applicable to the axis of type ValueAxis.
  * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
  */
-export declare const setBuffer: (config: ChartConfig, buffer: boolean, axisIndex: number) => void;
+export declare const setBuffer: (props: {
+    config: ChartConfig;
+    buffer: boolean;
+    axisIndex: number;
+}) => void;
 /**
  * Gets the tick spacing setting for the specified axis.
- * @param config The chart configuration object
- * @param axisIndex The index of the axis
+ * @param {ChartConfig} config The chart configuration object
+ * @param {number} axisIndex The index of the axis
  * @returns {number}
  * @remarks
  * a. To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
@@ -197,17 +201,21 @@ export declare const setBuffer: (config: ChartConfig, buffer: boolean, axisIndex
 export declare const getTickSpacing: (config: ChartConfig, axisIndex: number) => number | undefined;
 /**
  * Sets the tick spacing for the specified axis.
- * @param config The chart configuration object
- * @param tickSpacing The value to set for the tick spacing
- * @param axisIndex The index of the axis
+ * @param {ChartConfig} props.config The chart configuration object
+ * @param {number} props.tickSpacing The value to set for the tick spacing
+ * @param {number} props.axisIndex The index of the axis
  * @remarks
  * a. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
  */
-export declare const setTickSpacing: (config: ChartConfig, tickSpacing: number, axisIndex: number) => void;
+export declare const setTickSpacing: (props: {
+    config: ChartConfig;
+    tickSpacing: number;
+    axisIndex: number;
+}) => void;
 /**
  * Gets the integer only values setting for the specified axis.
- * @param config The chart configuration object
- * @param axisIndex The index of the axis
+ * @param {ChartConfig} config The chart configuration object
+ * @param {number} axisIndex The index of the axis
  * @returns {boolean}
  * @remarks
  * a. This setting is only applicable to the axis of type ValueAxis.
@@ -217,11 +225,15 @@ export declare const setTickSpacing: (config: ChartConfig, tickSpacing: number,
 export declare const getIntegerOnlyValues: (config: ChartConfig, axisIndex: number) => boolean;
 /**
  * Sets the integer only values setting for the specified axis.
- * @param config The chart configuration object
- * @param integerOnlyValues The boolean value to set for the integer only values setting
- * @param axisIndex The index of the axis
+ * @param {ChartConfig} props.config The chart configuration object
+ * @param {boolean} props.integerOnlyValues The boolean value to set for the integer only values setting
+ * @param {number} props.axisIndex The index of the axis
  * @remarks
  * a. This setting is only applicable to the axis of type ValueAxis.
  * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
  */
-export declare const setIntegerOnlyValues: (config: ChartConfig, integerOnlyValues: boolean, axisIndex: number) => void;
+export declare const setIntegerOnlyValues: (props: {
+    config: ChartConfig;
+    integerOnlyValues: boolean;
+    axisIndex: number;
+}) => void;

package/dist/model/mixins/utils/axis-label-behaviors.d.ts

@@ -1,5 +1,5 @@
 import { ChartConfig } from '../../../utils';
-import { WebChartLabelBehavior } from '@arcgis/charts-spec';
+import { WebChartLabelBehavior } from '../../../spec';
 /**
  * Gets the horizontal axis labels behavior.
  * @param {ChartConfig} config - The chart configuration.

package/dist/model/mixins/utils/baseline-stacking.d.ts

@@ -2,25 +2,19 @@ import { ChartConfig } from '../../../utils';
 import { ModelTypes } from '../../interfaces/common';
 /**
  * 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 {number} seriesIndex - The index of the series.
  * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
- * 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.
- *
  * @default true
  * @returns {boolean}
  */
 export declare const isNegativeValuesStackedToBaseline: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Specify how negative values are treated in stacked series.
- * @param {boolean} props.stackedToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
- *
- * 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.
- *
+ * **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 {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setNegativeValuesStackedToBaseline: (props: {
     stackNegativeValuesToBaseline: boolean;

package/dist/model/mixins/utils/cursor-crosshair.d.ts

@@ -1,5 +1,5 @@
 import { ChartConfig } from '../../../utils';
-import { ISimpleLineSymbol, WebChartCursorCrosshair } from '@arcgis/charts-spec';
+import { ISimpleLineSymbol, WebChartCursorCrosshair } from '../../../spec';
 /**
  * Gets the visibility of the horizontal line of the cursor's crosshair from the chart config.
  * @param config The chart configuration

package/dist/model/mixins/utils/data-labels.d.ts

@@ -1,5 +1,5 @@
 import { ChartConfig } from '../../../utils';
-import { WebChartTextSymbol } from '@arcgis/charts-spec';
+import { WebChartTextSymbol } from '../../../spec';
 /**
  * Gets the data labels visibility from the chart config.
  * @param config

package/dist/model/mixins/utils/guides.d.ts

@@ -1,4 +1,4 @@
-import { ISimpleFillSymbol, ISimpleLineSymbol, WebChartTextSymbol } from '@arcgis/charts-spec';
+import { ISimpleFillSymbol, ISimpleLineSymbol, WebChartTextSymbol } from '../../../spec';
 import { ChartConfig } from '../../../utils';
 import { GuideOrientation } from '../../interfaces/common';
 /**

package/dist/model/mixins/utils/legend.d.ts

@@ -1,4 +1,4 @@
-import { WebChartTextSymbol, WebChartLegendPositions } from '@arcgis/charts-spec';
+import { WebChartTextSymbol, WebChartLegendPositions } from '../../../spec';
 import { ChartConfig } from '../../../utils';
 /**
  * Gets the legend visibility from the chart config.