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

package/dist/model/heat-chart-model/utils/heat-chart-data.d.ts

@@ -1,7 +1,7 @@
-import { WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartLegendPositions } from '../../../spec';
+import { ISimpleFillSymbol, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartNullPolicyTypes, WebHeatChart, WebChartLegendPositions, WebChartStatisticType } from '../../../spec';
 import { ChartConfig } from '../../../utils';
 import { LayerInfo, ModelTypes } from '../../interfaces/common';
-type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
+type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebHeatChart>;
 /**
  * Sets the x field
  * @param xField The numeric field
@@ -9,7 +9,7 @@ type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
  * @param layerInfo The layer info
  */
 export declare const setXField: (props: {
-    xField?: string;
+    xField: string;
     config: HeatChartConfig;
     layerInfo: LayerInfo;
 }) => void;
@@ -17,13 +17,24 @@ export declare const setXField: (props: {
  * Gets the x field
  * @param config the heat chart config
  */
-export declare const getXField: (config: HeatChartConfig) => string | undefined;
+export declare const getXField: (config: HeatChartConfig) => string;
+/**
+ * Gets the hide empty rows and columns setting
+ * @param config The heat chart config
+ */
+export declare const getHideEmptyRowsAndColumns: (config: HeatChartConfig) => boolean | undefined;
+/**
+ * Sets the hide empty rows and columns setting
+ * @param config The heat chart config
+ * @param hideEmptyRowsAndColumns The hide empty rows and columns setting
+ */
+export declare const setHideEmptyRowsAndColumns: (config: HeatChartConfig, hideEmptyRowsAndColumns: boolean | undefined) => void;
 /**
  * Sets the heat rule type
  * @param config the chart config
- * @param heatRulesTypes the heat rules types
+ * @param heatRulesType the heat rules type
  */
-export declare const setHeatRulesType: (config: HeatChartConfig, heatRulesTypes?: WebChartHeatChartHeatRulesTypes) => void;
+export declare const setHeatRulesType: (config: HeatChartConfig, heatRulesType?: WebChartHeatChartHeatRulesTypes) => void;
 /**
  * Gets the heat rule type
  * @param config the chart config
@@ -47,7 +58,7 @@ export declare const getGradientRules: (config: HeatChartConfig) => WebChartHeat
  * @param layerInfo The layer info
  */
 export declare const setYField: (props: {
-    yField?: string;
+    yField: string;
     config: HeatChartConfig;
     layerInfo: LayerInfo;
 }) => void;
@@ -55,7 +66,7 @@ export declare const setYField: (props: {
  * Gets the y field
  * @param config the heat chart config
  */
-export declare const getYField: (config: HeatChartConfig) => string | undefined;
+export declare const getYField: (config: HeatChartConfig) => string;
 /**
  * Sets x binning
  * @param binning the x binning
@@ -78,6 +89,12 @@ export declare const setYTemporalBinning: (binning: WebChartCalendarDatePartsBin
  * @param config the heat chart config
  */
 export declare const getYTemporalBinning: (config: HeatChartConfig) => WebChartCalendarDatePartsBinning | undefined;
+/**
+ * Set the order by list in the config. The order by list is only used when the sort order kind is custom sort.
+ * @param values The order by values
+ * @param config The heat chart config
+ */
+export declare const setHeatChartOrderByList: (values: string[], config: HeatChartConfig) => void;
 /**
  * Sets the grid line width
  * @param width the grid line width
@@ -111,4 +128,59 @@ export declare const setLegendPosition: (position: WebChartLegendPositions, conf
  * @param config the heat chart config
  */
 export declare const getLegendPosition: (config: HeatChartConfig) => WebChartLegendPositions;
+/**
+ * Gets the numericField from the query
+ * @param config The heat chart config
+ */
+export declare const getNumericField: (config: HeatChartConfig) => string | undefined;
+/**
+ * Sets the numericField for the query
+ * @param field the field
+ * @param config The heat chart config
+ */
+export declare const setNumericField: (field: string, config: HeatChartConfig) => void;
+/**
+ * Gets the aggregationType from the query
+ * @param config the heat chart config
+ */
+export declare const getAggregationType: (config: HeatChartConfig) => "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile-continuous" | "percentile-discrete" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate";
+/**
+ * Sets the aggregationType for the query
+ * @param aggregationType the aggregation type
+ * @param config The heat chart config
+ */
+export declare const setAggregationType: (aggregationType: WebChartStatisticType, config: HeatChartConfig) => void;
+/**
+ * Gets the null policy
+ * @param config the heat chart config
+ */
+export declare const getNullPolicy: (config: HeatChartConfig) => WebChartNullPolicyTypes | undefined;
+/**
+ * Sets the null policy for the query
+ * @param nullPolicy the null policy
+ * @param config The heat chart config
+ */
+export declare const setNullPolicy: (nullPolicy: WebChartNullPolicyTypes | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the empty cell text
+ * @param config the heat chart config
+ */
+export declare const getEmptyCellText: (config: HeatChartConfig) => string | undefined;
+/**
+ * Sets the empty cell text
+ * @param text the text
+ * @param config The heat chart config
+ */
+export declare const setEmptyCellText: (text: string | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the empty cell symbol
+ * @param config the heat chart config
+ */
+export declare const getEmptyCellSymbol: (config: HeatChartConfig) => ISimpleFillSymbol | undefined;
+/**
+ * Sets the empty cell symbol
+ * @param symbol the symbol
+ * @param config The heat chart config
+ */
+export declare const setEmptyCellSymbol: (symbol: ISimpleFillSymbol | undefined, config: HeatChartConfig) => void;
 export {};

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/interfaces/chart-interfaces.d.ts

@@ -1,6 +1,7 @@
 import { ChartConfig } from '../../utils';
-import { IFeatureLayer, SupportedLayer, WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
+import { IFeatureLayer, WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
 import { ModelTypes } from './common';
+import { SupportedLayer } from '../../interfaces';
 /**
  * Parameters for creating a chart model.
  */

package/dist/model/interfaces/common.d.ts

@@ -1,4 +1,5 @@
-import { IField, SupportedLayer, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '../../spec';
+import { SupportedLayer } from '../../interfaces';
+import { IField, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '../../spec';
 import { SupportedChartSeries } from '../../utils';
 import { BarChartModel } from '../bar-chart-model/bar-chart-model';
 import { BoxPlotModel } from '../box-plot-model/box-plot-model';
@@ -28,6 +29,12 @@ export declare const BoxPlotDataSortingKinds: {
     readonly customSort: "customSort";
 };
 export type BoxPlotDataSortingKinds = (typeof BoxPlotDataSortingKinds)[keyof typeof BoxPlotDataSortingKinds];
+export declare const HeatChartDataSortingKinds: {
+    readonly Asc: "Asc";
+    readonly Desc: "Desc";
+    readonly customSort: "customSort";
+};
+export type HeatChartDataSortingKinds = (typeof HeatChartDataSortingKinds)[keyof typeof HeatChartDataSortingKinds];
 export declare const PieChartDataSortingKinds: {
     readonly labelAsc: "labelAsc";
     readonly labelDesc: "labelDesc";

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

@@ -5,23 +5,17 @@ export declare abstract class ModelWithBaselineStacking extends ChartModel {
     protected _config: ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
     /**
      * Specify how negative values are treated in stacked series.
-     * @param {number} seriesIndex - The index of the 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.
      *
-     * 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.
      */
     isNegativeValuesStackedToBaseline(seriesIndex: number): 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.
-     *
-     * 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.
      */
     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,135 +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} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-     * @param {number} props.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 the color of the filled area for line chart.
-     * @param {boolean | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
-     *
-     * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
+     * 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 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} props.visible - `true` if the line series should show area, `false` otherwise.
-     * @param {number} props.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} 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 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.
-     * @param {number} seriesIndex - The index of the series.
+     * **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.
      */
     getAreaColor(seriesIndex: number): 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 color - The color of the filled area for line chart.
+     * @param seriesIndex - The index of the series.
      */
     setAreaColor(color: Color | undefined, seriesIndex: number): void;
 }