@geoscene/charts-components 5.0.19

package/dist/loader.d.ts

@@ -0,0 +1,2 @@
+import "./index.js";
+export declare const defineCustomElements: import("@geoscene/lumina").DefineCustomElements;

package/dist/loader.js

@@ -0,0 +1,332 @@
+/* COPYRIGHT GeoScene - https://js.geoscene.cn/5.0/LICENSE.txt */
+import { r as e } from "./chunks/runtime.js";
+import { makeDefineCustomElements as t } from "@geoscene/lumina";
+const i = t(e, {
+  "geoscene-chart": [
+    () => import("./components/geoscene-chart/customElement.js"),
+    "_messages:,actionMode,allowUsingObjectIdStat,aria:,autoDestroyDisabled,autoDisposeChart,autoInverseDataLabelTextColor,chartIndex,chartLimits:,chartWillRender:,commonStrings:,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableAutoTheming,enableBetaFeatures,enableConfiguration,enableResponsiveFeatures,errorPolicy,featureIndex,filterByExtent,filterBySelection,gaugeInnerLabelFormatter:,guideTooltipFormatter:,hideEmptySeries,hideLicenseWatermark,hideLoaderAnimation,ignoreSmoothRenderingLimit,ignoreViewExtent,layer:,layerFieldsChangePolicy,layerFilterChangePolicy,layerItemId,layerRendererChangePolicy,legendPosition,legendValueLabelFormatter:,legendVisibility,loaderColors:,messageOverrides:,model:,nullAsValid,placeholder,queueChartCreation,replaceNoValueCategoryWithZero,returnFeaturesExtent,returnSelectionIndexes,returnSelectionOIDs,rotation,runtimeDataFilters:,secondaryYAxisLabelFormatter:,selectionData:,selectionTheme:,setTimeBinningInfoWhenNotProvided,showUIMessages,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,timeZone,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,errorAlert,exportAsCSV,exportAsImage,loadModel,notify,refresh,resetZoom,switchSelection",
+  ],
+  "geoscene-charts-action-bar": [
+    () => import("./components/geoscene-charts-action-bar/customElement.js"),
+    "_messages:,actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,commonStrings:,disableCSVExportForChartTypes:,editChartState,editChartTitle,editChartToggle,expanded,exportActionState,exportAsCSVState,exportAsCSVTitle,exportAsImageState,exportAsImageTitle,filterByExtentState,filterByExtentTitle,filterByExtentToggle,filterBySelectionState,filterBySelectionTitle,filterBySelectionToggle,forceDisableActions,fullExtentState,fullExtentTitle,fullExtentToggle,hiddenActions:,legendState,legendTitle,legendToggle,messageOverrides:,rotateChartState,rotateChartTitle,rotateChartToggle,selectionState,selectionTitle,selectionToggle,switchSelectionState,switchSelectionTitle,switchSelectionToggle,zoomState,zoomTitle,zoomToggle",
+  ],
+  "geoscene-charts-config-axes": [
+    () => import("./components/geoscene-charts-config-axes/customElement.js"),
+    "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,messageOverrides:,model:,open,showEnableXLogOption,showEnableYLogOption,showMaxXBoundOption,showMaxYBoundOption,showMinXBoundOption,showMinYBoundOption",
+  ],
+  "geoscene-charts-config-axis": [
+    () => import("./components/geoscene-charts-config-axis/customElement.js"),
+    "axisTitle,dataMaxValue,dataMinValue,initialMaxBound,initialMinBound,isXAxis,maxBoundMaxLimit,maxBoundMinLimit,messageOverrides:,minBoundMaxLimit,minBoundMinLimit,model:,showEnableLogOption,showMaxBoundOption,showMinBoundOption",
+  ],
+  "geoscene-charts-config-bar-chart": [
+    () =>
+      import("./components/geoscene-charts-config-bar-chart/customElement.js"),
+    "calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,seriesColor:,timeZone,usePopupTemplateFieldsInfo",
+  ],
+  "geoscene-charts-config-bar-chart-data": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-bar-chart-data/customElement.js"
+      ),
+    "layerFieldsInfo:,messageOverrides:,model:,open",
+  ],
+  "geoscene-charts-config-bar-chart-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-bar-chart-popover/customElement.js"
+      ),
+    "contentKind,headingTitle,isCustomSortDisabled,isNoAggregationDisabled,layerFieldsInfo:,messageOverrides:,open,referenceElement:,selectedContent;reposition",
+  ],
+  "geoscene-charts-config-bar-chart-series": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-bar-chart-series/customElement.js"
+      ),
+    "activeColorMatch,messageOverrides:,model:,popoverPlacement",
+  ],
+  "geoscene-charts-config-bar-chart-series-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-bar-chart-series-popover/customElement.js"
+      ),
+    "messageOverrides:,nullCategory:,open,placement,referenceElement:,selectedColor:,selectedName,selectedSeriesIndex;reposition",
+  ],
+  "geoscene-charts-config-box-plot": [
+    () =>
+      import("./components/geoscene-charts-config-box-plot/customElement.js"),
+    "calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,seriesColor:,usePopupTemplateFieldsInfo",
+  ],
+  "geoscene-charts-config-box-plot-data": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-box-plot-data/customElement.js"
+      ),
+    "layerFieldsInfo:,messageOverrides:,model:",
+  ],
+  "geoscene-charts-config-box-plot-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-box-plot-popover/customElement.js"
+      ),
+    "contentKind,headingTitle,isCustomSortDisabled,layerFieldsInfo:,messageOverrides:,open,referenceElement:,selectedContent;reposition",
+  ],
+  "geoscene-charts-config-box-plot-series": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-box-plot-series/customElement.js"
+      ),
+    "activeColorMatch,configSeriesOpen,messageOverrides:,model:,popoverPlacement",
+  ],
+  "geoscene-charts-config-box-plot-series-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-box-plot-series-popover/customElement.js"
+      ),
+    "isLineSymbol,labelCanBeConfigured,messageOverrides:,open,placement,referenceElement:,selectedColor:,selectedLineStyle,selectedLineWidth,selectedName,selectedSeriesIndex;reposition",
+  ],
+  "geoscene-charts-config-category-format": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-category-format/customElement.js"
+      ),
+    "categoryFormat:,messageOverrides:",
+  ],
+  "geoscene-charts-config-chart-rename-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-chart-rename-popover/customElement.js"
+      ),
+    "messageOverrides:,name,open,referenceElement:;reposition",
+  ],
+  "geoscene-charts-config-color-style": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-color-style/customElement.js"
+      ),
+    "enableClose,header,messageOverrides:,open,selectedColor:",
+  ],
+  "geoscene-charts-config-colors": [
+    () => import("./components/geoscene-charts-config-colors/customElement.js"),
+    "heading,messageOverrides:,rgba:",
+  ],
+  "geoscene-charts-config-create-flow": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-create-flow/customElement.js"
+      ),
+    "activeLayerId,calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,chartData:,disableEditing,filterBySelection,headerTitle,layerList:,messageOverrides:,modelList:,open,panelNumber,popoverPlacement,r2,selectedChartId,seriesColor:,syncChartsToLayers,timeZone,usePopupTemplateFieldsInfo;setFocus",
+  ],
+  "geoscene-charts-config-field-select": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-field-select/customElement.js"
+      ),
+    "disabled,invalid,label",
+  ],
+  "geoscene-charts-config-font-style": [
+    () =>
+      import("./components/geoscene-charts-config-font-style/customElement.js"),
+    "enableClose,fontStyle:,header,messageOverrides:,open",
+  ],
+  "geoscene-charts-config-format": [
+    () => import("./components/geoscene-charts-config-format/customElement.js"),
+    "messageOverrides:,model:",
+  ],
+  "geoscene-charts-config-format-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-format-popover/customElement.js"
+      ),
+    "messageOverrides:,open,placement,referenceElement:,selectedElement:;reposition",
+  ],
+  "geoscene-charts-config-general": [
+    () =>
+      import("./components/geoscene-charts-config-general/customElement.js"),
+    "messageOverrides:,model:,open",
+  ],
+  "geoscene-charts-config-guide": [
+    () => import("./components/geoscene-charts-config-guide/customElement.js"),
+    "calculatedMinMaxBounds:,index,latestGuidePosition,messageOverrides:,model:,orientation,timeZone",
+  ],
+  "geoscene-charts-config-guide-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-guide-popover/customElement.js"
+      ),
+    "messageOverrides:,open,placement,referenceElement:,selectedElement:;reposition",
+  ],
+  "geoscene-charts-config-guides": [
+    () => import("./components/geoscene-charts-config-guides/customElement.js"),
+    "calculatedMinMaxBounds:,enableXAxisGuide,enableYAxisGuide,messageOverrides:,model:,open,timeZone",
+  ],
+  "geoscene-charts-config-guides-type-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-guides-type-popover/customElement.js"
+      ),
+    "enableXAxisGuide,enableYAxisGuide,messageOverrides:,open,placement,referenceElement:;reposition",
+  ],
+  "geoscene-charts-config-heat-chart": [
+    () =>
+      import("./components/geoscene-charts-config-heat-chart/customElement.js"),
+    "layer:,model:,page,usePopupTemplateFieldsInfo",
+  ],
+  "geoscene-charts-config-heat-chart-data": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-heat-chart-data/customElement.js"
+      ),
+    "layerFieldsInfo:,messageOverrides:,model:,open",
+  ],
+  "geoscene-charts-config-heat-chart-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-heat-chart-popover/customElement.js"
+      ),
+    "colorRamps:,contentKind,headingTitle,isFlipped,layerFieldsInfo:,messageOverrides:,model:,open,referenceElement:,selectedContent;reposition",
+  ],
+  "geoscene-charts-config-histogram": [
+    () =>
+      import("./components/geoscene-charts-config-histogram/customElement.js"),
+    "calculatedMinMaxBounds:,chartData:,layer:,model:,page,seriesColor:,usePopupTemplateFieldsInfo",
+  ],
+  "geoscene-charts-config-histogram-data": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-histogram-data/customElement.js"
+      ),
+    "countValue,layerFieldsInfo:,maxValue,meanValue,medianValue,messageOverrides:,minValue,model:,nullsValue,open,selectedOverlaySymbolType,standardDevValue,sumValue",
+  ],
+  "geoscene-charts-config-histogram-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-histogram-popover/customElement.js"
+      ),
+    "contentKind,headingTitle,layerFieldsInfo:,messageOverrides:,open,placement,referenceElement:,selectedBinColor:,selectedNumericField,selectedOverlaySymbol:,selectedOverlaySymbolType,selectedTransformationType;reposition",
+  ],
+  "geoscene-charts-config-invalid-input-message": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-invalid-input-message/customElement.js"
+      ),
+    "invalidInputMessage,isInvalid",
+  ],
+  "geoscene-charts-config-line-chart": [
+    () =>
+      import("./components/geoscene-charts-config-line-chart/customElement.js"),
+    "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,seriesColor:,timeZone,usePopupTemplateFieldsInfo",
+  ],
+  "geoscene-charts-config-line-chart-data": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-line-chart-data/customElement.js"
+      ),
+    "layerFieldsInfo:,messageOverrides:,model:,resetTimeInterval:",
+  ],
+  "geoscene-charts-config-line-chart-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-line-chart-popover/customElement.js"
+      ),
+    "contentKind,headingTitle,layerFieldsInfo:,messageOverrides:,open,referenceElement:,selectedContent;reposition",
+  ],
+  "geoscene-charts-config-line-chart-series": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-line-chart-series/customElement.js"
+      ),
+    "activeColorMatch,messageOverrides:,model:,popoverPlacement",
+  ],
+  "geoscene-charts-config-line-chart-series-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-line-chart-series-popover/customElement.js"
+      ),
+    "messageOverrides:,open,placement,referenceElement:,selectedColor:,selectedLineStyle,selectedLineWidth,selectedName,selectedSeriesIndex;reposition",
+  ],
+  "geoscene-charts-config-line-style": [
+    () =>
+      import("./components/geoscene-charts-config-line-style/customElement.js"),
+    "enableClose,header,lineStyle:,messageOverrides:,open,usePanel",
+  ],
+  "geoscene-charts-config-number-format": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-number-format/customElement.js"
+      ),
+    "messageOverrides:,numberFormat:",
+  ],
+  "geoscene-charts-config-pie-chart": [
+    () =>
+      import("./components/geoscene-charts-config-pie-chart/customElement.js"),
+    "calculatedMinMaxBounds:,chartData:,filterBySelection,layer:,model:,page,popoverPlacement,seriesColor:,usePopupTemplateFieldsInfo",
+  ],
+  "geoscene-charts-config-pie-chart-data": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-pie-chart-data/customElement.js"
+      ),
+    "layerFieldsInfo:,messageOverrides:,model:",
+  ],
+  "geoscene-charts-config-pie-chart-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-pie-chart-popover/customElement.js"
+      ),
+    "contentKind,headingTitle,layerFieldsInfo:,messageOverrides:,open,referenceElement:,selectedContent;reposition",
+  ],
+  "geoscene-charts-config-pie-chart-slices": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-pie-chart-slices/customElement.js"
+      ),
+    "chartData:,messageOverrides:,model:,popoverPlacement",
+  ],
+  "geoscene-charts-config-pie-chart-slices-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-pie-chart-slices-popover/customElement.js"
+      ),
+    "messageOverrides:,open,placement,referenceElement:,selectedColor:,selectedName,selectedSliceId;reposition",
+  ],
+  "geoscene-charts-config-scatter-plot": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-scatter-plot/customElement.js"
+      ),
+    "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,r2,usePopupTemplateFieldsInfo",
+  ],
+  "geoscene-charts-config-scatter-plot-data": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-scatter-plot-data/customElement.js"
+      ),
+    "isTableLayer,layerFieldsInfo:,messageOverrides:,model:,r2",
+  ],
+  "geoscene-charts-config-scatter-plot-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-scatter-plot-popover/customElement.js"
+      ),
+    "contentKind,headingTitle,layerFieldsInfo:,messageOverrides:,open,placement,referenceElement:,selectedContent;reposition",
+  ],
+  "geoscene-charts-config-select-chart-type-popover": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-select-chart-type-popover/customElement.js"
+      ),
+    "headerTitle,layerId,messageOverrides:,open,popoverPlacement,referenceElement:,selectedModelType;reposition",
+  ],
+  "geoscene-charts-config-view-charts": [
+    () =>
+      import(
+        "./components/geoscene-charts-config-view-charts/customElement.js"
+      ),
+    "disableEditing,layer:,messageOverrides:,modelList:,noGroup,selectedChartId",
+  ],
+  "geoscene-charts-info-modal": [
+    () => import("./components/geoscene-charts-info-modal/customElement.js"),
+    "calciteThemeApplied,enableAutoTheming,heading,loaderColors:,message,showErrorModalInfo,showLoader",
+  ],
+});
+export { i as defineCustomElements };

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

@@ -0,0 +1,51 @@
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes, SerialChartDataSortingKinds } from "../interfaces/common.js";
+import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+
+export class BarChartModel extends SerialChartModel {
+  /**
+   * 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 stacked labels 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.
+   */
+  getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
+  /**
+   * Gets the sort order for the bar chart.
+   *
+   * @returns {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}
+   */
+  getSortOrder(): SerialChartDataSortingKinds;
+  /** Returns whether the series styling is able to be reset. */
+  resetAvailable(): boolean;
+  /** Resets the series styling to the default styling. */
+  resetSeriesStyling(): void;
+  /**
+   * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
+   *
+   * @param hide - The value for hiding oversized data labels.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
+  /**
+   * Sets whether to hide oversized stacked labels of the series based on the series index.
+   *
+   * @param hide - The value for hiding oversized stacked labels.
+   * @param seriesIndex - The index of the series. When not provided all the series will be updated.
+   */
+  setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex?: number): void;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.BarChart>>): Promise<void>;
+}

package/dist/model/box-plot-model/box-plot-model.d.ts

@@ -0,0 +1,177 @@
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ModelTypes, BoxPlotDataSortingKinds } 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 { WithColorMatch } from "../properties/color-match.js";
+import type { WithRotatedState } from "../properties/rotated-state.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 { WebChartDataFilters } from "../../spec/web-chart.js";
+import type { Color } from "../../spec/rest-js-types.js";
+import type { RESTSimpleLineSymbolStyle } from "../../spec/rest-js-object-literals.js";
+import type { ChartConfig } from "../../utils/types/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 BoxPlotModel extends BoxPlotModelSuperclass {
+  /**
+   * The index of the box plot series in the series array in config object when show mean is true.
+   *
+   * **Note**: There is only one box plot series when show mean is `true`. The function returns `-1` if show mean is `false`.
+   */
+  get boxPlotSeriesIndexWhenMeanLinesShown(): number;
+  /** The category field for the box plot. */
+  accessor category: string;
+  /**
+   * The color of the boxes when showing mean lines.
+   *
+   * Only applicable when mean lines are shown.
+   */
+  accessor meanLinesBoxColor: Color | undefined;
+  /** The numeric fields array for the box plot. */
+  get numericFields(): string[];
+  set numericFields(value: string[] | string);
+  /** The list of category values for custom sort. */
+  accessor orderByList: string[];
+  /** The order of the series array by returning an array of series ids. */
+  accessor orderOfSeries: string[];
+  /** Whether mean lines are shown. */
+  accessor showMeanLines: boolean | undefined;
+  /** Whether outliers are shown. */
+  accessor showOutliers: boolean;
+  /** The split-by field for the box plot. */
+  accessor splitByField: string;
+  /** Whether values are standardized as z-scores. */
+  accessor standardizeValues: boolean;
+  /** Generate the proper chart title given the current config. */
+  generateChartTitle(): string;
+  /** Generate the proper y-axis title given the current config. */
+  generateYAxisTitle(): string;
+  /** Gets the list of the category values for the chart. */
+  getCustomSortValues(): Promise<string[]>;
+  /**
+   * Gets the 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.
+   */
+  getSeriesColor(seriesIndex: number): Color | undefined;
+  /**
+   * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   *
+   * **Note**: Only applicable when mean lines are shown.
+   *
+   * @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`.
+   *
+   * **Note**: Only applicable when mean lines are shown.
+   *
+   * @param seriesIndex - The index of the series.
+   */
+  getSeriesLineWidth(seriesIndex: number): number | undefined;
+  /**
+   * Gets the name 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.
+   */
+  getSeriesName(seriesIndex: number): string | undefined;
+  /** Gets the sort order of the box plot data. */
+  getSortOrder(): BoxPlotDataSortingKinds;
+  /**
+   * Move the custom sort values in-place for the order by list in the config.
+   *
+   * **Note**: This method should be only used when the sort order is set to `BoxPlotDataSortingKinds.customSort`.
+   *
+   * @param fromIndex - The index to move the custom sort item from.
+   * @param toIndex - The index to move the category item to.
+   */
+  moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
+  /**
+   * Moves a series from one index in the series array to another.
+   *
+   * @param fromIndex - Index to move the series from.
+   * @param toIndex - Index to move the series to.
+   */
+  moveSeries(fromIndex: number, toIndex: number): void;
+  /** Returns whether the series styling is able to be reset. */
+  resetAvailable(): boolean;
+  /** Resets the config to the default config */
+  resetConfig(): void;
+  /** Resets the series styling to the default styling. */
+  resetSeriesStyling(): void;
+  /**
+   * Sets the data filter for the box plot.
+   *
+   * @param newDataFilter - The new data filter.
+   * @example
+   * ```typescript
+   * chartModel.setDataFilters({
+   *    where: "population > 100000",
+   * });
+   * ```
+   */
+  setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
+  /**
+   * Sets the color of the series based on the series index.
+   *
+   * @param newColor - The new color for the series.
+   * @param seriesIndex - The index of the series.
+   * @example
+   * ```typescript
+   * chartModel.setSeriesColor([100, 100, 100, 255], 1);
+   * ```
+   */
+  setSeriesColor(newColor: Color | undefined, seriesIndex: number): void;
+  /**
+   * Sets the line style of the series based on the series index.
+   *
+   * **Note**: Only applicable when mean lines are shown.
+   *
+   * @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**: Only applicable when mean lines are shown.
+   *
+   * @param newWidth - The new width for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
+  /**
+   * Sets name of the series based on the series index.
+   *
+   * @param newName - The new name for the series.
+   * @param seriesIndex - The index of the series.
+   */
+  setSeriesName(newName: string, seriesIndex: number): void;
+  /**
+   * Sets the sort order of the box plot data.
+   *
+   * @param newSortOrder - The new sort order.
+   * @param orderByList - The new list of category's values for custom sort.
+   */
+  setSortOrder(newSortOrder: BoxPlotDataSortingKinds, orderByList?: string[]): void;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   */
+  setup(params: ModelParams<ChartConfig<typeof ModelTypes.BoxPlot>>): Promise<void>;
+  /** Updates the series based on the layer filter. */
+  updateSeriesFromLayerFilter(): Promise<void>;
+}
+declare const BoxPlotModelSuperclass: 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 WithRotatedState & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes

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

@@ -0,0 +1,34 @@
+import type { ModelParams } from "../interfaces/chart-interfaces.js";
+import type { ChartModel } from "./chart-model.js";
+import type { ChartConfig } from "../../utils/types/index.js";
+import type { ChartTypes } from "../../utils/misc/index.js";
+
+export abstract class ChartModelBase extends EventTarget {
+  constructor(...args: any[]);
+  /**
+   * 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.
+   */
+  asyncUpdatesPromise: Promise<void>;
+  /** The chart type. */
+  get chartType(): ChartTypes;
+  /** Data store object that can be used to store any data needed for the chart. */
+  dataStore: any;
+  /** Generate the proper chart title from the current config. */
+  abstract generateChartTitle(): string;
+  /**
+   * Checks if the current chart model is for the same chart as another chart model.
+   *
+   * @param otherModel - The other chart model to compare to.
+   */
+  isSameChartAs(otherModel: ChartModel | undefined): boolean;
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params - The parameters to be used to set up the chart model.
+   */
+  abstract setup(params: ModelParams<ChartConfig>): Promise<void>;
+  /** Can be awaited to allow any pending async updates to complete. */
+  update(): Promise<void>;
+}

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

@@ -0,0 +1,28 @@
+import type { WithTitleText } from "../properties/title/title-text.js";
+import type { WithTitleSymbol } from "../properties/title/title-symbol.js";
+import type { ChartModelBase } from "./chart-model-base.js";
+import type { WithConfig } from "../properties/config.js";
+import type { WithLayer } from "../properties/layer.js";
+import type { WithChartId } from "../properties/chart-id.js";
+import type { WithVersion } from "../properties/version.js";
+import type { WithSubtitleText } from "../properties/subtitle/subtitle-text.js";
+import type { WithSubtitleSymbol } from "../properties/subtitle/subtitle-symbol.js";
+import type { WithDescriptionText } from "../properties/description/description-text.js";
+import type { WithDescriptionSymbol } from "../properties/description/description-symbol.js";
+import type { WithChartTitleVisibility } from "../properties/title/title-visibility.js";
+import type { WithChartSubtitleVisibility } from "../properties/subtitle/subtitle-visibility.js";
+import type { WithDescriptionVisibility } from "../properties/description/description-visibility.js";
+import type { WithChartRenderer } from "../properties/chart-renderer.js";
+import type { WithBackgroundColor } from "../properties/background-color.js";
+import type { WithSeriesVisibility } from "../properties/series/series-visibility.js";
+import type { WithSeriesId } from "../properties/series/series-id.js";
+import type { WithSeriesIndex } from "../properties/series/series-index.js";
+import type { WithSeriesLength } from "../properties/series/series-length.js";
+import type { WithChartSubType } from "../properties/chart-sub-type.js";
+import type { WithSeriesDataTooltipValueFormat } from "../properties/data-tooltip-value-format.js";
+import type { WithFetchNULLValues } from "../properties/fetch-null-values.js";
+import type { WithSplitByValues } from "../properties/split-by-values.js";
+import type { WithDataFilters } from "../properties/data-filters.js";
+
+export abstract class ChartModel extends ChartModelSuperclass {}
+declare const ChartModelSuperclass: typeof ChartModelBase & typeof WithDataFilters & typeof WithSplitByValues & typeof WithFetchNULLValues & typeof WithSeriesDataTooltipValueFormat & typeof WithChartSubType & typeof WithSeriesLength & typeof WithSeriesIndex & typeof WithSeriesId & typeof WithSeriesVisibility & typeof WithBackgroundColor & typeof WithChartRenderer & typeof WithDescriptionVisibility & typeof WithChartSubtitleVisibility & typeof WithChartTitleVisibility & typeof WithDescriptionSymbol & typeof WithDescriptionText & typeof WithSubtitleSymbol & typeof WithSubtitleText & typeof WithVersion & typeof WithTitleSymbol & typeof WithTitleText & typeof WithChartId & typeof WithLayer & typeof WithConfig

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

@@ -0,0 +1,10 @@
+import type { ChartConfig } from "../../../utils/types/index.js";
+import type { ModelTypes } from "../../interfaces/common.js";
+
+/** Payload for model config change event. */
+export type ModelConfigChangePayload<T extends ModelTypes = ModelTypes> = {
+  /** Name of the setter (either prop or method) which triggered the change. */
+  setterName: string;
+  /** New chart config. */
+  config: ChartConfig<T>;
+};