@arcgis/charts-components 4.34.0-next.14 → 4.34.0-next.141

package/dist/chunks/serial-chart-model.js

@@ -1,7 +1,8 @@
-import { WebChartStackedKinds as y } from "@arcgis/charts-spec";
-import "lodash-es";
+import "@arcgis/toolkit/intl";
+import { isEqual as _ } from "lodash-es";
+import { e as C, W as A } from "./series-types.js";
 import "d3-array";
-import { aq as F, ag as I, a8 as B, a6 as v, k as g, cs as l, o as A } from "./interfaces.js";
+import { au as F, s as x, av as v, aw as B, ax as b, m as d, C as h, i as O, c as M } from "./interfaces2.js";
 import "@arcgis/core/geometry/support/jsonUtils.js";
 import "@arcgis/core/rest/support/AttributeBinsQuery.js";
 import "@arcgis/core/rest/support/Query.js";
@@ -9,70 +10,72 @@ import "@arcgis/core/rest/support/StatisticDefinition.js";
 import "@arcgis/core/time/TimeExtent.js";
 import "@arcgis/core/core/promiseUtils.js";
 import "@arcgis/core/request.js";
-import { C as u, j as O, k as M, l as U, m as b, n as x, o as L, p as D, q as w, r as N, t as E, v as V, w as k, x as S, y as o, u as W, c as P, d as X, z as j, A as z, B as c, D as K, E as Y, F as G, G as q, H, I as J, J as Q, K as d, L as f, N as h, O as m, P as p, Q as R, a as Z, M as $, i as ee, e as ie } from "./serial-chart-data.js";
-import { l as C, j as T } from "./index4.js";
-import { S as te } from "./common.js";
-import { M as se, a as ae, b as oe, c as ne } from "./model-with-data-labels.js";
-import { M as re } from "./model-with-rotation.js";
+import "./runtime.js";
+import "@arcgis/toolkit/dom";
+import { C as T, M as U, b as N, a as L } from "./model-with-multi-axes.js";
+import { b as n, a as r, f as g } from "./index.js";
+import { t as w, v as D, w as E, x as V, y as W, z as k, A as P, B as X, C as z, D as j, E as K, b as S, j as f, k as o, u as G, s as m, h as R, F as Y, G as p, H as q, m as H, f as J, I as Q, i as Z, J as $, K as ee, L as ie, M as y, N as u, O as te, P as se, Q as ae, R as oe, e as ne } from "./data.js";
+import { M as re, a as le, b as ge, c as fe } from "./model-with-data-labels.js";
+import { M as ce } from "./model-with-rotation.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.14 */
-class ge extends u {
+v4.34.0-next.141 */
+class de extends T {
   /**
    * Sets the time interval size for a temporal bar/line chart.
    * @returns {number | undefined}
    */
   getTemporalBinningSize() {
-    return O(this._config);
+    return w(this._config);
   }
   /**
    * Sets the time interval size for a temporal bar/line chart.
    * @param {number | undefined} newSize The new time interval size.
    */
   setTemporalBinningSize(e) {
-    M(e, this._config), this.emitConfigUpdate("setTemporalBinningSize");
+    D(e, this._config), this.emitConfigUpdate("setTemporalBinningSize");
   }
   /**
    * Gets the time interval units for a temporal bar/line chart.
-   * @returns {WebChartFixedDateBinningUnits | undefined}
+   * @returns {WebChartTemporalBinningUnits | undefined}
    */
   getTemporalBinningUnit() {
-    return U(this._config);
+    return E(this._config);
   }
   /**
    * Sets the time interval units for a temporal bar/line chart.
-   * @param {WebChartFixedDateBinningUnits | undefined} newUnit The new time interval units.
+   * @param {WebChartTemporalBinningUnits | undefined} newUnit The new time interval units.
    */
   setTemporalBinningUnit(e) {
-    b(e, this._config), this.emitConfigUpdate("setTemporalBinningUnit");
+    V(e, this._config), this.emitConfigUpdate("setTemporalBinningUnit");
   }
   /**
    * Gets the time aggregation type for a temporal bar/line chart.
    * @returns {WebChartTimeAggregationTypes | undefined}
    */
   getTimeAggregationType() {
-    return x(this._config);
+    return W(this._config);
   }
   /**
    * Sets the time aggregation type for a temporal bar/line chart.
    * @param {WebChartTimeAggregationTypes | undefined} newTimeAggregationType The new time aggregation type.
    */
   setTimeAggregationType(e) {
-    L(e, this._config), this.emitConfigUpdate("setTimeAggregationType");
+    k(e, this._config), this.emitConfigUpdate("setTimeAggregationType");
   }
   /**
    * Gets whether to trim incomplete time intervals for a temporal bar/line chart.
    * @returns {boolean | undefined}
    */
   getTrimIncompleteTimeInterval() {
-    return D(this._config);
+    return P(this._config);
   }
   /**
    * Sets whether to trim incomplete time intervals for a temporal bar/line chart.
    * @param {boolean | undefined} newTrimIncompleteTimeInterval The new state.
    */
   setTrimIncompleteTimeInterval(e) {
-    w(e, this._config), this.emitConfigUpdate("setTrimIncompleteTimeInterval");
+    X(e, this._config), this.emitConfigUpdate("setTrimIncompleteTimeInterval");
   }
   /**
    * Gets the policy which tells the chart how to handle null values.
@@ -86,7 +89,7 @@ class ge extends u {
    * @return {WebChartNullPolicyTypes | undefined}
    */
   getNullPolicy() {
-    return N(this._config);
+    return z(this._config);
   }
   /**
    * Sets the policy which tells the chart how to handle null values.
@@ -100,61 +103,76 @@ class ge extends u {
    * @param {WebChartNullPolicyTypes | undefined} newNullPolicy The new null policy.
    */
   setNullPolicy(e) {
-    E(e, this._config), this.emitConfigUpdate("setNullPolicy");
+    j(e, this._config), this.emitConfigUpdate("setNullPolicy");
   }
   /**
    * Resets the time interval to default for a temporal line chart.
    */
   resetTimeInterval() {
-    V(this._config), this.emitConfigUpdate("resetTimeInterval");
+    K(this._config), this.emitConfigUpdate("resetTimeInterval");
   }
 }
-const le = (s, e) => e.series?.[s].assignToSecondValueAxis ?? !1, ce = (s, e, i) => {
-  i.series?.[e] && (i.series[e].assignToSecondValueAxis = s);
-}, de = (s, e) => e.series?.[s]?.name, fe = (s, e, i) => {
+const he = (s, e) => e.series?.[s].assignToSecondValueAxis ?? !1, me = async (s, e, i) => {
+  s && i.axes !== void 0 && !i.axes?.[2] && (i.axes[2] = (await v(A.BarSeries))[1]), i.series && i.series.forEach((t, a) => {
+    a === e ? t.assignToSecondValueAxis = s : a !== e && t?.assignToSecondValueAxis !== !0 && (t.assignToSecondValueAxis = !1);
+  }), i.axes?.[2] && !i.series.some((t) => t.assignToSecondValueAxis) && i.axes.splice(2, 1);
+}, pe = (s, e) => e.series?.[s]?.name, ye = (s, e, i) => {
   i.series?.[e] && (i.series[e].name = s);
-}, he = (s, e) => {
+}, ue = (s, e) => {
   const i = e.series?.[s];
   let t;
-  return C(i) ? t = i.fillSymbol?.color : T(i) && (t = i.lineSymbol?.color), t;
-}, me = (s, e, i) => {
+  return n(i) ? t = i.fillSymbol?.color : r(i) && (t = i.lineSymbol?.color), t;
+}, Ce = (s, e, i) => {
   const t = i.series?.[e];
-  t && (C(t) ? t.fillSymbol = {
+  t && (n(t) ? t.fillSymbol = {
     ...F(e),
     ...t.fillSymbol,
     color: s
-  } : T(t) && (t.lineSymbol = {
-    ...I(e),
+  } : r(t) && (t.lineSymbol = {
+    ...x(e),
     ...t.lineSymbol,
     color: s
   }));
-}, pe = (s) => s.series.map((e) => e.id), ye = (s, e) => {
+}, Te = (s) => s.series.map((e) => e.id), Se = (s, e) => {
   e.series?.sort(
     (i, t) => s.findIndex((a) => i.id === a) - s.findIndex((a) => t.id === a)
   );
-}, ue = (s) => s.stackedType ?? y.Side, Se = async (s) => {
+}, Ie = (s) => s.stackedType ?? C.Side, _e = async (s) => {
   const { newStackedType: e, config: i, layerInfo: t } = s;
   if (i.stackedType = e, t !== void 0) {
-    const a = await k({
+    const a = await S({
       config: i,
       layerInfo: t,
       numericFields: o(i),
-      aggregationType: S(i)
+      aggregationType: f(i)
     });
-    W(i, 1, a);
+    G(i, 1, a);
   }
-  i.axes?.[1] && (e === y.Stacked100 ? i.axes[1].valueFormat = B() : i.axes[1].valueFormat = v()), await P(i, null), await X(i, null);
+  i.axes?.[1] && (e === C.Stacked100 ? i.axes[1].valueFormat = B() : i.axes[1].valueFormat = b()), m({ config: i, value: null, axisIndex: 1, isMax: !1 }), m({ config: i, value: null, axisIndex: 1, isMax: !0 });
+}, Ae = (s) => {
+  let e;
+  const i = s.series.find(
+    (t) => (n(t) || r(t) || g(t)) && t.nullCategory !== void 0
+  );
+  return (n(i) || r(i) || g(i)) && (e = i?.nullCategory), e;
+}, Fe = (s, e) => {
+  s.series.forEach((i) => {
+    (n(i) || r(i) || g(i)) && (i.nullCategory = e);
+  });
 };
-class Ce extends u {
+class xe extends T {
+  static {
+    this.supportsCustomSort = !0;
+  }
   // ---------------------------------------------------------------------------------------------
-  // Data Props
+  // #region Data Props
   // ---------------------------------------------------------------------------------------------
   /**
    * Gets the x-axis field for the chart.
    * @returns {string}
    */
   getXAxisField() {
-    return j(this._config);
+    return R(this._config);
   }
   /**
    * Sets the x-axis field for the chart.
@@ -162,12 +180,12 @@ class Ce extends u {
    */
   async setXAxisField(e) {
     const i = e.trim() === "";
-    i || await z(e, this._config, this.layerInfo);
-    const t = o(this._config), r = g(this._config.series) === l.BarAndLineFromFields, n = t.includes(this.layerInfo?.objectIdField ?? "");
-    if (i || r && n) {
+    !i && this.layerInfo && await Y(e, this._config, this.layerInfo);
+    const t = o(this._config), c = d(this._config.series) === h.BarAndLineFromFields, l = t.includes(this.layerInfo?.objectIdField ?? "");
+    if (i || c && l) {
       await this.resetConfig();
-      const _ = t.length === 1 && t[0] === this.layerInfo?.objectIdField;
-      this.layerInfo && t.length > 0 && !_ && await c(t, this._config, this.layerInfo);
+      const I = t.length === 1 && t[0] === this.layerInfo?.objectIdField;
+      this.layerInfo && t.length > 0 && !I && await p(t, this._config, this.layerInfo);
     }
     this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("setXAxisField");
   }
@@ -176,7 +194,7 @@ class Ce extends u {
    * @returns {WebChartStatisticType}
    */
   getAggregationType() {
-    return S(this._config);
+    return f(this._config);
   }
   /**
    * Sets the aggregation type for the chart.
@@ -184,7 +202,7 @@ class Ce extends u {
    * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   async setAggregationType(e) {
-    this.layerInfo && (await K(e, this._config, this.layerInfo), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("setAggregationType"));
+    this.layerInfo && (await q(e, this._config, this.layerInfo), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("setAggregationType"));
   }
   /**
    * Gets whether the series should be assigned to the second value axis.
@@ -192,22 +210,22 @@ class Ce extends u {
    * @returns {boolean}
    */
   getAssignToSecondValueAxis(e) {
-    return le(e, this._config);
+    return he(e, this._config);
   }
   /**
    * Sets whether the series should be assigned to the second value axis.
    * @param assign - The value for the setting.
    * @param seriesIndex - The index of the series.
    */
-  setAssignToSecondValueAxis(e, i) {
-    ce(e, i, this._config), this.emitConfigUpdate("setAssignToSecondValueAxis");
+  async setAssignToSecondValueAxis(e, i) {
+    await me(e, i, this._config), this.emitConfigUpdate("setAssignToSecondValueAxis");
   }
   /**
    * Gets the split-by field for the chart.
    * @returns {string}
    */
   getSplitByField() {
-    return Y(this._config);
+    return H(this._config);
   }
   /**
    * Sets the split-by field for the chart.
@@ -215,7 +233,7 @@ class Ce extends u {
    * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   async setSplitByField(e) {
-    this.layerInfo?.layerFieldsInfo && G(this.layerInfo?.layerFieldsInfo, e) && (await q(e, this._config, this.layerInfo), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("setSplitByField"));
+    this.layerInfo?.layerFieldsInfo && J(this.layerInfo?.layerFieldsInfo, e) && (await Q(e, this._config, this.layerInfo), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("setSplitByField"));
   }
   /**
    * Gets the numeric fields array for the chart.
@@ -230,45 +248,18 @@ class Ce extends u {
    * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   async setNumericFields(e) {
-    if (typeof e == "string" && (e = [e]), H(this.layerInfo?.layerFieldsInfo ?? [], e) && this.layerInfo) {
-      await c(e, this._config, this.layerInfo);
+    if (typeof e == "string" && (e = [e]), Z(this.layerInfo?.layerFieldsInfo ?? [], e) && this.layerInfo) {
+      await p(e, this._config, this.layerInfo);
       const t = o(this._config);
-      g(this._config.series) === l.BarAndLineFromFields && t.some((n) => n === this.layerInfo?.objectIdField) && await this.resetConfig(), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("setNumericFields");
-    }
-  }
-  /**
-   * Gets the data filter for the bar chart.
-   * @returns {WebChartDataFilters | undefined}
-   */
-  getDataFilter() {
-    return J(this._config);
-  }
-  /**
-   * Sets the data filter for the bar chart.
-   * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
-   */
-  async setDataFilter(e) {
-    Q(e, this._config);
-    const i = d(this._config);
-    if (i === te.customSort) {
-      const t = await f(this._config, this.layerInfo);
-      h(i, this._config, t);
+      d(this._config.series) === h.BarAndLineFromFields && t.some((l) => l === this.layerInfo?.objectIdField) && await this.resetConfig(), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("setNumericFields");
     }
-    this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("setDataFilter");
-  }
-  /**
-   * Gets the list of the category values for the chart.
-   * @returns {string[]}
-   */
-  async getCustomSortValues() {
-    return await f(this._config, this.layerInfo);
   }
   /**
    * Gets the sort order for the bar chart.
    * @returns {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}
    */
   getSortOrder() {
-    return d(this._config);
+    return $(this._config);
   }
   /**
    * Sets the sort order for the bar chart.
@@ -276,28 +267,35 @@ class Ce extends u {
    * @param {string[]} orderByList The list of category's values to order by.
    */
   setSortOrder(e, i) {
-    h(e, this._config, i), this.emitConfigUpdate("setSortOrder");
+    ee(e, this._config, i), this.emitConfigUpdate("setSortOrder");
+  }
+  /**
+   * Gets the list of the category values for the chart.
+   * @returns {string[]}
+   */
+  async getCustomSortValues() {
+    return await ie(this._config, this.layerInfo);
   }
   /**
    * Gets the list of custom sort values for custom sort
    * @returns {string[]}
    */
   getOrderByList() {
-    return m(this._config);
+    return y(this._config);
   }
   /**
    * Sets the list of custom sort values for custom sort
    * @param {string[]} newOrderByList The new list of custom sort values
    */
   setOrderByList(e) {
-    !A(this._config) && (p(e, this._config), this.emitConfigUpdate("setOrderByList"));
+    !O(this._config) && (u(e, this._config), this.emitConfigUpdate("setOrderByList"));
   }
   /**
    * Updates the series based on the layer filter.
    * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   async updateSeriesFromLayerFilter() {
-    this.layerInfo !== void 0 && (await R({
+    this.layerInfo !== void 0 && (await te({
       splitByField: this.getSplitByField(),
       numericFields: this.getNumericFields(),
       aggregationType: this.getAggregationType(),
@@ -305,8 +303,25 @@ class Ce extends u {
       layerInfo: this.layerInfo
     }), this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("updateSeriesFromLayerFilter"));
   }
+  /**
+   * Gets whether temporal binning is enabled for all series in the config.
+   * @returns {boolean} - Whether temporal binning is enabled.
+   */
+  getBinTemporalData() {
+    return se(this._config);
+  }
+  /**
+   * Enable or disable temporal binning for all series in the config.
+   * @param {boolean} value - Whether to enable or disable temporal binning.
+   *
+   * **NOTE** This method removes any existing temporal binning settings if `value` is set to `false`.
+   */
+  setBinTemporalData(e) {
+    ae(e, this._config), this.emitConfigUpdate("enableTemporalBinning");
+  }
+  // #endregion
   // ---------------------------------------------------------------------------------------------
-  // Series Props
+  // #region Series Props
   // ---------------------------------------------------------------------------------------------
   /**
    * Gets the name of the series based on the series index.
@@ -315,7 +330,7 @@ class Ce extends u {
    * @returns {string | undefined}
    */
   getSeriesName(e) {
-    return de(e, this._config);
+    return pe(e, this._config);
   }
   /**
    * Sets name of the series based on the series index.
@@ -323,7 +338,7 @@ class Ce extends u {
    * @param {number} seriesIndex The index of the series.
    */
   setSeriesName(e, i) {
-    fe(e, i, this._config), this.emitConfigUpdate("setSeriesName");
+    ye(e, i, this._config), this.emitConfigUpdate("setSeriesName");
   }
   /**
    * Gets the color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
@@ -331,7 +346,7 @@ class Ce extends u {
    * @returns {Color | undefined}
    */
   getSeriesColor(e) {
-    return he(e, this._config);
+    return ue(e, this._config);
   }
   /**
    * Sets the color of the series based on the series index.
@@ -339,21 +354,21 @@ class Ce extends u {
    * @param {number} seriesIndex The index of the series.
    */
   setSeriesColor(e, i) {
-    me(e, i, this._config), this.emitConfigUpdate("setSeriesColor");
+    Ce(e, i, this._config), this.emitConfigUpdate("setSeriesColor");
   }
   /**
    * Gets the order of the series array by returning an array of series ids.
    * @returns {string[]}
    */
   getOrderOfSeries() {
-    return pe(this._config);
+    return Te(this._config);
   }
   /**
    * Sets the order of the series array by providing an array of series ids.
    * @param {string[]} newOrder The new order of the series array.
    */
   setOrderOfSeries(e) {
-    ye(e, this._config), this.emitConfigUpdate("setOrderOfSeries");
+    Se(e, this._config), this.emitConfigUpdate("setOrderOfSeries");
   }
   /**
    * Gets how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
@@ -366,7 +381,7 @@ class Ce extends u {
    * @returns {WebChartStackedKinds | undefined}
    */
   getStackedType() {
-    return ue(this._config);
+    return Ie(this._config);
   }
   /**
    * Sets how the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
@@ -379,7 +394,7 @@ class Ce extends u {
    * @default sideBySide
    */
   async setStackedType(e) {
-    await Se({
+    await _e({
       newStackedType: e,
       config: this._config,
       layerInfo: this.layerInfo
@@ -402,8 +417,23 @@ class Ce extends u {
    * @param {number} toIndex The index to move the custom sort value to.
    */
   moveCustomSortValuesInOrderByList(e, i) {
-    const t = m(this._config), [a] = t.splice(e, 1);
-    t.splice(i, 0, a), p(t, this._config), this.emitConfigUpdate("moveCustomSortValuesInOrderByList");
+    const t = y(this._config), [a] = t.splice(e, 1);
+    t.splice(i, 0, a), u(t, this._config), this.emitConfigUpdate("moveCustomSortValuesInOrderByList");
+  }
+  /**
+   * Gets the null category configuration of the bar chart.
+   * @returns {WebChartNullCategory | undefined}
+   */
+  getNullCategory() {
+    return Ae(this._config);
+  }
+  /**
+   * Sets the null category configuration of the bar chart.
+   * @param {WebChartNullCategory} nullCategory [Optional] The null category configuration to set.
+   */
+  setNullCategory(e) {
+    const i = this.getNullCategory();
+    _(i, e) || (Fe(this._config, e), this.emitConfigUpdate("setNullCategory"));
   }
   /**
    * Resets the config to the default config
@@ -412,20 +442,55 @@ class Ce extends u {
     const e = this._config.id;
     this._config = await this.generateDefaultConfig(), this._config.id = e, this.dispatchEvent(new CustomEvent("arcgisChartsModelDataChange")), this.emitConfigUpdate("resetConfig");
   }
+  // #endregion
+  // ---------------------------------------------------------------------------------------------
+  // #region General Props
+  // ---------------------------------------------------------------------------------------------
+  /**
+   * Generate the proper chart title given the current config.
+   *
+   * @returns {string}
+   */
+  async generateChartTitle() {
+    return this.layerInfo !== void 0 ? await oe(this._config, this.layerInfo) : "";
+  }
+  /**
+   * Generate the proper x-axis title given the current config.
+   *
+   * @returns {string}
+   */
+  generateXAxisTitle() {
+    const e = this.getXAxisField();
+    return this.layerInfo !== void 0 ? M(this.layerInfo.layerFieldsInfo, e) : "";
+  }
+  /**
+   * Generate the proper y-axis title given the current config.
+   *
+   * @returns {string}
+   */
+  async generateYAxisTitle() {
+    return this.layerInfo !== void 0 ? await S({
+      config: this._config,
+      layerInfo: this.layerInfo,
+      numericFields: o(this._config),
+      aggregationType: f(this._config)
+    }) : "";
+  }
+  // #endregion
 }
-Z(Ce, [
-  $,
-  se,
-  ae,
-  oe,
+ne(xe, [
+  U,
   re,
-  ne,
-  ee,
-  ie,
-  ge
+  le,
+  ge,
+  ce,
+  fe,
+  N,
+  L,
+  de
 ]);
 export {
-  Ce as S,
-  fe as a,
-  me as s
+  xe as S,
+  ye as a,
+  Ce as s
 };