@arcgis/charts-components 5.0.0-next.90 → 5.0.0-next.92

package/dist/model/gauge-model/utils/gauge-data.d.ts

@@ -10,15 +10,12 @@ export declare const updateSeries: (props: {
 }) => void;
 /**
  * Gets the aggregation type from the config.
+ *
  * @param config - the guage chart config
  */
 export declare const getAggregationType: (config: ChartConfig<typeof ModelTypes.Gauge>) => WebChartStatisticType;
 /**
  * Sets the aggregation type to the config.
- * @param props.aggregationType
- * @param props.config
- * @param props.layerInfo
- * @param props.commonStrings
  */
 export declare const setAggregationType: (props: {
     aggregationType: WebChartStatisticType;
@@ -29,23 +26,24 @@ export declare const setAggregationType: (props: {
 /**
  * Checks if the feature index is valid.
  *
- * NOTE: It should be a number and greater than or equal to 0.
- * @param { number | undefined } featureIndex - the feature index
+ * **Note**: It should be a number and greater than or equal to 0.
  *
- * @returns boolean
+ * @param featureIndex - the feature index
  */
 export declare const isValidFeatureIndex: (featureIndex?: number) => boolean;
 /**
- * Gets the field from the config
+ * Gets the field from the config.
+ *
  * @param config - the guage chart config
  */
 export declare const getField: (config: ChartConfig<typeof ModelTypes.Gauge>) => string;
 /**
- * Sets the field to the config
- * @param props.field The field to set
- * @param props.config The guage chart config
- * @param props.layerInfo The layer info
- * @param props.commonStrings The common strings
+ * Sets the field to the config.
+ *
+ * @param props.field - The field to set
+ * @param props.config - The guage chart config
+ * @param props.layerInfo - The layer info
+ * @param props.commonStrings - The common strings
  */
 export declare const setField: (props: {
     field: string;
@@ -54,40 +52,45 @@ export declare const setField: (props: {
     commonStrings: CommonStrings;
 }) => void;
 /**
- * Gets the inner radius from the config
+ * Gets the inner radius from the config.
+ *
  * @param config - the guage chart config
  */
 export declare const getInnerRadius: (config: ChartConfig<typeof ModelTypes.Gauge>) => number;
 /**
- * Sets the inner radius to the config
- * @param innerRadius The inner radius to set
- * @param config The guage chart config
+ * Sets the inner radius to the config.
+ *
+ * @param innerRadius - The inner radius to set
+ * @param config - The guage chart config
  */
 export declare const setInnerRadius: (innerRadius: number, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
- * Gets the start angle from the config
- * @param config The guage chart config
+ * Gets the start angle from the config.
+ *
+ * @param config - The guage chart config
  */
 export declare const getStartAngle: (config: ChartConfig<typeof ModelTypes.Gauge>) => number;
 /**
- * Sets the start angle to the config
- * @param startAngle The start angle to set
- * @param config The guage chart config
+ * Sets the start angle to the config.
+ *
+ * @param startAngle - The start angle to set
+ * @param config - The guage chart config
  */
 export declare const setStartAngle: (startAngle: number, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
- * Gets the end angle from the config
- * @param config The guage chart config
+ * Gets the end angle from the config.
+ *
+ * @param config - The guage chart config
  */
 export declare const getEndAngle: (config: ChartConfig<typeof ModelTypes.Gauge>) => number;
 /**
- * Sets the end angle to the config
- * @param endAngle The end angle to set
- * @param config The guage chart config
+ * Sets the end angle to the config.
+ *
+ * @param endAngle - The end angle to set
+ * @param config - The guage chart config
  */
 export declare const setEndAngle: (endAngle: number, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the proper chart title given the current config.
- * @returns {string}
  */
 export declare function getChartTitle(commonStrings: CommonStrings): string;

package/dist/model/gauge-model/utils/gauge-series.d.ts

@@ -2,33 +2,37 @@ import { ChartConfig, CommonStrings } from '../../../utils';
 import { ValueConversion, GaugeChartSubTypes } from '../../../spec';
 import { LayerInfo, ModelTypes } from '../../interfaces/common';
 /**
- * Gets the conversion to apply to the gauge value
- * @param {ChartConfig<typeof ModelTypes.Gauge>} config The gauge chart configuration object
- * @returns {ValueConversion | undefined}
+ * Gets the conversion to apply to the gauge value.
+ *
+ * @param config - The gauge chart configuration object
  */
 export declare const getValueConversion: (config: ChartConfig<typeof ModelTypes.Gauge>) => ValueConversion | undefined;
 /**
- * Sets the conversion to apply to the gauge value
- * @param {ValueConversion} valueConversion The conversion to apply
- * @param {ChartConfig<typeof ModelTypes.Gauge>} config The gauge chart configuration object
+ * Sets the conversion to apply to the gauge value.
+ *
+ * @param valueConversion - The conversion to apply
+ * @param config - The gauge chart configuration object
  */
 export declare const setValueConversion: (valueConversion: ValueConversion | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the index of the feature to be rendered.
- * @param {ChartConfig<typeof ModelTypes.Gauge>} config The gauge chart configuration object
- * @returns {number | undefined} The index of the feature to be rendered
- * @remarks
+ *
  * This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
- * For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)
+ * For feature-based gauge, if this property is not present, the first feature will be used (`featureIndex = 0`)
+ *
+ * @param config - The gauge chart configuration object
+ * @returns The index of the feature to be rendered
  */
 export declare const getFeatureIndex: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | undefined;
 /**
  * Sets the index of the feature to be rendered.
- * @param {number | undefined} props.featureIndex The index of the feature to be rendered
- * @param {ChartConfig<typeof ModelTypes.Gauge>} props.config The gauge chart configuration object
- * @param {LayerInfo} props.layerInfo The layer information
- * @param {CommonStrings} props.commonStrings The common strings
- * @remarks This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
+ *
+ * This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
+ *
+ * @param props.featureIndex - The index of the feature to be rendered
+ * @param props.config - The gauge chart configuration object
+ * @param props.layerInfo - The layer information
+ * @param props.commonStrings - The common strings
  */
 export declare const setFeatureIndex: (props: {
     featureIndex: number | null | undefined;
@@ -37,9 +41,10 @@ export declare const setFeatureIndex: (props: {
     commonStrings: CommonStrings;
 }) => void;
 /**
- * Gets the type of Gauge chart, like FeatureGauge and StatisticGauge.
- * @param {ChartConfig<typeof ModelTypes.Gauge>} config Tthe chart configuration
- * @returns {GaugeChartSubTypes}
- * @remarks When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
+ * Gets the type of Gauge chart, like `FeatureGauge` and `StatisticGauge`.
+ *
+ * When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
+ *
+ * @param config - The chart configuration
  */
 export declare const getGaugeSubType: (config: ChartConfig<typeof ModelTypes.Gauge>) => GaugeChartSubTypes;

package/dist/model/histogram-model/histogram-model.d.ts

@@ -79,14 +79,10 @@ export declare class HistogramModel extends ChartModel {
     set seriesOverlays(overlays: HistogramOverlays | undefined);
     /**
      * Generate the proper chart title given the current config.
-     *
-     * @returns {string}
      */
     generateChartTitle(): string;
     /**
      * Generate the proper x-axis title given the current config.
-     *
-     * @returns {string}
      */
     generateXAxisTitle(): string;
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;

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

@@ -11,7 +11,6 @@ export declare class LineChartModel extends SerialChartModel {
     protected _config: ChartConfig<typeof ModelTypes.LineChart, WebChart>;
     /**
      * Default series for the line chart. Used in resetting the series styling.
-     * @category Protected
      */
     protected defaultSeries: WebChartLineChartSeries | undefined;
     protected _chartType: "lineSeries";
@@ -20,7 +19,6 @@ export declare class LineChartModel extends SerialChartModel {
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Initializes the default series for the line chart. Used in resetting the series styling.
-     * @category Private
      */
     protected initDefaultSeries(): void;
     /**
@@ -29,7 +27,6 @@ export declare class LineChartModel extends SerialChartModel {
     resetSeriesStyling(): void;
     /**
      * Returns whether the series styling is able to be reset.
-     * @returns {boolean}
      */
     resetAvailable(): boolean;
 }

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

@@ -6,16 +6,16 @@ export declare abstract class ModelWithBaselineStacking extends ChartModel {
     /**
      * Specify how negative values are treated in stacked series.
      * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
-     * @param {number} seriesIndex - The index of the series.
-     * @default true
-     * @returns {boolean}
+     *
+     * @param seriesIndex - The index of the series.
      */
     isNegativeValuesStackedToBaseline(seriesIndex: number): boolean;
     /**
      * Specify how negative values are treated in stacked series.
      * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
-     * @param {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
-     * @param {number} seriesIndex - The index of the series.
+     *
+     * @param stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+     * @param seriesIndex - The index of the series.
      */
     setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
 }

package/dist/model/mixins/model-with-basic-x-axis.d.ts

@@ -40,8 +40,6 @@ export declare abstract class ModelWithBasicXAxis extends ChartModel {
     set axisLinesSymbol(newAxisLinesSymbol: ISimpleLineSymbol | undefined);
     /**
      * Generate the proper x-axis title from the current config.
-     *
-     * @returns {string}
      */
     abstract generateXAxisTitle(): string;
 }

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

@@ -4,117 +4,124 @@ import { GuideOrientation } from '../interfaces/common';
 export declare abstract class ModelWithGuides extends ChartModel {
     /**
      * The guide labels text symbol (font, color, style).
-     * @returns {WebChartTextSymbol | undefined}
      */
     get guideLabelsSymbol(): WebChartTextSymbol | undefined;
     set guideLabelsSymbol(newGuideLabelsSymbol: WebChartTextSymbol | undefined);
     /**
      * Gets whether a guide is visible.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {boolean}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideVisibility(index?: number, orientation?: GuideOrientation): boolean;
     /**
-     * Sets whether a guide is visible
-     * @param {boolean} visible New visibility to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     * Sets whether a guide is visible.
+     *
+     * @param visible - New visibility to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideVisibility(visible: boolean, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the start value of a guide.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {Date | number | string | null}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideStart(index?: number, orientation?: GuideOrientation): Date | number | string | null;
     /**
      * Sets the start value of a guide.
-     * @param {Date | number | string | null} start New start value to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param start - New start value to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideStart(start: Date | number | string | null, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the end value of a guide.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {Date | number | string | null}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideEnd(index?: number, orientation?: GuideOrientation): Date | number | string | null | undefined;
     /**
      * Sets the end value of a guide.
-     * @param {Date | number | string | null | undefined} end New end value to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param end - New end value to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideEnd(end: Date | number | string | null | undefined, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the name of a guide.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {string | undefined}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideName(index?: number, orientation?: GuideOrientation): string | undefined;
     /**
      * Sets the name of a guide.
-     * @param {string} name New name to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param name - New name to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideName(name: string, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the guide label text.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {string | undefined}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideLabelText(index?: number, orientation?: GuideOrientation): string | undefined;
     /**
      * Sets the guide label text.
-     * @param {string} labelText New label text to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param labelText - New label text to set.
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     setGuideLabelText(labelText: string, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets whether the guide should be rendered above the other chart elements.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {boolean}
+     *
+     * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation - Default `y`. The axis orientation of the guide.
      */
     getGuideAbove(index?: number, orientation?: GuideOrientation): boolean;
     /**
      * Sets whether the guide should be rendered above the other chart elements.
-     * @param {boolean} above New above boolean to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param above New above boolean to set.
+     * @param index Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation Default `y`. The axis orientation of the guide.
      */
     setGuideAbove(above: boolean, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets the guide style.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
-     * @returns {ISimpleFillSymbol | ISimpleLineSymbol | undefined}
+     *
+     * @param index Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation Default `y`. The axis orientation of the guide.
      */
     getGuideStyle(index?: number, orientation?: GuideOrientation): ISimpleFillSymbol | ISimpleLineSymbol | undefined;
     /**
      * Sets the guide style.
-     * @param {ISimpleFillSymbol | ISimpleLineSymbol} style New style to set.
-     * @param {number} [index] Default `0`. The index of the guide in the list of guides for the given axis orientation.
-     * @param {GuideOrientation} [orientation] Default `y`. The axis orientation of the guide.
+     *
+     * @param style New style to set.
+     * @param index Default `0`. The index of the guide in the list of guides for the given axis orientation.
+     * @param orientation Default `y`. The axis orientation of the guide.
      */
     setGuideStyle(style: ISimpleFillSymbol | ISimpleLineSymbol, index?: number, orientation?: GuideOrientation): void;
     /**
      * Gets whether the tooltip text color should be reversed for a guide.
+     *
      * @param index - The index of the guide in the list of guides for the given axis orientation.
      * @param orientation - The axis orientation of the guide.
-     * @returns {boolean}
      */
     getTooltipReverseColor(index: number, orientation?: GuideOrientation): boolean;
     /**
      * Sets whether the tooltip text color should be reversed for a guide.
+     *
      * @param reverseColor - New reverseColor boolean to set.
      * @param index - The index of the guide in the list of guides for the given axis orientation.
      * @param orientation - The axis orientation of the guide.

package/dist/model/mixins/model-with-line-marker-styling.d.ts

@@ -6,131 +6,135 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     protected _config: ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
     /**
      * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {RESTSimpleLineSymbolStyle | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
     /**
      * Sets the line style of the series based on the series index.
-     * @param {RESTSimpleLineSymbolStyle | undefined} style The new style for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param style - The new style for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesLineStyle(style: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number): void;
     /**
      * Gets the line width of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {number | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesLineWidth(seriesIndex: number): number | undefined;
     /**
      * Sets the line width of the series based on the series index.
-     * @param {number | undefined} width The new width for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param width - The new width for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesLineWidth(width: number | undefined, seriesIndex: number): void;
     /**
      * Gets the marker color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {Color | undefined}
+     *
+     * @param seriesIndex - The index of the series.
+     * @returns Color | undefined
      */
     getSeriesMarkerColor(seriesIndex: number): Color | undefined;
     /**
      * Sets the marker color of the series based on the series index.
-     * @param {Color | undefined} color The new color for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param color - The new color for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesMarkerColor(color: Color | undefined, seriesIndex: number): void;
     /**
      * Gets the marker style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {RESTSimpleMarkerSymbolStyle | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesMarkerStyle(seriesIndex: number): RESTSimpleMarkerSymbolStyle | undefined;
     /**
      * Sets the marker style of the series based on the series index.
-     * @param {RESTSimpleMarkerSymbolStyle | undefined} style The new style for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param style - The new style for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesMarkerStyle(style: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex: number): void;
     /**
      * Gets the marker size of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {number | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesMarkerSize(seriesIndex: number): number | undefined;
     /**
      * Sets the marker size of the series based on the series index.
-     * @param {number | undefined} size The new size for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param size - The new size for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesMarkerSize(size: number | undefined, seriesIndex: number): void;
     /**
      * Specify whether line segments of the series should be smoothed.
-     * @param {number} seriesIndex - The index of the series.
      *
-     * @default false
-     * @returns {boolean}
+     * @param seriesIndex - The index of the series.
      */
     isLineSmoothed(seriesIndex: number): boolean;
     /**
      * Specify whether line segments of the series should be smoothed.
-     * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-     * @param {number} seriesIndex - The index of the series.
+     *
+     * @param smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+     * @param seriesIndex - The index of the series.
      */
     setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
     /**
      * Specify the color of the filled area for line chart.
-     * @param {number} seriesIndex - The index of the series.
      *
-     * @returns {boolean | undefined}
+     * @param seriesIndex - The index of the series.
      */
     getConnectLines(seriesIndex: number): boolean | undefined;
     /**
      * Specify whether to connect the lines when there's a gap in the data.
      * **Note:** Can be overridden by the temporal data setting `nullPolicy`.
-     * @param {boolean | undefined} connect - Whether to connect the gap in the data
-     * @param {number} seriesIndex - The index of the series.
+     *
+     * @param connect - Whether to connect the gap in the data
+     * @param seriesIndex - The index of the series.
      */
     setConnectLines(connect: boolean | undefined, seriesIndex: number): void;
     /**
      * Specify whether the line series should show area.
-     * @param {number} seriesIndex - The index of the series.
      *
-     * @default false
-     * @returns {boolean}
+     * @param seriesIndex - The index of the series.
      */
     isAreaVisible(seriesIndex: number): boolean;
     /**
      * Specify whether the line series should show area.
-     * @param {boolean} visible - `true` if the line series should show area, `false` otherwise.
-     * @param {number} seriesIndex - The index of the series.
+     *
+     * @param visible - `true` if the line series should show area, `false` otherwise.
+     * @param seriesIndex - The index of the series.
      */
     setAreaVisible(visible: boolean, seriesIndex: number): void;
     /**
      * Indicate whether to show or hide the markers/bullets of the line series.
-     * @param {number} seriesIndex - The index of the series.
      *
-     * @default true
-     * @returns {boolean}
+     * @param seriesIndex - The index of the series.
      */
     isMarkerVisible(seriesIndex: number): boolean;
     /**
      * Indicate whether to show or hide the markers/bullets of the line series.
-     * @param {boolean} visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
-     * @param {number} seriesIndex - The index of the series.
+     *
+     * @param visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+     * @param seriesIndex - The index of the series.
      */
     setMarkerVisible(visible: boolean, seriesIndex: number): void;
     /**
      * Specify the color of the filled area for line chart.
      * **Note:** `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
-     * @param {number} seriesIndex - The index of the series.
-     * @returns {Color | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getAreaColor(seriesIndex: number): Color | undefined;
     /**
      * Specify the color of the filled area for line chart.
-     * @param {Color | undefined} color - The color of the filled area for line chart.
-     * @param {number} seriesIndex - The index of the series.
+     *
+     * @param color - The color of the filled area for line chart.
+     * @param seriesIndex - The index of the series.
      */
     setAreaColor(color: Color | undefined, seriesIndex: number): void;
 }