@arcgis/charts-components 5.0.0-next.3 → 5.0.0-next.30

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-09-28T04:45:23",
+  "timestamp": "2025-10-22T15:55:28",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "5.0.0-next.3",
+    "version": "5.0.0-next.30",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -16,7 +16,7 @@
           "customElement": true,
           "name": "ArcgisChart",
           "tagName": "arcgis-chart",
-          "description": "The ArcGIS Chart component renders various chart types based on the provided model.\n\nSupported chart types include bar charts, line charts, pie charts, box plots, combo bar-line charts, gauges, scatterplots, histograms and radar charts.\n\nThe Chart component can be rendered using an [existing model](https://developers.arcgis.com/javascript/latest/charts-components-intro/#use-an-existing-model-from-a-webmap-or-feature-layer) from a web map or feature layer,\nor by [creating a new model](https://developers.arcgis.com/javascript/latest/charts-components-intro/#create-a-new-model).\n\nSee also:\n- [Introduction to Charts components](https://developers.arcgis.com/javascript/latest/charts-components-intro/)\n- [Tutorial: Display and create charts components](https://developers.arcgis.com/javascript/latest/tutorials/display-and-create-charts-components/)",
+          "description": "The ArcGIS Chart component renders a chart based on the provided model. Get started by reading the [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/) page.\n\nSupported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.\n\nSee also:\n- [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/)\n- [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-and-create-charts-components/)\n- [Tutorial: Create a heat chart](https://developers.arcgis.com/javascript/latest/tutorials/create-a-heat-chart/)\n- [Tutorial: Modify a chart](https://developers.arcgis.com/javascript/latest/tutorials/modify-a-chart/)",
           "demos": [
             {
               "description": "Docs",
@@ -42,6 +42,10 @@
               "description": "Gauge\nGauges visualize a single metric within a quantitative context defined by minimum and maximum values.",
               "url": "https://developers.arcgis.com/javascript/latest/storybook/charts-components/?path=/story/arcgis-chart--gauge&singleStory=true"
             },
+            {
+              "description": "Heat Chart\nHeat charts visualize data density or intensity across two dimensions, using color gradients to represent values.",
+              "url": "https://developers.arcgis.com/javascript/latest/storybook/charts-components/?path=/story/arcgis-chart--heat-chart&singleStory=true"
+            },
             {
               "description": "Histogram\nHistograms visualize the distribution of a continuous numeric variable by showing the frequency of values within defined intervals.",
               "url": "https://developers.arcgis.com/javascript/latest/storybook/charts-components/?path=/story/arcgis-chart--histogram&singleStory=true"
@@ -103,7 +107,6 @@
               },
               "default": "undefined",
               "attribute": "action-mode",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -129,7 +132,6 @@
               },
               "default": "false",
               "attribute": "allow-using-object-id-stat",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -155,7 +157,6 @@
               },
               "default": "undefined",
               "attribute": "auto-dispose-chart",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -210,7 +211,6 @@
               },
               "default": "undefined",
               "attribute": "chart-index",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "example",
@@ -365,7 +365,6 @@
               },
               "default": "undefined",
               "attribute": "cursor-range",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -432,7 +431,6 @@
               },
               "default": "false",
               "attribute": "disable-interactions",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -461,7 +459,6 @@
               },
               "default": "undefined",
               "attribute": "disable-toggling-legend-items",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -491,7 +488,6 @@
               },
               "default": "false",
               "attribute": "enable-configuration",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -517,7 +513,6 @@
               },
               "default": "undefined",
               "attribute": "enable-responsive-features",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -596,7 +591,6 @@
               },
               "default": "\"throw\"",
               "attribute": "error-policy",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -729,7 +723,6 @@
               },
               "default": "undefined",
               "attribute": "feature-index",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -759,7 +752,6 @@
               },
               "default": "undefined",
               "attribute": "filter-by-extent",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -785,7 +777,6 @@
               },
               "default": "undefined",
               "attribute": "filter-by-selection",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -861,7 +852,6 @@
               },
               "default": "undefined",
               "attribute": "hide-empty-series",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -891,7 +881,6 @@
               },
               "default": "undefined",
               "attribute": "hide-license-watermark",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -917,7 +906,6 @@
               },
               "default": "undefined",
               "attribute": "hide-loader-animation",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -943,7 +931,6 @@
               },
               "default": "undefined",
               "attribute": "ignore-smooth-rendering-limit",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -973,7 +960,6 @@
               },
               "default": "false",
               "attribute": "ignore-view-extent",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1060,7 +1046,6 @@
               },
               "default": "\"refresh\"",
               "attribute": "layer-fields-change-policy",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1091,7 +1076,6 @@
               },
               "default": "\"refresh\"",
               "attribute": "layer-filter-change-policy",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1117,7 +1101,6 @@
               },
               "default": "undefined",
               "attribute": "layer-item-id",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "example",
@@ -1152,7 +1135,6 @@
               },
               "default": "\"refresh\"",
               "attribute": "layer-renderer-change-policy",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -1195,7 +1177,6 @@
               },
               "default": "undefined",
               "attribute": "legend-position",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -1248,7 +1229,6 @@
               },
               "default": "undefined",
               "attribute": "legend-visibility",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -1324,7 +1304,7 @@
             {
               "kind": "field",
               "name": "model",
-              "description": "Instance of an ArcGIS Chart Model. Provides an API to interact with the chart's configuration.\n\n**Note:** This property has a union type of `ChartModel | WebChart` meaning a raw chart config object can be passed to it instead, however it is recommended to use a `ChartModel` instance whenever possible.",
+              "description": "Instance of an ArcGIS Chart Model. Provides an API to interact with the chart's configuration.\n**Note:** This property has a union type of `ChartModel | WebChart` meaning a raw chart config object can be passed to it instead, however it is recommended to use a `ChartModel` instance whenever possible.",
               "type": {
                 "text": "ChartModel | WebChart",
                 "references": [
@@ -1466,7 +1446,6 @@
               },
               "default": "false",
               "attribute": "null-as-valid",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1492,7 +1471,6 @@
               },
               "default": "undefined",
               "attribute": "placeholder",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1518,7 +1496,6 @@
               },
               "default": "undefined",
               "attribute": "queue-chart-creation",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1539,13 +1516,13 @@
                   "name": "props",
                   "optional": true,
                   "type": {
-                    "text": "undefined | {\n    updateData?: boolean | undefined;\n    resetAxesBounds?: boolean | undefined;\n    updateExtent?: boolean | undefined;\n}",
+                    "text": "undefined | {\n    updateData?: boolean | undefined;\n    resetAxesBounds?: boolean | undefined;\n}",
                     "values": [
                       {
                         "type": "undefined"
                       },
                       {
-                        "type": "{\n    updateData?: boolean | undefined;\n    resetAxesBounds?: boolean | undefined;\n    updateExtent?: boolean | undefined;\n}"
+                        "type": "{\n    updateData?: boolean | undefined;\n    resetAxesBounds?: boolean | undefined;\n}"
                       }
                     ]
                   }
@@ -1570,10 +1547,6 @@
                   "name": "param",
                   "text": "props.updateData Indicates whether to fetch new data. Default: true."
                 },
-                {
-                  "name": "param",
-                  "text": "props.updateExtent Indicates whether the view's extent is to update. Default: false."
-                },
                 {
                   "name": "param",
                   "text": "props.resetAxesBounds Option to reset the axes bounds along with the refresh. Default: false;"
@@ -1583,7 +1556,7 @@
                   "text": "Public"
                 }
               ],
-              "signature": "(props?: { updateData?: boolean; resetAxesBounds?: boolean; updateExtent?: boolean; }): Promise<void>",
+              "signature": "(props?: { updateData?: boolean; resetAxesBounds?: boolean; }): Promise<void>",
               "async": true
             },
             {
@@ -1600,7 +1573,6 @@
               },
               "default": "undefined",
               "attribute": "replace-no-value-category-with-zero",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1657,7 +1629,6 @@
               },
               "default": "undefined",
               "attribute": "return-features-extent",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -1687,7 +1658,6 @@
               },
               "default": "undefined",
               "attribute": "return-selection-indexes",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -1717,7 +1687,6 @@
               },
               "default": "undefined",
               "attribute": "return-selection-oi-ds",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -1747,7 +1716,6 @@
               },
               "default": "undefined",
               "attribute": "rotation",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1877,7 +1845,6 @@
               },
               "default": "undefined",
               "attribute": "set-time-binning-info-when-not-provided",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "remarks",
@@ -1907,7 +1874,6 @@
               },
               "default": "undefined",
               "attribute": "show-ui-messages",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1964,7 +1930,6 @@
               },
               "default": "false",
               "attribute": "sync-selection",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -1995,7 +1960,6 @@
               },
               "default": "\"disabled",
               "attribute": "sync-selections-between-chart-and-layer-view-policy",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -2021,7 +1985,6 @@
               },
               "default": "undefined",
               "attribute": "time-zone",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -2118,7 +2081,6 @@
               },
               "default": "undefined",
               "attribute": "use-animated-charts",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -2144,7 +2106,6 @@
               },
               "default": "undefined",
               "attribute": "use-popup-template-fields-info",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -2220,7 +2181,6 @@
               },
               "default": "\"ignore\"",
               "attribute": "view-time-extent-change-policy",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "type",
@@ -3236,7 +3196,7 @@
           "customElement": true,
           "name": "ArcgisChartsActionBar",
           "tagName": "arcgis-charts-action-bar",
-          "description": "The ArcGIS charts action bar component enhances chart functionality by offering context-specific actions such as rotation, zooming, and filtering.\nIt also supports general actions like exporting the chart as an image or CSV.\nThis component is designed to be used with a chart component and is not intended for standalone use.\n\nSee also:\n- [Tutorial: Charts components with Map components using charts action bar](https://developers.arcgis.com/javascript/latest/tutorials/charts-components-with-map-components/)",
+          "description": "The ArcGIS Charts Action Bar component enhances chart functionality by providing context-specific actions such as rotation, zooming, and filtering, as well as general actions like exporting the chart as an image or CSV file.\nThis component is designed to be used with a chart component and is not intended for standalone use.\n\nSee also:\n- [Tutorial: Chart and map interactions](https://developers.arcgis.com/javascript/latest/tutorials/chart-and-map-interactions/)",
           "demos": [
             {
               "description": "Docs",
@@ -3283,7 +3243,6 @@
               },
               "default": "\"multiSelectionWithCtrlKey\"",
               "attribute": "action-bar-selection-mode",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3374,7 +3333,6 @@
               },
               "default": "undefined",
               "attribute": "chart-type",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3405,7 +3363,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "clear-selection-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3431,7 +3388,6 @@
               },
               "default": "undefined",
               "attribute": "clear-selection-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3462,7 +3418,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "clear-selection-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3522,7 +3477,6 @@
                 ]
               },
               "default": "[WebChartTypes.ScatterSeries, WebChartTypes.BoxPlotSeries]",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3553,7 +3507,6 @@
               },
               "default": "\"disabled\"",
               "attribute": "edit-chart-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3579,7 +3532,6 @@
               },
               "default": "undefined",
               "attribute": "edit-chart-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3610,7 +3562,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "edit-chart-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3636,7 +3587,6 @@
               },
               "default": "false",
               "attribute": "expanded",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3667,7 +3617,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "export-action-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3698,7 +3647,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "export-as-csv-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3724,7 +3672,6 @@
               },
               "default": "undefined",
               "attribute": "export-as-csv-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3755,7 +3702,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "export-as-image-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3781,7 +3727,6 @@
               },
               "default": "undefined",
               "attribute": "export-as-image-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3812,7 +3757,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "filter-by-extent-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3838,7 +3782,6 @@
               },
               "default": "undefined",
               "attribute": "filter-by-extent-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3869,7 +3812,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "filter-by-extent-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3900,7 +3842,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "filter-by-selection-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3926,7 +3867,6 @@
               },
               "default": "undefined",
               "attribute": "filter-by-selection-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3957,7 +3897,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "filter-by-selection-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -3979,7 +3918,6 @@
               },
               "default": "false",
               "attribute": "force-disable-actions",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4010,7 +3948,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "full-extent-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4036,7 +3973,6 @@
               },
               "default": "undefined",
               "attribute": "full-extent-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4067,7 +4003,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "full-extent-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4084,7 +4019,7 @@
               "name": "hiddenActions",
               "description": "Holds a list of actions to hide from the action bar.\n\n**Note:** The edit chart action is hidden by default. To show it, remove its value from this array.",
               "type": {
-                "text": "Array<\"legend\" | \"zoom\" | \"editChart\" | \"fullExtent\" | \"filterBySelection\" | \"filterByExtent\" | \"rotateChart\" | \"selection\" | \"clearSelection\" | \"switchSelection\" | \"exportAsImage\" | \"exportAsCSV\">",
+                "text": "Array<\"legend\" | \"zoom\" | \"filterBySelection\" | \"fullExtent\" | \"editChart\" | \"filterByExtent\" | \"rotateChart\" | \"selection\" | \"clearSelection\" | \"switchSelection\" | \"exportAsImage\" | \"exportAsCSV\">",
                 "references": [
                   {
                     "name": "Array",
@@ -4126,7 +4061,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "legend-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4152,7 +4086,6 @@
               },
               "default": "undefined",
               "attribute": "legend-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4183,7 +4116,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "legend-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4222,7 +4154,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "rotate-chart-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4248,7 +4179,6 @@
               },
               "default": "undefined",
               "attribute": "rotate-chart-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4279,7 +4209,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "rotate-chart-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4310,7 +4239,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "selection-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4336,7 +4264,6 @@
               },
               "default": "undefined",
               "attribute": "selection-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4367,7 +4294,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "selection-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4398,7 +4324,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "switch-selection-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4424,7 +4349,6 @@
               },
               "default": "undefined",
               "attribute": "switch-selection-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4455,7 +4379,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "switch-selection-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4486,7 +4409,6 @@
               },
               "default": "\"enabled\"",
               "attribute": "zoom-state",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4512,7 +4434,6 @@
               },
               "default": "undefined",
               "attribute": "zoom-title",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",
@@ -4543,7 +4464,6 @@
               },
               "default": "\"inactive\"",
               "attribute": "zoom-toggle",
-              "reflects": true,
               "docsTags": [
                 {
                   "name": "category",