@arcgis/charts-components 5.2.0-next.94 → 5.2.0-next.96

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

@@ -12,6 +12,16 @@ export interface NotifyOptions {
   closable?: boolean;
 }
 
+/**
+ * Describes the signature of the callback function used to customize the pie chart data labels and tooltips.
+ *
+ * @param category
+ * @param value
+ * @param percent
+ * @param originalCategory
+ */
+export type PieChartLabelFormatCallback = (category: string, value?: number, percent?: number, originalCategory?: WebChartDataItemValue) => string;
+
 /**
  * Describes the signature of the callback function used to customize the pie chart legend value labels.
  *
@@ -20,6 +30,33 @@ export interface NotifyOptions {
  */
 export type PieChartLegendValueLabelFormatCallback = (value?: number, percent?: number) => string;
 
+/**
+ * Describes the signature of the callback function used to customize the histogram tooltips.
+ *
+ * @param count
+ * @param binMinValue
+ * @param binMaxValue
+ */
+export type HistogramLabelFormatCallback = (count: number, binMinValue: number, binMaxValue: number) => string;
+
+/**
+ * Describes the signature of the callback function used to customize the scatterplot tooltips.
+ *
+ * @param x
+ * @param y
+ * @param sizePolicyValue
+ * @param dataContext
+ */
+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 data labels.
+ *
+ * @param statValue
+ * @param percent
+ */
+export type BarAndLineDataLabelFormatCallback = (statValue: number, percent?: number) => string;
+
 /**
  * Describes the signature of the callback function used to customize a guide's tooltip.
  *
@@ -56,6 +93,8 @@ export type PreRenderCallback = (props: {
     slices?: WebChartPieChartSlice[];
 }) => Promise<WebChart | WebGaugeChart>;
 
+export type TooltipFormatters = BarAndLineTooltipFormatCallback | BoxPlotTooltipFormatCallback | HistogramLabelFormatCallback | PieChartLabelFormatCallback | ScatterplotLabelFormatCallback;
+
 /** JSON representation of the runtime chart options for the update or initialization. */
 export interface ChartOptions {
   /**
@@ -78,6 +117,10 @@ export interface ChartOptions {
    * - `selectionData.selectionItems`: an array of data items representing a selection to apply to the chart.
    */
   selectionData?: SelectionData;
+  /** Indicates if the selection by indexes changed. */
+  selectionByIndexesChanged?: boolean;
+  /** Indicates if the selection by items changed. */
+  selectionByItemsChanged?: boolean;
   /**
    * Indicates if the object ids need to be computed whenever a selection is made on or passed to the chart.
    * Only considered for a data source using a feature layer.
@@ -277,15 +320,23 @@ export interface ChartOptions {
    *
    * Not applicable to gauge.
    *
-   * @deprecated since 5.1. Use [togglingLegendItemsDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/chart-rendering/common/interfaces/#ChartOptions-togglingLegendItemsDisabled) instead.
+   * @deprecated since 5.1. Use [legendInteractionsDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/chart-rendering/common/interfaces/#ChartOptions-legendInteractionsDisabled) instead.
    */
   disableTogglingLegendItems?: boolean;
   /**
    * Used to disable the toggling of legend items for xy chart series, pie slices, histogram overlays, and scatterplot trend line.
    *
-   * Not applicable to gauge.
+   * Only applicable to charts with multiple series and while the legend is displayed.
+   *
+   * @deprecated since 5.2. Use [legendInteractionsDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/chart-rendering/common/interfaces/#ChartOptions-legendInteractionsDisabled) instead.
    */
   togglingLegendItemsDisabled?: boolean;
+  /**
+   * When `true`, disables the toggling of series or slices from the legend items. Clicking on the legend items will not hide or show the corresponding elements on the chart.
+   *
+   * **Note**: Only applicable to charts with multiple series and while the legend is displayed.
+   */
+  legendInteractionsDisabled?: 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.
@@ -324,41 +375,18 @@ export interface ChartOptions {
 }
 
 /**
- * Describes the signature of the callback function used to customize the pie chart data labels and tooltips.
- *
- * @param category
- * @param value
- * @param percent
- * @param originalCategory
- */
-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.
- *
- * @param count
- * @param binMinValue
- * @param binMaxValue
- */
-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 bar and line chart plot tooltips.
  *
- * @param x
- * @param y
- * @param sizePolicyValue
- * @param dataContext
+ * @param props
  */
-export type ScatterplotLabelFormatCallback = (x: number, y: number, sizePolicyValue?: number, dataContext?: WebChartDataItem) => string;
+export type BarAndLineTooltipFormatCallback = (props: BarAndLineTooltipFormatCallbackProps) => string;
 
 /**
- * Describes the signature of the callback function used to customize the bar and line chart data labels.
+ * Describes the signature of the callback function used to customize the box plot tooltips.
  *
- * @param statValue
- * @param percent
+ * @param props
  */
-export type BarAndLineDataLabelFormatCallback = (statValue: number, percent?: number) => string;
+export type BoxPlotTooltipFormatCallback = (props: BoxPlotTooltipFormatCallbackProps) => string;
 
 export interface GuideTooltipFormatCallbackProps {
   guideName: string;
@@ -367,22 +395,6 @@ export interface GuideTooltipFormatCallbackProps {
   guideIndex: number;
 }
 
-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.
- *
- * @param props
- */
-export type BarAndLineTooltipFormatCallback = (props: BarAndLineTooltipFormatCallbackProps) => string;
-
-/**
- * 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;

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

@@ -2,7 +2,7 @@
 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 { a3 as y, a5 as b, a4 as m, t as S } from "./index3.js";
+import { a0 as y, a2 as b, a1 as m, t as S } from "./index3.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);

package/dist/chunks/chart-model.js

@@ -2,7 +2,7 @@
 import { f as j } from "./utils.js";
 import { g as F, W, c as L, d as I } from "./series-length.js";
 import { m as a, C as n } from "./model-setter.js";
-import { a3 as p, a5 as c, a4 as f } from "./index3.js";
+import { a0 as p, a2 as c, a1 as f } from "./index3.js";
 import { u as z } from "./index2.js";
 import { p as N } from "./index.js";
 var R = Object.defineProperty, M = Object.getOwnPropertyDescriptor, U = (e, t, r, l) => {

package/dist/chunks/data-labels-symbol.js

@@ -1,7 +1,7 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
 import { cloneDeep as m } from "lodash-es";
 import { C as L, m as d } from "./model-setter.js";
-import { a3 as p, a5 as l, a4 as v } from "./index3.js";
+import { a0 as p, a2 as l, a1 as v } from "./index3.js";
 var y = Object.defineProperty, u = Object.getOwnPropertyDescriptor, f = (e, t, a, r) => {
   for (var s = u(t, a), o = e.length - 1, i; o >= 0; o--)
     (i = e[o]) && (s = i(t, a, s) || s);

package/dist/chunks/data-labels-visibility.js

@@ -1,7 +1,7 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
 import { C as f } from "./chart-model.js";
 import { f as y } from "./chart-object-literals.js";
-import { a6 as d, a3 as b, a5 as r, a4 as v } from "./index3.js";
+import { a6 as d, a0 as b, a2 as r, a1 as v } from "./index3.js";
 import { m as o, C as h } from "./model-setter.js";
 const L = (t) => {
   let e = !1;

package/dist/chunks/data.js

@@ -1,8 +1,8 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
 import { capitalize as u } from "lodash-es";
-import { p as B, r as L, q as $, co as N, bY as h, bA as I, w as H, aN as P, c8 as _, y as v } from "./index.js";
+import { p as B, r as L, q as $, co as N, bY as h, bA as I, w as H, aM as P, c8 as _, y as M } from "./index.js";
 import { g as C } from "./series-types.js";
-import { P as M, H as A, S as o } from "./common.js";
+import { P as v, H as A, S as o } from "./common.js";
 import { a as d, d as g, g as l, t as n } from "./chart-object-literals.js";
 import { a as U } from "./index2.js";
 import { l as W } from "./index3.js";
@@ -77,7 +77,7 @@ const K = (e) => {
   let p = "y", F = "y";
   switch (T) {
     case d.PieSeries: {
-      i !== g.NoAggregation ? m === M.Category ? (p = `${i}_${t[0]}_0`.toUpperCase(), F = f ? u(g.Count) : u(`${i} of ${t[0]}`)) : p = v : p = t[0];
+      i !== g.NoAggregation ? m === v.Category ? (p = `${i}_${t[0]}_0`.toUpperCase(), F = f ? u(g.Count) : u(`${i} of ${t[0]}`)) : p = M : p = t[0];
       break;
     }
     case d.BarSeries:

package/dist/chunks/gauge-model.js

@@ -1,6 +1,6 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
 import { a as c, G as S, d as x } from "./chart-object-literals.js";
-import { ar as d, a3 as b, aA as _, as as m, aq as I } from "./index3.js";
+import { ar as d, a0 as b, aA as _, as as m, aq as I } from "./index3.js";
 import { r as C } from "./index.js";
 import { C as L } from "./chart-model.js";
 import { m as n } from "./model-setter.js";