@arcgis/charts-components 4.33.0-next.106 → 4.33.0-next.107

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

@@ -1,9 +1,9 @@
-import { WebGaugeChart, WebChartTextSymbol, WebChartGaugeSeries, WebChartStatisticType, ISimpleFillSymbol, ValueConversion, GaugeChartSubTypes } from '@arcgis/charts-spec';
+import { GaugeChartSubTypes, ISimpleFillSymbol, WebChartStatisticType, ValueConversion, WebChartGaugeSeries, WebChartTextSymbol, WebGaugeChart } from '@arcgis/charts-spec';
 import { ChartTypes, ChartConfig } from '../../utils';
-import { LayerInfo } from '../interfaces/common';
 import { ChartModel } from '../chart-model/customElement.js';
-import { ModelWithBasicXAxis, ModelWithXGuides } from '../mixins';
 import { ModelParams } from '../interfaces/chart-interfaces';
+import { LayerInfo } from '../interfaces/common';
+import { ModelWithBasicXAxis, ModelWithXGuides } from '../mixins';
 export declare class GaugeModel extends ChartModel {
     /**
      * Current configuration used for the histogram.
@@ -19,10 +19,10 @@ export declare class GaugeModel extends ChartModel {
     getField(): string;
     /**
      * Sets the data field used for the gauge.
-     * @param {string} newField The new field to set.
+     * @param {string} field The field to set.
      * @async **This method is `async` and must be awaited for the changes to take effect.**
      */
-    setField(newField: string): Promise<void>;
+    setField(field: string): Promise<void>;
     /**
      * Gets the aggregation type used for the gauge.
      * @returns {WebChartStatisticType}
@@ -30,10 +30,10 @@ export declare class GaugeModel extends ChartModel {
     getAggregationType(): WebChartStatisticType;
     /**
      * Sets the aggregation type used for the gauge.
-     * @param {WebChartStatisticType} newAggregationType The new aggregation type to set. Must be one of the values allowed by `WebChartStatisticType`, excluding `"no_aggregation"`.
+     * @param {WebChartStatisticType} aggregationType The aggregation type to set. Must be one of the values allowed by `WebChartStatisticType`, excluding `"no_aggregation"`.
      * @async **This method is `async` and must be awaited for the changes to take effect.**
      */
-    setAggregationType(newAggregationType: WebChartStatisticType): Promise<void>;
+    setAggregationType(aggregationType: WebChartStatisticType): Promise<void>;
     /**
      * Gets the inner radius of the gauge.
      * @returns {number}
@@ -41,9 +41,9 @@ export declare class GaugeModel extends ChartModel {
     getInnerRadius(): number;
     /**
      * Sets the inner radius of the gauge.
-     * @param {number} newInnerRadius The new inner radius to set.
+     * @param {number} innerRadius The inner radius to set.
      */
-    setInnerRadius(newInnerRadius: number): void;
+    setInnerRadius(innerRadius: number): void;
     /**
      * Gets the start angle of the gauge.
      * @returns {number}
@@ -51,9 +51,9 @@ export declare class GaugeModel extends ChartModel {
     getStartAngle(): number;
     /**
      * Sets the start angle of the gauge.
-     * @param {number} newStartAngle The new start angle to set.
+     * @param {number} startAngle The start angle to set.
      */
-    setStartAngle(newStartAngle: number): void;
+    setStartAngle(startAngle: number): void;
     /**
      * Gets the end angle of the gauge.
      * @returns {number}
@@ -61,48 +61,43 @@ export declare class GaugeModel extends ChartModel {
     getEndAngle(): number;
     /**
      * Sets the end angle of the gauge.
-     * @param {number} newEndAngle The new end angle to set.
+     * @param {number} endAngle The end angle to set.
      */
-    setEndAngle(newEndAngle: number): void;
+    setEndAngle(endAngle: number): void;
     /**
-     * Get the conversion to apply to the gauge value
+     * Gets the conversion to apply to the gauge value
      *
      * @returns {ValueConversion | undefined}
      */
     getValueConversion(): ValueConversion | undefined;
     /**
-     * Set the conversion to apply to the gauge value
-     * @param {ValueConversion} valueConversion - the conversion to apply
+     * Sets the conversion to apply to the gauge value
+     * @param {ValueConversion} valueConversion The conversion to apply
      */
     setValueConversion(valueConversion: ValueConversion): void;
     /**
-     * Get the index of the feature to be rendered.
-     *
-     * NOTE: This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
-     *
+     * Gets the index of the feature to be rendered.
      * @returns {number | undefined}
+     * @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)
      */
     getFeatureIndex(): number | undefined;
     /**
-     * Set the index of the feature to be rendered.
-     *
-     * NOTE: This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
+     * Sets the index of the feature to be rendered.
+     * @param {number | null} featureIndex 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)
-     *
-     * @param {number | null} featureIndex - the index of the feature to be rendered
      */
     setFeatureIndex(featureIndex: number | null): Promise<void>;
     /**
-     * Remove the existing feature index from the config object
+     * Removes the existing feature index from the config object
      */
     removeFeatureIndex(): void;
     /**
-     * Get the type of Gauge chart, like FeatureGauge and StatisticGauge.
-     *
-     * NOTE: When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
-     * @default GaugeChartSubTypes.StatisticGauge
-     *
+     * Gets the type of Gauge chart, like FeatureGauge and StatisticGauge.
      * @returns {GaugeChartSubTypes}
+     * @remarks When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
      */
     getGaugeSubType(): GaugeChartSubTypes;
     /**
@@ -112,9 +107,9 @@ export declare class GaugeModel extends ChartModel {
     getNeedleVisibility(): boolean;
     /**
      * Sets the visibility of the gauge's needle.
-     * @param {boolean} newNeedleVisibility The new visibility to set.
+     * @param {boolean} visible The visibility to set.
      */
-    setNeedleVisibility(newNeedleVisibility: boolean): void;
+    setNeedleVisibility(visible: boolean): void;
     /**
      * Gets the symbol of the gauge's needle.
      * @returns {ISimpleFillSymbol | undefined}
@@ -122,9 +117,9 @@ export declare class GaugeModel extends ChartModel {
     getNeedleSymbol(): ISimpleFillSymbol | undefined;
     /**
      * Sets the symbol of the gauge's needle.
-     * @param {ISimpleFillSymbol | undefined} newNeedleSymbol The new needle symbol to set.
+     * @param {ISimpleFillSymbol | undefined} needleSymbol The needle symbol to set.
      */
-    setNeedleSymbol(newNeedleSymbol: ISimpleFillSymbol | undefined): void;
+    setNeedleSymbol(needleSymbol: ISimpleFillSymbol | undefined): void;
     /**
      * Gets the start width of the gauge's needle.
      * @returns {number | null | undefined}
@@ -132,9 +127,9 @@ export declare class GaugeModel extends ChartModel {
     getNeedleStartWidth(): number | null | undefined;
     /**
      * Sets the start width of the gauge's needle.
-     * @param {number | null | undefined} newNeedleStartWidth The new start width to set.
+     * @param {number | null | undefined} width The start width to set.
      */
-    setNeedleStartWidth(newNeedleStartWidth: number | null | undefined): void;
+    setNeedleStartWidth(width: number | null | undefined): void;
     /**
      * Gets the end width of the gauge's needle.
      * @returns {number | null | undefined}
@@ -142,9 +137,9 @@ export declare class GaugeModel extends ChartModel {
     getNeedleEndWidth(): number | null | undefined;
     /**
      * Sets the end width of the gauge's needle.
-     * @param {number | null | undefined} newNeedleEndWidth The new end width to set.
+     * @param {number | null | undefined} width The end width to set.
      */
-    setNeedleEndWidth(newNeedleEndWidth: number | null | undefined): void;
+    setNeedleEndWidth(width: number | null | undefined): void;
     /**
      * Gets the inner radius of the gauge's needle.
      * @returns {number | null | undefined}
@@ -152,9 +147,9 @@ export declare class GaugeModel extends ChartModel {
     getNeedleInnerRadius(): number | null | undefined;
     /**
      * Sets the inner radius of the gauge's needle.
-     * @param {number | null | undefined} newNeedleInnerRadius The new inner radius to set.
+     * @param {number | null | undefined} innerRadius The inner radius to set.
      */
-    setNeedleInnerRadius(newNeedleInnerRadius: number): void;
+    setNeedleInnerRadius(innerRadius: number): void;
     /**
      * Gets whether to display the pin for the gauge's needle.
      * @returns {boolean}
@@ -162,9 +157,9 @@ export declare class GaugeModel extends ChartModel {
     getNeedleDisplayPin(): boolean;
     /**
      * Sets whether to display the pin for the gauge's needle.
-     * @param {boolean} newNeedleDisplayPin The new display pin state.
+     * @param {boolean} displayPin The display pin state.
      */
-    setNeedleDisplayPin(newNeedleDisplayPin: boolean): void;
+    setNeedleDisplayPin(displayPin: boolean): void;
     /**
      * Gets whether the inner label is visible.
      * @returns {boolean}
@@ -172,9 +167,9 @@ export declare class GaugeModel extends ChartModel {
     getInnerLabelVisible(): boolean;
     /**
      * Sets whether the inner label is visible.
-     * @param {boolean} newNeedleLabelVisibility The new visibility state.
+     * @param {boolean} visible The visibility state to set.
      */
-    setInnerLabelVisibility(newNeedleLabelVisibility: boolean): void;
+    setInnerLabelVisibility(visible: boolean): void;
     /**
      * Gets the inner label content symbol.
      * @returns {WebChartTextSymbol | undefined}
@@ -182,9 +177,9 @@ export declare class GaugeModel extends ChartModel {
     getInnerLabelContent(): WebChartTextSymbol | undefined;
     /**
      * Sets the inner label content symbol.
-     * @param {WebChartTextSymbol | undefined} newInnerLabelContent The new content symbol to set.
+     * @param {WebChartTextSymbol | undefined} innerLabelContent The content symbol to set.
      */
-    setInnerLabelContent(newInnerLabelContent: WebChartTextSymbol | undefined): void;
+    setInnerLabelContent(innerLabelContent: WebChartTextSymbol | undefined): void;
     /**
      * Gets whether the axis ticks are visible.
      * @returns {boolean}
@@ -192,9 +187,9 @@ export declare class GaugeModel extends ChartModel {
     getAxisTickVisibility(): boolean;
     /**
      * Sets whether the axis ticks are visible.
-     * @param {boolean} newAxisTickVisibility The new visibility state.
+     * @param {boolean} visibile The visibility state to set.
      */
-    setAxisTickVisibility(newAxisTickVisibility: boolean): void;
+    setAxisTickVisibility(visibile: boolean): void;
     /**
      * Gets the labels increment for the gauge.
      * @returns {number | undefined}
@@ -202,19 +197,19 @@ export declare class GaugeModel extends ChartModel {
     getLabelsIncrement(): number | undefined;
     /**
      * Sets the labels increment for the gauge.
-     * @param {number | undefined} newLabelsIncrement The new increment to set.
+     * @param {number | undefined} increment The increment to set.
      */
-    setLabelsIncrement(newLabelsIncrement: number | undefined): void;
+    setLabelsIncrement(increment: number | undefined): void;
     /**
      * Gets whether to only show the first and last labels.
      * @returns {boolean}
      */
     getOnlyShowFirstAndLastLabels(): boolean;
     /**
-     * Sets whether to only show the first and last labels.
-     * @param {boolean} newOnlyShowFirstAndLastLabels The new state.
+     * Sets whether to only show the first and last axis labels.
+     * @param {boolean} showOnlyFirstAndLastLabels Indicator of whether to only show the first and last axis labels
      */
-    setOnlyShowFirstAndLastLabels(newOnlyShowFirstAndLastLabels: boolean): void;
+    setOnlyShowFirstAndLastLabels(showOnlyFirstAndLastLabels: boolean): void;
     protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
 }
 export interface GaugeModel extends ModelWithBasicXAxis, ModelWithXGuides {

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

@@ -2,122 +2,144 @@ import { ChartConfig } from '../../../utils';
 import { ISimpleFillSymbol, WebChartGaugeSeries, WebChartTextSymbol } from '@arcgis/charts-spec';
 /**
  * Gets the visibility of the needle.
- * @param config
+ * @param config The chart configuration object
+ * @returns {boolean}
+ * @remarks If the needle or its visibility is not set, the default value of `true` will be returned.
  */
 export declare const getNeedleVisibility: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
 /**
  * Sets the visibility of the needle.
- * @param visible
- * @param config
+ * @param visible The visibility to set for the needle
+ * @param config The chart configuration object
+ * @remarks If the needle is not set, it will be created with the default values.
  */
 export declare const setNeedleVisibility: (visible: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets the symbol of the needle.
- * @param config
+ * @param config The chart configuration object
+ * @returns {ISimpleFillSymbol | undefined}
  */
 export declare const getNeedleSymbol: (config: ChartConfig<WebChartGaugeSeries>) => ISimpleFillSymbol | undefined;
 /**
  * Sets the symbol of the needle.
- * @param symbol
- * @param config
+ * @param symbol The symbol to set for the needle
+ * @param config The chart configuration object
+ * @remarks If the needle is not set, it will be created with the default values.
  */
 export declare const setNeedleSymbol: (symbol: ISimpleFillSymbol | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets the start width of the needle.
- * @param config
+ * @param config The chart configuration object
+ * @returns {number | null | undefined}
  */
 export declare const getNeedleStartWidth: (config: ChartConfig<WebChartGaugeSeries>) => number | null | undefined;
 /**
  * Sets the start width of the needle.
- * @param startWidth
- * @param config
+ * @param startWidth The start width to set for the needle
+ * @param config The chart configuration object
+ * @remarks If the needle is not set, it will be created with the default values.
  */
-export declare const setNeedleStartWidth: (startWidth: number | null | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
+export declare const setNeedleStartWidth: (width: number | null | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets the end width of the needle.
- * @param config
+ * @param config The chart configuration object
+ * @returns {number | null | undefined}
  */
 export declare const getNeedleEndWidth: (config: ChartConfig<WebChartGaugeSeries>) => number | null | undefined;
 /**
  * Sets the end width of the needle.
- * @param endWidth
- * @param config
+ * @param width The end width to set for the needle
+ * @param config The chart configuration object
+ * @remarks If the needle is not set, it will be created with the default values.
  */
-export declare const setNeedleEndWidth: (endWidth: number | null | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
+export declare const setNeedleEndWidth: (width: number | null | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets the inner radius of the needle.
- * @param config
+ * @param config The chart configuration object
+ * @returns {number | null | undefined}
  */
 export declare const getNeedleInnerRadius: (config: ChartConfig<WebChartGaugeSeries>) => number | null | undefined;
 /**
  * Sets the inner radius of the needle.
- * @param innerRadius
- * @param config
+ * @param innerRadius The inner radius to set for the needle
+ * @param config The chart configuration object
+ * @remarks If the needle is not set, it will be created with the default values.
  */
 export declare const setNeedleInnerRadius: (innerRadius: number | null | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets whether to display the pin for the needle.
- * @param config
+ * @param config The chart configuration object
+ * @returns {boolean}
  */
 export declare const getNeedleDisplayPin: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
 /**
  * Sets whether to display the pin for the needle.
- * @param displayPin
- * @param config
+ * @param displayPin The visibility to set for the needle pin
+ * @param config The chart configuration object
+ * @remarks If the needle is not set, it will be created with the default values.
  */
 export declare const setNeedleDisplayPin: (displayPin: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets whether the gauge inner label is visible.
- * @param config
+ * @param config The chart configuration object
+ * @returns {boolean}
  */
 export declare const getInnerLabelVisible: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
 /**
  * Sets whether the gauge inner label is visible.
- * @param visible
- * @param config
+ * @param visible The visibility to set for the gauge inner label
+ * @param config The chart configuration object
+ * @remarks If the inner label is not set, it will be created with the default values.
  */
 export declare const setInnerLabelVisibility: (visible: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets the content of the gauge inner label.
- * @param config
+ * @param config The chart configuration object
+ * @returns {WebChartTextSymbol | undefined}
  */
 export declare const getInnerLabelContent: (config: ChartConfig<WebChartGaugeSeries>) => WebChartTextSymbol | undefined;
 /**
  * Sets the content of the gauge inner label.
- * @param content
- * @param config
+ * @param content The content to set for the gauge inner label
+ * @param config The chart configuration object
+ * @remarks If the inner label is not set, it will be created with the default values.
  */
 export declare const setInnerLabelContent: (content: WebChartTextSymbol | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets the visibility of the gauge axis ticks.
- * @param config
+ * @param config The chart configuration object
+ * @returns {boolean}
  */
 export declare const getAxisTickVisibility: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
 /**
  * Sets the visibility of the gauge axis ticks.
- * @param visible
- * @param config
+ * @param visible The visibility to set for the gauge axis ticks
+ * @param config The chart configuration object
+ * @remarks If the ticks are not set, it will be created with the default values.
  */
 export declare const setAxisTickVisibility: (visible: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets the increment between axis labels.
- * @param config
+ * @param config The chart configuration object
+ * @returns {number | undefined}
  */
 export declare const getLabelsIncrement: (config: ChartConfig<WebChartGaugeSeries>) => number | undefined;
 /**
  * Sets the increment between axis labels.
- * @param increment
- * @param config
+ * @param increment The increment to set for the axis labels
+ * @param config The chart configuration object
  */
 export declare const setLabelsIncrement: (increment: number | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
  * Gets whether to only show the first and last axis labels.
- * @param config
+ * @param config The chart configuration object
+ * @returns {boolean}
+ * @remarks If the onlyShowFirstAndLastLabels is not set, the default value of `false` will be returned.
  */
 export declare const getShowOnlyMinMaxLabels: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
 /**
  * Sets whether to only show the first and last axis labels.
- * @param value
- * @param config
+ * @param showOnlyFirstAndLastLabels Indicator of whether to only show the first and last axis labels
+ * @param config The chart configuration object
  */
-export declare const setShowOnlyMinMaxLabels: (value: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;
+export declare const setShowOnlyMinMaxLabels: (showOnlyFirstAndLastLabels: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;

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

@@ -9,16 +9,16 @@ export declare const updateSeries: (props: {
 }) => Promise<void>;
 /**
  * Gets the aggregation type from the config.
- * @param config - the gauge chart config
+ * @param config - the guage chart config
  */
 export declare const getAggregationType: (config: ChartConfig<WebChartGaugeSeries>) => WebChartStatisticType;
 /**
  * Sets the aggregation type to the config.
- * @param newAggregationType
+ * @param aggregationType
  * @param config
  * @param layerInfo
  */
-export declare const setAggregationType: (newAggregationType: WebChartStatisticType, config: ChartConfig<WebChartGaugeSeries>, layerInfo: LayerInfo) => Promise<void>;
+export declare const setAggregationType: (aggregationType: WebChartStatisticType, config: ChartConfig<WebChartGaugeSeries>, layerInfo: LayerInfo) => Promise<void>;
 /**
  * Checks if the feature index is valid.
  *
@@ -29,46 +29,46 @@ export declare const setAggregationType: (newAggregationType: WebChartStatisticT
  */
 export declare const isValidFeatureIndex: (featureIndex?: number) => boolean;
 /**
- * get the field from the config
+ * Gets the field from the config
  * @param config - the guage chart config
  */
 export declare const getField: (config: ChartConfig<WebChartGaugeSeries>) => string;
 /**
- * set the new field to the config
- * @param newField - the new field
- * @param config - the guage chart config
+ * Sets the field to the config
+ * @param field The field to set
+ * @param config The guage chart config
  */
-export declare const setField: (newField: string, config: ChartConfig<WebChartGaugeSeries>, layerInfo: LayerInfo) => Promise<void>;
+export declare const setField: (field: string, config: ChartConfig<WebChartGaugeSeries>, layerInfo: LayerInfo) => Promise<void>;
 /**
- * get 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<WebChartGaugeSeries>) => number;
 /**
- * set the new inner radius to the config
- * @param newInnerRadius - the new inner radius
- * @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: (newInnerRadius: number, config: ChartConfig<WebChartGaugeSeries>) => void;
+export declare const setInnerRadius: (innerRadius: number, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
- * get 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<WebChartGaugeSeries>) => number;
 /**
- * set the new start angle to the config
- * @param newStartAngle - the new start angle
- * @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: (newStartAngle: number, config: ChartConfig<WebChartGaugeSeries>) => void;
+export declare const setStartAngle: (startAngle: number, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
- * get 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<WebChartGaugeSeries>) => number;
 /**
- * set the new end angle to the config
- * @param newEndAngle - the new end angle
- * @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: (newEndAngle: number, config: ChartConfig<WebChartGaugeSeries>) => void;
+export declare const setEndAngle: (endAngle: number, config: ChartConfig<WebChartGaugeSeries>) => void;

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

@@ -2,41 +2,38 @@ import { ChartConfig } from '../../../utils';
 import { ValueConversion, WebChartGaugeSeries, GaugeChartSubTypes } from '@arcgis/charts-spec';
 import { LayerInfo } from '../../interfaces/common';
 /**
- * Get the conversion to apply to the gauge value
- * @param {ChartConfig<WebChartGaugeSeries>} config - the chart configuration
+ * Gets the conversion to apply to the gauge value
+ * @param {ChartConfig<WebChartGaugeSeries>} config The gauge chart configuration object
+ * @returns {ValueConversion | undefined}
  */
 export declare const getValueConversion: (config: ChartConfig<WebChartGaugeSeries>) => ValueConversion | undefined;
 /**
- * Set the conversion to apply to the gauge value
- * @param {ValueConversion} valueConversion - the conversion to apply
- * @param {ChartConfig<WebChartGaugeSeries>} config - the chart configuration
+ * Sets the conversion to apply to the gauge value
+ * @param {ValueConversion} valueConversion The conversion to apply
+ * @param {ChartConfig<WebChartGaugeSeries>} config The gauge chart configuration object
  */
 export declare const setValueConversion: (valueConversion: ValueConversion, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
- * Get the index of the feature to be rendered.
- *
- * NOTE: This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
+ * Gets the index of the feature to be rendered.
+ * @param {ChartConfig<WebChartGaugeSeries>} 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)
- * @param {ChartConfig<WebChartGaugeSeries>} config - the chart configuration
  */
 export declare const getFeatureIndex: (config: ChartConfig<WebChartGaugeSeries>) => number | undefined;
 /**
- * Set the index of the feature to be rendered.
- *
- * NOTE: This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
- * @param {number | null} featureIndex - the index of the feature to be rendered
- * @param {ChartConfig<WebChartGaugeSeries>} config - the chart configuration
- * @param {LayerInfo} layerInfo - the layer information
+ * Sets the index of the feature to be rendered.
+ * @param {number | null} featureIndex The index of the feature to be rendered
+ * @param {ChartConfig<WebChartGaugeSeries>} config The gauge chart configuration object
+ * @param {LayerInfo} layerInfo The layer information
+ * @remarks This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
  */
 export declare const setFeatureIndex: (featureIndex: number | null, config: ChartConfig<WebChartGaugeSeries>, layerInfo: LayerInfo) => Promise<void>;
 /**
- * Get the type of Gauge chart, like FeatureGauge and StatisticGauge.
- *
- * NOTE: When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
- *
- * @param {ChartConfig<WebChartGaugeSeries>} config - the chart configuration
- * @default GaugeChartSubTypes.StatisticGauge
- *
+ * Gets the type of Gauge chart, like FeatureGauge and StatisticGauge.
+ * @param {ChartConfig<WebChartGaugeSeries>} config Tthe chart configuration
  * @returns {GaugeChartSubTypes}
+ * @remarks When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
  */
 export declare const getGaugeSubType: (config: ChartConfig<WebChartGaugeSeries>) => GaugeChartSubTypes;