@arcgis/charts-components 5.0.0-next.99 → 5.1.0-next.0

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

@@ -1,91 +1,70 @@
-import { ChartConfig, XYChartTypes } from '../../utils';
-import { WebChart, WebChartDataTransformations, ISimpleFillSymbol, ISimpleLineSymbol, HistogramOverlays } from '../../spec';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { ChartModel } from '../chart-model/chart-model';
-import { ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides, ModelWithLegend, ModelWithTooltips, ModelWithMultiAxes } from '../mixins';
-export declare class HistogramModel extends ChartModel {
-    /**
-     * Current configuration used for the histogram.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.Histogram, WebChart>;
-    protected _chartType: XYChartTypes;
-    protected layerInfo: LayerInfo;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.Histogram>>): Promise<void>;
-    /**
-     * Numeric field used to create the histogram to visualize the frequency distribution of its values.
-     */
-    get numericField(): string;
-    set numericField(numericField: string);
-    /**
-     * Number of bins used to create the histogram.
-     */
-    get binCount(): number;
-    set binCount(binCount: number);
-    /**
-     * Fill symbol used for the bins in the histogram.
-     */
-    get binSymbol(): ISimpleFillSymbol;
-    set binSymbol(symbol: ISimpleFillSymbol);
-    /**
-     * Data transformation type used in the histogram.
-     */
-    get dataTransformationType(): WebChartDataTransformations;
-    set dataTransformationType(dataTransformationType: WebChartDataTransformations);
-    /**
-     * Line symbol used for the mean overlay in the histogram.
-     */
-    get meanSymbol(): ISimpleLineSymbol;
-    set meanSymbol(symbol: ISimpleLineSymbol);
-    /**
-     * Line symbol used for the median overlay in the histogram.
-     */
-    get medianSymbol(): ISimpleLineSymbol;
-    set medianSymbol(symbol: ISimpleLineSymbol);
-    /**
-     * Line symbol used for the normal distribution overlay in the histogram.
-     */
-    get normalDistSymbol(): ISimpleLineSymbol;
-    set normalDistSymbol(symbol: ISimpleLineSymbol);
-    /**
-     * Line symbol used for the standard deviation overlay in the histogram.
-     */
-    get standardDevSymbol(): ISimpleLineSymbol;
-    set standardDevSymbol(symbol: ISimpleLineSymbol);
-    /**
-     * Whether the normal distribution overlay is shown in the histogram.
-     */
-    get showNormalDistOverlay(): boolean;
-    set showNormalDistOverlay(show: boolean);
-    /**
-     * Whether the mean overlay is shown in the histogram.
-     */
-    get showMeanOverlay(): boolean;
-    set showMeanOverlay(show: boolean);
-    /**
-     * Whether the median overlay is shown in the histogram.
-     */
-    get showMedianOverlay(): boolean;
-    set showMedianOverlay(show: boolean);
-    /**
-     * Whether the standard deviation overlay is shown in the histogram.
-     */
-    get showStandardDevOverlay(): boolean;
-    set showStandardDevOverlay(show: boolean);
-    /**
-     * Chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**.
-     */
-    get seriesOverlays(): HistogramOverlays | undefined;
-    set seriesOverlays(overlays: HistogramOverlays | undefined);
-    /**
-     * Generate the proper chart title given the current config.
-     */
-    generateChartTitle(): string;
-    /**
-     * Generate the proper x-axis title given the current config.
-     */
-    generateXAxisTitle(): string;
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-}
-export interface HistogramModel extends ModelWithMultiAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithYGuides {
+import type { LayerInfo, ModelTypes } from "../interfaces/common.js";
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { WithColorMatch } from "../properties/color-match.js";
+import type { WithDataLabelsVisibility } from "../properties/data-labels/data-labels-visibility.js";
+import type { WithDataLabelsSymbol } from "../properties/data-labels/data-labels-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 { WithAxisLabelsSymbol } from "../properties/axes/axis-labels-symbol.js";
+import type { WithAxisLinesSymbol } from "../properties/axes/axis-lines-symbol.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { HistogramOverlays, WebChart } from "../../spec/web-chart.js";
+import type { WebChartDataTransformations } from "../../spec/chart-object-literals.js";
+import type { ISimpleFillSymbol, ISimpleLineSymbol } from "../../spec/rest-js-types.js";
+import type { XYChartTypes } from "../../utils/misc/index.js";
+import type { ModelWithMultiAxes } from "../mixins/model-with-multi-axes.js";
+import type { ModelWithLegend } from "../mixins/model-with-legend.js";
+import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
+import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
+
+export class HistogramModel extends HistogramModelSuperclass {
+  /** Chart type. */
+  protected _chartType: XYChartTypes;
+  /** Current configuration used for the histogram. */
+  protected _config: ChartConfig<typeof ModelTypes.Histogram, WebChart>;
+  /** Number of bins used to create the histogram. */
+  accessor binCount: number;
+  /** Fill symbol used for the bins in the histogram. */
+  accessor binSymbol: ISimpleFillSymbol;
+  /** Data transformation type used in the histogram. */
+  accessor dataTransformationType: WebChartDataTransformations;
+  /** Grouping of layer-related properties to be passed to external function more compactly. */
+  protected layerInfo: LayerInfo;
+  /** Line symbol used for the mean overlay in the histogram. */
+  accessor meanSymbol: ISimpleLineSymbol;
+  /** Line symbol used for the median overlay in the histogram. */
+  accessor medianSymbol: ISimpleLineSymbol;
+  /** Line symbol used for the normal distribution overlay in the histogram. */
+  accessor normalDistSymbol: ISimpleLineSymbol;
+  /** Numeric field used to create the histogram to visualize the frequency distribution of its values. */
+  accessor numericField: string;
+  /** Chart overlays for the series. Histogram supports 4 overlays: **mean**, **median**, **standardDeviation** and **comparisonDistribution**. */
+  accessor seriesOverlays: HistogramOverlays | undefined;
+  /** Whether the mean overlay is shown in the histogram. */
+  accessor showMeanOverlay: boolean;
+  /** Whether the median overlay is shown in the histogram. */
+  accessor showMedianOverlay: boolean;
+  /** Whether the normal distribution overlay is shown in the histogram. */
+  accessor showNormalDistOverlay: boolean;
+  /** Whether the standard deviation overlay is shown in the histogram. */
+  accessor showStandardDevOverlay: boolean;
+  /** Line symbol used for the standard deviation overlay in the histogram. */
+  accessor standardDevSymbol: ISimpleLineSymbol;
+  /** Generate the proper chart title given the current config. */
+  generateChartTitle(): string;
+  /** A function that generates the default config object when creating a new chart. */
+  protected generateDefaultConfig(): Omit<ChartConfig<"histogram", WebChart>, "iLayer">;
+  /**
+   * 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.Histogram>>): Promise<void>;
 }
+declare const HistogramModelSuperclass: typeof ChartModel & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText & typeof ModelWithYGuides & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes

package/dist/model/index.d.ts

@@ -1,17 +1,18 @@
-export type * from './chart-model/chart-model.js';
-export type * from './chart-model/utils/types.js';
-export type * from './bar-chart-model/bar-chart-model.js';
-export type * from './box-plot-model/box-plot-model.js';
-export type * from './gauge-model/gauge-model.js';
-export type * from './histogram-model/histogram-model.js';
-export type * from './line-chart-model/line-chart-model.js';
-export type * from './radar-chart-model/radar-chart-model.js';
-export type * from './pie-chart-model/pie-chart-model.js';
-export type * from './pie-chart-model/pie-chart-legend-model.js';
-export type * from './scatterplot-model/scatterplot-model.js';
-export type * from './serial-chart-model/serial-chart-model.js';
-export type * from './combo-bar-line-chart-model/combo-bar-line-chart-model.js';
-export type * from './interfaces/chart-interfaces.js';
-export * from './interfaces/common.js';
-export * from './shared/type-guards.js';
-export * from './shared/setup-utils.js';
+export type * from "./chart-model/chart-model";
+export type * from "./chart-model/utils/types";
+export type * from "./bar-chart-model/bar-chart-model";
+export type * from "./box-plot-model/box-plot-model";
+export type * from "./gauge-model/gauge-model";
+export type * from "./histogram-model/histogram-model";
+export type * from "./line-chart-model/line-chart-model";
+export type * from "./radar-chart-model/radar-chart-model";
+export type * from "./pie-chart-model/pie-chart-model";
+export type * from "./pie-chart-model/pie-chart-legend-model";
+export type * from "./scatterplot-model/scatterplot-model";
+export type * from "./serial-chart-model/serial-chart-model";
+export type * from "./combo-bar-line-chart-model/combo-bar-line-chart-model";
+export type * from "./interfaces/chart-interfaces";
+export * from "./interfaces/common";
+export * from "./shared/type-guards";
+export * from "./shared/setup-utils";
+

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

@@ -1,29 +1,21 @@
-import { ChartConfig } from '../../utils';
-import { IFeatureLayer, WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
-import { ModelTypes } from './common';
-import { SupportedLayer } from '../../interfaces';
-/**
- * Parameters for creating a chart model.
- */
+import type { ModelTypes } from "./common.js";
+import type { SupportedLayer } from "../../interfaces.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { IFeatureLayer } from "../../spec/rest-js-types.js";
+import type { WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from "../../spec/web-chart.js";
+
+/** Parameters for creating a chart model. */
 export type ModelParams<T extends ChartConfig> = {
-    /**
-     * Layer instance associated with the chart.
-     */
-    layer?: SupportedLayer;
-    /**
-     * Layer description to be used when the `layer` property is not set.
-     */
-    iLayer?: IFeatureLayer;
-    /**
-     * Chart config object to be edited. If not provided, a new config will be created using default values.
-     */
-    config?: T;
+  /** Layer instance associated with the chart. */
+  layer?: SupportedLayer;
+  /** Layer description to be used when the `layer` property is not set. */
+  iLayer?: IFeatureLayer;
+  /** Chart config object to be edited. If not provided, a new config will be created using default values. */
+  config?: T;
 };
-/**
- * Type alias for the supported serial chart config.
- */
+
+/** Type alias for the supported serial chart config. */
 export type SerialChartConfig = ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.HeatChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-/**
- * Type alias for the supported serial chart series.
- */
-export type SerialChartSeries = WebChartBarChartSeries | WebChartHeatChartSeries | WebChartLineChartSeries | WebChartRadarChartSeries;
+
+/** Type alias for the supported serial chart series. */
+export type SerialChartSeries = WebChartBarChartSeries | WebChartHeatChartSeries | WebChartLineChartSeries | WebChartRadarChartSeries;

package/dist/model/interfaces/common.d.ts

@@ -1,25 +1,31 @@
-import { SupportedLayer } from '../../interfaces';
-import { IField, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartTypes } from '../../spec';
-import { SupportedChartSeries } from '../../utils';
-import { BarChartModel } from '../bar-chart-model/bar-chart-model';
-import { BoxPlotModel } from '../box-plot-model/box-plot-model';
-import { ComboBarLineChartModel } from '../combo-bar-line-chart-model/combo-bar-line-chart-model';
-import { GaugeModel } from '../gauge-model/gauge-model';
-import { HistogramModel } from '../histogram-model/histogram-model';
-import { LineChartModel } from '../line-chart-model/line-chart-model';
-import { PieChartModel } from '../pie-chart-model/pie-chart-model';
-import { RadarChartModel } from '../radar-chart-model/radar-chart-model';
-import { ScatterplotModel } from '../scatterplot-model/scatterplot-model';
-export declare const customSortString = "customSort";
-export declare const SerialChartDataSortingKinds: {
+import type { SupportedLayer } from "../../interfaces.js";
+import type { WebChartTypes } from "../../spec/chart-object-literals.js";
+import type { IField } from "../../spec/rest-js-types.js";
+import type { WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries } from "../../spec/web-chart.js";
+import type { SupportedChartSeries } from "../../utils/types/index.js";
+import type { BarChartModel } from "../bar-chart-model/bar-chart-model.js";
+import type { BoxPlotModel } from "../box-plot-model/box-plot-model.js";
+import type { ComboBarLineChartModel } from "../combo-bar-line-chart-model/combo-bar-line-chart-model.js";
+import type { GaugeModel } from "../gauge-model/gauge-model.js";
+import type { HistogramModel } from "../histogram-model/histogram-model.js";
+import type { LineChartModel } from "../line-chart-model/line-chart-model.js";
+import type { PieChartModel } from "../pie-chart-model/pie-chart-model.js";
+import type { RadarChartModel } from "../radar-chart-model/radar-chart-model.js";
+import type { ScatterplotModel } from "../scatterplot-model/scatterplot-model.js";
+
+export const customSortString: "customSort";
+
+export const SerialChartDataSortingKinds: {
     readonly xAxisAsc: "xAxisAsc";
     readonly xAxisDesc: "xAxisDesc";
     readonly yAxisAsc: "yAxisAsc";
     readonly yAxisDesc: "yAxisDesc";
     readonly customSort: "customSort";
 };
+
 export type SerialChartDataSortingKinds = (typeof SerialChartDataSortingKinds)[keyof typeof SerialChartDataSortingKinds];
-export declare const BoxPlotDataSortingKinds: {
+
+export const BoxPlotDataSortingKinds: {
     readonly xAxisAsc: "xAxisAsc";
     readonly xAxisDesc: "xAxisDesc";
     readonly meanAsc: "meanAsc";
@@ -28,34 +34,44 @@ export declare const BoxPlotDataSortingKinds: {
     readonly medianDesc: "medianDesc";
     readonly customSort: "customSort";
 };
+
 export type BoxPlotDataSortingKinds = (typeof BoxPlotDataSortingKinds)[keyof typeof BoxPlotDataSortingKinds];
-export declare const HeatChartDataSortingKinds: {
+
+export const HeatChartDataSortingKinds: {
     readonly Asc: "Asc";
     readonly Desc: "Desc";
     readonly customSort: "customSort";
 };
+
 export type HeatChartDataSortingKinds = (typeof HeatChartDataSortingKinds)[keyof typeof HeatChartDataSortingKinds];
-export declare const PieChartDataSortingKinds: {
+
+export const PieChartDataSortingKinds: {
     readonly labelAsc: "labelAsc";
     readonly labelDesc: "labelDesc";
     readonly valueAsc: "valueAsc";
     readonly valueDesc: "valueDesc";
     readonly customSort: "customSort";
 };
+
 export type PieChartDataSortingKinds = (typeof PieChartDataSortingKinds)[keyof typeof PieChartDataSortingKinds];
-export declare const PieChartDataModes: {
+
+export const PieChartDataModes: {
     readonly Category: "category";
     readonly Fields: "fields";
 };
+
 export type PieChartDataModes = (typeof PieChartDataModes)[keyof typeof PieChartDataModes];
-export declare const PieChartSlicesDisplay: {
+
+export const PieChartSlicesDisplay: {
     readonly Category: "category";
     readonly Value: "value";
     readonly Percentage: "percentage";
     readonly Both: "both";
 };
+
 export type PieChartSlicesDisplay = (typeof PieChartSlicesDisplay)[keyof typeof PieChartSlicesDisplay];
-export declare const FormatKeys: {
+
+export const FormatKeys: {
     readonly TextElements: "textElements";
     readonly XAxisTitle: "xAxisTitle";
     readonly YAxisTitle: "yAxisTitle";
@@ -71,14 +87,18 @@ export declare const FormatKeys: {
     readonly AxisLines: "axisLines";
     readonly GridLines: "gridLines";
 };
+
 export type FormatKeys = (typeof FormatKeys)[keyof typeof FormatKeys];
-export declare const LineFormatKeys: {
+
+export const LineFormatKeys: {
     readonly AxisLines: "axisLines";
     readonly GridLines: "gridLines";
     readonly LeaderLines: "leaderLines";
 };
+
 export type LineFormatKeys = (typeof LineFormatKeys)[keyof typeof LineFormatKeys];
-export declare const TextFormatKeys: {
+
+export const TextFormatKeys: {
     readonly Title: "title";
     readonly XAxisTitle: "xAxisTitle";
     readonly YAxisTitle: "yAxisTitle";
@@ -89,46 +109,45 @@ export declare const TextFormatKeys: {
     readonly Description: "description";
     readonly DataLabels: "dataLabels";
 };
+
 export type TextFormatKeys = (typeof TextFormatKeys)[keyof typeof TextFormatKeys];
-export declare const ColorFormatKeys: {
-    readonly Background: "background";
-};
+
+export const ColorFormatKeys: { readonly Background: "background"; };
+
 export type ColorFormatKeys = (typeof ColorFormatKeys)[keyof typeof ColorFormatKeys];
-/**
- * Axis orientation of the guide.
- */
-export declare const GuideOrientation: {
+
+/** Axis orientation of the guide. */
+export const GuideOrientation: {
     readonly X: "x";
     readonly Y: "y";
 };
+
 export type GuideOrientation = (typeof GuideOrientation)[keyof typeof GuideOrientation];
+
 export interface SplitByFieldInfos {
-    categoriesArray: (number | string)[];
-    splitByFieldType: string | undefined;
-    numericalField: string;
+  categoriesArray: (number | string)[];
+  splitByFieldType?: string;
+  numericalField: string;
 }
+
 export interface PieSeriesDisplayOptions {
-    displayCategoryOnDataLabel: boolean;
-    displayNumericValueOnDataLabel: boolean;
-    displayPercentageOnDataLabel: boolean;
-    displayNumericValue: boolean;
-    displayPercentage: boolean;
+  displayCategoryOnDataLabel: boolean;
+  displayNumericValueOnDataLabel: boolean;
+  displayPercentageOnDataLabel: boolean;
+  displayNumericValue: boolean;
+  displayPercentage: boolean;
 }
+
 export interface LayerInfo {
-    /**
-     * Layer used for this bar chart.
-     */
-    layer: SupportedLayer;
-    /**
-     * Fields information for the layer.
-     */
-    layerFieldsInfo: IField[];
-    /**
-     * Object ID field name for the layer.
-     */
-    objectIdField: string;
+  /** Layer used for this bar chart. */
+  layer: SupportedLayer;
+  /** Fields information for the layer. */
+  layerFieldsInfo: IField[];
+  /** Object ID field name for the layer. */
+  objectIdField: string;
 }
-export declare const ModelTypes: {
+
+export const ModelTypes: {
     readonly BarChart: "barChart";
     readonly LineChart: "lineChart";
     readonly ComboBarLineChart: "comboBarLineChart";
@@ -140,7 +159,11 @@ export declare const ModelTypes: {
     readonly RadarChart: "radarChart";
     readonly HeatChart: "heatChart";
 };
+
 export type ModelTypes = (typeof ModelTypes)[keyof typeof ModelTypes];
+
 export type ModelTypeToSeriesType<T extends ModelTypes> = T extends typeof ModelTypes.BarChart ? WebChartBarChartSeries : T extends typeof ModelTypes.LineChart ? WebChartLineChartSeries : T extends typeof ModelTypes.ComboBarLineChart ? WebChartBarChartSeries | WebChartLineChartSeries : T extends typeof ModelTypes.BoxPlot ? WebChartBoxPlotSeries | WebChartLineChartSeries : T extends typeof ModelTypes.PieChart ? WebChartPieChartSeries : T extends typeof ModelTypes.Scatterplot ? WebChartScatterplotSeries : T extends typeof ModelTypes.Histogram ? WebChartHistogramSeries : T extends typeof ModelTypes.Gauge ? WebChartGaugeSeries : T extends typeof ModelTypes.RadarChart ? WebChartRadarChartSeries : T extends typeof ModelTypes.HeatChart ? WebChartHeatChartSeries : SupportedChartSeries;
+
 export type SeriesTypeToChartType<T extends SupportedChartSeries> = T extends WebChartBarChartSeries ? typeof WebChartTypes.BarSeries : T extends WebChartLineChartSeries ? typeof WebChartTypes.LineSeries : T extends WebChartBoxPlotSeries ? typeof WebChartTypes.BoxPlotSeries : T extends WebChartPieChartSeries ? typeof WebChartTypes.PieSeries : T extends WebChartScatterplotSeries ? typeof WebChartTypes.ScatterSeries : T extends WebChartHistogramSeries ? typeof WebChartTypes.HistogramSeries : T extends WebChartGaugeSeries ? typeof WebChartTypes.GaugeSeries : T extends WebChartRadarChartSeries ? typeof WebChartTypes.RadarSeries : T extends WebChartHeatChartSeries ? typeof WebChartTypes.HeatSeries : never;
-export type ModelOfType<T> = T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterplotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : T extends typeof ModelTypes.HeatChart ? never : BarChartModel;
+
+export type ModelOfType<T> = T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterplotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : T extends typeof ModelTypes.HeatChart ? never : BarChartModel;

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

@@ -1,34 +1,34 @@
-import { ChartConfig } from '../../utils';
-import { WebChart, WebChartLineChartSeries } from '../../spec';
-import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
-import { ModelWithBaselineStacking, ModelWithLineMarkerStyling } from '../mixins';
-import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
-export declare class LineChartModel extends SerialChartModel {
-    /**
-     * Current configuration used for the line chart.
-     */
-    protected _config: ChartConfig<typeof ModelTypes.LineChart, WebChart>;
-    /**
-     * Default series for the line chart. Used in resetting the series styling.
-     */
-    protected defaultSeries: WebChartLineChartSeries | undefined;
-    protected _chartType: "lineSeries";
-    protected layerInfo: LayerInfo;
-    setup(params: ModelParams<ChartConfig<typeof ModelTypes.LineChart>>): Promise<void>;
-    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
-    /**
-     * Initializes the default series for the line chart. Used in resetting the series styling.
-     */
-    protected initDefaultSeries(): void;
-    /**
-     * Resets the series styling to the default styling.
-     */
-    resetSeriesStyling(): void;
-    /**
-     * Returns whether the series styling is able to be reset.
-     */
-    resetAvailable(): boolean;
-}
-export interface LineChartModel extends ModelWithBaselineStacking, ModelWithLineMarkerStyling {
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { LayerInfo, ModelTypes } from "../interfaces/common.js";
+import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
+import type { WithNegativeValuesStackedToBaseline } from "../properties/series/negative-values-stacked-to-baseline.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { WebChart, WebChartLineChartSeries } from "../../spec/web-chart.js";
+import type { ModelWithLineMarkerStyling } from "../mixins/model-with-line-marker-styling.js";
+
+export class LineChartModel extends LineChartModelSuperclass {
+  /** Chart type. */
+  protected _chartType: "lineSeries";
+  /** Current configuration used for the line chart. */
+  protected _config: ChartConfig<typeof ModelTypes.LineChart, WebChart>;
+  /** Default series for the line chart. Used in resetting the series styling. */
+  protected defaultSeries?: WebChartLineChartSeries;
+  /** Grouping of layer-related properties to be passed to external function more compactly. */
+  protected layerInfo: LayerInfo;
+  /** A function that generates the default config object when creating a new chart. */
+  protected generateDefaultConfig(): Omit<ChartConfig<"lineChart", WebChart>, "iLayer">;
+  /** Initializes the default series for the line chart. Used in resetting the series styling. */
+  protected initDefaultSeries(): void;
+  /** Returns whether the series styling is able to be reset. */
+  resetAvailable(): boolean;
+  /** Resets the series styling to the default styling. */
+  resetSeriesStyling(): 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.LineChart>>): Promise<void>;
 }
+declare const LineChartModelSuperclass: typeof SerialChartModel & typeof ModelWithLineMarkerStyling & typeof WithNegativeValuesStackedToBaseline