@arcgis/map-components 4.34.0-next.121 → 4.34.0-next.123

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-09-04T04:45:23",
+  "timestamp": "2025-09-06T04:42:30",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.121",
+    "version": "4.34.0-next.123",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -34817,6 +34817,25 @@
                 }
               ]
             },
+            {
+              "kind": "field",
+              "name": "highlightOptions",
+              "description": "copyDoc",
+              "type": {
+                "text": "HighlightOptions",
+                "references": [
+                  {
+                    "name": "HighlightOptions",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html",
+                    "start": 0,
+                    "end": 16
+                  }
+                ]
+              },
+              "deprecated": "since version 4.32. Use the [highlights](#highlights) property instead."
+            },
             {
               "kind": "field",
               "name": "highlights",
@@ -38271,6 +38290,25 @@
                 "text": "typeof this._map.ground"
               }
             },
+            {
+              "kind": "field",
+              "name": "highlightOptions",
+              "description": "copyDoc",
+              "type": {
+                "text": "HighlightOptions",
+                "references": [
+                  {
+                    "name": "HighlightOptions",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html",
+                    "start": 0,
+                    "end": 16
+                  }
+                ]
+              },
+              "deprecated": "since version 4.32. Use the [highlights](#highlights) property instead."
+            },
             {
               "kind": "field",
               "name": "highlights",
@@ -38756,6 +38794,21 @@
               },
               "default": "null"
             },
+            {
+              "kind": "field",
+              "name": "spatialReferenceLocked",
+              "description": "Indicates if the view's spatialReference can be changed after it is ready.\nThe default is false indicating the view's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the view's spatial reference\nwill be disabled in [ArcgisBasemapGallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [ArcgisBasemapToggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the view spatialReference cannot be changed at runtime.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "spatial-reference-locked"
+            },
             {
               "kind": "field",
               "name": "stationary",
@@ -39473,6 +39526,20 @@
               },
               "fieldName": "scale"
             },
+            {
+              "name": "spatial-reference-locked",
+              "description": "Indicates if the view's spatialReference can be changed after it is ready.\nThe default is false indicating the view's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the view's spatial reference\nwill be disabled in [ArcgisBasemapGallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [ArcgisBasemapToggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the view spatialReference cannot be changed at runtime.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "spatialReferenceLocked"
+            },
             {
               "name": "suspended",
               "description": "Indicates if the view is visible on the page.",
@@ -45210,6 +45277,25 @@
               "readonly": true,
               "docsOnlyReadonly": true
             },
+            {
+              "kind": "field",
+              "name": "highlightOptions",
+              "description": "copyDoc",
+              "type": {
+                "text": "HighlightOptions",
+                "references": [
+                  {
+                    "name": "HighlightOptions",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html",
+                    "start": 0,
+                    "end": 16
+                  }
+                ]
+              },
+              "deprecated": "since version 4.32. Use the [highlights](#highlights) property instead."
+            },
             {
               "kind": "field",
               "name": "highlights",
@@ -58160,6 +58246,200 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/utility-network-trace-analysis/result-feature-list/result-feature-list.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisResultFeatureList",
+          "tagName": "arcgis-result-feature-list",
+          "description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes trace result elements as input.\nIt displays the layers the elements are from, with a count of elements on each layer.\nA `UtilityNetwork` and list of layers is required to display feature layer names.",
+          "demos": [
+            {
+              "description": "Docs",
+              "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-result-feature-list/"
+            }
+          ],
+          "docsTags": [
+            {
+              "name": "since",
+              "text": "4.34"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "pascalCaseName": "ArcgisResultFeatureList",
+          "importPath": "components/arcgis-result-feature-list",
+          "members": [
+            {
+              "kind": "method",
+              "name": "componentOnReady",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "module": "lib/lib.es5.d.ts",
+                      "name": "Promise",
+                      "package": "typescript",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "description": "Create a promise that resolves once component is fully loaded.",
+              "signature": "(): Promise<void>",
+              "async": true,
+              "inheritedFrom": {
+                "name": "LitElement",
+                "package": "@arcgis/lumina"
+              },
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "```js\nconst arcgisResultFeatureList = document.querySelector(\"arcgis-result-feature-list\");\ndocument.body.append(arcgisResultFeatureList);\nawait arcgisResultFeatureList.componentOnReady();\nconsole.log(\"arcgis-result-feature-list is ready to go!\");\n```"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "elements",
+              "type": {
+                "text": "Array<NetworkElement>",
+                "references": [
+                  {
+                    "name": "Array",
+                    "package": "typescript",
+                    "module": "lib/lib.es5.d.ts",
+                    "start": 0,
+                    "end": 5
+                  },
+                  {
+                    "name": "NetworkElement",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html",
+                    "start": 6,
+                    "end": 20
+                  }
+                ]
+              },
+              "docsTags": [
+                {
+                  "name": "required"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "layers",
+              "type": {
+                "text": "Array<Layer>",
+                "references": [
+                  {
+                    "name": "Array",
+                    "package": "typescript",
+                    "module": "lib/lib.es5.d.ts",
+                    "start": 0,
+                    "end": 5
+                  },
+                  {
+                    "name": "Layer",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html",
+                    "start": 6,
+                    "end": 11
+                  }
+                ]
+              },
+              "docsTags": [
+                {
+                  "name": "required"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "messageOverrides",
+              "type": {
+                "text": "Record<string, unknown>"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "selectedLayer",
+              "type": {
+                "text": "Layer",
+                "references": [
+                  {
+                    "name": "Layer",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html",
+                    "start": 0,
+                    "end": 5
+                  }
+                ]
+              }
+            },
+            {
+              "kind": "field",
+              "name": "utilityNetwork",
+              "type": {
+                "text": "UtilityNetwork | undefined",
+                "references": [
+                  {
+                    "name": "UtilityNetwork",
+                    "package": "@arcgis/core",
+                    "module": "interfaces.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html",
+                    "start": 0,
+                    "end": 14
+                  }
+                ],
+                "values": [
+                  {
+                    "type": "UtilityNetwork"
+                  },
+                  {
+                    "type": "undefined"
+                  }
+                ]
+              },
+              "docsTags": [
+                {
+                  "name": "required"
+                }
+              ]
+            }
+          ],
+          "events": [
+            {
+              "name": "arcgisPropertyChange",
+              "type": {
+                "text": "{ name: \"selectedLayer\"; }"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-result-feature-list",
+          "declaration": {
+            "name": "ArcgisResultFeatureList",
+            "module": "src/components/utility-network-trace-analysis/result-feature-list/result-feature-list.tsx"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/utility-network-validate-topology/utility-network-validate-topology.tsx",

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-09-04T04:45:23",
+  "timestamp": "2025-09-06T04:42:30",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.34.0-next.121",
+    "version": "4.34.0-next.123",
     "typescriptVersion": "5.8.3"
   },
   "components": [
@@ -29221,6 +29221,29 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "highlightOptions",
+          "type": "HighlightOptions",
+          "complexType": {
+            "original": "HighlightOptions",
+            "resolved": "HighlightOptions",
+            "references": {
+              "HighlightOptions": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "copyDoc",
+          "docsTags": [],
+          "deprecation": "since version 4.32. Use the [highlights](#highlights) property instead.",
+          "values": [],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "highlights",
           "type": "Collection<HighlightOptions>",
@@ -32396,6 +32419,29 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "highlightOptions",
+          "type": "HighlightOptions",
+          "complexType": {
+            "original": "HighlightOptions",
+            "resolved": "HighlightOptions",
+            "references": {
+              "HighlightOptions": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "copyDoc",
+          "docsTags": [],
+          "deprecation": "since version 4.32. Use the [highlights](#highlights) property instead.",
+          "values": [],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "highlights",
           "type": "Collection<HighlightOptions>",
@@ -32860,6 +32906,28 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "spatialReferenceLocked",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "spatial-reference-locked",
+          "reflectToAttr": false,
+          "docs": "Indicates if the view's spatialReference can be changed after it is ready.\nThe default is false indicating the view's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the view's spatial reference\nwill be disabled in [ArcgisBasemapGallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [ArcgisBasemapToggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the view spatialReference cannot be changed at runtime.",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "stationary",
           "type": "boolean",
@@ -38472,6 +38540,29 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "highlightOptions",
+          "type": "HighlightOptions",
+          "complexType": {
+            "original": "HighlightOptions",
+            "resolved": "HighlightOptions",
+            "references": {
+              "HighlightOptions": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "copyDoc",
+          "docsTags": [],
+          "deprecation": "since version 4.32. Use the [highlights](#highlights) property instead.",
+          "values": [],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "highlights",
           "type": "Collection<HighlightOptions>",
@@ -50007,6 +50098,217 @@
       "parts": [],
       "listeners": []
     },
+    {
+      "filePath": "src/components/utility-network-trace-analysis/result-feature-list/result-feature-list.tsx",
+      "tag": "arcgis-result-feature-list",
+      "overview": "",
+      "readme": "",
+      "usage": {},
+      "docs": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes trace result elements as input.\nIt displays the layers the elements are from, with a count of elements on each layer.\nA `UtilityNetwork` and list of layers is required to display feature layer names.",
+      "docsTags": [
+        {
+          "name": "since",
+          "text": "4.34"
+        },
+        {
+          "name": "superclass",
+          "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
+        }
+      ],
+      "encapsulation": "shadow",
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {},
+      "props": [
+        {
+          "name": "elements",
+          "type": "Array<NetworkElement>",
+          "complexType": {
+            "original": "Array<NetworkElement>",
+            "resolved": "Array<NetworkElement>",
+            "references": {
+              "Array": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              },
+              "NetworkElement": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "required"
+            }
+          ],
+          "values": [],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "layers",
+          "type": "Array<Layer>",
+          "complexType": {
+            "original": "Array<Layer>",
+            "resolved": "Array<Layer>",
+            "references": {
+              "Array": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              },
+              "Layer": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "required"
+            }
+          ],
+          "values": [],
+          "optional": false,
+          "required": true
+        },
+        {
+          "name": "messageOverrides",
+          "type": "Record<string, unknown>",
+          "complexType": {
+            "original": "Record<string, unknown>",
+            "resolved": "Record<string, unknown>",
+            "references": {}
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "selectedLayer",
+          "type": "Layer",
+          "complexType": {
+            "original": "Layer",
+            "resolved": "Layer",
+            "references": {
+              "Layer": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "utilityNetwork",
+          "type": "UtilityNetwork | undefined",
+          "complexType": {
+            "original": "UtilityNetwork | undefined",
+            "resolved": "UtilityNetwork | undefined",
+            "references": {
+              "UtilityNetwork": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [
+            {
+              "name": "required"
+            }
+          ],
+          "values": [
+            {
+              "type": "UtilityNetwork"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": false,
+          "required": true
+        }
+      ],
+      "methods": [
+        {
+          "name": "componentOnReady",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(): Promise<void>",
+            "parameters": [],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "componentOnReady(): Promise<void>",
+          "parameters": [],
+          "docs": "Create a promise that resolves once component is fully loaded.",
+          "docsTags": [
+            {
+              "name": "example",
+              "text": "```js\nconst arcgisResultFeatureList = document.querySelector(\"arcgis-result-feature-list\");\ndocument.body.append(arcgisResultFeatureList);\nawait arcgisResultFeatureList.componentOnReady();\nconsole.log(\"arcgis-result-feature-list is ready to go!\");\n```"
+            },
+            {
+              "name": "inheritedFrom",
+              "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
+            }
+          ]
+        }
+      ],
+      "events": [
+        {
+          "event": "arcgisPropertyChange",
+          "detail": "{ name: \"selectedLayer\"; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{ name: \"selectedLayer\"; }",
+            "resolved": "{ name: \"selectedLayer\"; }",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "listeners": []
+    },
     {
       "filePath": "src/components/utility-network-validate-topology/utility-network-validate-topology.tsx",
       "tag": "arcgis-utility-network-validate-topology",