@arcgis/charts-components 5.2.0-next.13 → 5.2.0-next.131

package/dist/chunks/box-plot-model.js

@@ -1,36 +1,91 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import { isEqual as W } from "es-toolkit/compat";
 import { log as d } from "@arcgis/toolkit/log";
-import { u as A } from "./chart-object-literals.js";
-import { g as f, z as P, B as D, am as T, aB as V, h as y, l as m, m as p } from "./index.js";
-import { g as l } from "./index5.js";
-import { C as N } from "./chart-model.js";
-import { m as o } from "./model-setter.js";
-import { B as E } from "./common.js";
-import { M as R, a as U, W as z, b as X } from "./data-labels-visibility.js";
-import { M as j, a as K } from "./model-with-y-guides.js";
-import { W as Y, c as k, d as G } from "./axis-lines-symbol.js";
-import { W as q, c as H, d as J } from "./generate-x-axis-title.js";
-import { W as Q, a as Z } from "./x-bounds.js";
-import { W as $ } from "./data-labels-symbol.js";
-import { W as ee } from "./rotated-state.js";
-import { g as te, s as u, b as se, a as S } from "./series.js";
-import { j as ie, h as re, f as oe } from "./utils.js";
-import { s as ne, d as ae, e as le, f as he, h as ce, i as L, j as _, k as C, l as B, m as M, g as ge, n as de, o as fe, p as x, a as ye, c as me, b as pe, q as ue, r as F, t as Se, u as v, v as Le, w, x as _e, y as Ce, z as Be, A as Me, B as xe, C as Fe, D as b } from "./box-plot-data.js";
-var ve = Object.defineProperty, we = Object.getOwnPropertyDescriptor, n = (c, e, t, s) => {
-  for (var r = we(e, t), a = c.length - 1, h; a >= 0; a--)
-    (h = c[a]) && (r = h(e, t, r) || r);
-  return r && ve(e, t, r), r;
+import { a as O } from "./chart-object-literals.js";
+import { l as f, ao as P, a9 as D, g as R, aa as y, am as m, ab as p, r as A } from "./index3.js";
+import { cf as V, ca as h } from "./index.js";
+import { m as r } from "./model-setter.js";
+import { B as T } from "./common.js";
+import { M as E, a as N, W as z, b as U } from "./data-labels-visibility.js";
+import { M as X, a as j } from "./model-with-y-guides.js";
+import { W as k, c as q, d as G } from "./axis-lines-symbol.js";
+import { W as K, c as Y, d as H } from "./generate-x-axis-title.js";
+import { W as J, a as Q } from "./x-bounds.js";
+import { W as Z } from "./data-labels-symbol.js";
+import { W as $ } from "./rotated-state.js";
+import { g as ee, b as ie, s as te, a as se } from "./series.js";
+import { k as re, j as oe, l as ne, h as ae } from "./utils.js";
+import { s as le, d as he, e as ce, f as ge, h as de, i as u, j as S, k as _, l as L, m as B, g as fe, n as ye, o as me, p as C, a as pe, c as ue, b as Se, q as _e, r as F, t as Le, u as Be, v as M, w as Ce, x, y as Fe, z as Me, A as xe, B as Ie, C as be, D as ve, E as we, F as We, G as I } from "./box-plot-data.js";
+import { C as Oe } from "./chart-model.js";
+var Pe = Object.defineProperty, De = Object.getOwnPropertyDescriptor, o = (c, e, i, n) => {
+  for (var s = De(e, i), a = c.length - 1, l; a >= 0; a--)
+    (l = c[a]) && (s = l(e, i, s) || s);
+  return s && Pe(e, i, s), s;
 };
-class i extends N {
+class t extends Oe {
   constructor() {
-    super(...arguments), this._chartType = A.BoxPlotSeries, this._category = f, this._splitByField = "", this._numericFields = [];
+    super(...arguments), this._chartType = O.BoxPlotSeries, this._category = f, this._splitByField = "", this._numericFields = [], this._splitBySeriesLimitReached = !1, this._splitBySeriesCount = 0;
   }
   async setup(e) {
-    await this.loadConfigFromLayer(e), this.setupLocalProps(), e.config !== void 0 && await this.updateSeriesFromLayerFilter(), typeof this.resolveSetup == "function" && this.resolveSetup();
+    await this.loadConfigFromLayer(e), this.setupLocalProps(), e.config !== void 0 && await this.rebuildSeries(), typeof this.resolveSetup == "function" && this.resolveSetup();
   }
   // ---------------------------------------------------------------------------------------------
   // #region Data Props
   // ---------------------------------------------------------------------------------------------
+  /**
+   * The chart limits used when generating split-by series.
+   *
+   * @internal
+   */
+  get chartLimits() {
+    return this._chartLimits;
+  }
+  /**
+   * Sets the chart limits used when generating split-by series.
+   *
+   * When the limits change after model setup, the series are rebuilt asynchronously. Call the update() method to wait
+   * for the rebuild to complete.
+   *
+   * @internal
+   *
+   * @param chartLimits The chart limits to apply, or `undefined` to use the default limits.
+   */
+  set chartLimits(e) {
+    const i = !W(this._chartLimits, e);
+    this._chartLimits = e, i && this.layerInfo !== void 0 && this._config !== void 0 && this.processSeriesRebuild("chartLimits");
+  }
+  /**
+   * Get whether split-by series were trimmed to the configured chart limit.
+   *
+   * @internal
+   */
+  get splitBySeriesLimitReached() {
+    return this._splitBySeriesLimitReached;
+  }
+  /**
+   * Sets whether split-by series were trimmed to the configured chart limit.
+   *
+   * @internal
+   */
+  set splitBySeriesLimitReached(e) {
+    this._splitBySeriesLimitReached = e;
+  }
+  /**
+   * Get the number of split-by series before applying the configured chart limit.
+   *
+   * @internal
+   */
+  get splitBySeriesCount() {
+    return this._splitBySeriesCount;
+  }
+  /**
+   * Sets the number of split-by series before applying the configured chart limit.
+   *
+   * @internal
+   */
+  set splitBySeriesCount(e) {
+    this._splitBySeriesCount = e;
+  }
   /**
    * The category field for the box plot.
    */
@@ -38,8 +93,8 @@ class i extends N {
     return this._category;
   }
   set category(e) {
-    const t = e.trim() === "";
-    this._category = t ? f : e, this.dirtyAsyncSetters.push("category"), this.processSeriesRebuild();
+    const i = e.trim() === "";
+    this._category = i ? f : e, this.processSeriesRebuild("category");
   }
   /**
    * The numeric fields array for the box plot.
@@ -48,8 +103,8 @@ class i extends N {
     return this._numericFields;
   }
   set numericFields(e) {
-    const { layerFieldsInfo: t } = this.layerInfo;
-    typeof e == "string" && (e = [e]), ie(t, e) ? (this._numericFields = e, this.dirtyAsyncSetters.push("numericFields"), ne(this._category, this._numericFields) && (this._splitByField = "", this.dirtyAsyncSetters.push("splitByField")), this.processSeriesRebuild()) : d("error", "box-plot-model", "Invalid `numericFields`");
+    const { layerFieldsInfo: i } = this.layerInfo;
+    typeof e == "string" && (e = [e]), re(i, e) ? (this._numericFields = e, le(this._category, this._numericFields) && (this._splitByField = ""), this.processSeriesRebuild("numericFields")) : d("error", "box-plot-model", "Invalid `numericFields`");
   }
   /**
    * The split-by field for the box plot.
@@ -58,16 +113,16 @@ class i extends N {
     return this._splitByField;
   }
   set splitByField(e) {
-    re(this.layerInfo.layerFieldsInfo, e) ? (this._splitByField = e, this.dirtyAsyncSetters.push("splitByField"), this.processSeriesRebuild()) : d("error", "box-plot-model", "Invalid `splitByField`");
+    oe(this.layerInfo.layerFieldsInfo, e) ? (this._splitByField = e, this.processSeriesRebuild("splitByField")) : d("error", "box-plot-model", "Invalid `splitByField`");
   }
   /**
    * Whether outliers are shown.
    */
   get showOutliers() {
-    return ae(this._config);
+    return he(this._config);
   }
   set showOutliers(e) {
-    le({
+    ce({
       newShowOutliers: e,
       config: this._config,
       layerInfo: this.layerInfo,
@@ -78,10 +133,10 @@ class i extends N {
    * Whether values are standardized as z-scores.
    */
   get standardizeValues() {
-    return he(this._config);
+    return ge(this._config);
   }
   set standardizeValues(e) {
-    ce({
+    de({
       newStandardizeValues: e,
       config: this._config,
       layerInfo: this.layerInfo,
@@ -92,16 +147,16 @@ class i extends N {
    * Gets the sort order of the box plot data.
    */
   getSortOrder() {
-    return L(this._config);
+    return u(this._config);
   }
-  setSortOrder(e, t) {
-    _(e, this._config, t);
+  setSortOrder(e, i) {
+    S(e, this._config, i);
   }
   /**
    * Gets the list of the category values for the chart.
    */
   async getCustomSortValues() {
-    return await C({
+    return await _({
       config: this._config,
       layerInfo: this.layerInfo,
       errorStrings: this.commonStrings.errorStrings
@@ -109,15 +164,15 @@ class i extends N {
   }
   async setDataFilters(e) {
     super.setDataFilters(e);
-    const t = L(this._config);
-    if (t === E.customSort) {
+    const i = u(this._config);
+    if (i === T.customSort) {
       this.startAsyncUpdate();
-      const s = await C({
+      const n = await _({
         config: this._config,
         layerInfo: this.layerInfo,
         errorStrings: this.commonStrings.errorStrings
       });
-      _(t, this._config, s), this.finishAsyncUpdate();
+      S(i, this._config, n), this.finishAsyncUpdate();
     }
     this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange"));
   }
@@ -125,16 +180,24 @@ class i extends N {
    * The list of category values for custom sort.
    */
   get orderByList() {
-    return B(this._config);
+    return L(this._config);
   }
   set orderByList(e) {
-    M(e, this._config);
+    B(e, this._config);
   }
   /**
    * Updates the series based on the layer filter.
+   *
+   * @deprecated since 5.2. Use {@link model/box-plot-model/box-plot-model#rebuildSeries rebuildSeries} instead.
    */
   async updateSeriesFromLayerFilter() {
-    this.dirtyAsyncSetters.push("updateSeriesFromLayerFilter"), await this.processSeriesRebuild();
+    await this.processSeriesRebuild("updateSeriesFromLayerFilter");
+  }
+  /**
+   * Rebuilds the series based on the current configuration.
+   */
+  async rebuildSeries() {
+    await this.processSeriesRebuild("rebuildSeries");
   }
   // ---------------------------------------------------------------------------------------------
   // #region  Series Props
@@ -143,27 +206,27 @@ class i extends N {
    * Whether mean lines are shown.
    */
   get showMeanLines() {
-    return ge(this._config);
+    return fe(this._config);
   }
   set showMeanLines(e) {
-    const { previousMeanLinesBoxColor: t } = de({
+    const { previousMeanLinesBoxColor: i } = ye({
       newShowMeanLines: e,
       config: this._config,
       commonStrings: this.commonStrings,
       previousMeanLinesBoxColor: this.previousMeanLinesBoxColor
     });
-    this.previousMeanLinesBoxColor = t;
+    this.previousMeanLinesBoxColor = i;
   }
   /**
    * The color of the boxes when showing mean lines.
    *
-   * Only applicable when mean lines are shown.
+   * **Note**: Only applicable when mean lines are shown.
    */
   get meanLinesBoxColor() {
-    return fe(this._config);
+    return me(this._config);
   }
   set meanLinesBoxColor(e) {
-    x(e, this._config);
+    C(e, this._config);
   }
   // ---------------------------------------------------------------------------------------------
   // #region Protected Methods
@@ -173,7 +236,7 @@ class i extends N {
    * @private
    */
   setupLocalProps() {
-    this._category = ye(this._config), this._splitByField = me(this._config), this._numericFields = pe(this._config);
+    this._category = pe(this._config), this._splitByField = ue(this._config), this._numericFields = Se(this._config);
   }
   /** @private */
   generateDefaultConfig() {
@@ -185,33 +248,40 @@ class i extends N {
     this._config = this.generateDefaultConfig(), this._config.id = e, this.setupLocalProps(), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange"));
   }
   /**
-   * Determines if we can rebuild the series synchronously.
-   * We can call the build new series function synchronously when either is true:
-   * - there is no split-by field
-   * - there are multiple numeric fields
+   * Determines if we are using the split-by field, based on the following conditions:
+   *
+   * - there is split-by field
+   * - and, there are not multiple numeric fields
    *
    * @private
    */
-  canUseSynchronousSeriesRebuild() {
-    return !ue(this.category, this.numericFields, this.splitByField);
+  usingSplitBy() {
+    return _e(this.category, this.numericFields, this.splitByField);
   }
   /**
    * Processes the series rebuild.
-   * If multiple async setters are called in succession, this function will only rebuild the series once after all setters have been called.
+   *
    * @private
    */
-  async processSeriesRebuild() {
-    if (this.layerInfo !== void 0) {
-      const e = this.dirtyAsyncSetters[this.dirtyAsyncSetters.length - 1];
-      if (this.canUseSynchronousSeriesRebuild())
-        this.dirtyAsyncSetters = [], F(this.getBuildNewSeriesProps());
-      else if (!this.asyncConfigUpdateInProgress) {
-        for (this.startAsyncUpdate(); this.dirtyAsyncSetters.length > 0; )
-          this.dirtyAsyncSetters = [], await F(this.getBuildNewSeriesProps());
-        this.finishAsyncUpdate();
-      }
-      this.setupLocalProps(), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate(e);
-    }
+  async processSeriesRebuild(e) {
+    this.usingSplitBy() ? (this.startAsyncUpdate(), await this.fetchSplitByFieldInfos(), F(this.getBuildNewSeriesProps()), this.finishAsyncUpdate()) : (this._splitBySeriesLimitReached = !1, this._splitBySeriesCount = 0, F(this.getBuildNewSeriesProps())), this.setupLocalProps(), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate(e);
+  }
+  /**
+   * Fetches the split-by field information and stores it in a private member for use in building the series.
+   */
+  async fetchSplitByFieldInfos() {
+    const { fetchNullValues: e } = V(this._config)?.query ?? {};
+    return this.splitByFieldInfos = await ne({
+      config: this._config,
+      layer: this.layerInfo.layer,
+      layerFieldsInfo: this.layerInfo.layerFieldsInfo,
+      xAxisField: Le(this._category) ? void 0 : this._category,
+      aggregationFields: this.numericFields,
+      splitByField: this._splitByField,
+      fetchNullValues: e,
+      chartLimits: this._chartLimits,
+      errorStrings: this.commonStrings?.errorStrings
+    }), this._splitBySeriesLimitReached = this.splitByFieldInfos.seriesLimitReached, this._splitBySeriesCount = this.splitByFieldInfos.totalSeriesCount, this.splitByFieldInfos;
   }
   //#endregion
   // #region Private Methods
@@ -225,7 +295,8 @@ class i extends N {
       numericFields: this.numericFields,
       config: this._config,
       layerInfo: this.layerInfo,
-      commonStrings: this.commonStrings
+      commonStrings: this.commonStrings,
+      splitByFieldInfos: this.splitByFieldInfos
     };
   }
   // #endregion
@@ -238,10 +309,10 @@ class i extends N {
    * @param seriesIndex - The index of the series.
    */
   getSeriesName(e) {
-    return Se(e, this._config);
+    return Be(e, this._config);
   }
-  setSeriesName(e, t) {
-    v(e, t, this._config);
+  setSeriesName(e, i) {
+    M(e, i, this._config);
   }
   /**
    * Gets the color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
@@ -249,10 +320,10 @@ class i extends N {
    * @param seriesIndex - The index of the series.
    */
   getSeriesColor(e) {
-    return Le(e, this._config);
+    return Ce(e, this._config);
   }
-  setSeriesColor(e, t) {
-    w(e, t, this._config);
+  setSeriesColor(e, i) {
+    x(e, i, this._config);
   }
   /**
    * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
@@ -262,13 +333,12 @@ class i extends N {
    * @param seriesIndex - The index of the series.
    */
   getSeriesLineStyle(e) {
-    const t = this._config.series[e];
-    if (this.showMeanLines === !0 && l(t))
-      return te(t);
+    const i = this._config.series[e];
+    if (this.showMeanLines === !0 && h(i))
+      return ee(i);
   }
-  setSeriesLineStyle(e, t) {
-    const s = this._config.series[t];
-    this.showMeanLines === !0 && l(s) && u(e, s);
+  setSeriesLineStyle(e, i) {
+    this.showMeanLines === !0 && Fe({ style: e, seriesIndex: i, config: this._config });
   }
   /**
    * Gets the line width of the series based on the series index. If the index is out of bounds, it will return `undefined`.
@@ -278,25 +348,24 @@ class i extends N {
    * @param seriesIndex - The index of the series.
    */
   getSeriesLineWidth(e) {
-    const t = this._config.series[e];
-    if (this.showMeanLines === !0 && l(t))
-      return se(t);
+    const i = this._config.series[e];
+    if (this.showMeanLines === !0 && h(i))
+      return ie(i);
   }
-  setSeriesLineWidth(e, t) {
-    const s = this._config.series[t];
-    this.showMeanLines === !0 && l(s) && S(e, s);
+  setSeriesLineWidth(e, i) {
+    this.showMeanLines === !0 && Me({ width: e, seriesIndex: i, config: this._config });
   }
   /**
    * The order of the series array by returning an array of series ids.
    */
   get orderOfSeries() {
-    return _e(this._config);
+    return xe(this._config);
   }
   set orderOfSeries(e) {
-    Ce(e, this._config);
+    Ie(e, this._config);
   }
-  moveSeries(e, t) {
-    Be(e, t, this._config);
+  moveSeries(e, i) {
+    be(e, i, this._config);
   }
   /**
    * The index of the box plot series in the series array in config object when show mean is true.
@@ -304,11 +373,11 @@ class i extends N {
    * **Note**: There is only one box plot series when show mean is `true`. The function returns `-1` if show mean is `false`.
    */
   get boxPlotSeriesIndexWhenMeanLinesShown() {
-    return Me(this._config);
+    return ve(this._config);
   }
-  moveCustomSortValuesInOrderByList(e, t) {
-    const s = B(this._config), [r] = s.splice(e, 1);
-    s.splice(t, 0, r), M(s, this._config);
+  moveCustomSortValuesInOrderByList(e, i) {
+    const n = L(this._config), [s] = n.splice(e, 1);
+    n.splice(i, 0, s), B(n, this._config);
   }
   // ---------------------------------------------------------------------------------------------
   // #region General Methods
@@ -317,127 +386,127 @@ class i extends N {
    * Generate the proper chart title given the current config.
    */
   generateChartTitle() {
-    return xe(this._config, this.layerInfo, this.commonStrings);
+    return we(this._config, this.layerInfo, this.commonStrings);
   }
   /**
    * Generate the proper y-axis title given the current config.
    */
   generateYAxisTitle() {
-    return Fe(this._config, this.layerInfo, this.commonStrings);
+    return We(this._config, this.layerInfo, this.commonStrings);
   }
   resetSeriesStyling() {
     for (let e = this.showMeanLines === !0 ? 1 : 0; e < this.seriesLength; e += 1) {
-      const t = this.getSeriesId(e), s = T({
+      const i = this.getSeriesId(e), n = R({
         colorIndex: e,
-        opacity: V
-      }), r = this._config.series[e];
-      w(s, e, this._config);
-      const a = b({
-        series: r,
+        opacity: A
+      }), s = this._config.series[e];
+      x(n, e, this._config);
+      const a = I({
+        series: s,
         splitByField: this._splitByField,
         layerInfo: this.layerInfo,
         commonStrings: this.commonStrings
       });
-      v(a ?? t, e, this._config), this.showMeanLines === !0 && l(r) && (u(m, r), S(p, r));
+      M(a ?? i, e, this._config), this.showMeanLines === !0 && h(s) && (te(m, s), se(p, s));
     }
-    this.showMeanLines === !0 && x(y, this._config), this._config.colorMatch = !0;
+    this.showMeanLines === !0 && C(y, this._config), this._config.colorMatch = !0;
   }
   /**
    * Returns whether the series styling is able to be reset.
    */
   resetAvailable() {
-    const e = !this.colorMatch, t = this.showMeanLines === !0 && this.meanLinesBoxColor !== y;
-    let s = !1, r = !1;
+    const e = !this.colorMatch, i = this.showMeanLines === !0 && this.meanLinesBoxColor !== y;
+    let n = !1, s = !1;
     if (!e)
       for (let a = this.showMeanLines === !0 ? 1 : 0; a < this.seriesLength; a += 1) {
-        const h = this._config.series[a], g = b({
-          series: h,
+        const l = this._config.series[a], g = I({
+          series: l,
           splitByField: this._splitByField,
           layerInfo: this.layerInfo,
           commonStrings: this.commonStrings
-        }), W = this.getSeriesName(a);
-        if (g !== void 0 && g !== W) {
-          s = !0;
+        }), b = this.getSeriesName(a);
+        if (g !== void 0 && g !== b) {
+          n = !0;
           break;
         }
-        if (this.showMeanLines === !0 && l(h)) {
-          const I = this.getSeriesLineStyle(a), O = this.getSeriesLineWidth(a);
-          if (I !== m || O !== p) {
-            r = !0;
+        if (this.showMeanLines === !0 && h(l)) {
+          const v = this.getSeriesLineStyle(a), w = this.getSeriesLineWidth(a);
+          if (v !== m || w !== p) {
+            s = !0;
             break;
           }
         }
       }
-    return e || t || s || r;
+    return e || i || n || s;
   }
 }
-n([
-  o
-], i.prototype, "showOutliers");
-n([
-  o
-], i.prototype, "standardizeValues");
-n([
-  o
-], i.prototype, "setSortOrder");
-n([
-  o
-], i.prototype, "setDataFilters");
-n([
-  o
-], i.prototype, "orderByList");
-n([
-  o
-], i.prototype, "showMeanLines");
-n([
-  o
-], i.prototype, "meanLinesBoxColor");
-n([
-  o
-], i.prototype, "resetConfig");
-n([
-  o
-], i.prototype, "setSeriesName");
-n([
-  o
-], i.prototype, "setSeriesColor");
-n([
-  o
-], i.prototype, "setSeriesLineStyle");
-n([
-  o
-], i.prototype, "setSeriesLineWidth");
-n([
-  o
-], i.prototype, "orderOfSeries");
-n([
-  o
-], i.prototype, "moveSeries");
-n([
-  o
-], i.prototype, "moveCustomSortValuesInOrderByList");
-n([
-  o
-], i.prototype, "resetSeriesStyling");
-const be = [
-  j,
-  R,
-  U,
-  z,
-  ee,
+o([
+  r
+], t.prototype, "showOutliers");
+o([
+  r
+], t.prototype, "standardizeValues");
+o([
+  r
+], t.prototype, "setSortOrder");
+o([
+  r
+], t.prototype, "setDataFilters");
+o([
+  r
+], t.prototype, "orderByList");
+o([
+  r
+], t.prototype, "showMeanLines");
+o([
+  r
+], t.prototype, "meanLinesBoxColor");
+o([
+  r
+], t.prototype, "resetConfig");
+o([
+  r
+], t.prototype, "setSeriesName");
+o([
+  r
+], t.prototype, "setSeriesColor");
+o([
+  r
+], t.prototype, "setSeriesLineStyle");
+o([
+  r
+], t.prototype, "setSeriesLineWidth");
+o([
+  r
+], t.prototype, "orderOfSeries");
+o([
+  r
+], t.prototype, "moveSeries");
+o([
+  r
+], t.prototype, "moveCustomSortValuesInOrderByList");
+o([
+  r
+], t.prototype, "resetSeriesStyling");
+const Re = [
   X,
+  E,
+  N,
+  z,
   $,
-  K,
-  q,
-  Q,
-  H,
+  U,
   Z,
+  j,
+  K,
+  J,
   Y,
+  Q,
   k,
+  q,
   G,
-  J
+  H
 ];
-oe(i, be);
+ae(t, Re);
 export {
-  i as BoxPlotModel
+  t as BoxPlotModel
 };