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

package/dist/model/pie-chart-model/utils/pie-chart-series.d.ts

@@ -3,20 +3,20 @@ import { ChartConfig } from '../../../utils';
 import { ModelTypes, PieChartSlicesDisplay } from '../../interfaces/common';
 /**
  * Gets the inner radius size of the pie chart.
- * @param config The chart configuration.
- * @returns {number | null | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getInnerRadiusSize: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | null | undefined;
 /**
  * Sets the inner radius size of the pie chart.
- * @param radius The inner radius size for the pie chart.
- * @param config The chart configuration.
+ *
+ * @param radius - The inner radius size for the pie chart.
+ * @param config - The chart configuration.
  */
 export declare const setInnerRadiusSize: (radius: number, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the label character limit from the chart config.
  * @param config The chart configuration.
- * @returns {number | null | undefined}
  */
 export declare const getLabelCharacterLimit: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | null | undefined;
 /**
@@ -28,7 +28,6 @@ export declare const setLabelCharacterLimit: (characterLimit: number | null, con
 /**
  * Gets the start angle of the pie chart.
  * @param config The chart configuration.
- * @returns {number | null | undefined}
  */
 export declare const getStartAngle: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | null | undefined;
 /**
@@ -40,7 +39,6 @@ export declare const setStartAngle: (angle: number | null | undefined, config: C
 /**
  * Gets the end angle of the pie chart.
  * @param config The chart configuration.
- * @returns {number | null | undefined}
  */
 export declare const getEndAngle: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | null | undefined;
 /**
@@ -51,35 +49,40 @@ export declare const getEndAngle: (config: ChartConfig<typeof ModelTypes.PieChar
 export declare const setEndAngle: (angle: number | null | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the display category value on tooltip setting from the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `true`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayCategoryValueOnTooltip: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Gets the display category value on data label setting from the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `true`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayCategoryOnDataLabel: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the display category value on data label setting in the chart config.
- * @param display The boolean value to set the displayCategoryOnDataLabel to
- * @param config The chart configuration.
+ *
+ * @param display - The boolean value to set the displayCategoryOnDataLabel to
+ * @param config - The chart configuration.
  */
 export declare const setDisplayCategoryOnDataLabel: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the display numeric value on tooltip setting from the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `true`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayNumericValueOnTooltip: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the display category value on tooltip setting in the chart config.
- * @param display The boolean value to set the displayCategoryOnTooltip to
- * @param config The chart configuration.
+ *
+ * @param display - The boolean value to set the displayCategoryOnTooltip to
+ * @param config - The chart configuration.
  */
 export declare const setDisplayCategoryOnTooltip: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
@@ -90,69 +93,75 @@ export declare const setDisplayCategoryOnTooltip: (display: boolean, config: Cha
 export declare const setDisplayNumericValueOnTooltip: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the display percentage on tooltip setting from the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `true`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayPercentageOnTooltip: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the display percentage on tooltip setting in the chart config.
- * @param display The boolean value to set the displayPercentageOnTooltip to
- * @param config The chart configuration.
+ *
+ * @param display - The boolean value to set the `displayPercentageOnTooltip` to
+ * @param config - The chart configuration.
  */
 export declare const setDisplayPercentageOnTooltip: (display: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the prefix for the slice values in the chart config.
- * @param config The chart configuration.
- * @returns {string | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getValuePrefix: (config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Set the prefix for the slice values in the chart config.
- * @param prefix The prefix to set for the values in the chart config.
- * @param config The chart configuration.
+ *
+ * @param prefix - The prefix to set for the values in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setValuePrefix: (prefix: string | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the suffix for the slice values in the chart config.
- * @param config The chart configuration.
- * @returns {string | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getValueSuffix: (config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Sets the suffix for the slice values in the chart config.
- * @param suffix The suffix to set for the slice values in the chart config.
- * @param config The chart configuration.
+ *
+ * @param suffix - The suffix to set for the slice values in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setValueSuffix: (suffix: string | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the prefix for the slice percentage values in the chart config.
- * @param config The chart configuration.
- * @returns {string | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getPercentagePrefix: (config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Sets the prefix for the slice percentage values in the chart config.
- * @param prefix The prefix to set for the slice percentage values in the chart config.
- * @param config The chart configuration.
+ *
+ * @param prefix - The prefix to set for the slice percentage values in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setPercentagePrefix: (prefix: string | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the suffix for the slice percentage values in the chart config.
- * @param config The chart configuration.
- * @returns {string | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getPercentageSuffix: (config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Sets the suffix for the slice percentage values in the chart config.
- * @param suffix The suffix to set for the slice percentage values in the chart config.
- * @param config The chart configuration.
+ *
+ * @param suffix - The suffix to set for the slice percentage values in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setPercentageSuffix: (suffix: string | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the display type for the slices in the pie chart.
- * @param config The chart configuration.
- * @returns {PieChartSlicesDisplay}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDisplayType: (config: ChartConfig<typeof ModelTypes.PieChart>) => PieChartSlicesDisplay;
 /**
@@ -163,9 +172,10 @@ export declare const getDisplayType: (config: ChartConfig<typeof ModelTypes.PieC
 export declare const setDisplayType: (type: PieChartSlicesDisplay, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the setting for aligning the data labels in the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `false`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getAlignDataLabels: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
@@ -176,76 +186,85 @@ export declare const getAlignDataLabels: (config: ChartConfig<typeof ModelTypes.
 export declare const setAlignDataLabels: (align: boolean | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the setting for placing the data labels inside of the slices from the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `false`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `true`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDataLabelsInside: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the setting for placing the data labels inside of the slices in the chart config.
- * @param align The boolean value to set the dataLabelsInside to
- * @param config The chart configuration.
+ *
+ * @param align - The boolean value to set the dataLabelsInside to
+ * @param config - The chart configuration.
  */
 export declare const setDataLabelsInside: (align: boolean | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the data labels offset from the chart config.
- * @param config The chart configuration.
- * @returns {number}
- * @remarks If the setting is not found in the config, it will default to `10`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `10`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDataLabelsOffset: (config: ChartConfig<typeof ModelTypes.PieChart>) => number;
 /**
  * Sets the data labels offset in the chart config.
- * @param offset The offset to set for the data labels in the chart config.
- * @param config The chart configuration.
+ *
+ * @param offset - The offset to set for the data labels in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setDataLabelsOffset: (offset: number | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the decimal places limit from the chart config.
- * @param config The chart configuration.
- * @returns {number | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getDecimalPlaces: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | undefined;
 /**
  * Sets the decimal places limit for numeric value and percent value formats in the chart config.
- * @param decimalPlaces The decimal places limit to set in the chart config.
- * @param config The chart configuration.
+ *
+ * @param decimalPlaces - The decimal places limit to set in the chart config.
+ * @param config - The chart configuration.
  */
 export declare const setDecimalPlaces: (decimalPlaces: number, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the setting for optimizing data labels overlapping in the chart config.
- * @param config The chart configuration.
- * @returns {boolean}
- * @remarks If the setting is not found in the config, it will default to `false`.
+ *
+ * **Note**: If the setting is not found in the config, it will default to `false`.
+ *
+ * @param config - The chart configuration.
  */
 export declare const getOptimizeDataLabelsOverlapping: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the setting for optimizing data labels overlapping in the chart config.
- * @param optimize The boolean value to set the optimizeDataLabelsOverlapping to
- * @param config The chart configuration.
+ *
+ * @param optimize - The boolean value to set the `optimizeDataLabelsOverlapping` to
+ * @param config - The chart configuration.
  */
 export declare const setOptimizeDataLabelsOverlapping: (optimize: boolean | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the ticks' visible setting from the chart config.
+ *
  * @param config - The chart configuration.
- * @returns {boolean}
  */
 export declare const getTicksVisibility: (config: ChartConfig<typeof ModelTypes.PieChart>) => boolean;
 /**
  * Sets the ticks' visible setting in the chart config.
+ *
  * @param visibility - The visibility setting for the ticks.
  * @param config - The chart configuration.
  */
 export declare const setTicksVisibility: (visibility: boolean, config: ChartConfig<typeof ModelTypes.PieChart>) => void;
 /**
  * Gets the ticks' symbol from the chart config.
- * @param config The chart configuration.
- * @returns {ISimpleLineSymbol | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getTicksSymbol: (config: ChartConfig<typeof ModelTypes.PieChart>) => ISimpleLineSymbol | undefined;
 /**
  * Sets the ticks' symbol in the chart config.
- * @param config The chart configuration.
- * @param linesSymbol The ticks' symbol to set.
+ *
+ * @param config - The chart configuration.
+ * @param linesSymbol - The ticks' symbol to set.
  */
 export declare const setTicksSymbol: (linesSymbol: ISimpleLineSymbol | undefined, config: ChartConfig<typeof ModelTypes.PieChart>) => void;

package/dist/model/pie-chart-model/utils/pie-chart-slices.d.ts

@@ -6,7 +6,6 @@ export declare const getOriginalName: (sliceIndex: number, config: ChartConfig<t
  * Gets the name of the slice
  * @param sliceIndex The index of the slice
  * @param config The chart configuration
- * @returns {string | undefined}
  */
 export declare const getName: (sliceIndex: number, config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
@@ -20,7 +19,6 @@ export declare const setName: (name: string, sliceIndex: number, config: ChartCo
  * Gets the color of the slice
  * @param sliceIndex The index of the slice
  * @param config The chart configuration
- * @returns {Color | undefined}
  */
 export declare const getColor: (sliceIndex: number, config: ChartConfig<typeof ModelTypes.PieChart>) => Color | undefined;
 /**
@@ -33,7 +31,6 @@ export declare const setColor: (color: Color | undefined, sliceIndex: number, co
 /**
  * Gets original values of the slice
  * @param config The chart configuration
- * @returns {string[] | undefined}
  */
 export declare const getOrderOfSlices: (config: ChartConfig<typeof ModelTypes.PieChart>) => string[] | undefined;
 /**
@@ -45,7 +42,6 @@ export declare const setOrderOfSlices: (sliceOrder: string[], config: ChartConfi
 /**
  * Gets the grouping of slices
  * @param config The chart configuration
- * @returns {WebChartPieChartGroupSlice | undefined}
  */
 export declare const getSliceGrouping: (config: ChartConfig<typeof ModelTypes.PieChart>) => WebChartPieChartGroupSlice | undefined;
 /**
@@ -57,7 +53,6 @@ export declare const setSliceGrouping: (sliceGrouping: WebChartPieChartGroupSlic
 /**
  * Gets the grouping threshold
  * @param config The chart configuration
- * @returns {number | undefined}
  */
 export declare const getGroupingThreshold: (config: ChartConfig<typeof ModelTypes.PieChart>) => number | undefined;
 /**
@@ -69,7 +64,6 @@ export declare const setGroupingThreshold: (groupingThreshold: number, config: C
 /**
  * Gets the slices of the pie chart
  * @param config The chart configuration
- * @returns {WebChartPieChartSlice[] | undefined}
  */
 export declare const getSlices: (config: ChartConfig<typeof ModelTypes.PieChart>) => WebChartPieChartSlice[] | undefined;
 /**
@@ -87,19 +81,16 @@ export declare const resetSlices: (config: ChartConfig<typeof ModelTypes.PieChar
  * Gets the slice id
  * @param sliceIndex The index of the slice
  * @param config The chart configuration
- * @returns {string | undefined}
  */
 export declare const getSliceId: (sliceIndex: number, config: ChartConfig<typeof ModelTypes.PieChart>) => string | undefined;
 /**
  * Gets the slice index
  * @param sliceId The slice id
  * @param config The chart configuration
- * @returns {number | undefined}
  */
 export declare const getSliceIndex: (sliceId: string, config: ChartConfig<typeof ModelTypes.PieChart>) => number | undefined;
 /**
  * Gets the number of slices in a pie chart
  * @param config The chart configuration
- * @returns {number}
  */
 export declare const getSlicesLength: (config: ChartConfig<typeof ModelTypes.PieChart>) => number;

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

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

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

@@ -56,20 +56,14 @@ export declare class ScatterplotModel extends ChartModel {
     set additionalTooltipField(fields: string[] | string | 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;
     /**
      * Generate the proper y-axis title given the current config.
-     *
-     * @returns {string}
      */
     generateYAxisTitle(): string;
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;

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

@@ -93,24 +93,28 @@ export declare const getSizePolicy: (config: ScatterplotConfig) => SizePolicy |
 export declare const setSizePolicy: (sizePolicy: SizePolicy | undefined, config: ScatterplotConfig) => void;
 /**
  * Gets the chart overlays. The scatterplot implements only 1 overlay, **trendLine**.
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param config - The scatterplot config
  */
 export declare const getSeriesOverlays: (config: ScatterplotConfig) => ScatterplotOverlays | undefined;
 /**
  * Sets the chart overlays. The scatterplot implements only 1 overlay, **trendLine**.
- * @param {ScatterplotOverlays} overlays The overlays
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param overlays - The overlays
+ * @param config - The scatterplot config
  */
 export declare const setSeriesOverlays: (overlays: ScatterplotOverlays, config: ScatterplotConfig) => void;
 /**
  * Gets the additional tooltip display fields from the config.
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param config - The scatterplot config
  */
 export declare const getAdditionalTooltipField: (config: ScatterplotConfig) => string[];
 /**
  * Sets the additional tooltip display fields in the config.
- * @param {string | string[]} fields The tooltip display fields
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param fields - The tooltip display fields
+ * @param config - The scatterplot config
  *
  */
 export declare const setAdditionalTooltipField: (fields: string[] | string | undefined, config: ScatterplotConfig) => void;

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

@@ -2,12 +2,11 @@ import { SerialChartTypes } from '../../utils';
 import { ChartModel } from '../chart-model/chart-model';
 import { Color, WebChartDataFilters, WebChartNullCategory, WebChartStackedKinds, WebChartStatisticType } from '../../spec';
 import { SerialChartConfig } from '../interfaces/chart-interfaces';
-import { SerialChartDataSortingKinds } from '../interfaces/common';
+import { HeatChartDataSortingKinds, SerialChartDataSortingKinds } from '../interfaces/common';
 import { ModelWithColorMatch, ModelWithDataLabels, ModelWithLegend, ModelWithTooltips, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithYGuides, ModelWithMultiAxes } from '../mixins';
 export declare abstract class SerialChartModel extends ChartModel {
     /**
      * Current chart type.
-     * @category Protected
      */
     protected _chartType: SerialChartTypes;
     /**
@@ -16,22 +15,18 @@ export declare abstract class SerialChartModel extends ChartModel {
     protected _config: SerialChartConfig;
     /**
      * Internal storage of the x-axis field for the chart.
-     * @category Protected
      */
     protected _xAxisField: string;
     /**
      * Internal storage of the aggregation type for the chart.
-     * @category Protected
      */
     protected _aggregationType: WebChartStatisticType;
     /**
      * Internal storage of the split-by field for the chart.
-     * @category Protected
      */
     protected _splitByField: string;
     /**
      * Internal storage of the numeric fields for the chart.
-     * @category Protected
      */
     protected _numericFields: string[];
     /**
@@ -56,35 +51,36 @@ export declare abstract class SerialChartModel extends ChartModel {
     set numericFields(newNumericFields: string[] | string);
     /**
      * Gets whether the series should be assigned to the second value axis.
+     *
      * @param seriesIndex - The index of the series.
-     * @returns {boolean}
      */
     getAssignToSecondValueAxis(seriesIndex: number): boolean;
     /**
      * Sets whether the series should be assigned to the second value axis.
+     *
      * @param assign - The value for the setting.
      * @param seriesIndex - The index of the series.
      */
     setAssignToSecondValueAxis(assign: boolean, seriesIndex: number): void;
     /**
      * Gets the sort order for the bar chart.
-     * @returns {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}
      */
-    getSortOrder(): SerialChartDataSortingKinds;
+    getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
     /**
      * Sets the sort order for the bar chart.
-     * @param {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc"}  newSortOrder The new sort order.
-     * @param {string[]} orderByList The list of category's values to order by.
+     *
+     * @param newSortOrder - The new sort order.
+     * @param orderByList - The list of category's values to order by.
      */
-    setSortOrder(newSortOrder: SerialChartDataSortingKinds, orderByList?: string[]): void;
+    setSortOrder(newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, orderByList?: string[]): void;
     /**
      * Gets the list of the category values for the chart.
-     * @returns {string[]}
      */
     getCustomSortValues(): Promise<string[]>;
     /**
      * Sets the data filter for the bar chart.
-     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
+     *
+     * @param newDataFilter - The new data filter.
      */
     setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
     /**
@@ -106,77 +102,79 @@ export declare abstract class SerialChartModel extends ChartModel {
     /**
      * Gets the name 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 {string | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesName(seriesIndex: number): string | undefined;
     /**
      * Sets name of the series based on the series index.
-     * @param {string} name The name for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param name - The name for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesName(name: string, seriesIndex: number): void;
     /**
      * Gets the 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.
      */
     getSeriesColor(seriesIndex: number): Color | undefined;
     /**
      * Sets the color of the series based on the series index.
-     * @param {Color | undefined} newColor The new color for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param newColor - The new color for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesColor(newColor: Color | undefined, seriesIndex: number): void;
     /**
      * Gets the order of the series array by returning an array of series ids.
-     * @returns {string[]}
      */
     getOrderOfSeries(): string[];
     /**
      * Sets the order of the series array by providing an array of series ids.
-     * @param {string[]} newOrder The new order of the series array.
+     *
+     * @param newOrder - The new order of the series array.
      */
     setOrderOfSeries(newOrder: string[]): void;
     /**
      * How the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
      * when multiple attributes/fields corresponding to the same set of classes are to be visualized.
      *
-     * Currently this property is only used for bar and line series.
-     *
-     * @default sideBySide
-     *
-     * @returns {WebChartStackedKinds | undefined}
+     * **Note**: Currently this property is only used for bar and line series.
      */
     get stackedType(): WebChartStackedKinds | undefined;
     set stackedType(newStackedType: WebChartStackedKinds | undefined);
     /**
      * Moves a series from one index in the series array to another.
-     * @param {number} fromIndex Index to move the series from.
-     * @param {number} toIndex Index to move the series to.
+     *
+     * @param fromIndex - Index to move the series from.
+     * @param toIndex - Index to move the series to.
      */
     moveSeries(fromIndex: number, toIndex: number): void;
     /**
      * Moves the custom sort values in-place for the order by list in the config.
      * **Note:** This method should be only used when the sort order is set to `SerialChartDataSortingKinds.customSort`.
-     * @param {number} fromIndex The index to move the custom sort value from.
-     * @param {number} toIndex The index to move the custom sort value to.
+     *
+     * @param fromIndex - The index to move the custom sort value from.
+     * @param toIndex - The index to move the custom sort value to.
      */
     moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
     /**
      * The null category configuration of the bar chart.
+     *
+     * @requires the following to be set on the model for the null category to be applied:
+     * - `fetchNULLValues` to be set to `true` on the model.
+     * - `colorMatch` to be set to `false` on the model
      */
     get nullCategory(): WebChartNullCategory | undefined;
     set nullCategory(nullCategory: WebChartNullCategory | undefined);
     protected abstract generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Sets up the local props based on the current config.
-     * @category Protected
      */
     protected setupLocalProps(): void;
     /**
-     * Resets the config to the default config
-     * @category Protected
+     * Resets the config to the default config.
      */
     protected resetConfig(): void;
     /**
@@ -184,13 +182,11 @@ export declare abstract class SerialChartModel extends ChartModel {
      * We can call the build new series function synchronously when either is true:
      * - there is no split-by field
      * - there are multiple numeric fields
-     * @category Protected
      */
     protected canUseSynchronousSeriesRebuild(): boolean;
     /**
      * Processes the series rebuild.
      * If multiple async setters are called in succession, this function will only rebuild the series once after all setters have been called.
-     * @category Protected
      * @async
      */
     protected processSeriesRebuild(): Promise<void>;