@arcgis/charts-components 5.0.0-next.162 → 5.0.0-next.164

package/dist/chart-rendering/common/interfaces.d.ts

@@ -1,6 +1,6 @@
-import type MapView from "@arcgis/core/views/MapView";
-import type SceneView from "@arcgis/core/views/SceneView";
-import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView";
+import type MapView from "@arcgis/core/views/MapView.js";
+import type SceneView from "@arcgis/core/views/SceneView.js";
+import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView.js";
 import type { SupportedLayer } from "../../interfaces.js";
 import type { WebChart, WebChartDataFilters, WebChartPieChartSlice, WebGaugeChart } from "../../spec/web-chart.js";
 import type { WebChartDataItem, WebChartDataItemValue, WebChartDataTypes } from "../../spec/data-source.js";
@@ -21,7 +21,7 @@ export interface NotifyOptions {
 export type PieChartLegendValueLabelFormatCallback = (value?: number, percent?: number) => string;
 
 /**
- * Describes the signature of the callback function used to customize a guide's tooltip
+ * Describes the signature of the callback function used to customize a guide's tooltip.
  *
  * @param props
  */
@@ -29,8 +29,8 @@ export type GuideTooltipFormatCallback = (props: GuideTooltipFormatCallbackProps
 
 /**
  * Describes the signature of the callback function used to customize an axis labels.
- * The `value` is the displayed label.
- * The `originalValue` is provided when the `value` is an alias or coded domain description.
+ * - `value`: the displayed label.
+ * - `originalValue`: provided when the `value` is an alias or coded domain description.
  *
  * @param value
  * @param originalValue
@@ -46,7 +46,7 @@ export type GaugeInnerLabelFormatCallback = (value?: number) => string;
 
 /**
  * Describes the signature of the callback function executed before rendering the chart.
- * The `slices` property will be  only provided for the pie charts.
+ * The `slices` property will be only provided for the pie charts.
  *
  * @param props
  */
@@ -58,7 +58,7 @@ export type PreRenderCallback = (props: {
 
 /** JSON representation of the runtime chart options for the update or initialization. */
 export interface ChartOptions {
-  /** Whether to allow the object id to be used as a statistic other than COUNT. */
+  /** Whether to allow the object id to be used as a statistic other than `COUNT`. */
   allowUsingObjectIdStat?: boolean;
   /**
    * Whether to consider a `null` statistic as valid. If set to `false` and the data has only
@@ -74,9 +74,10 @@ export interface ChartOptions {
   showUIMessages?: boolean;
   /**
    * A property representing the selection to apply on the chart.
+   *
    * The properties are considered in the following order:
-   * - selectionData.selectionOIDs: an array of Object Ids (for Feature Layer) representing a selection to apply to the chart.
-   * - selectionData.selectionItems: an array of data items representing a selection to apply to the chart.
+   * - `selectionData.selectionOIDs`: an array of object Ids (for Feature Layer) representing a selection to apply to the chart.
+   * - `selectionData.selectionItems`: an array of data items representing a selection to apply to the chart.
    */
   selectionData?: SelectionData;
   /**
@@ -89,8 +90,9 @@ export interface ChartOptions {
   /**
    * Allows the features extent to be returned, through the `arcgisChartsJSDataProcessComplete` and `arcgisChartsJSSelectionComplete` events payload.
    * Applies only to:
-   *   - charts using an aggregation
-   *   - data source using a feature layer compatible with envelope aggregation
+   *   - Charts using an aggregation
+   *   - Data source using a feature layer compatible with envelope aggregation
+   *
    * The extent (IExtent) is returned through a property called `arcgis_charts_features_extent`.
    */
   returnFeaturesExtent?: boolean;
@@ -100,16 +102,15 @@ export interface ChartOptions {
    * If no style is provided for the non selected elements, the chart's style is applied.
    */
   selectionTheme?: SelectionTheme;
-  /** used to perform client-side queries */
+  /** Used to perform client-side queries. */
   view?: MapView | SceneView;
-  /** used to perform queries */
+  /** Used to perform queries. */
   layer?: FeatureLayerView | SupportedLayer;
-  /** enable filter by selection */
+  /** Enable filter by selection. */
   filterBySelection?: boolean;
   /**
-   * Re initialize chart object if the chart object is disposed.
-   * Honoured only during the update call.
-   * default is true;
+   * Re-initialize chart object if the chart object is disposed. Honored only during the update call.
+   * Default is `true`.
    */
   autoRecreateChart?: boolean;
   /**
@@ -118,13 +119,13 @@ export interface ChartOptions {
    * **Note**: Currently this feature is only available for stacked bar series and pie charts with `dataLabelsInside` set to true.
    */
   autoInverseDataLabelTextColor?: boolean;
-  /** optional create message to be displayed in the chart container. */
+  /** Optional create message to be displayed in the chart container. */
   createMessage?: string;
   /** Used to hide the loader animation (curtain and spinner), showed by default at every update. */
   hideLoaderAnimation?: boolean;
   /**
-   * Hide the series from the chart if it doesn't have data (i.e. empty)
-   * For example, after apply data filters, filter by attribute or geometry (as when using the filter by extent)
+   * Hide the series from the chart if it doesn't have data (i.e. empty).
+   * For example, after apply data filters, filter by attribute or geometry (as when using the filter by extent).
    */
   hideEmptySeries?: boolean;
   /**
@@ -142,110 +143,100 @@ export interface ChartOptions {
   /**
    * Used to customize the chart's limits, especially the maximum number of elements (bars, markers...) to be displayed.
    * The chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation
-   * or update of the chart, or render the elements up to the given limits. Available on all charts but scatterplot and histogram.
+   * or update of the chart, or render the elements up to the given limits.
+   *
+   * Not applicable for scatterplot and histogram.
    */
   chartLimits?: ChartElementLimit;
   /**
-   * Set the chart's mode (zoom, selection, none)
-   * - zoom: allows to zoom on the chart. All selection is disabled
-   * - mono-selection: the selection is enabled but only one element can be selected. Zoom is disabled
-   * - multi-selection: the selection is enabled and allows selecting multiple elements. Zoom is disabled
-   * - multi-selection-with-ctrl-key: the selection is enabled and allows selecting multiple elements when the ctrl/cmd key is pressed. Zoom is disabled
-   * - none: the zoom and selection features are disabled
+   * Set the chart's mode.
+   * - `zoom`: Allows to zoom on the chart. All selection is disabled.
+   * - `mono-selection`: The selection is enabled but only one element can be selected. Zoom is disabled.
+   * - `multi-selection`: The selection is enabled and allows selecting multiple elements. Zoom is disabled.
+   * - `multi-selection-with-ctrl-key`: The selection is enabled and allows selecting multiple elements when the ctrl/cmd key is pressed. Zoom is disabled.
+   * - `none`: The zoom and selection features are disabled.
    */
   actionMode?: ActionModes;
   /**
-   * Sets the cursor range:
-   * - CursorRange.MultiAxes: allows to draw a free rectangle
-   * - CursorRange.XAxis: allows to draw a rectangle bound to the x-axis
-   * - CursorRange.YAxis: allows to draw a rectangle bound to the y-axis
-   * - undefined: defaults to a preset behavior according to the chart type and action mode
+   * Sets the cursor range.
+   * - `multi-axes`: Allows to draw a free rectangle
+   * - `x-axis`: Allows to draw a rectangle bound to the x-axis
+   * - `y-axis`: Allows to draw a rectangle bound to the y-axis
+   * - `undefined`: Defaults to a preset behavior according to the chart type and action mode
+   *
    * Applies only when the action mode is set to zoom or multi-selection.
    */
   cursorRange?: CursorRange;
-  /** If the option is set to true, the chart gets a full refresh. */
+  /** When `true`, the chart gets a full refresh. */
   dataUpdated?: boolean;
   /**
-   * Helps identifying an update triggered after a view extent change.
+   * Helps to identify an update triggered after a view extent change.
    * This is used to support a selection workflow while the filter by extent mode is enabled.
    */
   viewExtentUpdated?: boolean;
   /** Used to apply runtime filters to the chart's data while in Feature Layer mode. */
   runtimeDataFilters?: WebChartDataFilters;
   /**
-   * This property will be effective when the component's `view` is provided or when the `layer` is set to a FeatureLayerView.
+   * This property will be effective when the component's `view` is provided or when the `layer` is set to a `FeatureLayerView`.
    * By default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any
    * geometry passed through the config (component.config.dataFilters) or the runtime filters (component.runtimeDataFilters).
    * Setting this property to `false` signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.
    */
   ignoreViewExtent?: boolean;
   /**
-   * Can be used when creating or updating a chart compatible with time binning. If this option is `true`, the series properties
-   * `unit` and `size` become optional and will be automatically set to values that fit the data set.
+   * Can be used when creating or updating a chart compatible with time binning.
+   *
+   * When `true`, the series properties `unit` and `size` become optional and will be automatically set to values that fit the data set.
    */
   setTimeBinningInfoWhenNotProvided?: boolean;
   /**
    * Can be used to disable the default setting that uses debounce functions to handle the visibility of markers
-   * (for scatter-plot and line charts) that are outside of plotting area when min/max bound changes and/or
+   * (for scatterplots and line charts) that are outside of plotting area when min/max bound changes and/or
    * when zoom action is performed (via chart cursor or scrollbar), to increase performance.
    *
    * This property will be set when the chart is created and cannot be updated after that.
    *
-   * It's recommended that this property should only be set to true for small datasets.
+   * It's recommended that this property should only be set to `true` for small datasets.
    */
   ignoreSmoothRenderingLimit?: boolean;
-  /**
-   * Used to customize the way the tooltips are rendered. The callback function can return an HTML string and the tags will
-   * be interpreted properly.
-   */
+  /** Used to customize how the tooltips are rendered. The callback function can return an HTML string and the tags will be interpreted properly. */
   tooltipFormatter?: TooltipFormatters;
   dataLabelFormatter?: BarAndLineDataLabelFormatCallback | HistogramLabelFormatCallback | PieChartLabelFormatCallback | ScatterplotLabelFormatCallback;
-  /**
-   * Used to customize the way the guides' tooltip are rendered. The callback function can return an HTML string and the tags will
-   * be interpreted properly.
-   */
+  /** Used to customize how the guides' tooltip are rendered. The callback function can return an HTML string and the tags will be interpreted properly. */
   guideTooltipFormatter?: GuideTooltipFormatCallback;
-  /**
-   * Used to customize the way the x-axis labels are rendered. The callback function can return an HTML string and the tags will
-   * be interpreted properly.
-   */
+  /** Used to customize how the x-axis labels are rendered. The callback function can return an HTML string and the tags will be interpreted properly. */
   xAxisLabelFormatter?: AxisLabelFormatCallback;
   /**
-   * Used to customize the way the y-axis labels are rendered. The callback function can return an HTML string and the tags will
-   * be interpreted properly.
-   * Not available on gauge for now.
+   * Used to customize how the y-axis labels are rendered. The callback function can return an HTML string and the tags will be interpreted properly.
+   * Not applicable to gauge.
    */
   yAxisLabelFormatter?: AxisLabelFormatCallback;
   /**
-   * Used to customize the way the secondary y-axis labels are rendered on a dual axis chart. The callback function can return an HTML
-   * string and the tags will be interpreted properly.
-   * Not available on gauge for now.
+   * Used to customize how the secondary y-axis labels are rendered on a dual axis chart. The callback function can return an HTML string and the tags will be interpreted properly.
+   * Not applicable to gauge.
    */
   secondaryYAxisLabelFormatter?: AxisLabelFormatCallback;
   pieChartLegendValueLabelFormatter?: PieChartLegendValueLabelFormatCallback;
-  /**
-   * Used to customize the gauge inner label. The callback function can return an HTML string and the tags will
-   * be interpreted properly.
-   */
+  /** Used to customize the gauge inner label. The callback function can return an HTML string and the tags will be interpreted properly. */
   gaugeInnerLabelFormatter?: GaugeInnerLabelFormatCallback;
   /**
-   * Used to disable the toggling of legend items for XYChart series, Pie slices,
-   * Histogram overlays, and Scatter-plot trend line.
-   * This option is not applied for Gauge.
+   * Used to disable the toggling of legend items for xy chart series, pie slices, histogram overlays, and scatterplot trend line.
+   *
+   * Not applicable to gauge.
    */
   disableTogglingLegendItems?: boolean;
   /**
    * Callback function executed after the data has been processed and before the chart renders.
    * Can be used to alter the config from information extracted from the data for instance.
-   * Only available for the pie chart and gauge at the moment.
+   * Only applicable to pie chart and gauge.
    */
   chartWillRender?: PreRenderCallback;
-  /** Can be set to true to read the fields from layer.popupTemplate and use their alias when rendering tooltips */
+  /** When `true` read the fields from `layer.popupTemplate` and use their alias when rendering tooltips. */
   usePopupTemplateFieldsInfo?: boolean;
 }
 
 /**
- * Describes the signature of the callback function used to customize the pie chart data labels and tooltips
+ * Describes the signature of the callback function used to customize the pie chart data labels and tooltips.
  *
  * @param category
  * @param value
@@ -255,7 +246,7 @@ export interface ChartOptions {
 export type PieChartLabelFormatCallback = (category: string, value?: number, percent?: number, originalCategory?: WebChartDataItemValue) => string;
 
 /**
- * Describes the signature of the callback function used to customize the histogram tooltips
+ * Describes the signature of the callback function used to customize the histogram tooltips.
  *
  * @param count
  * @param binMinValue
@@ -264,7 +255,7 @@ export type PieChartLabelFormatCallback = (category: string, value?: number, per
 export type HistogramLabelFormatCallback = (count: number, binMinValue: number, binMaxValue: number) => string;
 
 /**
- * Describes the signature of the callback function used to customize the scatterplot tooltips
+ * Describes the signature of the callback function used to customize the scatterplot tooltips.
  *
  * @param x
  * @param y
@@ -274,7 +265,7 @@ export type HistogramLabelFormatCallback = (count: number, binMinValue: number,
 export type ScatterplotLabelFormatCallback = (x: number, y: number, sizePolicyValue?: number, dataContext?: WebChartDataItem) => string;
 
 /**
- * Describes the signature of the callback function used to customize the bar and line chart plot data labels
+ * Describes the signature of the callback function used to customize the bar and line chart data labels.
  *
  * @param statValue
  * @param percent
@@ -291,19 +282,20 @@ export interface GuideTooltipFormatCallbackProps {
 export type TooltipFormatters = BarAndLineTooltipFormatCallback | BoxPlotTooltipFormatCallback | HistogramLabelFormatCallback | PieChartLabelFormatCallback | ScatterplotLabelFormatCallback;
 
 /**
- * Describes the signature of the callback function used to customize the bar and line chart plot tooltips
+ * Describes the signature of the callback function used to customize the bar and line chart plot tooltips.
  *
  * @param props
  */
 export type BarAndLineTooltipFormatCallback = (props: BarAndLineTooltipFormatCallbackProps) => string;
 
 /**
- * Describes the signature of the callback function used to customize the box plot tooltips
+ * Describes the signature of the callback function used to customize the box plot tooltips.
  *
  * @param props
  */
 export type BoxPlotTooltipFormatCallback = (props: BoxPlotTooltipFormatCallbackProps) => string;
 
+/** Describes the interface of the object passed to the callback function used to customize the bar and line chart tooltips. */
 export interface BarAndLineTooltipFormatCallbackProps {
   seriesName: string;
   statValue?: number;

package/dist/chunks/action-bar-utils.js

@@ -5,7 +5,7 @@ import "@arcgis/toolkit/intl";
 import "lodash-es";
 import "luxon";
 import "d3-array";
-import { dd as B, c$ as y, o as x, dh as u, a3 as f, _ as b } from "./index.js";
+import { de as B, d0 as y, o as x, di as u, a3 as f, _ as b } from "./index.js";
 import "@arcgis/core/geometry/support/jsonUtils.js";
 import "@arcgis/core/rest/support/AttributeBinsQuery.js";
 import "@arcgis/core/rest/support/StatisticDefinition.js";

package/dist/chunks/axis-lines-symbol.js

@@ -2,13 +2,13 @@
 import { C as r, m as a } from "./model-setter.js";
 import { a as f, s as c } from "./utils2.js";
 import { cloneDeep as x } from "lodash-es";
-import { aJ as y, bC as b, aH as m, aK as S } from "./index.js";
+import { aK as y, bD as b, aI as m, aL as S } from "./index.js";
 var p = Object.defineProperty, v = Object.getOwnPropertyDescriptor, _ = (s, e, t, l) => {
   for (var i = v(e, t), o = s.length - 1, n; o >= 0; o--)
     (n = s[o]) && (i = n(e, t, i) || i);
   return i && p(e, t, i), i;
 };
-function X(s) {
+function I(s) {
   return s !== void 0 && "xAxisTitleSymbol" in s;
 }
 class d extends r {
@@ -25,8 +25,8 @@ class d extends r {
 _([
   a
 ], d.prototype, "xAxisTitleSymbol");
-var u = Object.defineProperty, g = Object.getOwnPropertyDescriptor, L = (s, e, t, l) => {
-  for (var i = g(e, t), o = s.length - 1, n; o >= 0; o--)
+var u = Object.defineProperty, L = Object.getOwnPropertyDescriptor, g = (s, e, t, l) => {
+  for (var i = L(e, t), o = s.length - 1, n; o >= 0; o--)
     (n = s[o]) && (i = n(e, t, i) || i);
   return i && u(e, t, i), i;
 };
@@ -46,7 +46,7 @@ const A = (s) => {
       }) : t.labels.content = x(s), t.labels.content.text = l;
     }
 };
-function B(s) {
+function X(s) {
   return s !== void 0 && "axisLabelsSymbol" in s;
 }
 class O extends r {
@@ -60,44 +60,44 @@ class O extends r {
     h(e, this._config);
   }
 }
-L([
+g([
   a
 ], O.prototype, "axisLabelsSymbol");
-var P = Object.defineProperty, T = Object.getOwnPropertyDescriptor, D = (s, e, t, l) => {
-  for (var i = T(e, t), o = s.length - 1, n; o >= 0; o--)
+var P = Object.defineProperty, D = Object.getOwnPropertyDescriptor, T = (s, e, t, l) => {
+  for (var i = D(e, t), o = s.length - 1, n; o >= 0; o--)
     (n = s[o]) && (i = n(e, t, i) || i);
   return i && P(e, t, i), i;
 };
-const C = (s) => {
+const W = (s) => {
   for (const e of s.axes ?? [])
     if (e?.lineSymbol !== void 0)
       return e.lineSymbol;
-}, W = (s, e) => {
+}, j = (s, e) => {
   for (const t of e.axes ?? [])
     t !== void 0 && (t.lineSymbol = x(s) ?? S());
 };
-function E(s) {
+function B(s) {
   return s !== void 0 && "axisLinesSymbol" in s;
 }
-class j extends r {
+class w extends r {
   /**
    * Axis lines symbol (line width, style, color).
    */
   get axisLinesSymbol() {
-    return C(this._config);
+    return W(this._config);
   }
   set axisLinesSymbol(e) {
-    W(e, this._config);
+    j(e, this._config);
   }
 }
-D([
+T([
   a
-], j.prototype, "axisLinesSymbol");
+], w.prototype, "axisLinesSymbol");
 export {
   d as W,
   O as a,
-  j as b,
-  B as c,
-  X as d,
-  E as i
+  w as b,
+  X as c,
+  I as d,
+  B as i
 };

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

@@ -1,7 +1,7 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.0/LICENSE.txt */
 import { m as n } from "./model-setter.js";
-import { S as f, s as p, a as S } from "./serial-chart-model.js";
-import { g as c } from "./serial-chart-data.js";
+import { S as c, s as p, a as S } from "./serial-chart-model.js";
+import { g as f } from "./serial-chart-data.js";
 import { a as g } from "./data.js";
 import { g as h, s as y, a as u, b as v } from "./bar-chart-series.js";
 import "@arcgis/toolkit/intl";
@@ -10,7 +10,7 @@ import "luxon";
 import "d3-array";
 import "@arcgis/toolkit/type";
 import { W as b } from "./series-types.js";
-import { be as O, b7 as L, bL as a, aD as _, aq as I } from "./index.js";
+import { bf as O, b8 as _, bM as a, aE as L, ar as I } from "./index.js";
 import "@arcgis/core/Graphic.js";
 import "@arcgis/core/renderers/support/jsonUtils.js";
 import "@arcgis/core/symbols/support/symbolUtils.js";
@@ -34,7 +34,7 @@ var C = Object.defineProperty, z = Object.getOwnPropertyDescriptor, d = (o, e, t
     (m = o[s]) && (i = m(e, t, i) || i);
   return i && C(e, t, i), i;
 };
-class l extends f {
+class l extends c {
   constructor() {
     super(...arguments), this._chartType = b.BarSeries;
   }
@@ -49,7 +49,7 @@ class l extends f {
   generateDefaultConfig() {
     const e = O(this.commonStrings);
     return e.series = [
-      L({
+      _({
         objectIDField: a(this.layerInfo.layer).idField,
         commonStrings: this.commonStrings
       })
@@ -92,12 +92,12 @@ class l extends f {
   }
   resetSeriesStyling() {
     for (let e = 0; e < this.seriesLength; e += 1) {
-      const t = this.getSeriesId(e), r = _({
+      const t = this.getSeriesId(e), r = L({
         colorIndex: e,
         opacity: I
       });
       if (p(r, e, this._config), this.layerInfo !== void 0) {
-        const i = c({
+        const i = f({
           config: this._config,
           seriesIndex: e,
           layerInfo: this.layerInfo,
@@ -116,7 +116,7 @@ class l extends f {
     let t = !1;
     if (!e && this.layerInfo !== void 0)
       for (let r = 0; r < this.seriesLength; r += 1) {
-        const i = c({
+        const i = f({
           config: this._config,
           seriesIndex: r,
           layerInfo: this.layerInfo,