@arcgis/charts-components 5.2.0-next.71 → 5.2.0-next.72

package/dist/chunks/type-guards2.js

@@ -1,26 +1,26 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
 import { c as n } from "./model-types.js";
 import { u as e } from "./chart-object-literals.js";
-function c(i) {
+function d(i) {
   return i !== void 0 && "config" in i;
 }
 function s(i) {
   return i?.chartType === e.BarSeries;
 }
-function d(i) {
+function f(i) {
   return i?.chartType === e.LineSeries;
 }
-function f(i) {
+function h(i) {
   return i?.chartType === e.RadarSeries;
 }
 function o(i) {
   return i?.chartType === e.ComboLineAndBarSeries;
 }
-function h(i) {
+function l(i) {
   const t = i?.chartType;
   return t === e.LineSeries || t === e.BarSeries || t === e.ComboLineAndBarSeries || t === e.RadarSeries;
 }
-function l(i) {
+function a(i) {
   return i?.chartType === e.PieSeries;
 }
 function p(i) {
@@ -56,10 +56,10 @@ function C(i) {
 function x(i) {
   return i !== void 0 && "getDataTooltipVisibility" in i;
 }
-function v(i) {
+function B(i) {
   return i !== void 0 && "getGuideVisibility" in i && typeof i.getGuideVisibility == "function";
 }
-function B(i) {
+function v(i) {
   return i !== void 0 && "addXAxisGuide" in i && typeof i.addXAxisGuide == "function";
 }
 function A(i) {
@@ -69,7 +69,7 @@ function G(i) {
   return i !== void 0 && "legendVisibility" in i;
 }
 function L(i) {
-  return i !== void 0 && "displayCategory" in i;
+  return a(i);
 }
 function W(i) {
   return i !== void 0 && "temporalBinningSize" in i;
@@ -86,15 +86,15 @@ function P(i) {
 }
 export {
   p as a,
-  c as b,
+  d as b,
   o as c,
   T as d,
   S as e,
   M as f,
-  d as g,
+  f as g,
   H as h,
   s as i,
-  v as j,
+  B as j,
   G as k,
   C as l,
   g as m,
@@ -102,11 +102,11 @@ export {
   b as o,
   W as p,
   x as q,
-  B as r,
+  v as r,
   A as s,
   L as t,
-  l as u,
-  f as v,
+  a as u,
+  h as v,
   y as w,
-  h as x
+  l as x
 };

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

@@ -23,36 +23,18 @@ import type { T9nMeta } from "@arcgis/lumina/controllers";
 
 /**
  * The ArcGIS Chart component renders a chart by setting a [model](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#model) object that defines the chart's configuration and data.
- * There are different ways to render a chart with the ArcGIS Chart component:
  *
- * ##### Load from a layer item
+ * You can render a chart either by:
+ * - Setting [layerItemId](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#layerItemId) and [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) to load a saved chart from a layer item.
+ * - Create a new chart by using the [`createModel()`](/references/charts-components/model/shared/setup-utils/#createModel) function to create a chart model and set it to the [model](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#model) property.
  *
- * To load a chart from a layer item, first the chart needs to be [configured in Map Viewer](https://doc.arcgis.com/en/arcgis-online/create-maps/configure-charts-mv.htm) and [saved to the layer item](https://doc.arcgis.com/en/arcgis-online/create-maps/duplicate-save-layers.htm#ESRI_SECTION1_2AE9121DFA5D4E099F0D434EBA7D9365).
- * Then set the [layerItemId](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#layerItemId) property to the item's ID and the [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) property to the index of the chart within the item.
+ * > [!IMPORTANT]
+ * >
+ * > See the [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/) guide for detailed examples on how to render a chart using the above patterns.
  *
- * ```html
- * <arcgis-chart layer-item-id="..." chart-index="0"></arcgis-chart>
- * ```
- *
- * ##### Create a new chart with charts model
- *
- * To create a new chart, use the [createModel](https://developers.arcgis.com/javascript/latest/references/charts-components/model/shared/setup-utils/#createModel) method with a layer and a chart type, then configure the chart using the model's properties and methods.
- *
- * ```js
- * import FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
- * import { createModel } from "@arcgis/charts-components/model/shared/setup-utils.js";
- *
- * const myLayer = new FeatureLayer({ portalItem: { id: "..." } });
- *
- * const chartElement = document.querySelector("arcgis-chart");
- * const barChartModel = await createModel({ layer: myLayer, chartType: "barChart" });
- * barChartModel.xAxisField = "field";
- * ```
- *
- * Each supported [chart type](https://developers.arcgis.com/javascript/latest/charts/chart-types/) has its own configuration properties and methods with their corresponding models.
+ * There are 10 supported chart types, each with its own model properties and methods. Refer to the [chart types documentation](https://developers.arcgis.com/javascript/latest/charts/chart-types/) for more information on each chart type.
  *
  * ##### See also:
- * - [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/)
  * - [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-a-chart/)
  * - [Tutorial: Chart and map interactions](https://developers.arcgis.com/javascript/latest/tutorials/chart-and-map-interactions/)
  *
@@ -1031,15 +1013,15 @@ export abstract class ArcgisChart extends LitElement {
   accessor legendPosition: WebChartLegendPositions | undefined;
   /**
    * When the pie chart label contains either a numeric value or a percentage (which can be set through the
-   * [setDisplayNumericValue](https://developers.arcgis.com/javascript/latest/references/charts-components/model/pie-chart-model/pie-chart-model/#setDisplayNumericValue) and
-   * [setDisplayPercentage](https://developers.arcgis.com/javascript/latest/references/charts-components/model/pie-chart-model/pie-chart-model/#setDisplayPercentage) methods from the pie chart model), this property
+   * [displayNumericValueOnLegendItems](https://developers.arcgis.com/javascript/latest/references/charts-components/model/pie-chart-model/pie-chart-model/#displayNumericValueOnLegendItems) and
+   * [displayPercentageOnLegendItems](https://developers.arcgis.com/javascript/latest/references/charts-components/model/pie-chart-model/pie-chart-model/#displayPercentageOnLegendItems) properties from the pie chart model), this property
    * can be used to format the numeric value and/or percentage. If the returned string contains HTML tags they will be interpreted as such.
    *
    * @example
    * ```ts
    * // Set the pie chart model to display both numeric value and percentage.
-   * pieChartModel.setDisplayNumericValue(true);
-   * pieChartModel.setDisplayPercentage(true);
+   * pieChartModel.displayNumericValueOnLegendItems = true;
+   * pieChartModel.displayPercentageOnLegendItems = true;
    *
    * // Render the numeric value and percentage in bold and italic respectively, with 2 decimal places.
    * chartElement.legendValueLabelFormatter = (value, percentage) => {