@arcgis/charts-components 5.0.0-next.13 → 5.0.0-next.130

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

@@ -1,246 +1,32 @@
-import { Color, IDrawingInfo, LegendItemVisibility, NumberFormatOptions, SupportedLayer, WebChartDataFilters, WebChartTextSymbol } from '../../spec';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ChartConfig, ChartSubType, ChartTypes, CommonStrings } from '../../utils';
-export declare abstract class ChartModel extends EventTarget {
-    /**
-     * Current configuration used for the chart.
-     * @category Protected
-     */
-    protected _config: ChartConfig;
-    /**
-     * Grouping of layer-related properties to be passed to external function more compactly.
-     * @category Protected
-     */
-    protected layerInfo: LayerInfo;
-    /**
-     * Common strings used in the model.
-     * @category Protected
-     */
-    protected commonStrings: CommonStrings;
-    /**
-     * Chart Type
-     * @category Protected
-     */
-    protected _chartType: ChartTypes;
-    /**
-     * List of setters (either props or methods) that have been changed and will require an async series rebuild.
-     * @category Protected
-     */
-    protected dirtyAsyncSetters: string[];
-    /**
-     * Whether or not an async series update is currently in progress.
-     * @category Protected
-     */
-    protected asyncConfigUpdateInProgress: boolean;
-    /**
-     * Function that resolves the setup promise.
-     * @category Protected
-     */
-    protected resolveSetup?: () => void;
-    /**
-     * Completes the async setup process for the chart model. Must be called before using the model.
-     * @param {ModelParams} params The parameters to be used to set up the chart model.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
-     */
-    abstract setup(params: ModelParams<ChartConfig>): Promise<void>;
-    /**
-     * Checks if the current chart model is for the same chart as another chart model.
-     * @param {ChartModel | undefined} otherModel The other chart model to compare to.
-     */
-    isSameChartAs(otherModel: ChartModel | undefined): boolean;
-    /**
-     * Generate the proper chart title from the current config.
-     */
-    abstract generateChartTitle(): string;
-    /**
-     * Data store object that can be used to store any data needed for the chart.
-     */
-    dataStore: any;
-    /**
-     * The current chart configuration object.
-     */
-    get config(): ChartConfig;
-    set config(config: ChartConfig);
-    /**
-     * The chart type.
-     */
-    get chartType(): typeof this._chartType;
-    /**
-     * The associated layer.
-     */
-    get layer(): SupportedLayer | undefined;
-    /**
-     * The chart ID.
-     */
-    get chartId(): string | undefined;
-    set chartId(id: string | undefined);
-    /**
-     * Promise that resolves when the setup process is complete.
-     * **Note:** This promise does not need to be awaited if the `setup` method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.
-     */
-    setupFinished: Promise<void>;
-    /**
-     * The version of the chart configuration.
-     */
-    get version(): string | undefined;
-    /**
-     * The chart title text.
-     * @type {string}
-     */
-    get titleText(): string;
-    set titleText(title: string);
-    /**
-     * The chart subtitle text.
-     * @returns {string}
-     */
-    get subtitleText(): string;
-    set subtitleText(subtitle: string);
-    /**
-     * The chart description text.
-     */
-    get descriptionText(): string;
-    set descriptionText(description: string);
-    /**
-     * Whether or not the chart title is visible.
-     * `true`: Chart title is visible.
-     * `false`: Chart title is hidden.
-     * **Note:** Even if the title is visible, it may not be displayed if the title text is empty.
-     */
-    get chartTitleVisibility(): boolean;
-    set chartTitleVisibility(visibility: boolean);
-    /**
-     * Whether or not the chart subtitle is visible.
-     * `true`: Chart subtitle is visible.
-     * `false`: Chart subtitle is hidden.
-     * **Note:** Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.
-     */
-    get chartSubtitleVisibility(): boolean;
-    set chartSubtitleVisibility(visibility: boolean);
-    /**
-     * Whether or not the chart description is visible.
-     * `true`: Description is visible.
-     * `false`: Description is hidden.
-     * **Note:** Even if the description is visible, it may not be displayed if the description text is empty.
-     */
-    get descriptionVisibility(): boolean;
-    set descriptionVisibility(visibility: boolean);
-    /**
-     * The chart renderer.
-     */
-    get chartRenderer(): IDrawingInfo["renderer"] | undefined;
-    set chartRenderer(renderer: IDrawingInfo["renderer"]);
-    /**
-     * The title text symbol. Contains styling information such as font, color, and symbol style.
-     */
-    get titleSymbol(): WebChartTextSymbol | undefined;
-    set titleSymbol(titleSymbol: WebChartTextSymbol | undefined);
-    /**
-     * The subtitle text symbol. Contains styling information such as font, color, and symbol style.
-     */
-    get subtitleSymbol(): WebChartTextSymbol | undefined;
-    set subtitleSymbol(subtitleSymbol: WebChartTextSymbol | undefined);
-    /**
-     * The description text symbol. Contains styling information such as font, color, and symbol style.
-     */
-    get descriptionSymbol(): WebChartTextSymbol | undefined;
-    set descriptionSymbol(descriptionSymbol: WebChartTextSymbol | undefined);
-    /**
-     * The background color of the chart.
-     */
-    get backgroundColor(): Color | undefined;
-    set backgroundColor(backgroundColor: Color | undefined);
-    /**
-     * Gets the visibility of a series.
-     * @param seriesIndex The series index
-     * @returns {boolean}
-     */
-    getSeriesVisibility(seriesIndex: number): boolean;
-    /**
-     * Sets the visibility of a series.
-     * @param {LegendItemVisibility} props - Visibility options for the series.
-     */
-    setSeriesVisibility(props: LegendItemVisibility): void;
-    /**
-     * Gets the series ID for a given series index.
-     * If the series index is out of bounds, this function will return `undefined`.
-     *
-     * @param {number} seriesIndex The index of the series.
-     * @returns {string | undefined}
-     */
-    getSeriesId(seriesIndex: number): string | undefined;
-    /**
-     * Gets the series index for a given series ID.
-     * If the series ID is not found, this function will return `undefined`.
-     *
-     * @param {string} seriesId The ID of the series.
-     * @returns {number | undefined}
-     */
-    getSeriesIndex(seriesId: string): number | undefined;
-    /**
-     * The length of the series array.
-     */
-    get seriesLength(): number;
-    /**
-     * The chart sub type of the series.
-     */
-    get chartSubType(): ChartSubType;
-    /**
-     * Gets the data tooltip value format for a series.
-     *
-     * If the series index is out of bounds or the series list is empty, this function will return `undefined`.
-     *
-     * @param {number} seriesIndex The index of the series to retrieve the value format for.
-     * @returns {NumberFormatOptions | undefined}
-     */
-    getDataTooltipValueFormat(seriesIndex: number): NumberFormatOptions | undefined;
-    /**
-     * Sets the data tooltip value format for a series.
-     *
-     * @param {number} seriesIndex The index of the series to set the value format for.
-     * @param {NumberFormatOptions | undefined} valueFormat The value format to set.
-     */
-    setDataTooltipValueFormat(seriesIndex: number, valueFormat: NumberFormatOptions | undefined): void;
-    /**
-     * Whether to fetch `null` values for them to be counted or displayed as categories on the chart.
-     */
-    get fetchNULLValues(): boolean;
-    set fetchNULLValues(fetchNULLValues: boolean);
-    /**
-     * The split-by values for the chart.
-     */
-    get splitByValues(): string[];
-    /**
-     * Gets the data filter for the bar chart.
-     * @returns {WebChartDataFilters | undefined}
-     */
-    getDataFilters(): WebChartDataFilters | undefined;
-    /**
-     * Sets the data filter for the chart.
-     * @param {WebChartDataFilters | undefined} newDataFilters The new data filter.
-     */
-    setDataFilters(newDataFilters: WebChartDataFilters | undefined): Promise<void>;
-    /**
-     * Emits a config update event.
-     * @category Protected
-     */
-    protected emitConfigUpdate(setterName: string): void;
-    /**
-     * A function that generates the default config object when creating a new chart.
-     * @category Protected
-     */
-    protected abstract generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-    /**
-     * A function that loads the config based on the provided props.
-     * @category Protected
-     * @param params.layer The layer to be used as the data source for the chart.
-     * @param params.iLayer The layer description to use if the layer is not provided
-     * @param params.config The config object to be loaded.
-     */
-    protected loadConfigFromLayer<T extends ModelTypes>(params: ModelParams<ChartConfig<T>>): Promise<void>;
-    /**
-     * Guards a setter from being called while an async config update is in progress so that the value being set is not overwritten by the async config update.
-     * @param setter The setter callback to call after setup or async config update is finished.
-     */
-    protected guardSetterFromAsyncOverwrite(setter: (() => Promise<void>) | (() => void)): Promise<void>;
+import { MixinInstances } from '../shared/utils';
+import { WithTitleText } from '../properties/title/title-text';
+import { WithTitleSymbol } from '../properties/title/title-symbol';
+import { ChartModelBase } from './chart-model-base';
+import { WithConfig } from '../properties/config';
+import { WithLayer } from '../properties/layer';
+import { WithChartId } from '../properties/chart-id';
+import { WithVersion } from '../properties/version';
+import { WithSubtitleText } from '../properties/subtitle/subtitle-text';
+import { WithSubtitleSymbol } from '../properties/subtitle/subtitle-symbol';
+import { WithDescriptionText } from '../properties/description/description-text';
+import { WithDescriptionSymbol } from '../properties/description/description-symbol';
+import { WithChartTitleVisibility } from '../properties/title/title-visibility';
+import { WithChartSubtitleVisibility } from '../properties/subtitle/subtitle-visibility';
+import { WithDescriptionVisibility } from '../properties/description/description-visibility';
+import { WithChartRenderer } from '../properties/chart-renderer';
+import { WithBackgroundColor } from '../properties/background-color';
+import { WithSeriesVisibility } from '../properties/series/series-visibility';
+import { WithSeriesId } from '../properties/series/series-id';
+import { WithSeriesIndex } from '../properties/series/series-index';
+import { WithSeriesLength } from '../properties/series/series-length';
+import { WithChartSubType } from '../properties/chart-sub-type';
+import { WithSeriesDataTooltipValueFormat } from '../properties/data-tooltip-value-format';
+import { WithFetchNULLValues } from '../properties/fetch-null-values';
+import { WithSplitByValues } from '../properties/split-by-values';
+import { WithDataFilters } from '../properties/data-filters';
+export declare abstract class ChartModel extends ChartModelBase {
 }
+declare const chartModelMixins: readonly [typeof WithConfig, typeof WithLayer, typeof WithChartId, typeof WithTitleText, typeof WithTitleSymbol, typeof WithVersion, typeof WithSubtitleText, typeof WithSubtitleSymbol, typeof WithDescriptionText, typeof WithDescriptionSymbol, typeof WithChartTitleVisibility, typeof WithChartSubtitleVisibility, typeof WithDescriptionVisibility, typeof WithChartRenderer, typeof WithBackgroundColor, typeof WithSeriesVisibility, typeof WithSeriesId, typeof WithSeriesIndex, typeof WithSeriesLength, typeof WithChartSubType, typeof WithSeriesDataTooltipValueFormat, typeof WithFetchNULLValues, typeof WithSplitByValues, typeof WithDataFilters];
+export interface ChartModel extends MixinInstances<typeof chartModelMixins> {
+}
+export {};

package/dist/model/chart-model/utils/types.d.ts

@@ -1,4 +1,4 @@
-import { ChartConfig } from '../../../utils';
+import { ChartConfig } from '../../../utils/types/index';
 import { ModelTypes } from '../../interfaces/common';
 /**
  * Payload for model config change event.

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

@@ -1,8 +1,13 @@
-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 { WithNegativeValuesStackedToBaseline } from '../properties/series/negative-values-stacked-to-baseline';
 import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
+import { MixinInstances } from '../shared/utils';
+import { WebChart, WebChartLineChartSeries } from '../../spec/web-chart';
+import { WebChartTypes } from '../../spec/chart-object-literals';
+import { RESTSimpleLineSymbolStyle, RESTSimpleMarkerSymbolStyle } from '../../spec/rest-js-object-literals';
+import { Color } from '../../spec/rest-js-types';
+import { ChartConfig } from '../../utils/types/index';
 export declare class ComboBarLineChartModel extends SerialChartModel {
     /**
      * Current configuration used for the bar chart.
@@ -10,191 +15,180 @@ export declare class ComboBarLineChartModel extends SerialChartModel {
     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.
+     *
+     * @param seriesIndex - The index of the series to update.
+     * @param 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}
+     *
+     * @param seriesIndex The index of the series.
      */
     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.
+     * **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;
     /**
      * 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.
-     * **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.
+     * **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;
     /**
      * 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.
      */
     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.
+     * **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;
     /**
      * 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.
      * **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.
+     *
+     * @param newStyle - The new style for the series.
+     * @param 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}
+     * @param seriesIndex - The index of the series.
      */
     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.
+     *
+     * @param newSize - The new size for the series.
+     * @param 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}
+     * @param seriesIndex - The index of the series.
      */
     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
+     *
+     * @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 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.
      * **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.
+     *
+     * @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.
      * **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.
+     *
+     * @param visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+     * @param seriesIndex - The index of the series.
      */
     setMarkerVisible(visible: boolean, seriesIndex: number): void;
     /**
      * Specify the color of the filled area for line chart.
      * **Note:** `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
-     * @param {number} seriesIndex - The index of the series.
-     * @returns {Color | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getAreaColor(seriesIndex: number): Color | undefined;
     /**
      * Specify the color of the filled area for line chart.
      * **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.
+     *
+     * @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 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}
+     *
+     * @param seriesIndex - The index of the series.
      */
     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.
+     *
+     * @param hide - The value for hiding oversized labels.
+     * @param seriesIndex - The index of the 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}
+     *
+     * @param seriesIndex - The index of the series.
      */
     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.
+     *
+     * @param hide - The value for hiding oversized stacked labels.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
 }
+declare const comboBarLineChartMixins: readonly [typeof WithNegativeValuesStackedToBaseline];
+export interface ComboBarLineChartModel extends MixinInstances<typeof comboBarLineChartMixins> {
+}
+export {};

package/dist/model/decorators/model-setter.d.ts

@@ -0,0 +1,7 @@
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Decorator for property setter in a chart model that will:
+ * - guard against async overwrite issues
+ * - emit a config update event
+ */
+export declare function modelSetter(_target: ChartModelBase, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;

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

@@ -1,14 +1,24 @@
-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';
+import { ModelWithXGuides } from '../mixins';
+import { WithAxisLabelsSymbol } from '../properties/axes/axis-labels-symbol';
+import { WithAxisLinesSymbol } from '../properties/axes/axis-lines-symbol';
+import { WithXBounds } from '../properties/axes/x-axis/x-bounds';
+import { WithXAxisLabelsVisibility } from '../properties/axes/x-axis/x-axis-labels-visibility';
+import { WithXAxisTitleSymbol } from '../properties/axes/x-axis/x-axis-title-symbol';
+import { WithXAxisTitleText } from '../properties/axes/x-axis/x-axis-title-text';
+import { WithXAxisTitleVisibility } from '../properties/axes/x-axis/x-axis-title-visibility';
+import { WithGenerateXAxisTitle } from '../properties/axes/x-axis/generate-x-axis-title';
+import { MixinInstances } from '../shared/utils';
+import { ValueConversion, WebChartTextSymbol, WebGaugeChart } from '../../spec/web-chart';
+import { GaugeChartSubTypes, WebChartStatisticType } from '../../spec/chart-object-literals';
+import { ISimpleFillSymbol } from '../../spec/rest-js-types';
+import { ChartConfig } from '../../utils/types/index';
+import { ChartTypes } from '../../utils/misc/index';
 export declare class GaugeModel extends ChartModel {
     /**
      * Generate the proper chart title given the current config.
-     *
-     * @returns {string}
      */
     generateChartTitle(): string;
     /**
@@ -52,10 +62,8 @@ export declare class GaugeModel extends ChartModel {
     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)
+     * - 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);
@@ -64,9 +72,9 @@ export declare class GaugeModel extends ChartModel {
      */
     removeFeatureIndex(): void;
     /**
-     * Type of Gauge chart, like FeatureGauge and StatisticGauge.
+     * Type of Gauge chart, like `FeatureGauge` and `StatisticGauge`.
      *
-     * @remarks When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
+     * **Note**: When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
      */
     get gaugeSubType(): GaugeChartSubTypes;
     /**
@@ -126,5 +134,7 @@ export declare class GaugeModel extends ChartModel {
     set onlyShowFirstAndLastLabels(showOnlyFirstAndLastLabels: boolean);
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
 }
-export interface GaugeModel extends ModelWithBasicXAxis, ModelWithXGuides {
+declare const gaugeMixins: readonly [typeof WithXAxisTitleText, typeof WithXAxisLabelsVisibility, typeof WithXAxisTitleVisibility, typeof WithXBounds, typeof WithXAxisTitleSymbol, typeof WithAxisLabelsSymbol, typeof WithAxisLinesSymbol, typeof WithGenerateXAxisTitle, typeof ModelWithXGuides];
+export interface GaugeModel extends MixinInstances<typeof gaugeMixins> {
 }
+export {};