@arcgis/charts-components 5.0.0-next.12 → 5.0.0-next.120

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

@@ -1,19 +1,27 @@
+import { MixinInstances } from '../shared/utils';
 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;
 }
+declare const modelWithXGuidesMixins: readonly [typeof ModelWithGuides];
+export interface ModelWithXGuides extends MixinInstances<typeof modelWithXGuidesMixins> {
+}
+export {};

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

@@ -1,19 +1,27 @@
 import { ModelWithGuides } from '.';
+import { MixinInstances } from '../shared/utils';
 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;
 }
+declare const modelWithYGuidesMixins: readonly [typeof ModelWithGuides];
+export interface ModelWithYGuides extends MixinInstances<typeof modelWithYGuidesMixins> {
+}
+export {};

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

@@ -1,164 +1,122 @@
+import { ISimpleLineSymbol, WebChartAxisScrollBar } from '../../../spec';
 import { ChartConfig } from '../../../utils';
-import { ISimpleLineSymbol, WebChartAxisScrollBar, WebChartTextSymbol } from '../../../spec';
-/**
- * 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 getAxisTitleSymbol: (config: ChartConfig, axisIndex: number) => WebChartTextSymbol | undefined;
-/**
- * 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 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
- */
-export declare const getAxisLabelsSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the axis labels text symbol in the chart config.
- * @param config The chart config object
- * @param symbol The symbol to set for the axis labels
- */
-export declare const setAxisLabelsSymbol: (symbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Gets the axis lines symbol from the chart config.
- * @param config The chart config object
- */
-export declare const getAxisLinesSymbol: (config: ChartConfig) => ISimpleLineSymbol | undefined;
-/**
- * Sets the axis lines symbol in the chart config.
- * @param config The chart config object
- * @param symbol The symbol to set for the axis lines
- */
-export declare const setAxisLinesSymbol: (symbol: ISimpleLineSymbol | undefined, config: ChartConfig) => void;
 /**
  * Gets the grid lines symbol from the chart config.
- * @param config The chart config object
+ *
+ * @param config - The chart config object
  */
 export declare const getGridLinesSymbol: (config: ChartConfig) => ISimpleLineSymbol | undefined;
 /**
  * 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.
+ *
+ * @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, axisIndices: number[]) => void;
 /**
- * Gets the title text of the axis
- * @param config The chart config object
- * @param axisIndex The index of the axis
- */
-export declare const getAxisTitleText: (axisIndex: number, config: ChartConfig) => string;
-/**
- * Sets the title text of the axis
- * @param title The title text
- * @param axisIndex The index of the axis
- * @param config The chart config object
- */
-export declare const setAxisTitleText: (title: string, axisIndex: number, config: ChartConfig) => void;
-/**
- * Gets the visibility of the axis title
- * @param axisIndex The index of the axis
- * @param config The chart config object
+ * Gets the visibility of the axis
+ *
+ * @param axisIndex - The index of the axis
+ * @param config - The chart config object
  */
-export declare const getAxisTitleVisibility: (axisIndex: number, config: ChartConfig) => boolean;
+export declare const getAxisVisibility: (axisIndex: number, config: ChartConfig) => boolean;
 /**
- * Sets the visibility of the axis title
- * @param visibility Whether or not to show the axis title
- * @param axisIndex The index of the axis
- * @param config The chart config object
+ * Sets the visibility of the axis
+ *
+ * @param visibility - Whether or not to show the axis
+ * @param axisIndex - The index of the axis
+ * @param config - The chart config object
  */
-export declare const setAxisTitleVisibility: (visibility: boolean, axisIndex: number, config: ChartConfig) => void;
+export declare const setAxisVisibility: (visibility: boolean, axisIndex: number, config: ChartConfig) => void;
 /**
- * Gets whether the X logarithmic scale is enabled
- * @param config The chart config object
+ * Gets whether the X logarithmic scale is enabled.
+ *
+ * @param config - The chart config object
  */
 export declare const getXLogarithmic: (config: ChartConfig) => boolean;
 /**
- * Sets whether the X logarithmic scale is enabled
- * @param config The chart config object
- * @param enableXLogarithmic The value to set
+ * Sets whether the X logarithmic scale is enabled.
+ *
+ * @param config - The chart config object
+ * @param enableXLogarithmic - The value to set
  */
 export declare const setXLogarithmic: (config: ChartConfig, enableXLogarithmic: boolean) => void;
 /**
- * Gets whether the Y logarithmic scale is enabled
- * @param config The chart config object
+ * Gets whether the Y logarithmic scale is enabled.
+ *
+ * @param config - The chart config object
  */
 export declare const getYLogarithmic: (config: ChartConfig) => boolean;
 /**
- * Sets whether the Y logarithmic scale is enabled
- * @param config The config object
- * @param enableYLogarithmic The value to set
+ * Sets whether the Y logarithmic scale is enabled.
+ *
+ * @param config - The config object
+ * @param enableYLogarithmic - The value to set
  */
 export declare const setYLogarithmic: (config: ChartConfig, enableYLogarithmic: boolean) => void;
 /**
  * Gets the x-axis scrollbar configuration.
- * @param config The chart config object
+ *
+ * @param config - The chart config object
  */
 export declare const getXAxisScrollbar: (config: ChartConfig) => WebChartAxisScrollBar | undefined;
 /**
  * Sets the x-axis scrollbar configuration.
- * @param config The chart config object
- * @param scrollbar The scrollbar configuration to set for the x-axis
+ *
+ * @param config - The chart config object
+ * @param scrollbar - The scrollbar configuration to set for the x-axis
  */
 export declare const setXAxisScrollbar: (config: ChartConfig, scrollbar: WebChartAxisScrollBar | undefined) => void;
 /**
  * Gets the y-axis scrollbar configuration.
- * @param config The chart config object
+ *
+ * @param config - The chart config object
  */
 export declare const getYAxisScrollbar: (config: ChartConfig) => WebChartAxisScrollBar | undefined;
 /**
  * Sets the y-axis scrollbar configuration.
- * @param config The chart config object
- * @param scrollbar The scrollbar configuration to set for the y-axis
+ *
+ * @param config - The chart config object
+ * @param scrollbar - The scrollbar configuration to set for the y-axis
  */
 export declare const setYAxisScrollbar: (config: ChartConfig, scrollbar: WebChartAxisScrollBar | undefined) => void;
 /**
  * Gets the display of zero line setting for the axis from the chart config.
- * @param config The chart configuration object
- * @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 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 config - The chart configuration object
+ * @param axisIndex - The index of the axis
  */
 export declare const getDisplayZeroLine: (config: ChartConfig, axisIndex: number) => boolean;
 /**
- * Sets the display of zero line for the axis in the chart config.
- * @param config The chart configuration object
- * @param displayZeroLine The setting for the display of zero line in the axis
- * @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`.
+ * Sets the display of zero line for the axis in the chart config.'
+ * - 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`.
+ *
+ * @param config - The chart configuration object
+ * @param displayZeroLine - The setting for the display of zero line in the axis
+ * @param axisIndex - The index of the axis
  */
 export declare const setDisplayZeroLine: (config: ChartConfig, displayZeroLine: boolean, axisIndex: number) => void;
 /**
  * Gets the display cursor tooltips setting for the specified axis.
- * @param config The chart configuration.
- * @param axisIndex The index of the axis to get the setting 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 config - The chart configuration.
+ * @param axisIndex - The index of the axis to get the setting for.
  */
 export declare const getDisplayCursorTooltip: (config: ChartConfig, axisIndex: number) => boolean;
 /**
  * Sets the display cursor tooltips for the specified axis.
- * @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`.
+ * To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+ *
+ * @param props.config - The chart configuration.
+ * @param props.displayCursorTooltip - Indicator whether to display cursor tooltip.
+ * @param props.axisIndex - The index of the axis to set the setting for.
  */
 export declare const setDisplayCursorTooltip: (props: {
     config: ChartConfig;
@@ -167,23 +125,22 @@ export declare const setDisplayCursorTooltip: (props: {
 }) => void;
 /**
  * Gets the buffer setting for the specified 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.
- * 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 config - The chart configuration object
+ * @param axisIndex - The index of the axis
  */
 export declare const getBuffer: (config: ChartConfig, axisIndex: number) => boolean;
 /**
  * Sets the buffer for the specified 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`.
+ * - 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`.
+ *
+ * @param props.config - The chart configuration.
+ * @param props.buffer - The setting for the buffer
+ * @param props.axisIndex - The index of the axis
  */
 export declare const setBuffer: (props: {
     config: ChartConfig;
@@ -192,20 +149,19 @@ export declare const setBuffer: (props: {
 }) => void;
 /**
  * Gets the tick spacing setting for the specified 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`.
+ * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+ *
+ * @param config - The chart configuration object
+ * @param axisIndex - The index of the axis
  */
 export declare const getTickSpacing: (config: ChartConfig, axisIndex: number) => number | undefined;
 /**
  * Sets the tick spacing for the specified 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`.
+ * - To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+ *
+ * @param props.config - The chart configuration object
+ * @param props.tickSpacing - The value to set for the tick spacing
+ * @param props.axisIndex - The index of the axis
  */
 export declare const setTickSpacing: (props: {
     config: ChartConfig;
@@ -214,23 +170,22 @@ export declare const setTickSpacing: (props: {
 }) => void;
 /**
  * Gets the integer only values setting for the specified 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.
- * 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 config - The chart configuration object
+ * @param axisIndex - The index of the axis
  */
 export declare const getIntegerOnlyValues: (config: ChartConfig, axisIndex: number) => boolean;
 /**
  * Sets the integer only values setting for the specified 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`.
+ * - 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`.
+ *
+ * @param props.config - The chart configuration object
+ * @param props.integerOnlyValues - The boolean value to set for the integer only values setting
+ * @param props.axisIndex - The index of the axis
  */
 export declare const setIntegerOnlyValues: (props: {
     config: ChartConfig;

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

@@ -2,25 +2,25 @@ import { ChartConfig } from '../../../utils';
 import { WebChartLabelBehavior } from '../../../spec';
 /**
  * Gets the horizontal axis labels behavior.
- * @param {ChartConfig} config - The chart configuration.
- * @returns {WebChartLabelBehavior}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getHorizontalAxisLabelsBehavior: (config: ChartConfig) => WebChartLabelBehavior;
 /**
  * Sets the horizontal axis labels behavior.
- * @param {WebChartLabelBehavior} behavior - The behavior for the horizontal axis labels.
- * @param {ChartConfig} config - The chart configuration.
+ *
+ * @param behavior - The behavior for the horizontal axis labels.
+ * @param config - The chart configuration.
  */
 export declare const setHorizontalAxisLabelsBehavior: (behavior: WebChartLabelBehavior, config: ChartConfig) => void;
 /**
  * Gets the vertical axis labels behavior.
- * @param {ChartConfig} config - The chart configuration.
- * @returns {WebChartLabelBehavior}
+ * @param config   - The chart configuration.
  */
 export declare const getVerticalAxisLabelsBehavior: (config: ChartConfig) => WebChartLabelBehavior;
 /**
  * Sets the horizontal axis labels behavior.
- * @param {WebChartLabelBehavior} behavior - The behavior for the horizontal axis labels.
- * @param {ChartConfig} config - The chart configuration.
+ * @param behavior - The behavior for the horizontal axis labels.
+ * @param config - The chart configuration.
  */
 export declare const setVerticalAxisLabelsBehavior: (behavior: WebChartLabelBehavior, config: ChartConfig) => void;

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

@@ -2,51 +2,55 @@ import { ChartConfig } from '../../../utils';
 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
- * @returns {boolean}
- * @remarks if the cursor crosshair or its horizontal line visibility is not set, the default value of `false` will be returned.
+ * **Note**: If the cursor crosshair or its horizontal line visibility is not set, the default value of `false` will be returned.
+ *
+ * @param config - The chart configuration
  */
 export declare const getCursorCrosshairHorizontalLineVisibility: (config: ChartConfig) => boolean;
 /**
  * Sets the visibility of the horizontal line of the cursor's crosshair in the chart config.
- * @param visibility The visibility to set for the cursor's crosshair horizontal line
- * @param config The chart configuration
+ *
+ * @param visibility - The visibility to set for the cursor's crosshair horizontal line
+ * @param config - The chart configuration
  */
 export declare const setCursorCrosshairHorizontalLineVisibility: (visibility: boolean, config: ChartConfig) => void;
 /**
  * Gets the visibility of the vertical line of the cursor's crosshair from the chart config.
- * @param config The chart configuration
- * @returns {boolean}
- * @remarks if the cursor crosshair or its vertical line visibility is not set, the default value of `false` will be returned.
+ * **Note**: If the cursor crosshair or its vertical line visibility is not set, the default value of `false` will be returned.
+ *
+ * @param config - The chart configuration
  */
 export declare const getCursorCrosshairVerticalLineVisibility: (config: ChartConfig) => boolean;
 /**
  * Sets the visibility of the vertical line of the cursor's crosshair in the chart config.
- * @param visibility The visibility to set for the cursor's crosshair vertical line
- * @param config The chart configuration
+ *
+ * @param visibility - The visibility to set for the cursor's crosshair vertical line
+ * @param config - The chart configuration
  */
 export declare const setCursorCrosshairVerticalLineVisibility: (visibility: boolean, config: ChartConfig) => void;
 /**
  * Gets the style of the cursor's crosshair from the chart config.
- * @param config The chart configuration
- * @returns {boolean}
+ *
+ * @param config - The chart configuration
  */
 export declare const getCursorCrosshairStyle: (config: ChartConfig) => ISimpleLineSymbol | undefined;
 /**
  * Sets the style of the cursor's crosshair in the chart config.
- * @param style The style to set for the cursor's crosshair
- * @param config The chart configuration
+ *
+ * @param style - The style to set for the cursor's crosshair
+ * @param config - The chart configuration
  */
 export declare const setCursorCrosshairStyle: (style: ISimpleLineSymbol, config: ChartConfig) => void;
 /**
  * Gets the cursor crosshair from the chart config.
- * @param config The chart configuration object
- * @returns {WebChartCursorCrosshair | undefined}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getCursorCrosshair: (config: ChartConfig) => WebChartCursorCrosshair | undefined;
 /**
  * Sets the cursor crosshair in the chart config.
- * @param cursorCrosshair The cursor crosshair to set
- * @param config The chart configuration object
+ *
+ * @param cursorCrosshair - The cursor crosshair to set
+ * @param config - The chart configuration object
  */
 export declare const setCursorCrosshair: (cursorCrosshair: WebChartCursorCrosshair, config: ChartConfig) => void;

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

@@ -3,6 +3,8 @@ import { ChartConfig } from '../../../utils';
 import { GuideOrientation } from '../../interfaces/common';
 /**
  * Gets the guide labels text symbol from the chart config.
+ * TODO: Need to revisit how this is used. This function returns the first label found in
+ * the config, while each guide label could be different.
  * @param config
  */
 export declare const getGuideLabelsSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;