@arcgis/charts-components 5.0.0-next.16 → 5.0.0-next.160

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

@@ -1,200 +1,182 @@
-import { Color, RESTSimpleLineSymbolStyle, RESTSimpleMarkerSymbolStyle, WebChart, WebChartLineChartSeries, WebChartTypes } from '../../spec';
-import { ChartConfig } from '../../utils';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
-export declare class ComboBarLineChartModel extends SerialChartModel {
-    /**
-     * Current configuration used for the bar chart.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.ComboBarLineChart, WebChart>;
-    /**
-     * Default series for the line chart. Used in resetting the series styling.
-     * @category Protected
-     */
-    protected defaultSeries: WebChartLineChartSeries | undefined;
-    protected _chartType: "comboLineAndBarSeries";
-    protected layerInfo: LayerInfo;
-    get config(): typeof this._config;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.ComboBarLineChart>>): Promise<void>;
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-    /**
-     * Initializes the default series for the combo bar-line chart. Used in resetting the series styling.
-     * @category Private
-     */
-    protected initDefaultSeries(): void;
-    /**
-     * Changes the chart series type at the specified index from bar to line and vice-versa.
-     * @param {number} seriesIndex - The index of the series to update.
-     * @param {WebChartTypes} seriesType - The new chart series type to apply.
-     */
-    setSeriesType(seriesIndex: number, seriesType: WebChartTypes): void;
-    /**
-     * 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}
-     */
-    getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
-    /**
-     * Sets the line style of the series based on the series index.
-     * **Note:** This method will only work if the series is a line chart series.
-     * @param {RESTSimpleLineSymbolStyle | undefined} newStyle The new style for the series.
-     * @param {number} seriesIndex The index of the series.
-     */
-    setSeriesLineStyle(newStyle: 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}
-     */
-    getSeriesLineWidth(seriesIndex: number): number | undefined;
-    /**
-     * Sets the line width of the series based on the series index.
-     * **Note:** This method will only work if the series is a line chart series.
-     * @param {number | undefined} newWidth The new width for the series.
-     * @param {number} seriesIndex The index of the series.
-     */
-    setSeriesLineWidth(newWidth: 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}
-     */
-    getSeriesMarkerColor(seriesIndex: number): Color | undefined;
-    /**
-     * Sets the marker color of the series based on the series index.
-     * **Note:** This method will only work if the series is a line chart series.
-     * @param {Color | undefined} newColor The new color for the series.
-     * @param {number} seriesIndex The index of the series.
-     */
-    setSeriesMarkerColor(newColor: 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}
-     */
-    getSeriesMarkerStyle(seriesIndex: number): RESTSimpleMarkerSymbolStyle | undefined;
-    /**
-     * Sets the marker style of the series based on the series index.
-     * **Note:** This method will only work if the series is a line chart series.
-     * @param {RESTSimpleMarkerSymbolStyle | undefined} newStyle The new style for the series.
-     * @param {number} seriesIndex The index of the series.
-     */
-    setSeriesMarkerStyle(newStyle: 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}
-     */
-    getSeriesMarkerSize(seriesIndex: number): number | undefined;
-    /**
-     * Sets the marker size of the series based on the series index.
-     * **Note:** This method will only work if the series is a line chart series.
-     * @param {number | undefined} newSize The new size for the series.
-     * @param {number} seriesIndex The index of the series.
-     */
-    setSeriesMarkerSize(newSize: 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}
-     */
-    isLineSmoothed(seriesIndex: number): boolean;
-    /**
-     * Specify whether line segments of the series should be smoothed.
-     * **Note:** This method will only work if the series is a line chart series.
-     * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-     * @param {number} seriesIndex - The index of the series.
-     * @default false
-     */
-    setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
-    /**
-     * Specify whether the line series should show area.
-     * @param {number} seriesIndex - The index of the series.
-     *
-     * @default false
-     * @returns {boolean}
-     */
-    isAreaVisible(seriesIndex: number): boolean;
-    /**
-     * Specify whether the line series should show area.
-     * **Note:** This method will only work if the series is a line chart series.
-     * @param {boolean} visible - `true` if the line series should show area, `false` otherwise.
-     * @param {number} 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}
-     */
-    isMarkerVisible(seriesIndex: number): boolean;
-    /**
-     * Indicate whether to show or hide the markers/bullets of the line series.
-     * **Note:** This method will only work if the series is a line chart 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.
-     */
-    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}
-     */
-    getAreaColor(seriesIndex: number): Color | undefined;
-    /**
-     * Specify the color of the filled area for line chart.
-     * **Note:** This method will only work if the series is a line chart series.
-     * @param {Color | undefined} color The color of the filled area for line chart.
-     * @param {number} seriesIndex The index of the series.
-     */
-    setAreaColor(color: Color | undefined, seriesIndex: number): void;
-    /**
-     * 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}
-     */
-    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.
-     * **Note:** This method will only work if the series is a line chart series.
-     * @param {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
-     * @param {number} seriesIndex - The index of the series.
-     */
-    setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
-    /**
-     * Gets whether to hide oversized data labels of the side-by-side 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 {boolean | undefined}
-     */
-    getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
-    /**
-     * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
-     * @param {boolean} hide The value for hiding oversized labels.
-     * @param {number} seriesIndex The index of the series.
-     *
-     * **Note:** This method will only work if the series is a bar chart series.
-     */
-    setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
-    /**
-     * Gets whether to hide oversized data labels of the stacked 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 {boolean | undefined}
-     */
-    getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
-    /**
-     * Sets whether to hide oversized data labels of the stacked series based on the series index.
-     * **Note:** This method will only work if the series is a bar chart series.
-     * @param {boolean} hide The value for hiding oversized stacked labels.
-     * @param {number} seriesIndex The index of the series.
-     */
-    setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes } from "../interfaces/common.js";
+import type { WithNegativeValuesStackedToBaseline } from "../properties/series/negative-values-stacked-to-baseline.js";
+import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
+import type { WebChartTypes } from "../../spec/chart-object-literals.js";
+import type { RESTSimpleLineSymbolStyle, RESTSimpleMarkerSymbolStyle } from "../../spec/rest-js-object-literals.js";
+import type { Color } from "../../spec/rest-js-types.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+
+export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
+  /**
+   * 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 seriesIndex - The index of the series.
+   */
+  getAreaColor(seriesIndex: number): Color | undefined;
+  /**
+   * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
+  /**
+   * Gets whether to hide oversized data labels of the stacked series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
+  /**
+   * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
+  /**
+   * Gets the line width of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesLineWidth(seriesIndex: number): number | undefined;
+  /**
+   * Gets the marker color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesMarkerColor(seriesIndex: number): Color | undefined;
+  /**
+   * Gets the marker size of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesMarkerSize(seriesIndex: number): number | undefined;
+  /**
+   * Gets the marker style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesMarkerStyle(seriesIndex: number): RESTSimpleMarkerSymbolStyle | undefined;
+  /**
+   * Specify whether the line series should show area.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  isAreaVisible(seriesIndex: number): boolean;
+  /**
+   * Specify whether line segments of the series should be smoothed.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  isLineSmoothed(seriesIndex: number): boolean;
+  /**
+   * Indicate whether to show or hide the markers/bullets of the line series.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  isMarkerVisible(seriesIndex: number): boolean;
+  /**
+   * Specify the color of the filled area for line chart.
+   * **Note:** This method will only work if the series is a line chart 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;
+  /**
+   * Specify whether the line series should show area.
+   * **Note:** This method will only work if the series is a line chart 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;
+  /**
+   * Specify whether line segments of the series should be smoothed.
+   * **Note:** This method will only work if the series is a line chart 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;
+  /**
+   * Indicate whether to show or hide the markers/bullets of the line series.
+   * **Note:** This method will only work if the series is a line chart 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;
+  /**
+   * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
+   *
+   * **Note:** This method will only work if the series is a bar chart series.
+   *
+   * @param hide - The value for hiding oversized labels.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
+  /**
+   * Sets whether to hide oversized data labels of the stacked series based on the series index.
+   * **Note:** This method will only work if the series is a bar chart series.
+   *
+   * @param hide - The value for hiding oversized stacked labels.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
+  /**
+   * Sets the line style of the series based on the series index.
+   * **Note**: This method will only work if the series is a line chart series.
+   *
+   * @param newStyle - The new style for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesLineStyle(newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number): void;
+  /**
+   * Sets the line width of the series based on the series index.
+   * **Note**: This method will only work if the series is a line chart series.
+   *
+   * @param newWidth - The new width for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
+  /**
+   * Sets the marker color of the series based on the series index.
+   * **Note**: This method will only work if the series is a line chart series.
+   *
+   * @param newColor - The new color for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesMarkerColor(newColor: Color | undefined, seriesIndex: number): void;
+  /**
+   * Sets the marker size of the series based on the series index.
+   * **Note:** This method will only work if the series is a line chart series.
+   *
+   * @param newSize - The new size for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesMarkerSize(newSize: number | undefined, seriesIndex: number): void;
+  /**
+   * Sets the marker style of the series based on the series index.
+   * **Note:** This method will only work if the series is a line chart series.
+   *
+   * @param newStyle - The new style for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesMarkerStyle(newStyle: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex: number): void;
+  /**
+   * Changes the chart series type at the specified index from bar to line and vice-versa.
+   *
+   * @param seriesIndex - The index of the series to update.
+   * @param seriesType - The new chart series type to apply.
+   */
+  setSeriesType(seriesIndex: number, seriesType: WebChartTypes): void;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   * @async **This method is `async` and must be awaited for the changes to take effect.**
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.ComboBarLineChart>>): Promise<void>;
 }
+declare const ComboBarLineChartModelSuperclass: typeof SerialChartModel & typeof WithNegativeValuesStackedToBaseline

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

@@ -1,130 +1,82 @@
-import { GaugeChartSubTypes, ISimpleFillSymbol, WebChartStatisticType, ValueConversion, WebChartTextSymbol, WebGaugeChart } from '../../spec';
-import { ChartTypes, ChartConfig } from '../../utils';
-import { ChartModel } from '../chart-model/chart-model';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ModelWithBasicXAxis, ModelWithXGuides } from '../mixins';
-export declare class GaugeModel extends ChartModel {
-    /**
-     * Generate the proper chart title given the current config.
-     *
-     * @returns {string}
-     */
-    generateChartTitle(): string;
-    /**
-     * Current configuration used for the histogram.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.Gauge, WebGaugeChart>;
-    protected layerInfo: LayerInfo;
-    protected _chartType: ChartTypes;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.Gauge>>): Promise<void>;
-    /**
-     * Data field used for the gauge.
-     */
-    get field(): string;
-    set field(field: string);
-    /**
-     * Aggregation type used for the gauge.
-     *
-     * Must be one of the values allowed by `WebChartStatisticType`, excluding `"no_aggregation"`.
-     */
-    get aggregationType(): WebChartStatisticType;
-    set aggregationType(aggregationType: WebChartStatisticType);
-    /**
-     * Inner radius of the gauge.
-     */
-    get innerRadius(): number;
-    set innerRadius(innerRadius: number);
-    /**
-     * Start angle of the gauge.
-     */
-    get startAngle(): number;
-    set startAngle(startAngle: number);
-    /**
-     * End angle of the gauge.
-     */
-    get endAngle(): number;
-    set endAngle(endAngle: number);
-    /**
-     * Conversion to apply to the gauge value.
-     */
-    get valueConversion(): ValueConversion | undefined;
-    set valueConversion(valueConversion: ValueConversion | undefined);
-    /**
-     * Gets 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)
-     */
-    get featureIndex(): number | undefined;
-    set featureIndex(featureIndex: number | null | undefined);
-    /**
-     * Removes the existing feature index from the config object
-     */
-    removeFeatureIndex(): void;
-    /**
-     * Type of Gauge chart, like FeatureGauge and StatisticGauge.
-     *
-     * @remarks When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
-     */
-    get gaugeSubType(): GaugeChartSubTypes;
-    /**
-     * Visibility of the gauge's needle.
-     */
-    get needleVisibility(): boolean;
-    set needleVisibility(visible: boolean);
-    /**
-     * Symbol of the gauge's needle.
-     */
-    get needleSymbol(): ISimpleFillSymbol | undefined;
-    set needleSymbol(needleSymbol: ISimpleFillSymbol | undefined);
-    /**
-     * Start width of the gauge's needle.
-     */
-    get needleStartWidth(): number | null | undefined;
-    set needleStartWidth(width: number | null | undefined);
-    /**
-     * End width of the gauge's needle.
-     */
-    get needleEndWidth(): number | null | undefined;
-    set needleEndWidth(width: number | null | undefined);
-    /**
-     * Inner radius of the gauge's needle.
-     */
-    get needleInnerRadius(): number | null | undefined;
-    set needleInnerRadius(innerRadius: number | null | undefined);
-    /**
-     * Whether to display the pin for the gauge's needle.
-     */
-    get needleDisplayPin(): boolean;
-    set needleDisplayPin(displayPin: boolean);
-    /**
-     * Whether the inner label is visible.
-     */
-    get innerLabelVisible(): boolean;
-    set innerLabelVisible(visible: boolean);
-    /**
-     * Content symbol for the inner label.
-     */
-    get innerLabelContent(): WebChartTextSymbol | undefined;
-    set innerLabelContent(innerLabelContent: WebChartTextSymbol | undefined);
-    /**
-     * Whether axis ticks are visible.
-     */
-    get axisTickVisibility(): boolean;
-    set axisTickVisibility(visibile: boolean);
-    /**
-     * Labels increment for the gauge.
-     */
-    get labelsIncrement(): number | undefined;
-    set labelsIncrement(increment: number | undefined);
-    /**
-     * Whether to only show the first and last axis labels.
-     */
-    get onlyShowFirstAndLastLabels(): boolean;
-    set onlyShowFirstAndLastLabels(showOnlyFirstAndLastLabels: boolean);
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-}
-export interface GaugeModel extends ModelWithBasicXAxis, ModelWithXGuides {
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes } from "../interfaces/common.js";
+import type { WithAxisLabelsSymbol } from "../properties/axes/axis-labels-symbol.js";
+import type { WithAxisLinesSymbol } from "../properties/axes/axis-lines-symbol.js";
+import type { WithXBounds } from "../properties/axes/x-axis/x-bounds.js";
+import type { WithXAxisLabelsVisibility } from "../properties/axes/x-axis/x-axis-labels-visibility.js";
+import type { WithXAxisTitleSymbol } from "../properties/axes/x-axis/x-axis-title-symbol.js";
+import type { WithXAxisTitleText } from "../properties/axes/x-axis/x-axis-title-text.js";
+import type { WithXAxisTitleVisibility } from "../properties/axes/x-axis/x-axis-title-visibility.js";
+import type { WithGenerateXAxisTitle } from "../properties/axes/x-axis/generate-x-axis-title.js";
+import type { ValueConversion, WebChartTextSymbol } from "../../spec/web-chart.js";
+import type { GaugeChartSubTypes, WebChartStatisticType } from "../../spec/chart-object-literals.js";
+import type { ISimpleFillSymbol } from "../../spec/rest-js-types.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
+
+export class GaugeModel extends GaugeModelSuperclass {
+  /**
+   * Aggregation type used for the gauge.
+   *
+   * Must be one of the values allowed by `WebChartStatisticType`, excluding `"no_aggregation"`.
+   */
+  accessor aggregationType: WebChartStatisticType;
+  /** Whether axis ticks are visible. */
+  accessor axisTickVisibility: boolean;
+  /** End angle of the gauge. */
+  accessor endAngle: number;
+  /**
+   * Gets the index of the feature to be rendered.
+   * - 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)
+   */
+  get featureIndex(): number | undefined;
+  set featureIndex(value: number | null | undefined);
+  /** Data field used for the gauge. */
+  accessor field: string;
+  /**
+   * Type of Gauge chart, like `FeatureGauge` and `StatisticGauge`.
+   *
+   * **Note**: When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
+   */
+  get gaugeSubType(): GaugeChartSubTypes;
+  /** Content symbol for the inner label. */
+  accessor innerLabelContent: WebChartTextSymbol | undefined;
+  /** Whether the inner label is visible. */
+  accessor innerLabelVisible: boolean;
+  /** Inner radius of the gauge. */
+  accessor innerRadius: number;
+  /** Labels increment for the gauge. */
+  accessor labelsIncrement: number | undefined;
+  /** Whether to display the pin for the gauge's needle. */
+  accessor needleDisplayPin: boolean;
+  /** End width of the gauge's needle. */
+  accessor needleEndWidth: number | null | undefined;
+  /** Inner radius of the gauge's needle. */
+  accessor needleInnerRadius: number | null | undefined;
+  /** Start width of the gauge's needle. */
+  accessor needleStartWidth: number | null | undefined;
+  /** Symbol of the gauge's needle. */
+  accessor needleSymbol: ISimpleFillSymbol | undefined;
+  /** Visibility of the gauge's needle. */
+  accessor needleVisibility: boolean;
+  /** Whether to only show the first and last axis labels. */
+  accessor onlyShowFirstAndLastLabels: boolean;
+  /** Start angle of the gauge. */
+  accessor startAngle: number;
+  /** Conversion to apply to the gauge value. */
+  accessor valueConversion: ValueConversion | undefined;
+  /** Generate the proper chart title given the current config. */
+  generateChartTitle(): string;
+  /** Removes the existing feature index from the config object */
+  removeFeatureIndex(): void;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   * @async **This method is `async` and must be awaited for the changes to take effect.**
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.Gauge>>): Promise<void>;
 }
+declare const GaugeModelSuperclass: typeof ChartModel & typeof ModelWithXGuides & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText