@arcgis/charts-components 5.0.0-next.1 → 5.0.0-next.100

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

@@ -1,316 +1,316 @@
+import { CategoryFormatOptions, DateTimeFormatOptions, ISimpleLineSymbol, NumberFormatOptions, WebChartAxisScrollBar, WebChartCursorCrosshair, WebChartLabelBehavior, WebChartTextSymbol } from '../../spec';
 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}
+     *
+     * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
      */
     getAxisTitleText(axisIndex: number): string;
     /**
      * Sets the title text for the specified 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).
+     * **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.
      *
-     * **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 titleText - The title text for the axis.
+     * @param 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.
+     * Gets the visibility 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 {boolean}
+     */
+    getAxisVisibility(axisIndex: number): boolean;
+    /**
+     * Sets the visibility of the specified axis.
+     * **Note:** The 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.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisVisibility(isVisible: boolean, axisIndex: number): void;
+    /**
+     * Gets the visibility of the specified axis labels.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
      * @returns {boolean}
      */
+    getAxisLabelsVisibility(axisIndex: number): boolean;
+    /**
+     * Sets the visibility of the specified axis labels.
+     * **Note:** The labels 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 labels.
+     * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
+    setAxisLabelsVisibility(isVisible: boolean, axisIndex: number): void;
+    /**
+     * Gets the visibility of the specified axis title.
+     *
+     * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     */
     getAxisTitleVisibility(axisIndex: number): boolean;
     /**
      * Sets the visibility of the specified axis title.
-     * @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).
+     * **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.
      *
-     * **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 isVisible - The visibility state for the axis title.
+     * @param 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}
+     *
+     * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
      */
     getMaxBound(axisIndex: number): number;
     /**
      * Sets the maximum bound for the specified 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).
+     * **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.
      *
-     * **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 newMaxBound - The value to set as the maximum bound.
+     * @param 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}
+     *
+     * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
      */
     getMinBound(axisIndex: number): number;
     /**
      * Sets the minimum bound for the specified 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).
+     * **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.
      *
-     * **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 newMinBound - The value to set as the minimum bound.
+     * @param 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}
+     *
+     * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
      */
     getAxisValueFormat(axisIndex: number): CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
     /**
      * Sets 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).
-     * @param {CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions} valueFormat The value format to set.
+     * **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.
      *
-     * **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 axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+     * @param 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.
+     * - `true`: Logarithmic scale is enabled for the specified axis.
+     * - `false`: Logarithmic scale is disabled for the specified axis.
      *
-     * `false`: Logarithmic scale is disabled for the specified axis.
-     *
-     * @returns {boolean}
+     * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
      */
     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.
      *
-     * `true`: Enable logarithmic scale for the specified axis.
-     *
-     * `false`: Disable logarithmic scale for the specified 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).
+     * **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.
      *
-     * **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 isLogarithmic - Whether to enable logarithmic scale for the specified axis.
+     * @param 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}
+     *
+     * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
      */
     getAxisScrollbar(axisIndex: number): WebChartAxisScrollBar | undefined;
     /**
      * Sets the scrollbar configuration for the specified 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).
+     * **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.
      *
-     * **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 scrollbar - The scrollbar configuration to set.
+     * @param 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.
-     * @returns {WebChartTextSymbol | undefined}
+     *
+     * @param axisIndex - The index of the axis to get the title symbol for
      */
     getAxisTitleSymbol(axisIndex: number): WebChartTextSymbol | undefined;
     /**
      * Sets the title text symbol for the specified axis. Contains styling information such as font, color, and symbol style.
-     * @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).
+     * **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.
      *
-     * **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 titleSymbol - The title text symbol to set.
+     * @param 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.
-     * @param horizontalBehavior The behavior for the horizontal axis labels.
-     *
-     * **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.
+     * **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.
-     * @param verticalBehavior The behavior for the vertical axis labels.
+     * **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.
      *
-     * **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.
-     * @param {ISimpleLineSymbol | undefined} linesSymbol The grid lines symbol.
-     * @param {number[]} axisIndices The indices of the axes to set the grid lines symbol for.
+     * **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.
      *
-     * **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 linesSymbol - The grid lines symbol.
+     * @param 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>;
+    getDefaultXAxisTitleText(): 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.
+     * - This setting is only applicable to the axis of type ValueAxis.
+     * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * - If the displayZeroLine is not set on the axis, the default value of `false` will be returned.
+     *
+     * @param axisIndex - The index of the axis to get the display zero line for.
      */
     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.
+     * - This setting is only applicable to the axis of type ValueAxis.
+     * - 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.
+     *
+     * @param displayZeroLine - The display zero line setting for the axis.
+     * @param axisIndex - The index of the axis to set the display zero line for.
      */
     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.
+     * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * - If the displayCursorTooltip is not set on the axis, the default value of `false` will be returned.
+     *
+     * @param axisIndex - The index of the axis to get the display cursor tooltip for.
      */
     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`.
+     * - 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.
      *
-     * **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.
+     * @param displayCursorTooltip - The display cursor tooltip setting for the axis.
+     * @param axisIndex - The index of the axis to set the display cursor tooltip for.
      */
     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.
+     * - This setting is only applicable to the axis of type ValueAxis.
+     * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * - If the `buffer` is not set on the axis, the default value of `false` will be returned.
+     *
+     * @param axisIndex - The index of the axis
      */
     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`.
+     * - This setting is only applicable to the axis of type ValueAxis.
+     * - 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.
      *
-     * **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.
+     * @param buffer - The setting for the buffer
+     * @param axisIndex - The index of the 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`.
+     * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     *
+     * @param axisIndex - The index of the axis
      */
     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`.
+     * - 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.
      *
-     * **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.
+     * @param tickSpacing - The value to set for the tick spacing
+     * @param axisIndex - The index of the 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.
+     * - This setting is only applicable to the axis of type ValueAxis.
+     * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+     * - If the `integerOnlyValues` is not set on the axis, the default value of `false` will be returned.
+     *
+     * @param axisIndex - The index of the axis
      */
     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`.
+     * - This setting is only applicable to the axis of type ValueAxis.
+     * - 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.
      *
-     * **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.
+     * @param integerOnlyValues - The boolean value to set for the integer only values setting
+     * @param axisIndex - The index of the 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.
+     * - 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.
+     * **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.
+     * - 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.
+     * **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.
+     * **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.
+     * **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;
+    abstract generateYAxisTitle(): string;
 }

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

@@ -2,34 +2,33 @@ import { ChartModel } from '../chart-model/chart-model';
 export declare abstract class ModelWithTooltips extends ChartModel {
     /**
      * Gets the visibility of the data tooltips.
-     * @param seriesIndex The index of the series.
-     * @returns {boolean}
-     * @remarks
-     * a. If the seriesIndex is provided, the visibility for that series will be returned. Otherwise, the visibility of the first series will be returned.
-     * b. If the visibility is not set on the series, the default value of `true` will be returned.
+     * - If the seriesIndex is provided, the visibility for that series will be returned. Otherwise, the visibility of the first series will be returned.
+     * - If the visibility is not set on the series, the default value of `true` will be returned.
+     *
+     * @param seriesIndex - The index of the series.
      */
     getDataTooltipVisibility(seriesIndex?: number): boolean;
     /**
      * Sets the visibility of the data tooltips.
-     * @param visibility The visibility of the data tooltips.
-     * @param seriesIndex The index of the series to set the visibility.
-     * @remarks If the seriesIndex is provided, the visibility will be set for that series only. Otherwise, the visibility will be set for all series.
+     * - If the seriesIndex is provided, the visibility will be set for that series only. Otherwise, the visibility will be set for all series.
+     *
+     * @param visibility - The visibility of the data tooltips.
+     * @param seriesIndex - The index of the series to set the visibility.
      */
     setDataTooltipVisibility(visibility: boolean, seriesIndex?: number): void;
     /**
      * Gets the setting of the `dataTooltipReverseColor` property.
-     * @param seriesIndex The index of the series.
-     * @returns {boolean}
-     * @remarks
-     * a. If the seriesIndex is provided, the dataTooltipReverseColor for that series will be returned. Otherwise, the same property of the first series will be returned.
-     * b. If the dataTooltipReverseColor is not set on the series, the default value of `false` will be returned.
+     * - If the seriesIndex is provided, the dataTooltipReverseColor for that series will be returned. Otherwise, the same property of the first series will be returned.
+     * - If the dataTooltipReverseColor is not set on the series, the default value of `false` will be returned.
+     *
+     * @param seriesIndex - The index of the series.
      */
     getDataTooltipReverseColor(seriesIndex?: number): boolean;
     /**
      * Sets the setting of the `dataTooltipReverseColor` property.
-     * @param reverseColor Indicator of whether to reverse the color.
-     * @param seriesIndex The index of the series to set the reverse color.
-     * @remarks If the seriesIndex is provided, the reverse color will be set for that series only. Otherwise, the reverse color will be set for all series.
+     * - If the seriesIndex is provided, the reverse color will be set for that series only. Otherwise, the reverse color will be set for all series.
+     * @param reverseColor - Indicator of whether to reverse the color.
+     * @param seriesIndex - The index of the series to set the reverse color.
      */
     setDataTooltipReverseColor(reverseColor: boolean, seriesIndex?: number): void;
 }

package/dist/model/mixins/model-with-x-guides.d.ts

@@ -2,18 +2,21 @@ import { ModelWithGuides } from './model-with-guides';
 export declare abstract class ModelWithXGuides extends ModelWithGuides {
     /**
      * Gets the number guides in the X-axis guides list.
-     * @returns {number | undefined} The number of X-axis guides.
+     *
+     * @returns The number of X-axis guides.
      */
     getXGuidesLength(): number | undefined;
     /**
      * Adds an X-axis guide.
-     * @param {string} name The name of the guide.
-     * @param {number} [index] The index to insert the new guide in the list of X-axis guides. If left `undefined`, the guide is appended to the end of the list.
+     *
+     * @param name - The name of the guide.
+     * @param index - The index to insert the new guide in the list of X-axis guides. If left `undefined`, the guide is appended to the end of the list.
      */
     addXAxisGuide(name: string, index?: number): void;
     /**
      * Deletes an X-axis guide.
-     * @param {number} [index] The index of the guide to delete in the list of X-axis guides. If left `undefined`, the last guide in the list is deleted.
+     *
+     * @param index - The index of the guide to delete in the list of X-axis guides. If left `undefined`, the last guide in the list is deleted.
      */
     deleteXAxisGuide(index?: number): void;
 }

package/dist/model/mixins/model-with-y-guides.d.ts

@@ -2,18 +2,21 @@ import { ModelWithGuides } from '.';
 export declare abstract class ModelWithYGuides extends ModelWithGuides {
     /**
      * Gets the number guides in the Y-axis guides list.
-     * @returns {number | undefined} The number of Y-axis guides.
+     *
+     * @returns The number of Y-axis guides.
      */
     getYGuidesLength(): number | undefined;
     /**
      * Adds a Y-axis guide.
-     * @param {string} name The name of the guide.
-     * @param {number} [index] The index to insert the new guide in the list of Y-axis guides. If left `undefined`, the guide is appended to the end of the list.
+     *
+     * @param name - The name of the guide.
+     * @param index - The index to insert the new guide in the list of Y-axis guides. If left `undefined`, the guide is appended to the end of the list.
      */
     addYAxisGuide(name: string, index?: number): void;
     /**
      * Deletes a Y-axis guide.
-     * @param {number} [index] The index of the guide to delete in the list of Y-axis guides. If left `undefined`, the last guide in the list is deleted.
+     *
+     * @param index - The index of the guide to delete in the list of Y-axis guides. If left `undefined`, the last guide in the list is deleted.
      */
     deleteYAxisGuide(index?: number): void;
 }