@arcgis/charts-components 5.0.0-next.9 → 5.0.0-next.91

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

@@ -2,15 +2,17 @@ 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
+ *
+ * @param config - The chart config object
+ * @param 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
+ *
+ * @param props.config - The chart config object
+ * @param props.axisIndex - The index of the axis to set the title symbol for
+ * @param props.symbol - The symbol to set for the axis title
  */
 export declare const setAxisTitleSymbol: (props: {
     config: ChartConfig;
@@ -19,146 +21,162 @@ export declare const setAxisTitleSymbol: (props: {
 }) => void;
 /**
  * Gets the axis labels text symbol from the chart config.
- * @param config The chart config object
+ *
+ * @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
+ *
+ * @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
+ *
+ * @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
+ *
+ * @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
+ *
+ * @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
+ * 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 title.
+ *
+ * @param axisIndex - The index of the axis
+ * @param config - The chart config object
  */
 export declare const getAxisTitleVisibility: (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 title.
+ *
+ * @param visibility - Whether or not to show the axis title
+ * @param axisIndex - The index of the axis
+ * @param config - The chart config object
  */
 export declare const setAxisTitleVisibility: (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 +185,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 +209,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 +230,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/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.
- * @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.
  *
- * 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}
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 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 stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const setNegativeValuesStackedToBaseline: (props: {
     stackNegativeValuesToBaseline: boolean;

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/line-marker-styling.d.ts

@@ -13,18 +13,17 @@ export declare const getMarkerSize: (seriesIndex: number, config: ChartConfig<ty
 export declare const setMarkerSize: (newSize: number | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => void;
 /**
  * Specify whether line segments of the series should be smoothed.
- * @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.
  *
- * @default false
- * @returns {boolean}
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const isLineSmoothed: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Specify whether line segments of the series should be smoothed.
- * @param {boolean} props.smoothed - `true` if line segment of the series should be smoothed, `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.
+ *
+ * @param smoothed - `true` if line segments of the series should be smoothed, `false` otherwise.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const setLineSmoothed: (props: {
     smoothed: boolean;
@@ -33,18 +32,17 @@ export declare const setLineSmoothed: (props: {
 }) => void;
 /**
  * Specify whether the line series should show area.
- * @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.
  *
- * @default false
- * @returns {boolean}
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const isAreaVisible: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Specify whether the line series should show area.
- * @param {boolean} props.visible - `true` if the line series should show area, `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.
+ *
+ * @param visible - `true` if the line series should show area, `false` otherwise.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const setAreaVisible: (props: {
     visible: boolean;
@@ -53,18 +51,17 @@ export declare const setAreaVisible: (props: {
 }) => void;
 /**
  * Indicate whether to show or hide the markers/bullets of the line series.
- * @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.
  *
- * @default true
- * @returns {boolean}
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const isMarkerVisible: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Indicate whether to show or hide the markers/bullets of the line series.
- * @param {boolean} props.visible - `true` if the markers/bullets of the line series should be shown, `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.
+ *
+ * @param visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const setMarkerVisible: (props: {
     visible: boolean;
@@ -73,21 +70,19 @@ export declare const setMarkerVisible: (props: {
 }) => void;
 /**
  * Specify the color of the filled area for line chart.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
- * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+ * **Note:** areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
  *
- * @returns {Color | undefined}
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const getAreaColor: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => Color | undefined;
 /**
  * Specify the color of the filled area for line chart.
- * @param {Color | undefined} props.color - The color of the filled area for line chart.
- * @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:** `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
  *
- * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+ * @param color - The color of the filled area for line chart.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const setAreaColor: (props: {
     color: Color | undefined;
@@ -96,19 +91,18 @@ export declare const setAreaColor: (props: {
 }) => void;
 /**
  * Specify whether to connect the lines when there's a gap in the data.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  *
- * @returns {boolean | undefined}
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const getConnectLines: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean | undefined;
 /**
  * Specify whether to connect the lines when there's a gap in the data.
- * @param {boolean | undefined} props.connect - Whether to connect the gap in the data
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * **Note:** Can be overridden by the temporal data setting `nullPolicy`.
  *
- * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
+ * @param connect - Whether to connect the gap in the data
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const setConnectLines: (props: {
     connect: boolean | undefined;