@arcgis/charts-components 5.0.0-next.57 → 5.0.0-next.58

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-11-17T04:47:44",
+  "timestamp": "2025-11-18T04:39:54",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "5.0.0-next.57",
+    "version": "5.0.0-next.58",
     "typescriptVersion": "5.9.3"
   },
   "schemaVersion": "1.0.0",
@@ -143,6 +143,21 @@
                 }
               ]
             },
+            {
+              "kind": "field",
+              "name": "autoDestroyDisabled",
+              "description": "If true, the chart will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the chart to a different place on the page, or temporarily hide it.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "auto-destroy-disabled"
+            },
             {
               "kind": "field",
               "name": "autoDisposeChart",
@@ -156,6 +171,7 @@
                 ]
               },
               "default": "undefined",
+              "deprecated": "since 5.0. Use `autoDestroyDisabled` instead. Will be removed in 6.0.",
               "attribute": "auto-dispose-chart",
               "docsTags": [
                 {
@@ -709,6 +725,36 @@
               "async": true,
               "default": "DownloadableChartImagesTypes.PNG"
             },
+            {
+              "kind": "field",
+              "name": "featureIndex",
+              "description": "The index of the feature to be rendered.\nOnly used when the gauge is a feature-based gauge.",
+              "type": {
+                "text": "number",
+                "values": [
+                  {
+                    "type": "number"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "deprecated": "since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/charts-model/gauge-model/#featureindex) prop instead.",
+              "attribute": "feature-index",
+              "docsTags": [
+                {
+                  "name": "remarks",
+                  "text": "Applicable to gauge only."
+                },
+                {
+                  "name": "type",
+                  "text": "{number | undefined}"
+                },
+                {
+                  "name": "category",
+                  "text": "Public"
+                }
+              ]
+            },
             {
               "kind": "field",
               "name": "filterByExtent",
@@ -1121,6 +1167,49 @@
                 }
               ]
             },
+            {
+              "kind": "field",
+              "name": "legendPosition",
+              "description": "Used to set the legend's position on the chart.",
+              "type": {
+                "text": "\"bottom\" | \"left\" | \"right\" | \"top\"",
+                "values": [
+                  {
+                    "value": "bottom",
+                    "type": "string"
+                  },
+                  {
+                    "value": "left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "deprecated": "since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendPosition) prop instead.",
+              "attribute": "legend-position",
+              "docsTags": [
+                {
+                  "name": "remarks",
+                  "text": "Not applicable to gauge."
+                },
+                {
+                  "name": "type",
+                  "text": "{WebChartLegendPositions | undefined}"
+                },
+                {
+                  "name": "category",
+                  "text": "Public"
+                }
+              ]
+            },
             {
               "kind": "field",
               "name": "legendValueLabelFormatter",
@@ -1144,6 +1233,36 @@
                 }
               ]
             },
+            {
+              "kind": "field",
+              "name": "legendVisibility",
+              "description": "When `true`, the legend is visible on the chart.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "deprecated": "since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendVisibility) prop instead.",
+              "attribute": "legend-visibility",
+              "docsTags": [
+                {
+                  "name": "remarks",
+                  "text": "Not applicable to gauge."
+                },
+                {
+                  "name": "type",
+                  "text": "{boolean | undefined}"
+                },
+                {
+                  "name": "category",
+                  "text": "Public"
+                }
+              ]
+            },
             {
               "kind": "field",
               "name": "loaderColors",
@@ -1615,6 +1734,32 @@
                 }
               ]
             },
+            {
+              "kind": "field",
+              "name": "rotation",
+              "description": "Applicable to bar chart, line chart, combo bar-line and box plot.\nWhen `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "deprecated": "since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#rotatedstate) prop instead.",
+              "attribute": "rotation",
+              "docsTags": [
+                {
+                  "name": "type",
+                  "text": "{boolean | undefined}"
+                },
+                {
+                  "name": "category",
+                  "text": "Public"
+                }
+              ]
+            },
             {
               "kind": "field",
               "name": "runtimeDataFilters",
@@ -2173,6 +2318,20 @@
               "default": "false",
               "fieldName": "allowUsingObjectIdStat"
             },
+            {
+              "name": "auto-destroy-disabled",
+              "description": "If true, the chart will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the chart to a different place on the page, or temporarily hide it.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "autoDestroyDisabled"
+            },
             {
               "name": "auto-dispose-chart",
               "description": "Auto-disposes the chart when a new one is created in the same container.",
@@ -2185,7 +2344,8 @@
                 ]
               },
               "default": "undefined",
-              "fieldName": "autoDisposeChart"
+              "fieldName": "autoDisposeChart",
+              "deprecated": "since 5.0. Use `autoDestroyDisabled` instead. Will be removed in 6.0."
             },
             {
               "name": "auto-inverse-data-label-text-color",
@@ -2313,6 +2473,21 @@
               "default": "\"throw\"",
               "fieldName": "errorPolicy"
             },
+            {
+              "name": "feature-index",
+              "description": "The index of the feature to be rendered.\nOnly used when the gauge is a feature-based gauge.",
+              "type": {
+                "text": "number",
+                "values": [
+                  {
+                    "type": "number"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "fieldName": "featureIndex",
+              "deprecated": "since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/charts-model/gauge-model/#featureindex) prop instead."
+            },
             {
               "name": "filter-by-extent",
               "description": "When `true`, all chart elements are filtered based on view extent.",
@@ -2482,6 +2657,49 @@
               "default": "\"refresh\"",
               "fieldName": "layerRendererChangePolicy"
             },
+            {
+              "name": "legend-position",
+              "description": "Used to set the legend's position on the chart.",
+              "type": {
+                "text": "\"bottom\" | \"left\" | \"right\" | \"top\"",
+                "values": [
+                  {
+                    "value": "bottom",
+                    "type": "string"
+                  },
+                  {
+                    "value": "left",
+                    "type": "string"
+                  },
+                  {
+                    "value": "right",
+                    "type": "string"
+                  },
+                  {
+                    "value": "top",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "fieldName": "legendPosition",
+              "deprecated": "since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendPosition) prop instead."
+            },
+            {
+              "name": "legend-visibility",
+              "description": "When `true`, the legend is visible on the chart.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "fieldName": "legendVisibility",
+              "deprecated": "since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendVisibility) prop instead."
+            },
             {
               "name": "null-as-valid",
               "description": "Whether to consider a `null` statistic as valid. If set to `false` and the data has only\nnull values, the chart's dataset will be considered empty:\n- the corresponding warning event will be sent\n- the \"no data\" message will be displayed (unless `showUIMesssages` is set to `false`)",
@@ -2580,6 +2798,21 @@
               "default": "undefined",
               "fieldName": "returnSelectionOIDs"
             },
+            {
+              "name": "rotation",
+              "description": "Applicable to bar chart, line chart, combo bar-line and box plot.\nWhen `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "undefined",
+              "fieldName": "rotation",
+              "deprecated": "since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#rotatedstate) prop instead."
+            },
             {
               "name": "set-time-binning-info-when-not-provided",
               "description": "When `true`, the series properties `unit` and `size` become optional and will be automatically set to values that fit the data set. Used when creating or updating a chart compatible with time binning.",

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-11-17T04:47:44",
+  "timestamp": "2025-11-18T04:39:54",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "5.0.0-next.57",
+    "version": "5.0.0-next.58",
     "typescriptVersion": "5.9.3"
   },
   "components": [
@@ -107,6 +107,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "autoDestroyDisabled",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "auto-destroy-disabled",
+          "reflectToAttr": false,
+          "docs": "If true, the chart will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the chart to a different place on the page, or temporarily hide it.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "autoDisposeChart",
           "type": "boolean",
@@ -130,6 +152,7 @@
             }
           ],
           "default": "undefined",
+          "deprecation": "since 5.0. Use `autoDestroyDisabled` instead. Will be removed in 6.0.",
           "values": [
             {
               "type": "boolean"
@@ -521,6 +544,42 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "featureIndex",
+          "type": "number",
+          "complexType": {
+            "original": "number",
+            "resolved": "number",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "feature-index",
+          "reflectToAttr": false,
+          "docs": "The index of the feature to be rendered.\nOnly used when the gauge is a feature-based gauge.",
+          "docsTags": [
+            {
+              "name": "remarks",
+              "text": "Applicable to gauge only."
+            },
+            {
+              "name": "type",
+              "text": "{number | undefined}"
+            },
+            {
+              "name": "category",
+              "text": "Public"
+            }
+          ],
+          "default": "undefined",
+          "deprecation": "since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/charts-model/gauge-model/#featureindex) prop instead.",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "filterByExtent",
           "type": "boolean",
@@ -1009,6 +1068,55 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "legendPosition",
+          "type": "\"bottom\" | \"left\" | \"right\" | \"top\"",
+          "complexType": {
+            "original": "\"bottom\" | \"left\" | \"right\" | \"top\"",
+            "resolved": "\"bottom\" | \"left\" | \"right\" | \"top\"",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "legend-position",
+          "reflectToAttr": false,
+          "docs": "Used to set the legend's position on the chart.",
+          "docsTags": [
+            {
+              "name": "remarks",
+              "text": "Not applicable to gauge."
+            },
+            {
+              "name": "type",
+              "text": "{WebChartLegendPositions | undefined}"
+            },
+            {
+              "name": "category",
+              "text": "Public"
+            }
+          ],
+          "default": "undefined",
+          "deprecation": "since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendPosition) prop instead.",
+          "values": [
+            {
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "left",
+              "type": "string"
+            },
+            {
+              "value": "right",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "legendValueLabelFormatter",
           "type": "(((value?: number | undefined, percent?: number | undefined) => string))",
@@ -1039,6 +1147,42 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "legendVisibility",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "legend-visibility",
+          "reflectToAttr": false,
+          "docs": "When `true`, the legend is visible on the chart.",
+          "docsTags": [
+            {
+              "name": "remarks",
+              "text": "Not applicable to gauge."
+            },
+            {
+              "name": "type",
+              "text": "{boolean | undefined}"
+            },
+            {
+              "name": "category",
+              "text": "Public"
+            }
+          ],
+          "default": "undefined",
+          "deprecation": "since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendVisibility) prop instead.",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "loaderColors",
           "type": "LoaderColors",
@@ -1360,6 +1504,38 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "rotation",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "rotation",
+          "reflectToAttr": false,
+          "docs": "Applicable to bar chart, line chart, combo bar-line and box plot.\nWhen `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.",
+          "docsTags": [
+            {
+              "name": "type",
+              "text": "{boolean | undefined}"
+            },
+            {
+              "name": "category",
+              "text": "Public"
+            }
+          ],
+          "default": "undefined",
+          "deprecation": "since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#rotatedstate) prop instead.",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "runtimeDataFilters",
           "type": "{\n    spatialRelationship?: \"intersects\" | \"contains\" | \"crosses\" | \"disjoint\" | \"envelope-intersects\" | \"index-intersects\" | \"overlaps\" | \"touches\" | \"within\" | \"relation\" | undefined;\n    distance?: number | undefined;\n    gdbVersion?: string | undefined;\n    geometry?: IPoint | IPolyline | IPolygon | IPolygonWithCurves | IEnvelope | IExtent | undefined;\n    objectIds?: Array<string | number> | undefined;\n    timeExtent?: [number, number] | undefined;\n    units?: RESTUnits | undefined;\n    where?: string | undefined;\n}",

package/dist/docs/vscode.html-custom-data.json

@@ -32,9 +32,14 @@
           "description": "Whether to allow the object id to be used as a statistic other than COUNT.",
           "values": []
         },
+        {
+          "name": "auto-destroy-disabled",
+          "description": "If true, the chart will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the chart to a different place on the page, or temporarily hide it.",
+          "values": []
+        },
         {
           "name": "auto-dispose-chart",
-          "description": "Auto-disposes the chart when a new one is created in the same container.",
+          "description": "**Deprecated**: since 5.0. Use `autoDestroyDisabled` instead. Will be removed in 6.0.. Auto-disposes the chart when a new one is created in the same container.",
           "values": []
         },
         {
@@ -94,6 +99,11 @@
             }
           ]
         },
+        {
+          "name": "feature-index",
+          "description": "**Deprecated**: since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/charts-model/gauge-model/#featureindex) prop instead.. The index of the feature to be rendered.\nOnly used when the gauge is a feature-based gauge.",
+          "values": []
+        },
         {
           "name": "filter-by-extent",
           "description": "When `true`, all chart elements are filtered based on view extent.",
@@ -170,6 +180,29 @@
             }
           ]
         },
+        {
+          "name": "legend-position",
+          "description": "**Deprecated**: since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendPosition) prop instead.. Used to set the legend's position on the chart.",
+          "values": [
+            {
+              "name": "bottom"
+            },
+            {
+              "name": "left"
+            },
+            {
+              "name": "right"
+            },
+            {
+              "name": "top"
+            }
+          ]
+        },
+        {
+          "name": "legend-visibility",
+          "description": "**Deprecated**: since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendVisibility) prop instead.. When `true`, the legend is visible on the chart.",
+          "values": []
+        },
         {
           "name": "null-as-valid",
           "description": "Whether to consider a `null` statistic as valid. If set to `false` and the data has only\nnull values, the chart's dataset will be considered empty:\n- the corresponding warning event will be sent\n- the \"no data\" message will be displayed (unless `showUIMesssages` is set to `false`)",
@@ -205,6 +238,11 @@
           "description": "When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.\nOnly considered for a data source using a feature layer.",
           "values": []
         },
+        {
+          "name": "rotation",
+          "description": "**Deprecated**: since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#rotatedstate) prop instead.. Applicable to bar chart, line chart, combo bar-line and box plot.\nWhen `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.",
+          "values": []
+        },
         {
           "name": "set-time-binning-info-when-not-provided",
           "description": "When `true`, the series properties `unit` and `size` become optional and will be automatically set to values that fit the data set. Used when creating or updating a chart compatible with time binning.",