@arcgis/charts-components 5.1.0-next.82 → 5.1.0-next.83

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

@@ -1,10 +1,10 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import { substitute as w } from "@arcgis/core/intl.js";
+import { substitute as R } from "@arcgis/core/intl.js";
 import { cloneDeep as ie, isEmpty as Ae, memoize as ve } from "lodash-es";
 import "@arcgis/toolkit/type";
 import { w as fe, u as v, r as I, k as Ie, n as L, m as j, p as Le, t as qe, s as G } from "./series-types.js";
 import { i as Ve, R as Ne } from "./rest-js-object-literals.js";
-import { d6 as J, d8 as Oe, cY as ke, dS as De, a1 as Re, ap as Y, e4 as we, e7 as Pe, R as Me, C as D, c5 as se, d_ as Ee, h as $e, c4 as Ye, a8 as We, bq as Xe, cT as Ue, am as je, l as He, dC as Ke, $ as V, c_ as Qe, e8 as _e, _ as ze, e9 as oe, dA as Ge, ea as Je, dw as Ze, B as et, cU as K, bm as R, e5 as tt, e2 as H, bI as W, bp as Se, ax as it, e3 as ae, cD as st, x as Z, d1 as at, d9 as ue, cG as U, aZ as rt, b8 as lt, bu as nt, aB as ot, cP as ce, aG as de, aL as ye, b0 as ut } from "./index.js";
+import { d6 as J, d8 as Oe, cY as ke, dS as De, a1 as we, ap as Y, e4 as Re, e7 as Pe, R as Me, C as D, c5 as se, d_ as Ee, h as $e, c4 as Ye, a8 as We, bq as Xe, cT as Ue, am as je, l as He, dC as Ke, $ as V, c_ as Qe, e8 as _e, _ as ze, e9 as oe, dA as Ge, ea as Je, dw as Ze, B as et, cU as K, bm as w, e5 as tt, e2 as H, bI as W, bp as Se, ax as it, e3 as ae, cD as st, x as Z, d1 as at, d9 as ue, cG as U, aZ as rt, b8 as lt, bu as nt, aB as ot, cP as ce, aG as de, aL as ye, b0 as ut } from "./index.js";
 import "@arcgis/toolkit/intl";
 import "luxon";
 import "@arcgis/core/Graphic.js";
@@ -227,10 +227,10 @@ function At(t, e) {
   return i;
 }
 function vi(t) {
-  const { data: e, config: i, hideEmptySeries: r } = t, a = i.series.length, s = ie(i);
+  const { data: e, config: i, showEmptySeries: r } = t, a = i.series.length, s = ie(i);
   let l = !1;
-  if (r && a > 1 && e) {
-    const n = Re(e), u = fe(i?.series), c = Y(i?.series), S = /* @__PURE__ */ new Set();
+  if (!r && a > 1 && e) {
+    const n = we(e), u = fe(i?.series), c = Y(i?.series), S = /* @__PURE__ */ new Set();
     switch (u) {
       case v.ComboLineAndBarSeries:
       case v.BarSeries:
@@ -247,7 +247,7 @@ function vi(t) {
         break;
       }
       case v.BoxPlotSeries: {
-        if (we(i)) {
+        if (Re(i)) {
           const y = Pe(i);
           i.series.forEach((m) => {
             let g, d;
@@ -312,7 +312,7 @@ const Ii = (t) => {
   }), q({ config: e, value: null, axisIndex: 1, isMax: !1 }), q({ config: e, value: null, axisIndex: 1, isMax: !0 });
 }, Di = (t) => {
   It(0, t);
-}, Ri = (t) => t.hideEmptyRowsAndColumns, wi = (t, e) => {
+}, wi = (t) => t.hideEmptyRowsAndColumns, Ri = (t, e) => {
   t.hideEmptyRowsAndColumns = e;
 }, Pi = (t, e) => {
   const i = t.series[0];
@@ -323,7 +323,7 @@ const Ii = (t) => {
 }, $i = (t) => t.series[0].gradientRules, Yi = (t) => {
   const { yField: e, config: i, layerInfo: r } = t, { layerFieldsInfo: a } = r, s = le(1, i), l = qt(i), n = K(i), u = i.series[0];
   if (typeof e == "string" && l !== e && u && (u.y = e, ht(i), l === s || n)) {
-    const c = R(a, e);
+    const c = w(a, e);
     P(i, 1, c);
   }
 }, qt = (t) => t.series[0].y ?? "", Wi = (t) => {
@@ -466,14 +466,14 @@ function E(t) {
   return ie(g);
 }
 function X(t, e, i) {
-  const { layerFieldsInfo: r } = e, { idField: a, isTraditionalTypeOID: s } = W(e.layer), l = M(t), n = _(t), u = Be(t), c = ne(t), S = s && (n.length === 0 || n.includes(a)), o = it(u, i), y = S ? "" : n.map((p) => R(r ?? [], p)).join(", "), m = R(r ?? [], l), g = R(r ?? [], c), d = t.series.some((p) => N(p)), f = d ? "category" : "xAxisField", b = m;
+  const { layerFieldsInfo: r } = e, { idField: a, isTraditionalTypeOID: s } = W(e.layer), l = M(t), n = _(t), u = Be(t), c = ne(t), S = s && (n.length === 0 || n.includes(a)), o = it(u, i), y = S ? "" : n.map((p) => w(r ?? [], p)).join(", "), m = w(r ?? [], l), g = w(r ?? [], c), d = t.series.some((p) => N(p)), f = d ? "category" : "xAxisField", b = m;
   let h = "";
   if (Te({
     fieldName: l,
     numericFields: n,
     fieldList: r
   }))
-    h = w(i.titleLabels.aggrTypeOfAggrFields, {
+    h = R(i.titleLabels.aggrTypeOfAggrFields, {
       aggregationType: o,
       aggregationFields: y
     });
@@ -481,13 +481,13 @@ function X(t, e, i) {
     const p = S ? a : y;
     if (c === "") {
       const k = d ? "aggrTypeCategory" : "aggrTypeXAxisField";
-      h = w(i.titleLabels[k], {
+      h = R(i.titleLabels[k], {
         aggregationType: p,
         [f]: b
       });
     } else {
       const k = d ? "aggrTypeCategoryBySplitBy" : "aggrTypeXAxisFieldBySplitBy";
-      h = w(i.titleLabels[k], {
+      h = R(i.titleLabels[k], {
         aggregationType: p,
         [f]: b,
         splitByField: g
@@ -496,13 +496,13 @@ function X(t, e, i) {
   } else if (u === I.Count)
     if (c === "") {
       const p = d ? "aggrTypeCategory" : "aggrTypeXAxisField";
-      h = w(i.titleLabels[p], {
+      h = R(i.titleLabels[p], {
         aggregationType: o,
         [f]: b
       });
     } else {
       const p = d ? "aggrTypeCategoryBySplitBy" : "aggrTypeXAxisFieldBySplitBy";
-      h = w(i.titleLabels[p], {
+      h = R(i.titleLabels[p], {
         aggregationType: o,
         [f]: b,
         splitByField: g
@@ -510,7 +510,7 @@ function X(t, e, i) {
     }
   else if (c !== "") {
     const p = d ? "aggrTypeOfAggrFieldByCategoryBySplitByField" : "aggrTypeOfAggrFieldByXAxisFieldBySplitByField";
-    h = w(i.titleLabels[p], {
+    h = R(i.titleLabels[p], {
       aggregationType: o,
       aggregationField: y,
       [f]: b,
@@ -518,7 +518,7 @@ function X(t, e, i) {
     });
   } else if (n.length > 0) {
     const p = d ? "aggrTypeOfAggrFieldsByCategory" : "aggrTypeOfAggrFieldsByXAxisField";
-    h = w(i.titleLabels[p], {
+    h = R(i.titleLabels[p], {
       aggregationType: o,
       aggregationFields: y,
       [f]: b
@@ -636,7 +636,7 @@ function Ce(t) {
     i && h !== u && (p = {
       ...p,
       id: h,
-      name: R(n, h)
+      name: w(n, h)
     });
     let k = h;
     p.query !== void 0 && (r !== I.NoAggregation ? (k = b, p.query.outStatistics = [
@@ -786,7 +786,7 @@ const Ts = (t) => {
     layerInfo: l,
     commonStrings: n,
     splitByFieldInfos: u
-  } = t, { layerFieldsInfo: c } = l ?? {}, S = ft(s), o = M(s), y = c.find((C) => C.name === o), m = s.series[0]?.query === void 0, g = c.find((C) => C.name === e), d = z(s, l, n), f = be(s, l, n), b = Rt(s, l);
+  } = t, { layerFieldsInfo: c } = l ?? {}, S = ft(s), o = M(s), y = c.find((C) => C.name === o), m = s.series[0]?.query === void 0, g = c.find((C) => C.name === e), d = z(s, l, n), f = be(s, l, n), b = wt(s, l);
   let h = Fe(s);
   const p = s.series.some((C) => N(C)), k = ct(s.series), T = dt(s.series), O = ae(s), F = {};
   O && (F.classBreaksRules = s.series[0]?.classBreaksRules, F.xTemporalBinning = s.series[0]?.xTemporalBinning, F.yTemporalBinning = s.series[0]?.yTemporalBinning, F.emptyCells = s.series[0]?.emptyCells, F.nullPolicy = s.nullPolicy);
@@ -823,7 +823,7 @@ const Ts = (t) => {
     commonStrings: n,
     splitByFieldInfos: u
   })), b && s.series[0].type !== v.HeatSeries) {
-    const C = R(c, e);
+    const C = w(c, e);
     P(s, 0, C);
   }
   if (f && s.series[0].type !== v.HeatSeries) {
@@ -855,7 +855,7 @@ const Ts = (t) => {
     n = a.axisLabels.values;
   else if (Ae(l)) {
     const c = s.query?.outStatistics?.[0]?.onStatisticField;
-    c !== void 0 && c !== W(r.layer).idField && (n = R(r.layerFieldsInfo, c));
+    c !== void 0 && c !== W(r.layer).idField && (n = w(r.layerFieldsInfo, c));
   } else {
     const c = String(xe(s)).trim().replace(/'/gu, "");
     n = Se({
@@ -879,7 +879,7 @@ const Ts = (t) => {
 }, Cs = async (t, e) => {
   const i = M(t), r = Fe(t)?.type, a = _(t), s = Y(t.series);
   let l = [];
-  return r === v.CategoryAxisFormat && (s === D.BarAndLineFromFields || i === Z ? l = a.map((n) => R(e?.layerFieldsInfo, n)) : i.trim() !== "" && i !== Z && e !== void 0 && (l = await yt({
+  return r === v.CategoryAxisFormat && (s === D.BarAndLineFromFields || i === Z ? l = a.map((n) => w(e?.layerFieldsInfo, n)) : i.trim() !== "" && i !== Z && e !== void 0 && (l = await yt({
     layerInfo: e,
     config: t,
     category: i
@@ -899,8 +899,8 @@ function be(t, e, i) {
   }), a = le(1, t), s = K(t);
   return r === a || s;
 }
-function Rt(t, e) {
-  const i = R(e.layerFieldsInfo, M(t)), r = le(0, t), a = K(t);
+function wt(t, e) {
+  const i = w(e.layerFieldsInfo, M(t)), r = le(0, t), a = K(t);
   return i === r || a;
 }
 function bs(t) {
@@ -979,8 +979,8 @@ export {
   ps as n,
   gs as o,
   fs as p,
-  Ri as q,
-  wi as r,
+  wi as q,
+  Ri as r,
   Yi as s,
   Ki as t,
   Hi as u,

package/dist/components/arcgis-chart/customElement.d.ts

@@ -73,14 +73,14 @@ export abstract class ArcgisChart extends LitElement {
    * @deprecated since 5.0. Use [autoDestroyDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#autoDestroyDisabled) instead.
    * @default false
    */
-  accessor autoDisposeChart: boolean | undefined;
+  accessor autoDisposeChart: boolean;
   /**
    * When `true`, the data label text color is automatically adjusted for readability based on its background.
    * If the label is dark and appears over a dark series area, the text color is switched to either the chart background color or white.
    *
    * @default false
    */
-  accessor autoInverseDataLabelTextColor: boolean | undefined;
+  accessor autoInverseDataLabelTextColor: boolean;
   /**
    * The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.
    *
@@ -654,8 +654,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  get disableInteractions(): boolean;
-  set disableInteractions(value: boolean | undefined);
+  accessor disableInteractions: boolean;
   /**
    * Disables the toggling of series via the legend items.
    *
@@ -663,7 +662,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  accessor disableTogglingLegendItems: boolean | undefined;
+  accessor disableTogglingLegendItems: boolean;
   /**
    * Whether to enable automatic chart theming based on Calcite theme detection.
    *
@@ -702,7 +701,7 @@ export abstract class ArcgisChart extends LitElement {
    * @deprecated since 5.1. Won't be replaced.
    * @default false
    */
-  accessor enableResponsiveFeatures: boolean | undefined;
+  accessor enableResponsiveFeatures: boolean;
   /**
    * Whether to display an error alert and hide the chart when it can't be created or updated.
    *
@@ -722,7 +721,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  accessor filterByExtent: boolean | undefined;
+  accessor filterByExtent: boolean;
   /**
    * When `true`, all chart elements are filtered based on the selection.
    *
@@ -731,7 +730,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  accessor filterBySelection: boolean | undefined;
+  accessor filterBySelection: boolean;
   /**
    * A callback function used to format the gauge inner label. If the returned string contains HTML tags they will be interpreted as such.
    *
@@ -750,13 +749,14 @@ export abstract class ArcgisChart extends LitElement {
    *
    * **Note**: Not applicable to gauge.
    *
+   * @deprecated since 5.1. Use [showEmptySeries](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#showEmptySeries) instead.
    * @default false
    */
   accessor hideEmptySeries: boolean | undefined;
   /**
    * Hides the license watermark.
    *
-   * @deprecated since 5.1. Won't be replaced.
+   * @deprecated since 5.1. Use [showLicenseWatermark](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#showLicenseWatermark) instead.
    * @default false
    */
   accessor hideLicenseWatermark: boolean | undefined;
@@ -765,7 +765,28 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  accessor hideLoaderAnimation: boolean | undefined;
+  accessor hideLoaderAnimation: boolean;
+  /**
+   * Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an axis when the data contains values <= 0).
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor hideUIMessages: boolean;
+  /**
+   * Whether to keep missing categories from a count aggregation as gaps in the chart's data.
+   *
+   * When data is retrieved from the server, the server excludes all features having a count of 0 from the response; hence resulting in missing entries on the charts.
+   *
+   * When this property is set to `true`, the dataset will keep these gaps instead of filling them with 0s.
+   *
+   * When left to `false`,  the chart's dataItems associated with empty (no value) categories (from only a `Count` aggregation)
+   * will be populated with 0s, via the`completeDataForEmptyCategoriesWithZeros` method.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor hideZeroCountCategories: boolean;
   /**
    * When `true`, disables the default setting that uses debounce functions to handle the visibility of markers
    * that are outside of the plotting area when the min/max bound changes and/or when a zoom action is performed
@@ -777,9 +798,10 @@ export abstract class ArcgisChart extends LitElement {
    *
    * **Note**: Applicable to line chart only.
    *
+   * @deprecated since 5.1. Won't be replaced.
    * @default false
    */
-  accessor ignoreSmoothRenderingLimit: boolean | undefined;
+  accessor ignoreSmoothRenderingLimit: boolean;
   /**
    * This property will be effective when the component's `view` is provided or when the `layer` is set to a FeatureLayerView.
    *
@@ -790,7 +812,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  accessor ignoreViewExtent: boolean | undefined;
+  accessor ignoreViewExtent: boolean;
   /**
    * Used to perform queries.
    * If the layer is a `FeatureLayerView` or if the layer and the `view` property are both provided, the queries will be executed client-side.
@@ -854,7 +876,7 @@ export abstract class ArcgisChart extends LitElement {
    * @deprecated since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#legendVisibility) prop instead.
    * @default false
    */
-  accessor legendVisibility: boolean | undefined;
+  accessor legendVisibility: boolean;
   /** Defines the colors for the loader animation. */
   accessor loaderColors: LoaderColors | undefined;
   /** Custom message overrides for the chart's strings. */
@@ -1126,7 +1148,7 @@ export abstract class ArcgisChart extends LitElement {
   /**
    * Whether to consider a `null` statistic as valid. If set to `false` and the data has only null values, the chart's dataset will be considered empty:
    * - The corresponding warning event will be sent
-   * - The "no data" message will be displayed (unless `showUIMessages` is set to `false`)
+   * - The "no data" message will be displayed (unless `hideUIMessages` is set to `true` or `showUIMessages` is set to `false`)
    *
    * @default false
    */
@@ -1136,7 +1158,7 @@ export abstract class ArcgisChart extends LitElement {
   /**
    * Builds charts sequentially instead of rendering them all at once
    *
-   * @deprecated since 5.1. Won't be replaced.
+   * @deprecated since 5.1. Use [skipChartCreationQueue](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#skipChartCreationQueue) instead.
    * @default false
    */
   accessor queueChartCreation: boolean | undefined;
@@ -1144,6 +1166,7 @@ export abstract class ArcgisChart extends LitElement {
    * When `true`, the chart's dataItems associated with empty (no value) categories (from only a `Count` aggregation)
    * will be populated with 0s, via the `completeDataForEmptyCategoriesWithZeros` method.
    *
+   * @deprecated since 5.0. Use [hideZeroCountCategories](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideZeroCountCategories) instead.
    * @default false
    */
   accessor replaceNoValueCategoryWithZero: boolean | undefined;
@@ -1159,7 +1182,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  accessor returnFeaturesExtent: boolean | undefined;
+  accessor returnFeaturesExtent: boolean;
   /**
    * When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.
    *
@@ -1167,7 +1190,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  accessor returnSelectionIndexes: boolean | undefined;
+  accessor returnSelectionIndexes: boolean;
   /**
    * When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.
    * Only considered for a data source using a feature layer.
@@ -1186,7 +1209,7 @@ export abstract class ArcgisChart extends LitElement {
    * @deprecated since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#rotatedState) prop instead.
    * @default false
    */
-  accessor rotation: boolean | undefined;
+  accessor rotation: boolean;
   /** Applies runtime data filters to the chart. */
   accessor runtimeDataFilters: WebChartDataFilters | undefined;
   /**
@@ -1224,13 +1247,45 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  accessor setTimeBinningInfoWhenNotProvided: boolean | undefined;
+  accessor setTimeBinningInfoWhenNotProvided: boolean;
+  /**
+   * Show the series on the chart even if it doesn't have data (i.e. empty)
+   *
+   * When `false`, the empty series are completely hidden from the chart and the legend.
+   * For example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by extent).
+   *
+   * **Note**: Not applicable to gauge.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor showEmptySeries: boolean;
+  /**
+   * Shows the license watermark.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor showLicenseWatermark: boolean;
   /**
    * Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an axis when the data contains values <= 0).
    *
+   * @deprecated since 5.1. Use [hideUIMessages](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideUIMessages) instead.
    * @default false
    */
   accessor showUIMessages: boolean | undefined;
+  /**
+   * Whether to skip the chart rendering queue.
+   *
+   * When `true`, charts will render immediately without waiting for other charts
+   * to finish rendering. This bypasses the queuing mechanism used by `amChartsOptions.queue`.
+   *
+   * When `false` (default), charts are queued so that only one chart renders at a time.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor skipChartCreationQueue: boolean;
   /**
    * Whether to synchronize the selection between chart components from the same layer.
    *
@@ -1273,13 +1328,13 @@ export abstract class ArcgisChart extends LitElement {
    *
    * @default false
    */
-  accessor useAnimatedCharts: boolean | undefined;
+  accessor useAnimatedCharts: boolean;
   /**
    * Allows the use of the fields alias from the `layer.popupTemplate` when rendering the field names on the chart (e.g. tooltips, axes, legend).
    *
    * @default false
    */
-  accessor usePopupTemplateFieldsInfo: boolean | undefined;
+  accessor usePopupTemplateFieldsInfo: boolean;
   /** Used to access the feature layer view instance in order to perform client side queries. */
   accessor view: MapView | SceneView | undefined;
   /**
@@ -1381,9 +1436,6 @@ export abstract class ArcgisChart extends LitElement {
    * **Note**: Not applicable to gauge.
    */
   switchSelection(): Promise<void>;
-  "@setterTypes": {
-    disableInteractions?: boolean | undefined;
-  };
   /** Event triggered once the chart axes min/max values are computed. */
   readonly arcgisAxesMinMaxChange: import("@arcgis/lumina").TargetedEvent<this, AxesMinMaxChangePayload>;
   /** Event triggered when an error is detected with the data set. */