@arcgis/charts-components 4.33.0-next.94 → 4.33.0-next.96

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

@@ -0,0 +1,221 @@
+import { WebGaugeChart, WebChartTextSymbol, WebChartGaugeSeries, RESTStatisticType, ISimpleFillSymbol, ValueConversion, GaugeChartSubTypes } from '@arcgis/charts-spec';
+import { ChartTypes, ChartConfig } from '@arcgis/charts-shared-utils';
+import { LayerInfo } from '../interfaces/common';
+import { ChartModel } from '../chart-model/customElement.js';
+import { ModelWithBasicXAxis, ModelWithXGuides } from '../mixins';
+import { ModelParams } from '../interfaces/chart-interfaces';
+export declare class GaugeModel extends ChartModel {
+    /**
+     * Current configuration used for the histogram.
+     */
+    protected _config: ChartConfig<WebChartGaugeSeries, WebGaugeChart>;
+    protected layerInfo: LayerInfo;
+    protected _chartType: ChartTypes;
+    setup(params: ModelParams<ChartConfig<WebChartGaugeSeries>>): Promise<void>;
+    /**
+     * Gets the data field used for the gauge.
+     * @returns {string}
+     */
+    getField(): string;
+    /**
+     * Sets the data field used for the gauge.
+     * @param {string} newField The new field to set.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setField(newField: string): Promise<void>;
+    /**
+     * Gets the aggregation type used for the gauge.
+     * @returns {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate"}
+     */
+    getAggregationType(): Exclude<RESTStatisticType, "no_aggregation">;
+    /**
+     * Sets the aggregation type used for the gauge.
+     * @param {"count" | "sum" | "min" | "max" | "avg" | "stddev" | "var" | "percentile_cont" | "percentile_disc" | "envelope-aggregate" | "centroid-aggregate" | "convex-hull-aggregate"} newAggregationType The new aggregation type to set. Must be one of the values allowed by `RESTStatisticType`, excluding `"no_aggregation"`.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setAggregationType(newAggregationType: Exclude<RESTStatisticType, "no_aggregation">): Promise<void>;
+    /**
+     * Gets the inner radius of the gauge.
+     * @returns {number}
+     */
+    getInnerRadius(): number;
+    /**
+     * Sets the inner radius of the gauge.
+     * @param {number} newInnerRadius The new inner radius to set.
+     */
+    setInnerRadius(newInnerRadius: number): void;
+    /**
+     * Gets the start angle of the gauge.
+     * @returns {number}
+     */
+    getStartAngle(): number;
+    /**
+     * Sets the start angle of the gauge.
+     * @param {number} newStartAngle The new start angle to set.
+     */
+    setStartAngle(newStartAngle: number): void;
+    /**
+     * Gets the end angle of the gauge.
+     * @returns {number}
+     */
+    getEndAngle(): number;
+    /**
+     * Sets the end angle of the gauge.
+     * @param {number} newEndAngle The new end angle to set.
+     */
+    setEndAngle(newEndAngle: number): void;
+    /**
+     * Get 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
+     */
+    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).
+     *
+     * @returns {number | undefined}
+     */
+    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).
+     * For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)
+     *
+     * @param {number} featureIndex - the index of the feature to be rendered
+     */
+    setFeatureIndex(featureIndex: number): Promise<void>;
+    /**
+     * Remove 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
+     *
+     * @returns {GaugeChartSubTypes}
+     */
+    getGaugeSubType(): GaugeChartSubTypes;
+    /**
+     * Gets the visibility of the gauge's needle.
+     * @returns {boolean}
+     */
+    getNeedleVisibility(): boolean;
+    /**
+     * Sets the visibility of the gauge's needle.
+     * @param {boolean} newNeedleVisibility The new visibility to set.
+     */
+    setNeedleVisibility(newNeedleVisibility: boolean): void;
+    /**
+     * Gets the symbol of the gauge's needle.
+     * @returns {ISimpleFillSymbol | undefined}
+     */
+    getNeedleSymbol(): ISimpleFillSymbol | undefined;
+    /**
+     * Sets the symbol of the gauge's needle.
+     * @param {ISimpleFillSymbol | undefined} newNeedleSymbol The new needle symbol to set.
+     */
+    setNeedleSymbol(newNeedleSymbol: ISimpleFillSymbol | undefined): void;
+    /**
+     * Gets the start width of the gauge's needle.
+     * @returns {number | null | undefined}
+     */
+    getNeedleStartWidth(): number | null | undefined;
+    /**
+     * Sets the start width of the gauge's needle.
+     * @param {number | null | undefined} newNeedleStartWidth The new start width to set.
+     */
+    setNeedleStartWidth(newNeedleStartWidth: number | null | undefined): void;
+    /**
+     * Gets the end width of the gauge's needle.
+     * @returns {number | null | undefined}
+     */
+    getNeedleEndWidth(): number | null | undefined;
+    /**
+     * Sets the end width of the gauge's needle.
+     * @param {number | null | undefined} newNeedleEndWidth The new end width to set.
+     */
+    setNeedleEndWidth(newNeedleEndWidth: number | null | undefined): void;
+    /**
+     * Gets the inner radius of the gauge's needle.
+     * @returns {number | null | undefined}
+     */
+    getNeedleInnerRadius(): number | null | undefined;
+    /**
+     * Sets the inner radius of the gauge's needle.
+     * @param {number | null | undefined} newNeedleInnerRadius The new inner radius to set.
+     */
+    setNeedleInnerRadius(newNeedleInnerRadius: number): void;
+    /**
+     * Gets whether to display the pin for the gauge's needle.
+     * @returns {boolean}
+     */
+    getNeedleDisplayPin(): boolean;
+    /**
+     * Sets whether to display the pin for the gauge's needle.
+     * @param {boolean} newNeedleDisplayPin The new display pin state.
+     */
+    setNeedleDisplayPin(newNeedleDisplayPin: boolean): void;
+    /**
+     * Gets whether the inner label is visible.
+     * @returns {boolean}
+     */
+    getInnerLabelVisible(): boolean;
+    /**
+     * Sets whether the inner label is visible.
+     * @param {boolean} newNeedleLabelVisibility The new visibility state.
+     */
+    setInnerLabelVisibility(newNeedleLabelVisibility: boolean): void;
+    /**
+     * Gets the inner label content symbol.
+     * @returns {WebChartTextSymbol | undefined}
+     */
+    getInnerLabelContent(): WebChartTextSymbol | undefined;
+    /**
+     * Sets the inner label content symbol.
+     * @param {WebChartTextSymbol | undefined} newInnerLabelContent The new content symbol to set.
+     */
+    setInnerLabelContent(newInnerLabelContent: WebChartTextSymbol | undefined): void;
+    /**
+     * Gets whether the axis ticks are visible.
+     * @returns {boolean}
+     */
+    getAxisTickVisibility(): boolean;
+    /**
+     * Sets whether the axis ticks are visible.
+     * @param {boolean} newAxisTickVisibility The new visibility state.
+     */
+    setAxisTickVisibility(newAxisTickVisibility: boolean): void;
+    /**
+     * Gets the labels increment for the gauge.
+     * @returns {number | undefined}
+     */
+    getLabelsIncrement(): number | undefined;
+    /**
+     * Sets the labels increment for the gauge.
+     * @param {number | undefined} newLabelsIncrement The new increment to set.
+     */
+    setLabelsIncrement(newLabelsIncrement: 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.
+     */
+    setOnlyShowFirstAndLastLabels(newOnlyShowFirstAndLastLabels: 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

@@ -0,0 +1,123 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { ISimpleFillSymbol, WebChartGaugeSeries, WebChartTextSymbol } from '@arcgis/charts-spec';
+/**
+ * Gets the visibility of the needle.
+ * @param config
+ */
+export declare const getNeedleVisibility: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
+/**
+ * Sets the visibility of the needle.
+ * @param visible
+ * @param config
+ */
+export declare const setNeedleVisibility: (visible: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets the symbol of the needle.
+ * @param config
+ */
+export declare const getNeedleSymbol: (config: ChartConfig<WebChartGaugeSeries>) => ISimpleFillSymbol | undefined;
+/**
+ * Sets the symbol of the needle.
+ * @param symbol
+ * @param config
+ */
+export declare const setNeedleSymbol: (symbol: ISimpleFillSymbol | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets the start width of the needle.
+ * @param config
+ */
+export declare const getNeedleStartWidth: (config: ChartConfig<WebChartGaugeSeries>) => number | null | undefined;
+/**
+ * Sets the start width of the needle.
+ * @param startWidth
+ * @param config
+ */
+export declare const setNeedleStartWidth: (startWidth: number | null | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets the end width of the needle.
+ * @param config
+ */
+export declare const getNeedleEndWidth: (config: ChartConfig<WebChartGaugeSeries>) => number | null | undefined;
+/**
+ * Sets the end width of the needle.
+ * @param endWidth
+ * @param config
+ */
+export declare const setNeedleEndWidth: (endWidth: number | null | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets the inner radius of the needle.
+ * @param config
+ */
+export declare const getNeedleInnerRadius: (config: ChartConfig<WebChartGaugeSeries>) => number | null | undefined;
+/**
+ * Sets the inner radius of the needle.
+ * @param innerRadius
+ * @param config
+ */
+export declare const setNeedleInnerRadius: (innerRadius: number | null | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets whether to display the pin for the needle.
+ * @param config
+ */
+export declare const getNeedleDisplayPin: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
+/**
+ * Sets whether to display the pin for the needle.
+ * @param displayPin
+ * @param config
+ */
+export declare const setNeedleDisplayPin: (displayPin: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets whether the gauge inner label is visible.
+ * @param config
+ */
+export declare const getInnerLabelVisible: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
+/**
+ * Sets whether the gauge inner label is visible.
+ * @param visible
+ * @param config
+ */
+export declare const setInnerLabelVisibility: (visible: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets the content of the gauge inner label.
+ * @param config
+ */
+export declare const getInnerLabelContent: (config: ChartConfig<WebChartGaugeSeries>) => WebChartTextSymbol | undefined;
+/**
+ * Sets the content of the gauge inner label.
+ * @param content
+ * @param config
+ */
+export declare const setInnerLabelContent: (content: WebChartTextSymbol | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets the visibility of the gauge axis ticks.
+ * @param config
+ */
+export declare const getAxisTickVisibility: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
+/**
+ * Sets the visibility of the gauge axis ticks.
+ * @param visible
+ * @param config
+ */
+export declare const setAxisTickVisibility: (visible: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets the increment between axis labels.
+ * @param config
+ */
+export declare const getLabelsIncrement: (config: ChartConfig<WebChartGaugeSeries>) => number | undefined;
+/**
+ * Sets the increment between axis labels.
+ * @param increment
+ * @param config
+ */
+export declare const setLabelsIncrement: (increment: number | undefined, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * Gets whether to only show the first and last axis labels.
+ * @param config
+ */
+export declare const getShowOnlyMinMaxLabels: (config: ChartConfig<WebChartGaugeSeries>) => boolean;
+/**
+ * Sets whether to only show the first and last axis labels.
+ * @param value
+ * @param config
+ */
+export declare const setShowOnlyMinMaxLabels: (value: boolean, config: ChartConfig<WebChartGaugeSeries>) => void;

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

@@ -0,0 +1,74 @@
+import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { WebChartGaugeSeries, RESTStatisticType } from '@arcgis/charts-spec';
+import { LayerInfo } from '../../interfaces/common';
+export declare const updateSeries: (props: {
+    config: ChartConfig<WebChartGaugeSeries>;
+    layerInfo: LayerInfo;
+    field: string;
+    aggregationType: Exclude<RESTStatisticType, "no_aggregation">;
+}) => Promise<void>;
+/**
+ * Gets the aggregation type from the config.
+ * @param config - the guage chart config
+ */
+export declare const getAggregationType: (config: ChartConfig<WebChartGaugeSeries>) => Exclude<RESTStatisticType, "no_aggregation">;
+/**
+ * Sets the aggregation type to the config.
+ * @param newAggregationType
+ * @param config
+ * @param layerInfo
+ */
+export declare const setAggregationType: (newAggregationType: Exclude<RESTStatisticType, "no_aggregation">, config: ChartConfig<WebChartGaugeSeries>, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * Checks if the feature index is valid.
+ *
+ * NOTE: It should be a number and greater than or equal to 0.
+ * @param { number | undefined } featureIndex - the feature index
+ *
+ * @returns boolean
+ */
+export declare const isValidFeatureIndex: (featureIndex?: number) => boolean;
+/**
+ * get 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
+ */
+export declare const setField: (newField: string, config: ChartConfig<WebChartGaugeSeries>, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * get 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
+ */
+export declare const setInnerRadius: (newInnerRadius: number, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * get 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
+ */
+export declare const setStartAngle: (newStartAngle: number, config: ChartConfig<WebChartGaugeSeries>) => void;
+/**
+ * get 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
+ */
+export declare const setEndAngle: (newEndAngle: number, config: ChartConfig<WebChartGaugeSeries>) => void;

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

@@ -0,0 +1,42 @@
+import { ChartConfig } from '@arcgis/charts-shared-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
+ */
+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
+ */
+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).
+ * 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
+ */
+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
+ *
+ * @returns {GaugeChartSubTypes}
+ */
+export declare const getGaugeSubType: (config: ChartConfig<WebChartGaugeSeries>) => GaugeChartSubTypes;

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

@@ -0,0 +1,148 @@
+import { ChartConfig, XYChartTypes } from '@arcgis/charts-shared-utils';
+import { WebChart, WebChartDataTransformations, ISimpleFillSymbol, ISimpleLineSymbol, WebChartHistogramSeries, HistogramOverlays } from '@arcgis/charts-spec';
+import { LayerInfo } from '../interfaces/common';
+import { ModelParams } from '../interfaces/chart-interfaces';
+import { ChartModel } from '../chart-model/customElement.js';
+import { ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides, ModelWithLegend, ModelWithXYAxes, ModelWithTooltips } from '../mixins';
+export declare class HistogramModel extends ChartModel {
+    /**
+     * Current configuration used for the histogram.
+     */
+    protected _config: ChartConfig<WebChartHistogramSeries, WebChart>;
+    protected _chartType: XYChartTypes;
+    protected layerInfo: LayerInfo;
+    setup(params: ModelParams<ChartConfig<WebChartHistogramSeries>>): Promise<void>;
+    /**
+     * Gets numeric field. This is the field used to create a histogram to visualize the frequency distribution of its values.
+     * @returns {string}
+     */
+    getNumericField(): string;
+    /**
+     * Sets numeric field. This is the field used to create a histogram to visualize the frequency distribution of its values.
+     * @param {string} newNumericField
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setNumericField(newNumericField: string): Promise<void>;
+    /**
+     * Gets the number of bins used to create the histogram.
+     * @returns {number}
+     */
+    getBinCount(): number;
+    /**
+     * Sets the number of bins used to create the histogram.
+     * @param {number} newBinCount
+     */
+    setBinCount(newBinCount: number): void;
+    /**
+     * Gets the fill color used for the bins in the histogram.
+     * @returns {ISimpleFillSymbol}
+     */
+    getBinColor(): ISimpleFillSymbol;
+    /**
+     * Sets the fill color used for the bins in the histogram.
+     * @param {ISimpleFillSymbol} newBinColor
+     */
+    setBinColor(newBinColor: ISimpleFillSymbol): void;
+    /**
+     * Gets the data transformation type used in the histogram.
+     * @returns {WebChartDataTransformations}
+     */
+    getDataTransformationType(): WebChartDataTransformations;
+    /**
+     * Sets the data transformation type used in the histogram.
+     * @param {WebChartDataTransformations} newDataTransformationType
+     */
+    setDataTransformationType(newDataTransformationType: WebChartDataTransformations): void;
+    /**
+     * Gets the line color used for the mean overlay in the histogram.
+     * @returns {ISimpleLineSymbol}
+     */
+    getMeanColor(): ISimpleLineSymbol;
+    /**
+     * Sets the line color used for the mean overlay in the histogram.
+     * @param {ISimpleLineSymbol} newMeanColor
+     */
+    setMeanColor(newMeanColor: ISimpleLineSymbol): void;
+    /**
+     * Gets the line color used for the median overlay in the histogram.
+     * @returns {ISimpleLineSymbol}
+     */
+    getMedianColor(): ISimpleLineSymbol;
+    /**
+     * Sets the line color used for the median overlay in the histogram.
+     * @param {ISimpleLineSymbol} newMedianColor
+     */
+    setMedianColor(newMedianColor: ISimpleLineSymbol): void;
+    /**
+     * Gets the line color used for the normal distribution overlay in the histogram.
+     * @returns {ISimpleLineSymbol}
+     */
+    getNormalDistColor(): ISimpleLineSymbol;
+    /**
+     * Sets the line color used for the normal distribution overlay in the histogram.
+     * @param {ISimpleLineSymbol} newNormalDistColor
+     */
+    setNormalDistColor(newNormalDistColor: ISimpleLineSymbol): void;
+    /**
+     * Gets the line color used for the standard deviation overlay in the histogram.
+     * @returns {ISimpleLineSymbol}
+     */
+    getStandardDevColor(): ISimpleLineSymbol;
+    /**
+     * Sets the line color used for the standard deviation overlay in the histogram.
+     * @param {ISimpleLineSymbol} newStandardDevColor
+     */
+    setStandardDevColor(newStandardDevColor: ISimpleLineSymbol): void;
+    /**
+     * Gets whether the normal distribution overlay is shown in the histogram.
+     * @returns {boolean}
+     */
+    getShowNormalDistOverlay(): boolean;
+    /**
+     * Sets whether the normal distribution overlay is shown in the histogram.
+     * @param {boolean} newShowNormalDistOverlay
+     */
+    setShowNormalDistOverlay(newShowNormalDistOverlay: boolean): void;
+    /**
+     * Gets whether the mean overlay is shown in the histogram.
+     * @returns {boolean}
+     */
+    getShowMeanOverlay(): boolean;
+    /**
+     * Sets whether the mean overlay is shown in the histogram.
+     * @param {boolean} newShowMeanOverlay
+     */
+    setShowMeanOverlay(newShowMeanOverlay: boolean): void;
+    /**
+     * Gets whether the median overlay is shown in the histogram.
+     * @returns {boolean}
+     */
+    getShowMedianOverlay(): boolean;
+    /**
+     * Sets whether the median overlay is shown in the histogram.
+     * @param {boolean} newShowMedianOverlay
+     */
+    setShowMedianOverlay(newShowMedianOverlay: boolean): void;
+    /**
+     * Gets whether the standard deviation overlay is shown in the histogram.
+     * @returns {boolean}
+     */
+    getShowStandardDevOverlay(): boolean;
+    /**
+     * Sets whether the standard deviation overlay is shown in the histogram.
+     * @param {boolean} newShowStandardDevOverlay
+     */
+    setShowStandardDevOverlay(newShowStandardDevOverlay: boolean): void;
+    /**
+     * Get the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
+     */
+    getSeriesOverlay(): HistogramOverlays | undefined;
+    /**
+     * Set the chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
+     * @param newOverlays - the new overlays
+     */
+    setSeriesOverlays(newSeriesOverlay: HistogramOverlays): void;
+    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+}
+export interface HistogramModel extends ModelWithXYAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides {
+}