{"deprecation":"docs.json is deprecated and will be removed in a future release. Use api.json instead","timestamp":"2026-07-09T17:16:28","compiler":{"name":"@arcgis/lumina-compiler","version":"5.1.12","typescriptVersion":"6.0.2"},"components":[{"filePath":"src/components/area-measurement-2d/area-measurement-2d.tsx","tag":"arcgis-area-measurement-2d","overview":"","readme":"","usage":{},"docs":"The Area Measurement 2D component can be added to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent to calculate and display the area and perimeter of a polygon.\n\nHow areas and perimeters are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, areas and perimeters are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, areas and perimeters are computed in a Euclidean manner (in their respective PCS).","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"analysis","type":"AreaMeasurementAnalysis","complexType":{"original":"AreaMeasurementAnalysis","resolved":"AreaMeasurementAnalysis","references":{"default":{"location":"import","path":"@arcgis/core/analysis/AreaMeasurementAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Area Measurement 2D component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent, it automatically creates an empty analysis and adds it to the Map's\n[arcgis-map.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#analyses) collection.\nYou can then wait for the [AreaMeasurementAnalysisView2D](https://developers.arcgis.com/javascript/latest/references/core/views/2d/analysis/AreaMeasurementAnalysisView2D/)\nto be created before accessing the analysis results.\n\n```js\n// Get the Map component and the Area Measurement 2D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\nconst areaMeasurement2dElement = document.querySelector(\"arcgis-area-measurement-2d\");\nawait areaMeasurement2dElement.componentOnReady();\n\n// Get the AreaMeasurementAnalysis created by the Area Measurement 2D component.\nconst analysis = areaMeasurement2dElement.analysis;\n\n// Get the AreaMeasurementAnalysisView2D and watch for results.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysisView?.result,\n () => {\n console.log(\"Analysis results:\", analysisView.result);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Map component.\n\n```js\n// Create the AreaMeasurementAnalysis.\nconst areaMeasurementAnalysis = new AreaMeasurementAnalysis({\n geometry: new Polygon({\n rings: [\n [\n [-80.208889, 25.775278], // Maimi, Florida\n [-64.782, 32.293],       // Hamilton, Bermuda\n [-66.063889, 18.406389], // San Juan, Puerto Rico\n [-80.208889, 25.775278], // Maimi, Florida\n ],\n ],\n }),\n});\n\n// Get the Map component and the Area Measurement 2D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\nconst areaMeasurement2dElement = document.querySelector(\"arcgis-area-measurement-2d\");\nawait areaMeasurement2dElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Map component.\nviewElement.analyses.add(areaMeasurementAnalysis);\n\n// Connect the analysis to the measurement component:\nareaMeasurement2dElement.analysis = areaMeasurementAnalysis;\n```","docsTags":[],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStartButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-start-button","reflectToAttr":false,"docs":"If true, the button that starts a new measurement will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-unit-select","reflectToAttr":false,"docs":"If true, the unit selection dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualization","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization","reflectToAttr":false,"docs":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"measure-area\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"snappingOptions","type":"SnappingOptions","complexType":{"original":"SnappingOptions","resolved":"SnappingOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/snapping/SnappingOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/) for measuring.","docsTags":[{"name":"since","text":"4.28"}],"values":[],"optional":true,"required":false},{"name":"state","type":"AreaMeasurement2DState","complexType":{"original":"AreaMeasurement2DState","resolved":"AreaMeasurement2DState","references":{"AreaMeasurement2DState":{"location":"local","path":"components/arcgis-area-measurement-2d/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"unsupported"},{"type":"string","value":"measured"},{"type":"string","value":"measuring"}],"optional":true,"required":false},{"name":"unit","type":"SystemOrAreaUnit","complexType":{"original":"SystemOrAreaUnit","resolved":"SystemOrAreaUnit","references":{"SystemOrAreaUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unitOptions).","docsTags":[],"values":[{"type":"string","value":"metric"},{"type":"string","value":"imperial"},{"type":"string","value":"square-inches"},{"type":"string","value":"square-feet"},{"type":"string","value":"square-yards"},{"type":"string","value":"square-miles"},{"type":"string","value":"square-nautical-miles"},{"type":"string","value":"square-us-feet"},{"type":"string","value":"square-millimeters"},{"type":"string","value":"square-centimeters"},{"type":"string","value":"square-decimeters"},{"type":"string","value":"square-meters"},{"type":"string","value":"square-kilometers"},{"type":"string","value":"acres"},{"type":"string","value":"ares"},{"type":"string","value":"hectares"}],"optional":true,"required":false},{"name":"unitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrAreaUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unit) values can only be a subset of this list.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-area-measurement-2d component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Clears the current measurement.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAreaMeasurement2d = document.createElement(\"arcgis-area-measurement-2d\");\ndocument.body.append(arcgisAreaMeasurement2d);\nawait arcgisAreaMeasurement2d.componentOnReady();\nconsole.log(\"arcgis-area-measurement-2d is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"start","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"start(): Promise","parameters":[],"docs":"Starts a new measurement.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"analysis\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"analysis\" | \"state\"; }","resolved":"{ name: \"analysis\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/area-measurement-3d/area-measurement-3d.tsx","tag":"arcgis-area-measurement-3d","overview":"","readme":"","usage":{},"docs":"The Area Measurement 3D component can be added to an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent to calculate and display area and perimeter of polygons.\n\n[![measurement-area-3d](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/3D_AreaMeasurement_widget.avif)](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow the area and perimeter are computed depends on the scene's spatial reference and the length of the measured perimeter.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- If the measurement's perimeter is below 100 km, they are computed in a Euclidean manner,\n in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets).\n- If the perimeter is above 100 km, they are computed geodetically, and the visualization takes\n the curvature of the planet into consideration.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, the area and perimeter\nare always calculated in a Euclidean manner (in their respective PCS).\n\nThe area may be visualized and calculated in two ways:\n1. If all the vertices are mostly coplanar (lying on the same plane),\n the measurement polygon is formed on that plane, and area and perimeter are calculated from its geometry.\n2. If the vertices don't form a planar surface, the measurement polygon\n is projected to a horizontal plane, and area and perimeter are calculated from its geometry.\n\n![area-measurement-3d-types](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/area-measurement-3d-types.avif)\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\n\n**Things to consider**\n\n* Area Measurement 3D is designed to work in the Scene component. For measurements in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent, use [arcgis-area-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/).\n* Snapping is enabled by default. Holding the `CTRL` key disables it.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"analysis","type":"AreaMeasurementAnalysis","complexType":{"original":"AreaMeasurementAnalysis","resolved":"AreaMeasurementAnalysis","references":{"default":{"location":"import","path":"@arcgis/core/analysis/AreaMeasurementAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Area Measurement 3D component to the [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses) collection.\nYou can then wait for the [AreaMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/AreaMeasurementAnalysisView3D/)\nto be created before accessing the analysis results.\n\n```js\n// Get the Scene component and the Area Measurement 3D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst areaMeasurement3dElement = document.querySelector(\"arcgis-area-measurement-3d\");\nawait areaMeasurement3dElement.componentOnReady();\n\n// Get the AreaMeasurementAnalysis created by the Area Measurement 3D component.\nconst analysis = areaMeasurement3dElement.analysis;\n\n// Get the AreaMeasurementAnalysisView3D and watch for results.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysisView?.result,\n () => {\n console.log(\"Analysis results:\", analysisView.result);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.\n\n```js\n// Create the AreaMeasurementAnalysis.\nconst areaMeasurementAnalysis = new AreaMeasurementAnalysis({\n geometry: new Polygon({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n rings: [\n [\n [-13624861.22274897, 4550346.5519295, 63.378210234455764],\n [-13624935.305160372, 4550273.144585712, 63.37829629518092],\n [-13624995.61798748, 4550334.030096778, 63.37819860037416],\n [-13624921.53589075, 4550407.42357004, 63.3783810287714],\n [-13624861.22274897, 4550346.5519295, 63.378210234455764]\n ]\n ]\n })\n});\n// Get the Scene component and the Area Measurement 3D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst areaMeasurement3dElement = document.querySelector(\"arcgis-area-measurement-3d\");\nawait areaMeasurement3dElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Scene component.\nviewElement.analyses.add(areaMeasurementAnalysis);\n\n// Connect the analysis to the measurement component:\nareaMeasurement3dElement.analysis = areaMeasurementAnalysis;\n```","docsTags":[],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStartButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-start-button","reflectToAttr":false,"docs":"If true, the button that starts a new measurement will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-unit-select","reflectToAttr":false,"docs":"If true, the unit selection dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualization","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization","reflectToAttr":false,"docs":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"measure-area\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"AreaMeasurement3DState","complexType":{"original":"AreaMeasurement3DState","resolved":"AreaMeasurement3DState","references":{"AreaMeasurement3DState":{"location":"local","path":"components/arcgis-area-measurement-3d/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"unsupported"},{"type":"string","value":"measured"},{"type":"string","value":"measuring"}],"optional":true,"required":false},{"name":"unit","type":"SystemOrAreaUnit","complexType":{"original":"SystemOrAreaUnit","resolved":"SystemOrAreaUnit","references":{"SystemOrAreaUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#unitOptions).","docsTags":[],"values":[{"type":"string","value":"metric"},{"type":"string","value":"imperial"},{"type":"string","value":"square-inches"},{"type":"string","value":"square-feet"},{"type":"string","value":"square-yards"},{"type":"string","value":"square-miles"},{"type":"string","value":"square-nautical-miles"},{"type":"string","value":"square-us-feet"},{"type":"string","value":"square-millimeters"},{"type":"string","value":"square-centimeters"},{"type":"string","value":"square-decimeters"},{"type":"string","value":"square-meters"},{"type":"string","value":"square-kilometers"},{"type":"string","value":"acres"},{"type":"string","value":"ares"},{"type":"string","value":"hectares"}],"optional":true,"required":false},{"name":"unitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrAreaUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#unit) values can only be a subset of this list.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-area-measurement-3d component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Clears the current measurement.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAreaMeasurement3d = document.createElement(\"arcgis-area-measurement-3d\");\ndocument.body.append(arcgisAreaMeasurement3d);\nawait arcgisAreaMeasurement3d.componentOnReady();\nconsole.log(\"arcgis-area-measurement-3d is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"start","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"start(): Promise","parameters":[],"docs":"Starts a new measurement.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"analysis\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"analysis\" | \"state\"; }","resolved":"{ name: \"analysis\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/attachments/attachments.tsx","tag":"arcgis-attachments","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"attachmentInfos","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/rest/query/support/AttachmentInfo.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of [AttachmentInfo](https://developers.arcgis.com/javascript/latest/references/core/rest/query/support/AttachmentInfo/) defined on a feature.","docsTags":[{"name":"see","text":"[ArcGIS REST API - Attachment Infos (Feature Service)](https://developers.arcgis.com/rest/services-reference/attachment-infos-feature-service-.htm)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"attachmentKeywords","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of strings used to identify attachment(s). When attachments are displayed, this property is used to query attachments using an exact match on the keywords provided.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"attachmentTypes","type":"Array<\"image\" | \"model\" | \"text\" | \"video\" | \"application\" | \"audio\"> | null | undefined","complexType":{"original":"Array<\"image\" | \"model\" | \"text\" | \"video\" | \"application\" | \"audio\"> | null | undefined","resolved":"Array<\"image\" | \"model\" | \"text\" | \"video\" | \"application\" | \"audio\"> | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of strings representing MIME types. When attachments are displayed, this property is used to query attachments based on MIME type. Valid values: application, audio, image, model, text, and video.","docsTags":[],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachments/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"capabilities","type":"AttachmentsCapabilities","complexType":{"original":"AttachmentsCapabilities","resolved":"AttachmentsCapabilities","references":{"AttachmentsCapabilities":{"location":"import","path":"@arcgis/core/widgets/Attachments/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The capabilities needed for the attachments component.","docsTags":[{"name":"since","text":"4.27"}],"values":[],"optional":true,"required":false},{"name":"displayType","type":"AttachmentsDisplay","complexType":{"original":"AttachmentsDisplay","resolved":"AttachmentsDisplay","references":{"AttachmentsDisplay":{"location":"import","path":"@arcgis/core/widgets/Attachments/types.js","id":"notImplemented"}}},"mutable":true,"attr":"display-type","reflectToAttr":false,"docs":"String indicating how to [display](https://developers.arcgis.com/javascript/latest/references/core/widgets/Attachments/#displayType) the attachments.\n\n| Value | Description |\n| ------ | ----------- |\n| auto | Default value. If a feature layer's capabilities supports [resizing attachments](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities), the popup will display attachments in `preview` mode.|\n| preview | Shows a thumbnail image of the attachment.|\n| list | Shows a list of attachment links. |","docsTags":[],"default":"\"auto\"","values":[{"type":"string","value":"list"},{"type":"string","value":"auto"},{"type":"string","value":"preview"}],"optional":true,"required":false},{"name":"graphic","type":"Graphic | null | undefined","complexType":{"original":"Graphic | null | undefined","resolved":"Graphic | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The graphic for the attachments.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"hideAddButton","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-add-button","reflectToAttr":false,"docs":"Indicates whether to hide the `Add` button which prompts the dialog to add a new attachment.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideAddSubmitButton","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-add-submit-button","reflectToAttr":false,"docs":"Indicates whether to hide the `add` button after selecting the attachment to add..","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCancelAddButton","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-cancel-add-button","reflectToAttr":false,"docs":"Indicates whether to hide the `cancel` button after selecting the attachment to add.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCancelUpdateButton","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-cancel-update-button","reflectToAttr":false,"docs":"Indicates whether to hide the `cancel` button after selecting an attachment to update an existing attachment.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDeleteButton","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-delete-button","reflectToAttr":false,"docs":"Indicates whether to hide the `delete` button to delete an existing attachment.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideErrorMessage","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-error-message","reflectToAttr":false,"docs":"Indicates whether to hide an error message if adding or updating an attachment results in errors.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideProgressBar","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-progress-bar","reflectToAttr":false,"docs":"Indicates whether to hide a progress bar when adding an attachment.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUpdateButton","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-update-button","reflectToAttr":false,"docs":"Indicates whether to hide an `update` button to allow updating on existing attachments.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"attachment\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"AttachmentsViewModelState","complexType":{"original":"AttachmentsViewModelState","resolved":"AttachmentsViewModelState","references":{"AttachmentsViewModelState":{"location":"import","path":"@arcgis/core/widgets/Attachments/AttachmentsViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"ready\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"submitting","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether there is currently an attachment being added, updated or deleted.","docsTags":[{"name":"since","text":"4.27"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAttachments = document.createElement(\"arcgis-attachments\");\ndocument.body.append(arcgisAttachments);\nawait arcgisAttachments.componentOnReady();\nconsole.log(\"arcgis-attachments is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"submitting\" | \"state\" | \"attachmentInfos\"; }","bubbles":true,"complexType":{"original":"{ name: \"submitting\" | \"state\" | \"attachmentInfos\"; }","resolved":"{ name: \"submitting\" | \"state\" | \"attachmentInfos\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/basemap-gallery/basemap-gallery.tsx","tag":"arcgis-basemap-gallery","overview":"","readme":"","usage":{},"docs":"The Basemap Gallery component displays a collection images representing basemaps from [ArcGIS.com](https://www.arcgis.com/index.html) or a user-defined set of map or image services. When a new basemap is selected from the Basemap Gallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"activeBasemap","type":"BasemapProperties | string | undefined","complexType":{"original":"BasemapProperties | string | undefined","resolved":"BasemapProperties | string | undefined","references":{"BasemapProperties":{"location":"import","path":"@arcgis/core/Basemap.js","id":"notImplemented"}}},"mutable":true,"attr":"active-basemap","reflectToAttr":false,"docs":"The map's current [basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":true,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the Basemap Gallery.","docsTags":[],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"icon","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"basemap\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"source","type":"LocalBasemapsSource | PortalBasemapsSource","complexType":{"original":"LocalBasemapsSource | PortalBasemapsSource","resolved":"LocalBasemapsSource | PortalBasemapsSource","references":{"default":{"location":"import","path":"@arcgis/core/widgets/BasemapGallery/support/PortalBasemapsSource.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The source for basemaps that the component will display.","docsTags":[{"name":"example","text":"Set the source from a local basemap collection.\n```html\n\n \n\n\n\n```"},{"name":"example","text":"Set the source from a Portal group\n```html\n\n \n\n\n\n```"}],"values":[],"optional":true,"required":false},{"name":"state","type":"BasemapGalleryViewModelState","complexType":{"original":"BasemapGalleryViewModelState","resolved":"BasemapGalleryViewModelState","references":{"BasemapGalleryViewModelState":{"location":"import","path":"@arcgis/core/widgets/BasemapGallery/BasemapGalleryViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"unsupported"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-basemap-gallery component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisBasemapGallery = document.createElement(\"arcgis-basemap-gallery\");\ndocument.body.append(arcgisBasemapGallery);\nawait arcgisBasemapGallery.componentOnReady();\nconsole.log(\"arcgis-basemap-gallery is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"activeBasemap\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"activeBasemap\" | \"state\"; }","resolved":"{ name: \"activeBasemap\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/basemap-layer-list/basemap-layer-list.tsx","tag":"arcgis-basemap-layer-list","overview":"","readme":"","usage":{},"docs":"The Basemap Layer List component provides a way to display a list of [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) layers and switch on/off their visibility. [Base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers) are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"baseFilterPredicate","type":"FilterPredicate | null | undefined","complexType":{"original":"FilterPredicate | null | undefined","resolved":"FilterPredicate | null | undefined","references":{"FilterPredicate":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a function to handle filtering base layer [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/).","docsTags":[{"name":"since","text":"4.32"},{"name":"example","text":"```js\nbasemapLayerListElement.baseFilterPredicate = (item) => item.title.toLowerCase().includes(\"streets\");\n```"}],"values":[],"optional":true,"required":false},{"name":"baseFilterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"base-filter-text","reflectToAttr":false,"docs":"The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter)"},{"name":"example","text":"```js\nreactiveUtils.watch(\n () => basemapLayerListElement.baseFilterText,\n (baseFilterText) => console.log(baseFilterText)\n);\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"baseItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of ListItems representing the baseLayers.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"baseListItemCreatedFunction","type":"ListItemModifier | null | undefined","complexType":{"original":"ListItemModifier | null | undefined","resolved":"ListItemModifier | null | undefined","references":{"ListItemModifier":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) representing a base layer.\nEach list item's modifiable properties can be updated within. Actions can be added to list items\nusing the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/#actionsSections)\nproperty of the ListItem.","docsTags":[{"name":"example","text":"```js\nbasemapLayerListElement.baseListItemCreatedFunction = (event) => {\n const baseListItem = event.item;\n if(baseListItem.title === \"World Imagery_01\"){\n // clean up title\n baseListItem.title = \"World Imagery\";\n // open the baseList item\n baseListItem.open = true;\n }\n}\n```"}],"values":[],"optional":true,"required":false},{"name":"basemapTitle","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"basemap-title","reflectToAttr":false,"docs":"The current basemap's title.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"catalogLayerList","type":"CatalogLayerList | null | undefined","complexType":{"original":"CatalogLayerList | null | undefined","resolved":"CatalogLayerList | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/CatalogLayerList.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The CatalogLayerList that displays a catalog layer's dynamic group layer.","docsTags":[{"name":"see","text":"[arcgis-catalog-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/)"},{"name":"see","text":"[catalogOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#catalogOptions)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"catalogOptions","type":"CatalogLayerListProperties | null | undefined","complexType":{"original":"CatalogLayerListProperties | null | undefined","resolved":"CatalogLayerListProperties | null | undefined","references":{"CatalogLayerListProperties":{"location":"import","path":"@arcgis/core/widgets/CatalogLayerList.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"[CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) specific properties.\nCatalog layers will display their [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) as an expandable [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#catalogLayerList) in the BasemapLayerList widget.\nThis list item will only be displayed when catalog layers with dynamic group layers are loaded in the map.\nThese are the properties that are used to configure the [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#catalogLayerList).","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#catalogLayerList)"},{"name":"example","text":"```js\nbasemapLayerListElement.catalogOptions = {\n listItemCreatedFunction: (event) => {\n const { item } = event;\n item.actionsSections = [\n [\n {\n title: \"Add layer to map\",\n icon: \"add-layer\",\n id: \"add-layer\"\n }\n ]\n ];\n },\n selectionMode: \"single\",\n visibleElements: {\n filter: true\n temporaryLayerIndicators: true\n }\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"closed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closed","reflectToAttr":false,"docs":"Indicates whether a component is closed. When `true`, the component will be hidden.","docsTags":[{"name":"since","text":"4.33"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapsed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"collapsed","reflectToAttr":true,"docs":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showCollapseButton)"},{"name":"example","text":"```js\nbasemapLayerListElement.collapsed = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"dragEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"drag-enabled","reflectToAttr":false,"docs":"Indicates whether [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) may be reordered within the list by dragging and dropping.\nMapImageLayer [sublayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.","docsTags":[{"name":"since","text":"4.29"},{"name":"example","text":"```js\nbasemapLayerListElement.dragEnabled = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"editingTitle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"editing-title","reflectToAttr":false,"docs":"Indicates whether the form to edit the basemap's title is currently visible.\nAny edits made will only be shown locally and will not be saved.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showEditTitleButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showEditTitleButton)"},{"name":"example","text":"```js\nbasemapLayerListElement.editingTitle = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterPlaceholder","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-placeholder","reflectToAttr":false,"docs":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter)"},{"name":"example","text":"```js\nbasemapLayerListElement.filterPlaceholder = \"Filter layers\";\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the component's title (i.e. \"Navigation\").\nBy default, the basemap's title is rendered\nas a level 2 heading (e.g. `

Navigation

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[{"name":"since","text":"4.20"},{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"example","text":"```js\n// the component title will render as an

\nbasemapLayerListElement.headingLevel = 3;\n```"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideBaseLayers","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-base-layers","reflectToAttr":false,"docs":"Indicates whether the base layers will be displayed.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-heading","reflectToAttr":false,"docs":"Indicates whether the basemap layer list displays a heading. The heading text is the title of the basemap. The heading level can be set with the [BasemapLayerList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#headingLevel).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideReferenceLayers","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-reference-layers","reflectToAttr":false,"docs":"Indicates whether to the reference layers will be displayed.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStatusIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-status-indicators","reflectToAttr":false,"docs":"Indicates whether the status indicators will be displayed.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"layers\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"minFilterItems","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-filter-items","reflectToAttr":false,"docs":"The minimum number of list items required to display the [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) input box.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter)"},{"name":"example","text":"```js\nbasemapLayerListElement.showFilter = true;\nbasemapLayerListElement.minFilterItems = 5;\n```"}],"default":"10","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"referenceFilterPredicate","type":"FilterPredicate | null | undefined","complexType":{"original":"FilterPredicate | null | undefined","resolved":"FilterPredicate | null | undefined","references":{"FilterPredicate":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a function to handle filtering reference layer [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/).","docsTags":[{"name":"since","text":"4.32"},{"name":"example","text":"```js\nlayerList.referenceFilterPredicate = (item) => item.title.toLowerCase().includes(\"streets\");\n```"}],"values":[],"optional":true,"required":false},{"name":"referenceFilterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"reference-filter-text","reflectToAttr":false,"docs":"The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter)"},{"name":"example","text":"```js\nreactiveUtils.watch(\n () => basemapLayerListElement.referenceFilterText,\n (referenceFilterText) => console.log(referenceFilterText)\n);\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of ListItems representing the referenceLayers.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"referenceListItemCreatedFunction","type":"ListItemModifier | null | undefined","complexType":{"original":"ListItemModifier | null | undefined","resolved":"ListItemModifier | null | undefined","references":{"ListItemModifier":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) representing a reference layer.\nEach list item's modifiable properties can be updated within. Actions can be added to list items\nusing the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/#actionsSections).","docsTags":[{"name":"example","text":"```js\nbasemapLayerListElement.referenceListItemCreatedFunction = (event) => {\n referenceListItem = event.item;\n if(referenceListItem.title === \"World Imagery_01_reference_layer\"){\n // clean up title\n referenceListItem.title = \"Reference layer\";\n // open the baseList item\n referenceListItem.open = true;\n }\n}\n```"}],"values":[],"optional":true,"required":false},{"name":"selectedItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/)s representing basemap layers\nselected by the user.","docsTags":[{"name":"see","text":"[selectionMode](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#selectionMode)"}],"values":[],"optional":true,"required":false},{"name":"selectionMode","type":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","complexType":{"original":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","resolved":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","references":{}},"mutable":true,"attr":"selection-mode","reflectToAttr":false,"docs":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#selectedItems) property.\n\n| Value | Description |\n| ----- | ----------- |\n| multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |\n| none | Disables selection. Use this when you want to prevent selecting items. |\n| single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |\n| single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#selectedItems)"},{"name":"example","text":"```js\nbasemapLayerListElement.selectionMode = \"multiple\";\n```"}],"default":"\"none\"","values":[{"type":"string","value":"multiple"},{"type":"string","value":"single"},{"type":"string","value":"none"},{"type":"string","value":"single-persist"}],"optional":true,"required":false},{"name":"showCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-close-button","reflectToAttr":false,"docs":"Indicates whether to display a close button in the header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse-button","reflectToAttr":false,"docs":"Indicates whether to display a collapse button in the header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showEditTitleButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-edit-title-button","reflectToAttr":false,"docs":"Indicates whether to display a button in the header to edit the basemap title.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showErrors","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-errors","reflectToAttr":false,"docs":"Indicates whether to display layers with load errors.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showFilter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-filter","reflectToAttr":false,"docs":"Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [BasemapLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#minFilterItems), allowing users to filter layers by their title.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showTemporaryLayerIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-temporary-layer-indicators","reflectToAttr":false,"docs":"Indicates whether temporary layer indicators will be displayed for layers with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the layer title.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"BasemapLayerListState","complexType":{"original":"BasemapLayerListState","resolved":"BasemapLayerListState","references":{"BasemapLayerListState":{"location":"import","path":"@arcgis/core/widgets/BasemapLayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-basemap-layer-list component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visibilityAppearance","type":"VisibilityAppearance","complexType":{"original":"VisibilityAppearance","resolved":"VisibilityAppearance","references":{"VisibilityAppearance":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"attr":"visibility-appearance","reflectToAttr":false,"docs":"Determines the icons used to indicate visibility.\n\n| Value | Description | Example |\n| ----- | ----------- | ------- |\n| default | Displays view icons on the far side. Icons are hidden except on hover or if they have keyboard focus. See [view-visible](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-visible&library=Calcite%20UI&query=view) and [view-hide](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-hide&library=Calcite%20UI&query=view) calcite icons. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-default.avif) |\n| checkbox | Displays checkbox icons on the near side. See [check-square-f](https://developers.arcgis.com/calcite-design-system/icons/?icon=check-square-f&library=Calcite%20UI&query=check) and [square](https://developers.arcgis.com/calcite-design-system/icons/?icon=square&library=Calcite%20UI&query=square) calcite icons. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-checkbox.avif) |","docsTags":[{"name":"since","text":"4.29"},{"name":"example","text":"```js\nbasemapLayerListElement.visibilityAppearance = \"checkbox\";\n```"}],"default":"\"default\"","values":[{"type":"string","value":"checkbox"},{"type":"string","value":"default"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisBasemapLayerList = document.createElement(\"arcgis-basemap-layer-list\");\ndocument.body.append(arcgisBasemapLayerList);\nawait arcgisBasemapLayerList.componentOnReady();\nconsole.log(\"arcgis-basemap-layer-list is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[{"name":"since","text":"4.33"}]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTriggerAction","detail":"LayerListViewModelTriggerActionEvent","bubbles":true,"complexType":{"original":"LayerListViewModelTriggerActionEvent","resolved":"LayerListViewModelTriggerActionEvent","references":{"LayerListViewModelTriggerActionEvent":{"location":"import","path":"@arcgis/core/widgets/LayerList/LayerListViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when an action is triggered on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/basemap-toggle/basemap-toggle.tsx","tag":"arcgis-basemap-toggle","overview":"","readme":"","usage":{},"docs":"The Basemap Toggle component allows an end-user to switch between two basemaps.\n\nThe basemaps can have different spatial references.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"activeBasemap","type":"Basemap | null | undefined","complexType":{"original":"Basemap | null | undefined","resolved":"Basemap | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Basemap.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The map's current [basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).","docsTags":[{"name":"readonly","text":""}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"layer-basemap\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"nextBasemap","type":"BasemapProperties | string | undefined","complexType":{"original":"BasemapProperties | string | undefined","resolved":"BasemapProperties | string | undefined","references":{"BasemapProperties":{"location":"import","path":"@arcgis/core/Basemap.js","id":"notImplemented"}}},"mutable":true,"attr":"next-basemap","reflectToAttr":false,"docs":"The next basemap for toggling.","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"showTitle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-title","reflectToAttr":false,"docs":"Indicates if the Basemap title is displayed.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"BasemapToggleViewModelState","complexType":{"original":"BasemapToggleViewModelState","resolved":"BasemapToggleViewModelState","references":{"BasemapToggleViewModelState":{"location":"import","path":"@arcgis/core/widgets/BasemapToggle/BasemapToggleViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"incompatible-next-basemap"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-basemap-toggle component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisBasemapToggle = document.createElement(\"arcgis-basemap-toggle\");\ndocument.body.append(arcgisBasemapToggle);\nawait arcgisBasemapToggle.componentOnReady();\nconsole.log(\"arcgis-basemap-toggle is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"toggle","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"toggle(): Promise","parameters":[],"docs":"Toggles to the [nextBasemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/#nextBasemap).","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"activeBasemap\" | \"nextBasemap\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"activeBasemap\" | \"nextBasemap\" | \"state\"; }","resolved":"{ name: \"activeBasemap\" | \"nextBasemap\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/bookmarks/bookmarks.tsx","tag":"arcgis-bookmarks","overview":"","readme":"","usage":{},"docs":"The Bookmarks component allows end users to quickly navigate to a particular area of interest.\nIt displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/),\nwhich are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks).\n\nEach bookmark may contain the following properties: `name`, `thumbnail`, `viewpoint` (defines rotation, scale, and target geometry), and `timeExtent`.\nWhen a bookmark with a timeExtent is selected, the [arcgis-map.timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeExtent) of the Map will be set to the timeExtent of the selected bookmark.\nTo disable time capability in the Bookmarks component, set [timeDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#timeDisabled) to `true`.\n\nStarting with version `5.1`, on [@arcgisBookmarkSelect](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#event-arcgisBookmarkSelect) the selected bookmark's name is announced to assistive technologies. Visit the [Accessibility guide](https://developers.arcgis.com/javascript/latest/accessibility/#assistive-technologies) to learn more\nabout live announcements supporting more audiences.\n\nThe Bookmarks component can be used to create, edit, reorder, and delete bookmarks.\nTo enable these features, set the following properties to `true`:\n[showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#dragEnabled).\n\n**Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks) or are provided manually from [bookmarks](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/).","docsTags":[{"name":"since","text":"4.28"},{"name":"see","text":"[Sample - Bookmarks component](https://developers.arcgis.com/javascript/latest/sample-code/bookmarks/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"bookmarks","type":"ReadonlyArrayOrCollection","complexType":{"original":"ReadonlyArrayOrCollection","resolved":"ReadonlyArrayOrCollection","references":{"ReadonlyArrayOrCollection":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/webmap/Bookmark.js","id":"notImplemented"}}},"mutable":true,"attr":"bookmarks","reflectToAttr":false,"docs":"A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/)s. These are typically defined inside of a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks), but can also be defined manually, as shown in the code snippet below.","docsTags":[{"name":"example","text":"```js\nconst bookmarksElement = document.querySelector(\"arcgis-bookmarks\");\n// define bookmarks manually\nbookmarksElement.bookmarks = [\n new Bookmark({\n name: \"Angeles National Forest\",\n viewpoint: {\n targetGeometry: {\n type: \"extent\",\n spatialReference: {\n wkid: 102100\n },\n xmin: -13139131.948889678,\n ymin: 4047767.23531948,\n xmax: -13092887.54677721,\n ymax: 4090610.189673263\n }\n }\n }),\n new Bookmark({\n name: \"Crystal Lake\",\n viewpoint: {\n targetGeometry: {\n type: \"extent\",\n spatialReference: {\n wkid: 102100\n },\n xmin: -13125852.551697943,\n ymin: 4066904.1101411926,\n xmax: -13114291.451169826,\n ymax: 4077614.8487296384\n },\n rotation: 90\n }\n })\n];"}],"values":[],"optional":true,"required":false},{"name":"closed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closed","reflectToAttr":true,"docs":"Indicates whether a component is closed. When `true`, the component will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"defaultCreateOptions","type":"Partial","complexType":{"original":"Partial","resolved":"Partial","references":{"Partial":{"location":"global","path":"global:","id":"notImplemented"},"BookmarkOptions":{"location":"local","path":"components/arcgis-bookmarks/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies how new bookmarks will be created if [showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showAddBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is created.","docsTags":[{"name":"example","text":"```js\nconst bookmarksElement = document.querySelector(\"arcgis-bookmarks\");\nbookmarksElement.showAddBookmarkButton = true;\nbookmarksElement.defaultCreateOptions = {\n // whenever a new bookmark is created, a 100x100 px\n // screenshot of the view will be taken and the rotation, scale, and extent\n // of the view will not be set as the viewpoint of the new bookmark\n takeScreenshot: true,\n captureViewpoint: false,\n captureTimeExtent: false, // the time extent will not be saved in the bookmark\n screenshotSettings: {\n width: 100,\n height: 100\n }\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"defaultEditOptions","type":"Partial","complexType":{"original":"Partial","resolved":"Partial","references":{"Partial":{"location":"global","path":"global:","id":"notImplemented"},"BookmarkOptions":{"location":"local","path":"components/arcgis-bookmarks/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies how bookmarks will be edited, if [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showEditBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is edited.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"dragEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"drag-enabled","reflectToAttr":false,"docs":"Indicates if a Bookmark is able to be dragged in order to update its position in the list.","docsTags":[{"name":"since","text":"4.29"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterPlaceholder","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-placeholder","reflectToAttr":false,"docs":"Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showFilter) is set to `true`.","docsTags":[{"name":"since","text":"4.29"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"filterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-text","reflectToAttr":false,"docs":"Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showFilter) is set to `true`.","docsTags":[{"name":"since","text":"4.29"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | undefined","complexType":{"original":"GoToOverride | undefined","resolved":"GoToOverride | undefined","references":{"GoToOverride":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the message \"No bookmarks\" when no bookmarks\nare available. By default, this message is rendered\nas a level 2 heading (e.g. `

No bookmarks

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"since","text":"4.34"},{"name":"example","text":"```js\n// \"No bookmarks\" will render as an

\nbookmarksElement.headingLevel = 3;\n```"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideThumbnail","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-thumbnail","reflectToAttr":false,"docs":"Indicates whether the thumbnail associated with the bookmark is hidden.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTime","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-time","reflectToAttr":false,"docs":"Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"bookmark\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"showAddBookmarkButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-add-bookmark-button","reflectToAttr":false,"docs":"Indicates whether to display the button to add a new bookmark.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-close-button","reflectToAttr":false,"docs":"Indicates whether to display the close button.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse-button","reflectToAttr":false,"docs":"Indicates whether to display the collapse button.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showEditBookmarkButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-edit-bookmark-button","reflectToAttr":false,"docs":"Indicates whether to display the button to edit a bookmark.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showFilter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-filter","reflectToAttr":false,"docs":"Indicates whether to display the bookmark filter.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-heading","reflectToAttr":false,"docs":"Indicates whether to display the heading.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"BookmarksState","complexType":{"original":"BookmarksState","resolved":"BookmarksState","references":{"BookmarksState":{"location":"local","path":"components/arcgis-bookmarks/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"ready\"","values":[{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"timeDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"time-disabled","reflectToAttr":false,"docs":"Indicates whether to disable the time capability of the Bookmarks component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-bookmarks component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisBookmarks = document.createElement(\"arcgis-bookmarks\");\ndocument.body.append(arcgisBookmarks);\nawait arcgisBookmarks.componentOnReady();\nconsole.log(\"arcgis-bookmarks is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"goTo","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(bookmark: Bookmark): Promise","parameters":[{"name":"bookmark","type":"Bookmark","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/webmap/Bookmark.js","id":"notImplemented"}}},"signature":"goTo(bookmark: Bookmark): Promise","parameters":[{"name":"bookmark","type":"Bookmark","docs":""}],"docs":"Zoom to a specific bookmark.","docsTags":[{"name":"since","text":"4.34"}]}],"events":[{"event":"arcgisBookmarkEdit","detail":"BookmarkEditEvent","bubbles":true,"complexType":{"original":"BookmarkEditEvent","resolved":"BookmarkEditEvent","references":{"BookmarkEditEvent":{"location":"local","path":"components/arcgis-bookmarks/types","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is edited.","docsTags":[{"name":"since","text":"4.34"},{"name":"example","text":"```js\n// once an edit has been made, enable the \"Save Webmap\" button\n// to allow the user to save their changes\nbookmarksElement.addEventListener(\"arcgisBookmarkEdit\", (event) => {\n saveBtn.disabled = false;\n});\n```"}]},{"event":"arcgisBookmarkSelect","detail":"BookmarkSelectEvent","bubbles":true,"complexType":{"original":"BookmarkSelectEvent","resolved":"BookmarkSelectEvent","references":{"BookmarkSelectEvent":{"location":"local","path":"components/arcgis-bookmarks/types","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is selected.","docsTags":[{"name":"since","text":"4.34"},{"name":"example","text":"```html\n\n \n\n\n\n```"}]},{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/building-explorer/building-explorer.tsx","tag":"arcgis-building-explorer","overview":"","readme":"","usage":{},"docs":"The Building Explorer component is used to filter and explore the various building elements of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of building elements grouped in sublayers. Using the Building Explorer component, buildings can be filtered by [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#level), [phase](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#phase) or by disciplines and categories.\nThe visibility of these elements can be configured using the component's [hideLevels](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideLevels), [hidePhases](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hidePhases) and [hideDisciplines](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideDisciplines) properties.\n\n[![building-explorer](https://developers.arcgis.com/javascript/latest/assets/references/components/building-explorer/building-explorer.avif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n\nThe [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) to be explored have to be set on the [layers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#layers) property of the component. When setting multiple layers, the filters set by the Building Explorer component will be applied on all layers. The component doesn't allow the user to select between multiple layers present in a scene.\n\nOften, [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) contain an _Overview_ [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingComponentSublayer/) that serves as an exterior shell and views the building model as a single feature. When a layer is added to the Building Explorer component, the visibility of the _Overview_ layer is turned off, so that the user can directly interact with the individual features in the _Full Model_ [BuildingGroupSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingGroupSublayer/).\n\nThe Level element of the Building Explorer component allows to select a single level in one or several buildings. When selecting a level, the levels above it are hidden and the levels below it become semi-transparent for added visual context.\n\nSome [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) include information indicating the phase in which building elements, such as doors or pipes, were created and, optionally, when they were demolished. If a layer has multiple construction phases, these will be displayed in the Construction phases element. When selecting a construction phase, all the building elements created during or before the phase are selected. Demolished building elements aren't displayed.\n\nDiscipline layers are [group layers](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingGroupSublayer/) that organize the [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) content into architectural, structural, mechanical, or electrical groups. These layers contain a number of Category layers such as walls, windows, furniture, and lighting fixtures. These layers can be turned on and off in the Disciplines and Categories list.\n\nThe Building Explorer component can only display filters set by the component itself. Filters set by other applications will be ignored.\n\n**Known limitations**\n\nBuilding Explorer is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [Sample - Filter BuildingSceneLayer with Building Explorer](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the component title.","docsTags":[{"name":"since","text":"4.28"}],"default":"3","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideDisciplines","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-disciplines","reflectToAttr":false,"docs":"If true, the disciplines tree will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLevels","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-levels","reflectToAttr":false,"docs":"If true, the levels filter will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePhases","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-phases","reflectToAttr":false,"docs":"If true, the phases filter will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"organization\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layers","type":"BuildingSceneLayer[]","complexType":{"original":"BuildingSceneLayer[]","resolved":"BuildingSceneLayer[]","references":{"default":{"location":"import","path":"@arcgis/core/layers/BuildingSceneLayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A list of layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) that are added to the component for exploration.\n\nThe component UI is only displayed when this property is set. In case of multiple layers, the component will display and apply the filters on all layers.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"level","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"level","reflectToAttr":false,"docs":"The currently selected value for the building level filter.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"levelDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the level picker and filter is disabled. If `true`, the filters expression won't be used to filter a [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/).","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"levels","type":"readonly number[] | undefined","complexType":{"original":"readonly number[] | undefined","resolved":"readonly number[] | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"List of the building level values which are allowed for the levels filter.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"phase","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"phase","reflectToAttr":false,"docs":"The currently selected value for the construction phase filter.\nConstruction phases are used to track site development for a [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/). Setting a construction phase in the Building Explorer selects everything in the layer which is already constructed at that phase (created phase <= selected phase) but not yet demolished (demolished phase > selected phase). The goal is to display what the building or construction site looks like at that selected phase.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"phaseDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the phase picker and filter is disabled. If `true`, the filters expression won't be used to filter a [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/).","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"phases","type":"readonly number[] | undefined","complexType":{"original":"readonly number[] | undefined","resolved":"readonly number[] | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"List of the building phase values which are allowed for the phases filter.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-building-explorer component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisBuildingExplorer = document.createElement(\"arcgis-building-explorer\");\ndocument.body.append(arcgisBuildingExplorer);\nawait arcgisBuildingExplorer.componentOnReady();\nconsole.log(\"arcgis-building-explorer is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisBuildingLevelChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the user changes the selected building level, or when a new filter instance is loaded.","docsTags":[{"name":"since","text":"5.0"}]},{"event":"arcgisBuildingPhaseChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the user changes the selected construction phase, or when a new filter instance is loaded.","docsTags":[{"name":"since","text":"5.0"}]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/catalog-layer-list/catalog-layer-list.tsx","tag":"arcgis-catalog-layer-list","overview":"","readme":"","usage":{},"docs":"The Catalog Layer List provides a way to display and interact with [CatalogLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/).\nThe component displays a list of layers in the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer)\nand allows you to toggle their visibility.\n\nThe [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.","docsTags":[{"name":"since","text":"4.31"},{"name":"example","text":"```js\nconst catalogLayerListElement = document.createElement(\"arcgis-catalog-layer-list\");\ncatalogLayerListElement.referenceElement = viewElement;\ncatalogLayerListElement.slot = \"top-right\";\nviewElement.appendChild(catalogLayerListElement);\n\ncatalogLayerListElement.listItemCreatedFunction = (event) => {\n const { item } = event;\n const { layer } = item;\n\n if (isLayerFromCatalog(layer)) {\n item.actionsSections = [\n [\n {\n title: \"Add layer to map\",\n icon: \"add-layer\",\n id: \"add-layer\"\n }\n ]\n ];\n }\n}\n\n// Listen for the arcgisTriggerAction event on the CatalogLayerList\n// and add layers from the catalog to the map when the \"add-layer\" action is triggered.\n// To correctly add a layer to the map, you must create a footprint from the layer\n// and then create a new layer from the footprint.\ncatalogLayerList.addEventListener(\"arcgisTriggerAction\", async (event) => {\n const { id } = event.action;\n const { layer } = event.item;\n\n if (id === \"add-layer\") {\n const parentCatalogLayer = catalogUtils.getCatalogLayerForLayer(layer);\n const footprint = parentCatalogLayer.createFootprintFromLayer(layer);\n const layerFromFootprint = await parentCatalogLayer.createLayerFromFootprint(footprint);\n viewElement.map.add(layerFromFootprint);\n }\n});\n```"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"catalogItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of ListItems representing the CatalogLayer's [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer).","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"catalogLayer","type":"CatalogLayer | null | undefined","complexType":{"original":"CatalogLayer | null | undefined","resolved":"CatalogLayer | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/CatalogLayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) to display in the component.","docsTags":[{"name":"example","text":"```js\ncatalogLayerListElement.catalogLayer = new CatalogLayer({ url });\n```"}],"values":[],"optional":true,"required":false},{"name":"closed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closed","reflectToAttr":false,"docs":"Indicates whether a component is closed. When `true`, the component will be hidden.","docsTags":[{"name":"since","text":"4.33"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapsed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"collapsed","reflectToAttr":true,"docs":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and the heading are displayed.","docsTags":[{"name":"see","text":"[showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showCollapseButton)"},{"name":"example","text":"```js\ncatalogLayerListElement.collapsed = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterPlaceholder","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-placeholder","reflectToAttr":false,"docs":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) is true.","docsTags":[{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter)"},{"name":"example","text":"```js\ncatalogLayerListElement.filterPlaceholder = \"Filter layers\";\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"filterPredicate","type":"FilterPredicate | null | undefined","complexType":{"original":"FilterPredicate | null | undefined","resolved":"FilterPredicate | null | undefined","references":{"FilterPredicate":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/).","docsTags":[{"name":"since","text":"4.32"},{"name":"example","text":"```js\ncatalogLayerListElement.filterPredicate = (item) => item.title.toLowerCase().includes(\"streets\");\n```"}],"values":[],"optional":true,"required":false},{"name":"filterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-text","reflectToAttr":false,"docs":"The value of the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) is true.","docsTags":[{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter)"},{"name":"example","text":"```js\nreactiveUtils.watch(\n () => catalogLayerListElement.filterText,\n (filterText) => console.log(filterText)\n);\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the heading of the component.\nBy default, the heading is rendered as a level 2 heading (e.g., `

Catalog Layer List

`).\nDepending on the component's placement in your app, you may need to adjust this heading for proper semantics.\nThis is important for meeting accessibility standards.","docsTags":[{"name":"see","text":"[showHeading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showHeading)"},{"name":"example","text":"```js\ncatalogLayerListElement.headingLevel = 3;\n```"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideStatusIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-status-indicators","reflectToAttr":false,"docs":"Indicates whether the status indicators will be displayed.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"catalog-dataset\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layerTablesEnabled","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"TableSupportedLayers":{"location":"local","path":"utils/layer-list-utils","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"listItemCreatedFunction","type":"ListItemModifier | null | undefined","complexType":{"original":"ListItemModifier | null | undefined","resolved":"ListItemModifier | null | undefined","references":{"ListItemModifier":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) is created.\nUse this function to add actions and panels to list items, and to override\nthe default settings of a list item. Actions can be added to list items\nusing the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/#actionsSections).","docsTags":[{"name":"example","text":"```js\ncatalogLayerListElement.listItemCreatedFunction = (event) => {\n const { item } = event;\n const { layer } = item;\n\n if (isLayerFromCatalog(layer)) {\n item.actionsSections = [\n [\n {\n title: \"Add layer to map\",\n icon: \"add-layer\",\n id: \"add-layer\"\n }\n ]\n ];\n }\n}\n```"}],"values":[],"optional":true,"required":false},{"name":"minFilterItems","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-filter-items","reflectToAttr":false,"docs":"The minimum number of list items required to display the [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) input box.","docsTags":[{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter)"},{"name":"example","text":"```js\ncatalogLayerListElement.showFilter = true;\ncatalogLayerListElement.minFilterItems = 5;\n```"}],"default":"10","values":[{"type":"number"}],"optional":true,"required":false},{"name":"onCatalogOpen","type":"(item: ListItem) => void","complexType":{"original":"(item: ListItem) => void","resolved":"(item: ListItem) => void","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"onTablesOpen","type":"(item: ListItem) => void","complexType":{"original":"(item: ListItem) => void","resolved":"(item: ListItem) => void","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of selected [ListItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) representing [catalogItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#catalogItems)\nselected by the user.","docsTags":[{"name":"see","text":"[selectionMode](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#selectionMode)"},{"name":"see","text":"[catalogItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#catalogItems)"}],"values":[],"optional":true,"required":false},{"name":"selectionMode","type":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","complexType":{"original":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","resolved":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","references":{}},"mutable":true,"attr":"selection-mode","reflectToAttr":false,"docs":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#selectedItems) property.\n\n| Value | Description |\n| ----- | ----------- |\n| multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |\n| none | Disables selection. Use this when you want to prevent selecting items. |\n| single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |\n| single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |","docsTags":[{"name":"see","text":"[selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#selectedItems)"},{"name":"example","text":"```js\ncatalogLayerListElement.selectionMode = \"multiple\";\n```"}],"default":"\"none\"","values":[{"type":"string","value":"multiple"},{"type":"string","value":"single"},{"type":"string","value":"none"},{"type":"string","value":"single-persist"}],"optional":true,"required":false},{"name":"showCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-close-button","reflectToAttr":false,"docs":"Indicates whether to display a close button in the header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse-button","reflectToAttr":false,"docs":"Indicates whether to display a collapse button in the header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showErrors","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-errors","reflectToAttr":false,"docs":"Indicates whether to display layers with load errors.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showFilter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-filter","reflectToAttr":false,"docs":"Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [CatalogLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#minFilterItems), allowing users to filter layers by their title.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-heading","reflectToAttr":false,"docs":"Indicates whether to display the component's heading. The heading text is \"Layer List\". The heading level can be set with the [CatalogLayerList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#headingLevel).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showTemporaryLayerIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-temporary-layer-indicators","reflectToAttr":false,"docs":"Indicates whether temporary layer indicators will be displayed for layers with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the layer title.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"CatalogLayerListState","complexType":{"original":"CatalogLayerListState","resolved":"CatalogLayerListState","references":{"CatalogLayerListState":{"location":"import","path":"@arcgis/core/widgets/CatalogLayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-catalog-layer-list component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visibilityAppearance","type":"VisibilityAppearance","complexType":{"original":"VisibilityAppearance","resolved":"VisibilityAppearance","references":{"VisibilityAppearance":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"attr":"visibility-appearance","reflectToAttr":false,"docs":"Determines the icons used to indicate visibility.\n\n| Value | Description | Example |\n| ----- | ----------- | ------- |\n| default | Displays view icons on the far side. Icons are hidden except on hover or if they have keyboard focus. See [view-visible](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-visible&library=Calcite%20UI&query=view) and [view-hide](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-hide&library=Calcite%20UI&query=view) calcite icons. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\n| checkbox | Displays checkbox icons on the near side. See [check-square-f](https://developers.arcgis.com/calcite-design-system/icons/?icon=check-square-f&library=Calcite%20UI&query=check) and [square](https://developers.arcgis.com/calcite-design-system/icons/?icon=square&library=Calcite%20UI&query=square) calcite icons. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |","docsTags":[{"name":"example","text":"```js\ncatalogLayerListElement.visibilityAppearance = \"checkbox\";\n```"}],"default":"\"default\"","values":[{"type":"string","value":"checkbox"},{"type":"string","value":"default"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisCatalogLayerList = document.createElement(\"arcgis-catalog-layer-list\");\ndocument.body.append(arcgisCatalogLayerList);\nawait arcgisCatalogLayerList.componentOnReady();\nconsole.log(\"arcgis-catalog-layer-list is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[{"name":"since","text":"4.33"}]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTriggerAction","detail":"LayerListViewModelTriggerActionEvent","bubbles":true,"complexType":{"original":"LayerListViewModelTriggerActionEvent","resolved":"LayerListViewModelTriggerActionEvent","references":{"LayerListViewModelTriggerActionEvent":{"location":"import","path":"@arcgis/core/widgets/LayerList/LayerListViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when an action is triggered on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/compass/compass.tsx","tag":"arcgis-compass","overview":"","readme":"","usage":{},"docs":"The Compass component indicates where north is in relation to the current view [rotation](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/references/core/Camera/#heading).","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-compass/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | undefined","complexType":{"original":"GoToOverride | undefined","resolved":"GoToOverride | undefined","references":{"GoToOverride":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName | undefined","complexType":{"original":"IconName | undefined","resolved":"IconName | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon displayed in the component's button.","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"orientation","type":"Axes","complexType":{"original":"Axes","resolved":"Axes","references":{"Axes":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The z axis orientation.","docsTags":[{"name":"readonly","text":""}],"default":"{ z: 0 }","values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"CompassState","complexType":{"original":"CompassState","resolved":"CompassState","references":{"CompassState":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"rotation"},{"type":"string","value":"disabled"},{"type":"string","value":"compass"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-compass component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":true,"docs":"Specifies the size of the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisCompass = document.createElement(\"arcgis-compass\");\ndocument.body.append(arcgisCompass);\nawait arcgisCompass.componentOnReady();\nconsole.log(\"arcgis-compass is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"reset","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"reset(): Promise","parameters":[],"docs":"","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\" | \"orientation\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\" | \"orientation\"; }","resolved":"{ name: \"state\" | \"orientation\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/coordinate-conversion/coordinate-conversion.tsx","tag":"arcgis-coordinate-conversion","overview":"","readme":"","usage":{},"docs":"> [!NOTE]\n> In version 6.0, the implementation of [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) will be updated under the hood to that of [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) , and deprecated properties on this component will be removed. We encourage using the [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) component and providing feedback.\n\nThe Coordinate Conversion component provides a way to display user cursor position either as map coordinates or\nas any of several popular coordinate notations. Additionally, the component provides a way to convert\nuser input coordinates into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\n\n\nSeveral common formats are included by default:\n* XY - Longitude, Latitude (WGS84)\n* MGRS - [Military Grid Reference System](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#mgrs)\n* UTM - [Universal Transverse Mercator](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#utm)\n* DD - Decimal Degrees\n* DDM - Degrees Decimal Minutes\n* DMS - Degrees Minutes Seconds\n* Basemap - X, Y in the coordinate system used by the current basemap in the units used by the basemap.\nWeb Mercator is the standard for Esri-provided basemaps.\n\nAdditional formats can be created by a developer and made available\nthrough the component","docsTags":[{"name":"example","text":"```html\n\n \n\n```"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"conversions","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/CoordinateConversion/support/Conversion.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of conversions\nthat the component is currently displaying. Each row in the component displaying a coordinate is a conversion.","docsTags":[{"name":"example","text":"Conversions can be set with an array of strings where each string is a format's name.\n```js\ncoordinateConversionComponent.conversions = [\"mgrs\"];\n```"},{"name":"since","text":"4.7"}],"values":[],"optional":true,"required":false},{"name":"currentLocation","type":"Point | null | undefined","complexType":{"original":"Point | null | undefined","resolved":"Point | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Describes the location of the coordinates currently displayed by the component as a [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\nSetting this property will update all conversions.","docsTags":[{"name":"example","text":"Set the current location.\n```js\ncoordinateConversionComponent.currentLocation = { x: 77.0369, y: 38.9072, spatialReference: { wkid: 4326 } };\n```"},{"name":"since","text":"4.7"}],"values":[],"optional":true,"required":false},{"name":"expanded","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"expanded","reflectToAttr":true,"docs":"Describes whether the component is expanded or not. If `true`, the component is expanded and all conversions are visible.","docsTags":[{"name":"example","text":"Expand the component.\n```js\ncoordinateConversionComponent.expanded = true;\n```"}],"default":"false","deprecation":"since 5.1. The expand/collapse functionality will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"formats","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/CoordinateConversion/support/Format.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) containing every coordinate format\nthat the component is capable of displaying.\n\nThe default formats are `basemap`, `dd`, `ddm`, `dms`, `mgrs`, `usng`, `utm`, and `xy`.","docsTags":[{"name":"example","text":"Only show the \"xy\" format.\n```js\nconst coordinateConversionComponent = document.getElementsByTagName(\"arcgis-coordinate-conversion\")[0];\nconst toRemove = coordinateConversionComponent.formats.filter(format => format.name !== \"xy\");\ncoordinateConversionComponent.formats.removeMany(toRemove);\n```"},{"name":"example","text":"Show every format except \"xy\".\n```js\nconst coordinateConversionComponent = document.getElementsByTagName(\"arcgis-coordinate-conversion\")[0];\nconst toRemove = coordinateConversionComponent.formats.filter(format => format.name === \"xy\");\ncoordinateConversionComponent.formats.removeMany(toRemove);\n```"}],"values":[],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | null | undefined","complexType":{"original":"GoToOverride | null | undefined","resolved":"GoToOverride | null | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the coordinate input and coordinate settings headings. By default,\nthese headings are rendered as level 4 headings (e.g. `

Input coordinate

`). Depending on the coordinate conversion component's\nplacement in your app, you may need to adjust this heading for proper semantics. This is important for meeting\naccessibility standards.","docsTags":[],"default":"4","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideCaptureButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-capture-button","reflectToAttr":true,"docs":"Determines whether the capture button will be shown in the component. If `true`, the capture button will be hidden.","docsTags":[{"name":"example","text":"Hide the capture button.\n```html\n\n \n\n```"}],"default":"false","deprecation":"since 5.1. The capture button will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideExpandButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-expand-button","reflectToAttr":true,"docs":"Determines whether the expand button will be shown in the component. If `true`, the expand button will be hidden.","docsTags":[{"name":"example","text":"Hide the expand button.\n```html\n\n \n\n```"}],"default":"false","deprecation":"since 5.1. The expand/collapse functionality will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideInputButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-input-button","reflectToAttr":true,"docs":"Determines whether the input coordinate button will be shown in the component. If `true`, the input button will be hidden.","docsTags":[{"name":"example","text":"Hide the input button.\n```html\n\n \n\n```"}],"default":"false","deprecation":"since 5.1. The input button will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSettingsButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-settings-button","reflectToAttr":true,"docs":"Determines whether the settings button will be shown in the component. If `true`, the settings button will be hidden.","docsTags":[{"name":"example","text":"Hide the settings button.\n```html\n\n \n\n```"}],"default":"false","deprecation":"since 5.1. The settings button will be removed as part of migration to [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/).","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.","docsTags":[],"default":"\"coordinate-system\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"ignoreCoordinatePrecision","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"ignore-coordinate-precision","reflectToAttr":false,"docs":"If false, the component will estimate coordinate precision based on the current state of the\nview. As the view is zoomed farther out, fewer decimal places will be shown. Only affects `DD`,\n`DDM`, `DMS`, and `XY` formats.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"default":"\"Coordinate conversion\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"locationSymbol","type":"PictureMarkerSymbol | SimpleMarkerSymbol | CIMSymbol | PointSymbol3D","complexType":{"original":"PictureMarkerSymbol | SimpleMarkerSymbol | CIMSymbol | PointSymbol3D","resolved":"PictureMarkerSymbol | SimpleMarkerSymbol | CIMSymbol | PointSymbol3D","references":{"default":{"location":"import","path":"@arcgis/core/symbols/PointSymbol3D.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This symbol is used to visualize the location currently described by the component when `capture` mode\nis active.\n\nThis property should be set to a point symbol, typically a [Simple Marker Symbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleMarkerSymbol/).","docsTags":[{"name":"example","text":"Set the location symbol to be an 'x'.\n```js\nconst coordinateConversionComponent = document.getElementsByTagName(\"arcgis-coordinate-conversion\")[0];\ncoordinateConversionComponent.locationSymbol = { type: \"simple-marker\", style: \"x\" };\n```"}],"values":[],"optional":true,"required":false},{"name":"mode","type":"Mode","complexType":{"original":"Mode","resolved":"Mode","references":{"Mode":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"attr":"mode","reflectToAttr":true,"docs":"Describes the current mode of the component.\n\n* While in `live` mode, the component will update as the cursor moves.\n* While in `capture` mode, the component will update on mouse click and display a graphic\nmarking the current location.","docsTags":[{"name":"example","text":"Programmatically set the component to capture mode.\n```js\nconst coordinateConversionComponent = document.getElementsByTagName(\"arcgis-coordinate-conversion\")[0];\ncoordinateConversionComponent.mode = \"capture\";\n```"}],"default":"\"live\"","values":[{"type":"string","value":"capture"},{"type":"string","value":"live"},{"type":"string","value":"idle"}],"optional":true,"required":false},{"name":"multipleConversionsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"multiple-conversions-disabled","reflectToAttr":true,"docs":"If this property is set to `true`, multiple conversions will be disabled, and only a single conversion will be displayed. Otherwise, multiple conversions will be shown.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"orientation","type":"Orientation","complexType":{"original":"Orientation","resolved":"Orientation","references":{"Orientation":{"location":"local","path":"components/arcgis-coordinate-conversion/types","id":"notImplemented"}}},"mutable":true,"attr":"orientation","reflectToAttr":true,"docs":"Determines whether the component should expand up or down. If set to `auto`,\nthe component will be oriented based on its position in the view.","docsTags":[],"default":"\"auto\"","values":[{"type":"string","value":"auto"},{"type":"string","value":"expand-down"},{"type":"string","value":"expand-up"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"removeLeadingZeros","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"remove-leading-zeros","reflectToAttr":true,"docs":"Determines whether leading zeros will be shown in `DD`, `DDM`, and `DMS` formats.\nWhen false: 01.37°N, 008.71°E\nWhen true: 1.37°N, 8.71°E","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"CoordinateConversionViewModelState","complexType":{"original":"CoordinateConversionViewModelState","resolved":"CoordinateConversionViewModelState","references":{"CoordinateConversionViewModelState":{"location":"import","path":"@arcgis/core/widgets/CoordinateConversion/CoordinateConversionViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"storageDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"storage-disabled","reflectToAttr":true,"docs":"If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/references/core/widgets/CoordinateConversion/#storageType))\nwill not be used to hydrate and persist the component's state.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"storageType","type":"StorageType","complexType":{"original":"StorageType","resolved":"StorageType","references":{"StorageType":{"location":"local","path":"components/arcgis-coordinate-conversion/types","id":"notImplemented"}}},"mutable":true,"attr":"storage-type","reflectToAttr":false,"docs":"This property determines whether sessionStorage or localStorage will be used to store component's state.","docsTags":[{"name":"see","text":"[Window.sessionStorage](https://developer.mozilla.org/docs/Web/API/Window/sessionStorage)"},{"name":"see","text":"[Window.localStorage](https://developer.mozilla.org/docs/Web/API/Window/localStorage)"},{"name":"since","text":"4.23"}],"default":"\"session\"","values":[{"type":"string","value":"local"},{"type":"string","value":"session"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-coordinate-conversion component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisCoordinateConversion = document.createElement(\"arcgis-coordinate-conversion\");\ndocument.body.append(arcgisCoordinateConversion);\nawait arcgisCoordinateConversion.componentOnReady();\nconsole.log(\"arcgis-coordinate-conversion is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"reverseConvert","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(coordinate: string, format: Format): Promise","parameters":[{"name":"coordinate","type":"string","docs":"The coordinate string."},{"name":"format","type":"Format","docs":"Specifies the format of the input coordinate."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/CoordinateConversion/support/Format.js","id":"notImplemented"}}},"signature":"reverseConvert(coordinate: string, format: Format): Promise","parameters":[{"name":"coordinate","type":"string","docs":"The coordinate string."},{"name":"format","type":"Format","docs":"Specifies the format of the input coordinate."}],"docs":"Attempt to convert a string into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/). The format of the\nstring must be specified. A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of available formats can be\nobtained from the [formats](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/#formats) property.","docsTags":[]}],"events":[{"event":"arcgisConversionChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when a conversion is added or removed, or when the order of conversions changes.","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisPropertyChange","detail":"{ name: \"currentLocation\" | \"state\" | \"expanded\" | \"mode\"; }","bubbles":true,"complexType":{"original":"{ name: \"currentLocation\" | \"state\" | \"expanded\" | \"mode\"; }","resolved":"{ name: \"currentLocation\" | \"state\" | \"expanded\" | \"mode\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/coordinate-conversion-next/coordinate-conversion-next.tsx","tag":"arcgis-coordinate-conversion-next","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n> The Coordinate Conversion (next) component is the successor to the [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) component, provided to you for early testing and feedback.\n> It provides a more consistent design and improved user experience.\n> In version 6.0, the implementation of [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) will be updated under the hood to that of [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) and this component will be removed.\n> To update at version 6.0, simply remove `-next` from the component name.\n\nThe Coordinate Conversion component provides a way to display user cursor position either as map coordinates or\nas any of several popular coordinate notations. Additionally, the component provides a way to convert\nuser input coordinates into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\n\n\nSeveral common formats are included by default:\n* XY - Longitude, Latitude (WGS84)\n* MGRS - [Military Grid Reference System](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#mgrs)\n* UTM - [Universal Transverse Mercator](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#utm)\n* DD - Decimal Degrees\n* DDM - Degrees Decimal Minutes\n* DMS - Degrees Minutes Seconds\n* Basemap - X, Y in the coordinate system used by the current basemap in the units used by the basemap.\nWeb Mercator is the standard for Esri-provided basemaps.\n\nAdditional formats can be created by a developer and made available\nthrough the component","docsTags":[{"name":"beta"},{"name":"since","text":"5.1"},{"name":"example","text":"```html\n\n \n\n```"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"conversions","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/CoordinateConversion/support/Conversion.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of conversions\nthat the component is currently displaying. Each row in the component displaying a coordinate is a conversion.","docsTags":[{"name":"example","text":"Conversions can be set with an array of strings where each string is a format's name.\n```js\ncoordinateConversionComponent.conversions = [\"mgrs\"];\n```"},{"name":"since","text":"4.7"}],"values":[],"optional":true,"required":false},{"name":"currentLocation","type":"Point | null | undefined","complexType":{"original":"Point | null | undefined","resolved":"Point | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Describes the location of the coordinates currently displayed by the component as a [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\nSetting this property will update all conversions.","docsTags":[{"name":"example","text":"Set the current location.\n```js\ncoordinateConversionComponent.currentLocation = { x: 77.0369, y: 38.9072, spatialReference: { wkid: 4326 } };\n```"},{"name":"since","text":"4.7"}],"values":[],"optional":true,"required":false},{"name":"formats","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/CoordinateConversion/support/Format.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) containing every coordinate format\nthat the component is capable of displaying.\n\nThe default formats are `basemap`, `dd`, `ddm`, `dms`, `mgrs`, `usng`, `utm`, and `xy`.","docsTags":[{"name":"example","text":"Only show the \"xy\" format.\n```js\nconst coordinateConversionComponent = document.getElementsByTagName(\"arcgis-coordinate-conversion\")[0];\nconst toRemove = coordinateConversionComponent.formats.filter(format => format.name !== \"xy\");\ncoordinateConversionComponent.formats.removeMany(toRemove);\n```"},{"name":"example","text":"Show every format except \"xy\".\n```js\nconst coordinateConversionComponent = document.getElementsByTagName(\"arcgis-coordinate-conversion\")[0];\nconst toRemove = coordinateConversionComponent.formats.filter(format => format.name === \"xy\");\ncoordinateConversionComponent.formats.removeMany(toRemove);\n```"}],"values":[],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | null | undefined","complexType":{"original":"GoToOverride | null | undefined","resolved":"GoToOverride | null | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the coordinate input and coordinate settings headings. By default,\nthese headings are rendered as level 4 headings (e.g. `

Input coordinate

`). Depending on the coordinate conversion component's\nplacement in your app, you may need to adjust this heading for proper semantics. This is important for meeting\naccessibility standards.","docsTags":[],"default":"4","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideCaptureSection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-capture-section","reflectToAttr":true,"docs":"Determines whether the capture section will be shown in the component. If `true`, the capture section will be hidden.","docsTags":[{"name":"since","text":"5.1"},{"name":"example","text":"Hide the capture section.\n```html\n\n \n\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideInputSection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-input-section","reflectToAttr":true,"docs":"Determines whether the input section will be shown in the component. If `true`, the input section will be hidden.","docsTags":[{"name":"since","text":"5.1"},{"name":"example","text":"Hide the input section.\n```html\n\n \n\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSettingsButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-settings-button","reflectToAttr":true,"docs":"Determines whether the settings button will be shown in the component. If `true`, the settings button will be hidden.","docsTags":[{"name":"example","text":"Hide the settings button.\n```html\n\n \n\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.","docsTags":[],"default":"\"coordinate-system\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"ignoreCoordinatePrecision","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"ignore-coordinate-precision","reflectToAttr":false,"docs":"If false, the component will estimate coordinate precision based on the current state of the\nview. As the view is zoomed farther out, fewer decimal places will be shown. Only affects `DD`,\n`DDM`, `DMS`, and `XY` formats.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"default":"\"Coordinate conversion\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"locationSymbol","type":"PictureMarkerSymbol | SimpleMarkerSymbol | CIMSymbol | PointSymbol3D","complexType":{"original":"PictureMarkerSymbol | SimpleMarkerSymbol | CIMSymbol | PointSymbol3D","resolved":"PictureMarkerSymbol | SimpleMarkerSymbol | CIMSymbol | PointSymbol3D","references":{"default":{"location":"import","path":"@arcgis/core/symbols/PointSymbol3D.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This symbol is used to visualize the location currently described by the component when `capture` mode\nis active.\n\nThis property should be set to a point symbol, typically a [Simple Marker Symbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleMarkerSymbol/).","docsTags":[{"name":"example","text":"Set the location symbol to be an 'x'.\n```js\nconst coordinateConversionComponent = document.getElementsByTagName(\"arcgis-coordinate-conversion\")[0];\ncoordinateConversionComponent.locationSymbol = { type: \"simple-marker\", style: \"x\" };\n```"}],"values":[],"optional":true,"required":false},{"name":"mode","type":"Mode","complexType":{"original":"Mode","resolved":"Mode","references":{"Mode":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"attr":"mode","reflectToAttr":true,"docs":"Describes the current mode of the component.\n\n* While in `live` mode, the component will update as the cursor moves.\n* While in `capture` mode, the component will update on mouse click and display a graphic\nmarking the current location.\n* While in `idle` mode, the component will not update based on cursor movement or mouse clicks.\nThis mode can be used to \"pause\" the component without losing the current location.","docsTags":[{"name":"example","text":"Programmatically set the component to idle mode.\n```js\nconst coordinateConversionComponent = document.getElementsByTagName(\"arcgis-coordinate-conversion\")[0];\ncoordinateConversionComponent.mode = \"idle\";\n```"}],"default":"\"live\"","values":[{"type":"string","value":"capture"},{"type":"string","value":"live"},{"type":"string","value":"idle"}],"optional":true,"required":false},{"name":"multipleConversionsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"multiple-conversions-disabled","reflectToAttr":true,"docs":"If this property is set to `true`, multiple conversions will be disabled, and only a single conversion will be displayed. Otherwise, multiple conversions will be shown.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"removeLeadingZeros","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"remove-leading-zeros","reflectToAttr":true,"docs":"Determines whether leading zeros will be shown in `DD`, `DDM`, and `DMS` formats.\nWhen false: 01.37°N, 008.71°E\nWhen true: 1.37°N, 8.71°E","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showElevation","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-elevation","reflectToAttr":true,"docs":"Determines whether the elevation of the current location will be shown. Only applicable when the view is a SceneView.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"CoordinateConversionViewModelState","complexType":{"original":"CoordinateConversionViewModelState","resolved":"CoordinateConversionViewModelState","references":{"CoordinateConversionViewModelState":{"location":"import","path":"@arcgis/core/widgets/CoordinateConversion/CoordinateConversionViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"storageDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"storage-disabled","reflectToAttr":true,"docs":"If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/references/core/widgets/CoordinateConversion/#storageType))\nwill not be used to hydrate and persist the component's state.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"storageType","type":"StorageType","complexType":{"original":"StorageType","resolved":"StorageType","references":{"StorageType":{"location":"local","path":"components/arcgis-coordinate-conversion-next/types","id":"notImplemented"}}},"mutable":true,"attr":"storage-type","reflectToAttr":false,"docs":"This property determines whether sessionStorage or localStorage will be used to store component's state.","docsTags":[{"name":"see","text":"[Window.sessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)"},{"name":"see","text":"[Window.localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)"},{"name":"since","text":"4.23"}],"default":"\"session\"","values":[{"type":"string","value":"local"},{"type":"string","value":"session"}],"optional":true,"required":false},{"name":"verticalUnit","type":"LengthUnit","complexType":{"original":"LengthUnit","resolved":"LengthUnit","references":{"LengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"vertical-unit","reflectToAttr":false,"docs":"Indicates the vertical unit to use when displaying elevation.","docsTags":[{"name":"since","text":"5.1"},{"name":"see","text":"[LengthUnit](https://developers.arcgis.com/javascript/latest/references/core/core/units/#LengthUnit)"}],"default":"\"meters\"","values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-coordinate-conversion-next component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Panel[\"scale\"]","complexType":{"original":"Panel[\"scale\"]","resolved":"Panel[\"scale\"]","references":{"Panel":{"location":"import","path":"@esri/calcite-components/components/calcite-panel","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Determines the component's scale. Options are small (\"s\"), medium (\"m\"), and large (\"l\").","docsTags":[{"name":"since","text":"5.1"}],"default":"\"s\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisCoordinateConversionNext = document.createElement(\"arcgis-coordinate-conversion-next\");\ndocument.body.append(arcgisCoordinateConversionNext);\nawait arcgisCoordinateConversionNext.componentOnReady();\nconsole.log(\"arcgis-coordinate-conversion-next is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"reverseConvert","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(coordinate: string, format: Format): Promise","parameters":[{"name":"coordinate","type":"string","docs":"The coordinate string."},{"name":"format","type":"Format","docs":"Specifies the format of the input coordinate."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/CoordinateConversion/support/Format.js","id":"notImplemented"}}},"signature":"reverseConvert(coordinate: string, format: Format): Promise","parameters":[{"name":"coordinate","type":"string","docs":"The coordinate string."},{"name":"format","type":"Format","docs":"Specifies the format of the input coordinate."}],"docs":"Attempt to convert a string into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/). The format of the\nstring must be specified. A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of available formats can be\nobtained from the [arcgis-coordinate-conversion.formats](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/#formats) property.","docsTags":[]}],"events":[{"event":"arcgisConversionChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when a conversion is added or removed, or when the order of conversions changes.","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisPropertyChange","detail":"{ name: \"currentLocation\" | \"state\" | \"mode\" | \"verticalUnit\"; }","bubbles":true,"complexType":{"original":"{ name: \"currentLocation\" | \"state\" | \"mode\" | \"verticalUnit\"; }","resolved":"{ name: \"currentLocation\" | \"state\" | \"mode\" | \"verticalUnit\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/daylight/daylight.tsx","tag":"arcgis-daylight","overview":"","readme":"","usage":{},"docs":"The Daylight component can be used to manipulate the lighting conditions of an\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\nTo achieve this, the component modifies the `lighting` property of the\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) of the Scene component.\n\nTo illuminate the scene, one can either use a configuration of date and time to position the\n[sun](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/) or switch to the\n[virtual](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/) mode,\nwhere the light source is relative to the camera.\n\nWhen illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/)**\nand adjusting the time and date, the positions of the sun and stars are updated accordingly. This also updates the\n[date](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/#date) property of\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment).\n\n[![daylight-default](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-default.avif)](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n\nThe component has an option to select the timezone. When the user makes any adjustments here, a new time\nin the chosen timezone is calculated and displayed in the slider. The timezone selector can be disabled\nby using the [hideTimezone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#hideTimezone) property.\n\nBy default, a calendar is displayed to select the day, month, and year.\nWith the [dateOrSeason](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#dateOrSeason) property, the calendar can be replaced with\na dropdown menu where a season can be selected instead:\n\n![daylight-seasons](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-seasons.avif)\n\nThere are two play buttons: one corresponds to the time-of-day slider and animates the lighting\nover the course of a day, while the other corresponds to the date picker\nand animates the lighting over the course of a year (month by month). The speed of the time-of-day animation can\nbe set using the [playSpeedMultiplier](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#playSpeedMultiplier) property.\n\n\n\nExcept for the daytime slider, all the elements in the Daylight component can be hidden:\n\n![daylight-no-elements](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-no-elements.avif)\n\nWhenever the sun position option is unchecked, the scene applies the\n**[virtual light](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/)** source relative to the camera.\nWith this, the component's time slider, timezone, and date picker get automatically disabled:\n\n![daylight-virtual](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-virtual.avif)\n\n**Things to consider**\n\n* Daylight is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n* The Daylight component uses UTC time and does not account for the daylight savings times in different countries and regions of the world.\n* When using the [virtual light](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/),\nsetting the time and date programmatically does not have an influence on the lighting conditions of the scene.\n* When using the [sunlight](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/),\nthe time slider and time zone automatically react to the changes of the camera (e.g., position, rotation, pan, zoom) because the position of the simulated sun\nis updated to maintain a consistent solar time of day based on the camera's current longitude. This can be adjusted using the\n[cameraTrackingEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/#cameraTrackingEnabled)\nproperty on [arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment).","docsTags":[{"name":"see","text":"[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment)"},{"name":"see","text":"[SunLighting](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/)"},{"name":"see","text":"[VirtualLighting](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/)"},{"name":"see","text":"[Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)"},{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"currentSeason","type":"Season","complexType":{"original":"Season","resolved":"Season","references":{"Season":{"location":"local","path":"components/arcgis-daylight/types","id":"notImplemented"}}},"mutable":true,"attr":"current-season","reflectToAttr":false,"docs":"Sets the season that is used when the component displays the season picker.\nEach season uses a fixed date corresponding to the seasonal equinoxes and solstices.","docsTags":[{"name":"see","text":"[dateOrSeason](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#dateOrSeason)"}],"values":[{"type":"string","value":"fall"},{"type":"string","value":"spring"},{"type":"string","value":"summer"},{"type":"string","value":"winter"}],"optional":true,"required":false},{"name":"dateOrSeason","type":"\"date\" | \"season\"","complexType":{"original":"\"date\" | \"season\"","resolved":"\"date\" | \"season\"","references":{}},"mutable":true,"attr":"date-or-season","reflectToAttr":true,"docs":"Controls whether the component displays a date or a season picker. When the date picker is set, the user selects the date from a calendar. The season picker allows the user to choose a season from a drop-down list. Each season uses a fixed month and day corresponding to the equinoxes and solstices in the current local date's year.","docsTags":[],"default":"\"date\"","values":[{"type":"string","value":"date"},{"type":"string","value":"season"}],"optional":true,"required":false},{"name":"dayPlaying","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"day-playing","reflectToAttr":false,"docs":"Starts or pauses the daytime animation cycling through the minutes of the day.\nSet the property to `true` to start the animation and to `false` to pause it.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the component title.","docsTags":[],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideDatePicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-date-picker","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-header","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePlayButtons","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-play-buttons","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideShadowsToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-shadows-toggle","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSunLightingToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-sun-lighting-toggle","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTimezone","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-timezone","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"brightness\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"localDate","type":"Date | number | string","complexType":{"original":"Date | number | string","resolved":"Date | number | string","references":{"Date":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"attr":"local-date","reflectToAttr":false,"docs":"The calendar date in the timezone given by [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#utcOffset).","docsTags":[{"name":"example","text":"```js\ndaylight.localDate = new Date(\"2005-08-25\");\n```"},{"name":"example","text":"```js\n// Alternatively, the date can be set by configuring the `date` property of `SunLighting`.\nviewElement.environment.lighting = new SunLighting({\n date: new Date(\"2005-08-25T16:00:00\")\n});\n```"},{"name":"since","text":"4.34"}],"values":[{"type":"string"},{"type":"number"},{"type":"object"}],"optional":true,"required":false},{"name":"localDateAsString","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"playSpeedMultiplier","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"play-speed-multiplier","reflectToAttr":false,"docs":"Controls the daytime animation speed.","docsTags":[{"name":"example","text":"```js\n// Plays the daylight animation at half of the default speed\ndaylight.playSpeedMultiplier = 0.5;\n```"}],"default":"1.0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"timeSliderPosition","type":"number | null | undefined","complexType":{"original":"number | null | undefined","resolved":"number | null | undefined","references":{}},"mutable":true,"attr":"time-slider-position","reflectToAttr":false,"docs":"Slider position for the time of day in the timezone\ngiven by [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440.","docsTags":[{"name":"example","text":"```js\n// Set the time to 4:00 PM (16:00) in the given timezone.\ndaylight.timeSliderPosition = 16 * 60;\n```"},{"name":"example","text":"```js\n// Alternatively, the time can be set by configuring the `date` property of `SunLighting`.\n// Then, the time slider gets updated automatically.\nviewElement.environment.lighting = new SunLighting({\n date: new Date(\"2005-08-25T16:00:00\")\n});\n```"},{"name":"since","text":"4.34"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"timeSliderSteps","type":"number[] | number","complexType":{"original":"number[] | number","resolved":"number[] | number","references":{}},"mutable":true,"attr":"time-slider-steps","reflectToAttr":false,"docs":"Sets the interval, in minutes, with which the time slider increments or decrements as it is dragged or changed via the keyboard.","docsTags":[{"name":"example","text":"```js\n// Set steps at an interval of 60. Then, the slider thumb snaps at each hour of the day.\ndaylight.timeSliderSteps = 60;\n```"}],"default":"5","values":[{"type":"number"},{"type":"object"}],"optional":true,"required":false},{"name":"utcOffset","type":"number | null | undefined","complexType":{"original":"number | null | undefined","resolved":"number | null | undefined","references":{}},"mutable":true,"attr":"utc-offset","reflectToAttr":false,"docs":"The difference in hours between UTC time and the time displayed in the component.","docsTags":[{"name":"example","text":"```js\ndaylight.utcOffset = -8;\n```"},{"name":"example","text":"```js\n// Alternatively, the UTC offset can be set by configuring the `displayUTCOffset` property of `SunLighting`.\nviewElement.environment.lighting = new SunLighting({\n displayUTCOffset: -8\n});\n```"},{"name":"since","text":"4.34"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-daylight component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"yearPlaying","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"year-playing","reflectToAttr":false,"docs":"Starts or pauses the date animation cycling through the months of the year.\nSet the property to `true` to start the animation and to `false` to pause it.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisDaylight = document.createElement(\"arcgis-daylight\");\ndocument.body.append(arcgisDaylight);\nawait arcgisDaylight.componentOnReady();\nconsole.log(\"arcgis-daylight is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisUserDateTimeChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.","docsTags":[{"name":"since","text":"4.33"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/directional-pad/directional-pad.tsx","tag":"arcgis-directional-pad","overview":"","readme":"","usage":{},"docs":"A directional pad (D-Pad) component can be used to control the position and\nrotation of the map. The D-Pad provides eight directions of movement, a small\ncompass which indicates the current orientation of the map and a slider for\nrotating the map.\n\nIt is also possible to disable the map's rotation controls or change the size\nof the component.\n\nThe Directional Pad component is not supported in 3D.","docsTags":[{"name":"since","text":"4.29"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directional-pad/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDirectionalButtons","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-directional-buttons","reflectToAttr":false,"docs":"Whether to hide directional pad buttons.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"move\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"showRotationResetButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-rotation-reset-button","reflectToAttr":false,"docs":"Whether to display the button to reset the rotation angle. This only takes\neffect if showRotationSlider is true.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showRotationSlider","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-rotation-slider","reflectToAttr":false,"docs":"Whether to display the map rotation slider.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"DirectionalPadViewModelState","complexType":{"original":"DirectionalPadViewModelState","resolved":"DirectionalPadViewModelState","references":{"DirectionalPadViewModelState":{"location":"import","path":"@arcgis/core/widgets/DirectionalPad/DirectionalPadViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"moving"}],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-directional-pad component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Determines the size of directional pad buttons and the slider.\n\nIn addition to this parameter, you can set the width on the component\ncontainer to dictate directional pad size.","docsTags":[],"default":"\"s\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisDirectionalPad = document.createElement(\"arcgis-directional-pad\");\ndocument.body.append(arcgisDirectionalPad);\nawait arcgisDirectionalPad.componentOnReady();\nconsole.log(\"arcgis-directional-pad is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/directions/directions.tsx","tag":"arcgis-directions","overview":"","readme":"","usage":{},"docs":"The Directions component provides a way to calculate directions, between two or more input locations with a [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/), using ArcGIS Online and custom Network Analysis Route services.\nThis component generates a route finding a least-cost path between multiple points using the routing service associated with the assigned RouteLayer. The route is calculated based on the stops and barriers added to the RouteLayer. The component provides a user interface for adding, removing, and reordering stops and barriers. Once the route is solved, the component displays the route on the map and provides turn-by-turn directions in a list format.\n\nDirections uses the [Search component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/) to locate each stop, either by selecting a point on the map, or by entering a search term into the textbox.\nSearch uses settings defined in the `Search properties`. This includes the `locationType`, which defines the type of geocoding result that is returned, and defaults to \"street\".\n\nDirections requires a RouteLayer to be associated with the `layer` property or using the `useDefaultRouteLayer` property. A RouteLayer can be programmatically created or derived from an external source like a portal item or webmap.\nPlease note that in order to view or interact with routing inputs and results, the RouteLayer must be added to the map. Routing service and symbology is configured in the layer, specifically the `url` and `defaultSymbols` properties respectively.\n\nThe ArcGIS Online routing service requires authentication. If an API key is specified at the app level (see [Config#apiKey](https://developers.arcgis.com/javascript/latest/references/core/config/#Config-apiKey)) or component level (see [apiKey](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#apiKey))) then this key will accompany requests to both the routing service and geocoder/reverse-geocoder.\nPlease refer to the Search component for more information on geocoding.\n\nLocations on the map can be reverse geocoded and used as stops in the route. Click the button with a crosshairs icon to associate a location with a new or existing stop. After clicking the button, click the map once. To cancel this process, press the `escape` key.\nThe resulting driving directions are automatically collapsed and can be optionally saved to a new or existing portal item. This can be achieved programically with `save` and `saveAs`. The `Clear` button calls the `reset()` method, which removes all stops, directions, and the solved route.\n\nSelecting the `Edit route` button allows you to add/move/remove stops, add/move/remove/reshape polyline barriers, and add/move/remove waypoints. To add a new waypoint, first hover the cursor over the route and select the desired point. Then select and drag the point to move and place the waypoint. By default the route will be automatically resolve at the completion of any editing operation. For more complex routes, it may be advantageous to disable auto-solving and solve as and when needed with the dedicated solve button. Currently, this is only supported in 2D MapViews.\n\n**Note:** Printing in Directions is in beta and considered experimental. The print preview dialog, in some scenarios, may not display as aniticipated.","docsTags":[{"name":"see","text":"[Sample - Directions component with RouteLayer](https://developers.arcgis.com/javascript/latest/sample-code/directions-routelayer/)"},{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"apiKey","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"api-key","reflectToAttr":false,"docs":"An authorization string used to access a resource or service.\n[API keys](https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/) are generated\nand managed in the portal. An API key is tied\nexplicitly to an ArcGIS account; it is also used to monitor service usage.\nSetting a fine-grained API key on a specific class overrides the [global API key](https://developers.arcgis.com/javascript/latest/references/core/config/#ConfigWithApiKey).\n\nBy default, the following URLs will be used (unless overwritten in the app, or if using different defaults from a portal):\n\nGeocoding URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`\n\nRouting URL: `https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World`","docsTags":[{"name":"since","text":"4.19"},{"name":"example","text":"// Add the Directions component to the top right corner of the view component\n\n \n"}],"values":[{"type":"string"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"autoSolveOnEditActive","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-solve-on-edit-active","reflectToAttr":false,"docs":"When `true`, the route will re-solve continuously as an interactive operation is ongoing (e.g., while dragging a stop or waypoint).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | null | undefined","complexType":{"original":"GoToOverride | null | undefined","resolved":"GoToOverride | null | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the origin and destination addresses (i.e. \"380 New York Street\").\nBy default, this is rendered\nas a level 2 heading (e.g. `

380 New York Street

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[{"name":"since","text":"4.20"},{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"example","text":"// address text will render as an

\ndirections.headingLevel = 3;"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideLayerDetails","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-layer-details","reflectToAttr":false,"docs":"Indicates whether to a link to the route layer portal-item (if any) will be displayed","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePrintButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-print-button","reflectToAttr":false,"docs":"Indicates whether to the Print button will be displayed","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSaveAsButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-save-as-button","reflectToAttr":false,"docs":"Indicates whether to the Save As button will be displayed","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSaveButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-save-button","reflectToAttr":false,"docs":"Indicates whether to the Save button will be displayed","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"right\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.7"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"lastRoute","type":"RouteLayerSolveResult | null | undefined","complexType":{"original":"RouteLayerSolveResult | null | undefined","resolved":"RouteLayerSolveResult | null | undefined","references":{"RouteLayerSolveResult":{"location":"import","path":"@arcgis/core/layers/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The most recent route result. Returns a [RouteLayerSolveResult](https://developers.arcgis.com/javascript/latest/references/core/layers/types/#RouteLayerSolveResult)\nobject containing properties for barriers (if any), stops, and directions.","docsTags":[{"name":"see","text":"[RouteLayer#solve()](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/#solve)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"layer","type":"RouteLayer | null | undefined","complexType":{"original":"RouteLayer | null | undefined","resolved":"RouteLayer | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/RouteLayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/) associated with the Directions component.\nA RouteLayer must be associated with the component in order to solve routes and display results on the map.\n\nThe RouteLayer can be set directly via the `layer` property, or indirectly by setting either the [mapLayerId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#mapLayerId) or [routeLayerItemId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#routeLayerItemId) properties.\nIf using the latter, the component will attempt to find and use a layer matching the provided ID from the map or portal item.\nIf no layer is found and [useDefaultRouteLayer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#useDefaultRouteLayer) is not set to `true`, then no RouteLayer will be associated and routing functionality will be unavailable.\nThe RouteLayer contains stops and barriers and will be used to display and solve routes.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `routeLayerItemId` independently; only one should be set at a time.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"mapLayerId","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"map-layer-id","reflectToAttr":false,"docs":"The layer ID of a route layer in the associated map.\nWhen set, the component will attempt to find and use the layer with the provided ID from the map.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `routeLayerItemId` independently; only one should be set at a time.","docsTags":[{"name":"since","text":"5.1"},{"name":"example","text":"```html\n\n \n\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"maxStops","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-stops","reflectToAttr":false,"docs":"The maximum number of stops allowed for routing.","docsTags":[],"default":"50","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"routeLayerItemId","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"route-layer-item-id","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"searchProperties","type":"SearchProperties | null | undefined","complexType":{"original":"SearchProperties | null | undefined","resolved":"SearchProperties | null | undefined","references":{"SearchProperties":{"location":"import","path":"@arcgis/core/widgets/Search.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Controls the default properties used when searching.\nNote that the default `searchProperties` differ slightly from\nthe [Search component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/).","docsTags":[],"default":"{ popupEnabled: false, resultGraphicEnabled: false }","values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/Directions/DirectionsViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"error"},{"type":"string","value":"initializing"},{"type":"string","value":"routing"},{"type":"string","value":"unauthenticated"}],"optional":true,"required":false},{"name":"unit","type":"SystemOrLengthUnit","complexType":{"original":"SystemOrLengthUnit","resolved":"SystemOrLengthUnit","references":{"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the distance values.\nIf not set, the component will attempt to pick \"imperial\" or \"metric\" based on the user's portal settings.\n\nThis property will affect the summary distance as well as distance for each turn-by-turn maneuver.","docsTags":[{"name":"since","text":"4.25"},{"name":"example","text":"// Display distances in nautical miles.\nconst directions = new Directions({\n unit: \"nautical-miles\",\n layer: routeLayer,\n view: view\n});"}],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"metric"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"},{"type":"string","value":"imperial"}],"optional":true,"required":false},{"name":"useDefaultRouteLayer","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"use-default-route-layer","reflectToAttr":false,"docs":"If `true`, a new [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/) will be created, added to the map and assigned to the `layer` property.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-directions component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisDirections = document.createElement(\"arcgis-directions\");\ndocument.body.append(arcgisDirections);\nawait arcgisDirections.componentOnReady();\nconsole.log(\"arcgis-directions is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"getDirections","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"RouteLayerSolveResult":{"location":"import","path":"@arcgis/core/layers/types.js","id":"notImplemented"}}},"signature":"getDirections(): Promise","parameters":[],"docs":"Computes a route and directions. If successfully computed, results will be assigned to the [lastRoute](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#lastRoute) property.","docsTags":[]},{"name":"save","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/portal/PortalItem.js","id":"notImplemented"}}},"signature":"save(): Promise","parameters":[],"docs":"Saves the currently assigned [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/)\n(see [layer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#layer)) to an existing portal item.","docsTags":[]},{"name":"saveAs","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(portalItem: PortalItem, options: { folder: PortalFolder; }): Promise","parameters":[{"name":"portalItem","type":"PortalItem","docs":""},{"name":"options","type":"{ folder: PortalFolder; }","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/portal/PortalFolder.js","id":"notImplemented"}}},"signature":"saveAs(portalItem: PortalItem, options: { folder: PortalFolder; }): Promise","parameters":[{"name":"portalItem","type":"PortalItem","docs":""},{"name":"options","type":"{ folder: PortalFolder; }","docs":""}],"docs":"Saves the currently assigned [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/)\n(see [layer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#layer)) to a new portal item.","docsTags":[]},{"name":"startEditing","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"startEditing(): Promise","parameters":[],"docs":"Starts an edit session for interactive addition, modification, and deletion of stops, barriers, and waypoints.","docsTags":[]},{"name":"stopEditing","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"stopEditing(): Promise","parameters":[],"docs":"Ends an interactive edit session.","docsTags":[]},{"name":"zoomToRoute","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomToRoute(): Promise","parameters":[],"docs":"Zoom so that the entire route is displayed within the current map extent.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"lastRoute\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"lastRoute\" | \"state\"; }","resolved":"{ name: \"lastRoute\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/directline-measurement-3d/directline-measurement-3d.tsx","tag":"arcgis-direct-line-measurement-3d","overview":"","readme":"","usage":{},"docs":"The Direct Line Measurement 3D component can be added to an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent to calculate and display vertical, horizontal, and direct distances between two points.\n\n[![measurement-line-3d](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/3D_DirectLineMeasurement_widget.avif)](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- Direct distance is computed in a Euclidean manner, in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets);\n- Horizontal distance is computed geodetically, taking into consideration the curvature of the planet;\n- Vertical distance is computed as an elevation difference.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, all three distances (direct, horizontal, and vertical)\n are computed in a Euclidean manner (in their respective PCS).\n\nDirect Line Measurement 3D component visualizes and labels the direct, horizontal, and vertical distances and displays the same values\nin the UI panel. When the distance between the points is greater than 100 kilometers,\nthe measurement visualization is simplified, and only the horizontal and vertical distances are calculated.\nThe direct distance option becomes unavailable.\n\n![measurement-line-3d](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/direct-line-measurement-3d.avif)\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\nA second laser line shows the intersection of the scene with the vertical plane that passes through the checkered line.\n\n**Things to consider**\n\n* Direct Line Measurement 3D is designed to work in the Scene component. For measurements in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent, use [arcgis-distance-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/).\n* Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/).\n\n**See also**\n\n- [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/DirectLineMeasurementAnalysis/)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n- [Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)","docsTags":[{"name":"since","text":"4.33"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"analysis","type":"DirectLineMeasurementAnalysis","complexType":{"original":"DirectLineMeasurementAnalysis","resolved":"DirectLineMeasurementAnalysis","references":{"default":{"location":"import","path":"@arcgis/core/analysis/DirectLineMeasurementAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/DirectLineMeasurementAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Direct Line Measurement 3D component to an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses) collection.\nYou can then wait for the [DirectLineMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/DirectLineMeasurementAnalysisView3D/)\nto be created before accessing the analysis results.\n\n```js\n// Get the Scene component and the Direct Line Measurement 3D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3dElement = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3dElement.componentOnReady();\n\n// Get the DirectLineMeasurementAnalysis created by the Direct Line Measurement 3D component.\nconst analysis = directLineMeasurement3dElement.analysis;\n\n// Get the DirectLineMeasurementAnalysisView3D and watch for results.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysisView?.result,\n () => {\n console.log(\"Analysis results:\", analysisView.result);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/DirectLineMeasurementAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.\n\n```js\n// Create the DirectLineMeasurementAnalysis.\nconst directLineAnalysis = new DirectLineMeasurementAnalysis({\n startPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624995.61798748,\n y: 4550334.030096778,\n z: 63.378210234455764\n }),\n endPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624921.53589075,\n y: 4550407.42357004,\n z: 63.3783810287714\n }),\n});\n// Get the Scene component and the Direct Line Measurement 3D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3dElement = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3dElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Scene component.\nviewElement.analyses.add(directLineAnalysis);\n\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3dElement.analysis = directLineAnalysis;\n```","docsTags":[],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStartButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-start-button","reflectToAttr":false,"docs":"If true, the button that starts a new measurement will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-unit-select","reflectToAttr":false,"docs":"If true, the unit selection dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualization","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization","reflectToAttr":false,"docs":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"measure-line\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"DirectLineMeasurement3DState","complexType":{"original":"DirectLineMeasurement3DState","resolved":"DirectLineMeasurement3DState","references":{"DirectLineMeasurement3DState":{"location":"local","path":"components/arcgis-direct-line-measurement-3d/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"unsupported"},{"type":"string","value":"measured"},{"type":"string","value":"measuring"}],"optional":true,"required":false},{"name":"unit","type":"SystemOrLengthUnit","complexType":{"original":"SystemOrLengthUnit","resolved":"SystemOrLengthUnit","references":{"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/#unitOptions).","docsTags":[],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"metric"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"},{"type":"string","value":"imperial"}],"optional":true,"required":false},{"name":"unitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.\nPossible [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/#unit) values can only be a subset of this list.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-direct-line-measurement-3d component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Clears the current measurement.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisDirectLineMeasurement3d = document.createElement(\"arcgis-direct-line-measurement-3d\");\ndocument.body.append(arcgisDirectLineMeasurement3d);\nawait arcgisDirectLineMeasurement3d.componentOnReady();\nconsole.log(\"arcgis-direct-line-measurement-3d is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"start","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"start(): Promise","parameters":[],"docs":"Starts a new measurement.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"analysis\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"analysis\" | \"state\"; }","resolved":"{ name: \"analysis\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/distance-measurement-2d/distance-measurement-2d.tsx","tag":"arcgis-distance-measurement-2d","overview":"","readme":"","usage":{},"docs":"The Distance Measurement 2D component can be added to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent to calculate and display the length of a polyline.\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, lengths are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, lengths are computed in a Euclidean manner (in their respective PCS).","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"analysis","type":"DistanceMeasurementAnalysis","complexType":{"original":"DistanceMeasurementAnalysis","resolved":"DistanceMeasurementAnalysis","references":{"default":{"location":"import","path":"@arcgis/core/analysis/DistanceMeasurementAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [DistanceMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/DistanceMeasurementAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Distance Measurement 2D component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent, it automatically creates an empty analysis and adds it to the Map's\n[arcgis-map.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#analyses) collection.\nYou can then wait for the [DistanceMeasurementAnalysisView2D](https://developers.arcgis.com/javascript/latest/references/core/views/2d/analysis/DistanceMeasurementAnalysisView2D/)\nto be created before accessing the analysis results.\n\n```js\n// Get the Map component and the Distance Measurement 2D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\nconst distanceMeasurement2dElement = document.querySelector(\"arcgis-distance-measurement-2d\");\nawait distanceMeasurement2dElement.componentOnReady();\n\n// Get the DistanceMeasurementAnalysis created by the Distance Measurement 2D component.\nconst analysis = distanceMeasurement2dElement.analysis;\n\n// Get the DistanceMeasurementAnalysisView2D and watch for results.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysisView?.result,\n () => {\n console.log(\"Analysis results:\", analysisView.result);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [DistanceMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/DistanceMeasurementAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Map component.\n\n```js\n// Create the DistanceMeasurementAnalysis.\nconst distanceMeasurementAnalysis = new DistanceMeasurementAnalysis({\n geometry: new Polyline({\n paths: [\n [\n [-118.25, 34.05], // Los Angeles\n [-77.02, 38.90], // Washington, D.C.\n ]\n ],\n }),\n unit: \"miles\", // Display length in miles.\n});\n\n// Get the Map component and the Distance Measurement 2D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\nconst distanceMeasurement2dElement = document.querySelector(\"arcgis-distance-measurement-2d\");\nawait distanceMeasurement2dElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Map component.\nviewElement.analyses.add(distanceMeasurementAnalysis);\n\n// Connect the analysis to the measurement component:\ndistanceMeasurement2dElement.analysis = distanceMeasurementAnalysis;\n```","docsTags":[{"name":"since","text":"5.0"}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStartButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-start-button","reflectToAttr":false,"docs":"If true, the button that starts a new measurement will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-unit-select","reflectToAttr":false,"docs":"If true, the unit selection dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualization","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization","reflectToAttr":false,"docs":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"measure-line\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"snappingOptions","type":"SnappingOptions","complexType":{"original":"SnappingOptions","resolved":"SnappingOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/snapping/SnappingOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/) for measuring.","docsTags":[{"name":"since","text":"4.28"}],"values":[],"optional":true,"required":false},{"name":"state","type":"DistanceMeasurement2DState","complexType":{"original":"DistanceMeasurement2DState","resolved":"DistanceMeasurement2DState","references":{"DistanceMeasurement2DState":{"location":"local","path":"components/arcgis-distance-measurement-2d/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"unsupported"},{"type":"string","value":"measured"},{"type":"string","value":"measuring"}],"optional":true,"required":false},{"name":"unit","type":"SystemOrLengthUnit","complexType":{"original":"SystemOrLengthUnit","resolved":"SystemOrLengthUnit","references":{"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/#unitOptions).","docsTags":[],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"metric"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"},{"type":"string","value":"imperial"}],"optional":true,"required":false},{"name":"unitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.\nPossible [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/#unit) values can only be a subset of this list.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-distance-measurement-2d component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Clears the current measurement.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisDistanceMeasurement2d = document.createElement(\"arcgis-distance-measurement-2d\");\ndocument.body.append(arcgisDistanceMeasurement2d);\nawait arcgisDistanceMeasurement2d.componentOnReady();\nconsole.log(\"arcgis-distance-measurement-2d is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"start","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"start(): Promise","parameters":[],"docs":"Starts a new measurement.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"analysis\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"analysis\" | \"state\"; }","resolved":"{ name: \"analysis\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/editor/editor.tsx","tag":"arcgis-editor","overview":"","readme":"","usage":{},"docs":"The Editor component provides an out-of-the-box editing experience to help streamline editing within a web application.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"activeWorkflow","type":"CreateFeaturesWorkflow | UpdateWorkflow | null | undefined","complexType":{"original":"CreateFeaturesWorkflow | UpdateWorkflow | null | undefined","resolved":"CreateFeaturesWorkflow | UpdateWorkflow | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Editor/UpdateWorkflow.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A property indicating the current active workflow. This is either\n[CreateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/CreateFeaturesWorkflow/) or [UpdateWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/UpdateWorkflow/).","docsTags":[{"name":"readonly","text":""}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"effectiveSelectionManager","type":"SelectionManager","complexType":{"original":"SelectionManager","resolved":"SelectionManager","references":{"default":{"location":"import","path":"@arcgis/core/views/SelectionManager.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A reference to the selection manager currently in use by Editor.","docsTags":[{"name":"internal"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for title of the component. By default, the title (i.e. \"Editor\") is rendered\nas a level 4 heading (e.g. `

Editor

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[{"name":"since","text":"4.20"},{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"example","text":"// \"Editor\" will render as an

\neditor.headingLevel = 3;"}],"default":"4","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideCreateFeaturesSection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-create-features-section","reflectToAttr":false,"docs":"Indicates whether to hide the \"create features\" section of the component in the default view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideEditFeaturesSection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-edit-features-section","reflectToAttr":false,"docs":"Indicates whether to hide the \"edit features\" section of the component in the default view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLabelsToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-labels-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the sketch labels toggle.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMergeButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-merge-button","reflectToAttr":false,"docs":"Indicates whether to hide the \"Merge features\" button in contexts where that command is available. Default value is `true`.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSelectionToolbar","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-selection-toolbar","reflectToAttr":false,"docs":"Controls whether to use the fully featured selection experience. This includes the\nselection toolbar — which provides multiple selection tools — and the\nselection list, which allows modifying selections and starting\nmulti-feature editing workflows, like bulk updates and merges.\n\nIf set to `true`, the component will use a simplified selection experience,\nconsisting of a single \"Select\" button.","docsTags":[{"name":"internal"},{"name":"sine","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSettingsMenu","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-settings-menu","reflectToAttr":false,"docs":"Indicates whether to hide the settings menu. This menu contains the snapping and tooltips settings.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSketch","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-sketch","reflectToAttr":false,"docs":"Determines whether the component should display an embedded Sketch component to provide graphical controls for choosing drawing tools.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-enabled-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `enabledToggle` (Enable snapping). This toggles\nthe [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#enabled) property.\n> [!WARNING]\n>\n> **Note**\n>\n> It is recommended to set `SnappingControls.snappingOptions.enabled = true` if `enabledToggle` is set to `false`.\n> This is because `selfEnabledToggle` and `featureEnabledToggle` require snapping globally to be enabled in order to be interactive. Otherwise, these toggles will not be responsive.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsFeatureEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-feature-enabled-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `featureEnabledToggle` (Feature to feature). This toggles\nthe [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#featureEnabled) property.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControls","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls","reflectToAttr":false,"docs":"Indicates whether to hide the `gridControls` (configuration of the snapping grid).","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsColorSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-color-selection","reflectToAttr":false,"docs":"Indicates whether to hide the `colorSelection` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsDynamicScaleToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-dynamic-scale-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `dynamicScaleToggle` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsLineIntervalInput","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-line-interval-input","reflectToAttr":false,"docs":"Indicates whether to hide the `lineIntervalInput` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsNumericInputs","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-numeric-inputs","reflectToAttr":false,"docs":"Indicates whether to hide the `numericInputs` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsOutOfScaleWarning","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-out-of-scale-warning","reflectToAttr":false,"docs":"Indicates whether to hide the `outOfScaleWarning` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsPlacementButtons","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-placement-buttons","reflectToAttr":false,"docs":"Indicates whether to hide the `placementButtons` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsRotateWithMapToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-rotate-with-map-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `rotateWithMapToggle` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-enabled-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `gridEnabledToggle` (snap-to-grid).","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsLayerList","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-layer-list","reflectToAttr":false,"docs":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/) layerList. The layerlist provides the available layer sources supported for snapping.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsSelfEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-self-enabled-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `selfEnabledToggle` (Geometry guides). This toggles\nthe [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#selfEnabled) property.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSplitButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-split-button","reflectToAttr":false,"docs":"Indicates whether to hide the \"Split\" button in contexts where that command is available. Default value is `true`.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTooltipsToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-tooltips-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the tooltips toggle. Default value is `true`.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUndoRedoButtons","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-undo-redo-buttons","reflectToAttr":false,"docs":"Indicates whether to hide undo/redo buttons in the embedded Sketch toolbar. Default value is `true`.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideZoomToButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-zoom-to-button","reflectToAttr":false,"docs":"Indicates whether to hide the \"Zoom to\" button when creating and editing features. Default value is `true`.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"pencil\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"labelOptions","type":"SketchLabelOptions","complexType":{"original":"SketchLabelOptions","resolved":"SketchLabelOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/sketch/SketchLabelOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Options to configure the sketch labels shown next to each segment of the geometry being created or updated.\n\n> [!WARNING]\n>\n> **Known Limitation**\n>\n> Sketch labels are currently only supported when working with a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).","docsTags":[{"name":"since","text":"4.24"}],"values":[],"optional":true,"required":false},{"name":"layerInfos","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"LayerInfo":{"location":"import","path":"@arcgis/core/widgets/Editor/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of editing configurations for individual layers. It is possible to iterate through the map's [Map#editableLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#editableLayers) and configure these individual layers as needed.\n\nIf you have an editable feature layer but do not want\nthe end user to do any type of editing, you can limit this by\nsetting the `enabled` property to `false`.","docsTags":[{"name":"see","text":"[Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)"},{"name":"see","text":"[Map#editableLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#editableLayers)"},{"name":"example","text":"const editor = new Editor({\n view: view,\n layerInfos: [{\n layer: featureLayer, // pass in the feature layer,\n formTemplate: { // autocastable to FormTemplate\n elements: [\n { // autocastable to FieldElement\n type: \"field\",\n fieldName: \"fulladdr\",\n label: \"Full Address\"\n }\n ]\n },\n enabled: true, // Default is true, set to false to disable editing functionality.\n addEnabled: true, // Default is true, set to false to disable the ability to add a new feature.\n updateEnabled: false, // Default is true, set to false to disable the ability to edit an existing feature.\n deleteEnabled: false, // Default is true, set to false to disable the ability to delete features.\n attributeUpdatesEnabled: true, // Default is true, set to false to disable the ability to edit attributes in the update workflow.\n geometryUpdatesEnabled: true, // Default is true, set to false to disable the ability to edit feature geometries in the update workflow.\n attachmentsOnCreateEnabled: true, //Default is true, set to false to disable the ability to work with attachments while creating features.\n attachmentsOnUpdateEnabled: true //Default is true, set to false to disable the ability to work with attachments while updating/deleting features.\n }]\n});"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectionManager","type":"SelectionManager | null | undefined","complexType":{"original":"SelectionManager | null | undefined","resolved":"SelectionManager | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SelectionManager.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Use this property to supply a custom [SelectionManager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) that overrides the default selection manager.\nThis is useful when applications want to share selection sets between components, without relying on the view's selection manager. This property is ignored if [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#syncViewSelection) is `true`.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"}],"values":[],"optional":true,"required":false},{"name":"showSnappingControlsElementsHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-snapping-controls-elements-header","reflectToAttr":false,"docs":"Indicates whether to display the header. Default is `false`.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"snappingOptions","type":"SnappingOptions","complexType":{"original":"SnappingOptions","resolved":"SnappingOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/snapping/SnappingOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/) for editing. Supports self snapping and feature snapping. Starting with version 4.23, the [SnappingControls](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SnappingControls/) UI is automatically integrated into the Editor component.\nModify the `snappingOptions` if modifications are needed from what is provided in the default UI.","docsTags":[{"name":"since","text":"4.19"},{"name":"see","text":"[Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)"},{"name":"example","text":"// Creates the Editor with SnappingOptions with no snapping UI\nconst editor = new Editor({\n view: view,\n snappingOptions: { // autocasts to SnappingOptions()\n enabled: true,\n featureSources: [{layer: streetsLayer}] // autocasts to FeatureSnappingLayerSource()\n }\n});\n\n// Add the component to the view component\n\n \n"}],"values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/Editor/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"add-association-select-layer"},{"type":"string","value":"add-association-select-feature"},{"type":"string","value":"add-association-create-association"},{"type":"string","value":"adding-attachment"},{"type":"string","value":"awaiting-feature-creation-info"},{"type":"string","value":"awaiting-feature-to-create"},{"type":"string","value":"awaiting-feature-to-update"},{"type":"string","value":"awaiting-update-feature-candidate"},{"type":"string","value":"choosing-key-feature"},{"type":"string","value":"creating-features"},{"type":"string","value":"drawing-splitter-geometry"},{"type":"string","value":"editing-attributes"},{"type":"string","value":"editing-attachment"},{"type":"string","value":"editing-existing-feature"},{"type":"string","value":"editing-features"},{"type":"string","value":"reviewing-features"},{"type":"string","value":"viewing-selection-list"}],"optional":true,"required":false},{"name":"supportingWidgetDefaults","type":"SupportingWidgetDefaults | null | undefined","complexType":{"original":"SupportingWidgetDefaults | null | undefined","resolved":"SupportingWidgetDefaults | null | undefined","references":{"SupportingWidgetDefaults":{"location":"import","path":"@arcgis/core/widgets/Editor/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property allows customization of supporting Editor components and their default behavior.\nThese components include [FeatureForm](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureForm/), [FeatureTemplates](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/), and the\n[SketchViewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/SketchViewModel/).\n\n> [!WARNING]\n>\n> This property is useful for basic overrides of the default components. There may be some limitations\n> to what the Editor can do with these overridden properties. For example, the Editor will disable the `multipleSelectionEnabled` property in [Sketch#defaultUpdateOptions](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#defaultUpdateOptions)\n> no matter what is set within this property.","docsTags":[{"name":"see","text":"[Sample - Editor component with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)"},{"name":"see","text":"[Sample - Editing with calculated field expressions](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featureform-async/)"}],"values":[],"optional":true,"required":false},{"name":"syncViewSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"sync-view-selection","reflectToAttr":false,"docs":"Controls whether the editor should sync with the view's selection manager.\nThis does not include selection sources, which must be configured independently\non the view's selection manager.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"tooltipOptions","type":"SketchTooltipOptions","complexType":{"original":"SketchTooltipOptions","resolved":"SketchTooltipOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/sketch/SketchTooltipOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Options to configure the tooltip shown next to the cursor when creating or updating graphics.","docsTags":[{"name":"since","text":"4.24"}],"values":[],"optional":true,"required":false},{"name":"useLegacyCreateTools","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"use-legacy-create-tools","reflectToAttr":false,"docs":"Starting at version 5.0, `arcgis-editor` is transitioning to a next generation geometry\ncreation experience. This new experience provides advanced curve creation tools\nand allows multiple tools to be used in combination to define a single geometry.\n\nAs of 5.0, this experience is only available in 2D (e.g. [`arcgis-map`](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map)).\n\nThis property is available to allow 2D applications to temporarily\nopt out of this experience.\n\n> [!CAUTION]\n>\n> This option will be removed in an upcoming release.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","deprecation":"","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-editor component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"cancelSelectionTool","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"cancelSelectionTool(): void","parameters":[],"docs":"Cancels any active selection operation.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"cancelWorkflow","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"cancelWorkflow(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisEditor = document.createElement(\"arcgis-editor\");\ndocument.body.append(arcgisEditor);\nawait arcgisEditor.componentOnReady();\nconsole.log(\"arcgis-editor is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"deleteFeatureFromWorkflow","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"deleteFeatureFromWorkflow(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"startCreateFeaturesWorkflowAtFeatureCreation","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(info: CreateFeaturesCreationInfo): Promise","parameters":[{"name":"info","type":"CreateFeaturesCreationInfo","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"CreateFeaturesCreationInfo":{"location":"import","path":"@arcgis/core/widgets/Editor.js","id":"notImplemented"}}},"signature":"startCreateFeaturesWorkflowAtFeatureCreation(info: CreateFeaturesCreationInfo): Promise","parameters":[{"name":"info","type":"CreateFeaturesCreationInfo","docs":""}],"docs":"","docsTags":[]},{"name":"startCreateFeaturesWorkflowAtFeatureTypeSelection","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"startMergeFeaturesWorkflow","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(features: FeatureInfo | Graphic[], options: EditorStartMergeFeaturesWorkflowOptions): Promise","parameters":[{"name":"features","type":"FeatureInfo | Graphic[]","docs":"The features to be merged. These can be supplied\neither as an array of [Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) instances or as a single\n[FeatureInfo](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/types/#FeatureInfo) object specifying a layer\nand the object IDs of the features."},{"name":"options","type":"EditorStartMergeFeaturesWorkflowOptions","docs":"Options for the merge features workflow."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"FeatureInfo":{"location":"import","path":"@arcgis/core/widgets/Editor/types.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"},"EditorStartMergeFeaturesWorkflowOptions":{"location":"import","path":"@arcgis/core/widgets/Editor.js","id":"notImplemented"}}},"signature":"startMergeFeaturesWorkflow(features: FeatureInfo | Graphic[], options: EditorStartMergeFeaturesWorkflowOptions): Promise","parameters":[{"name":"features","type":"FeatureInfo | Graphic[]","docs":"The features to be merged. These can be supplied\neither as an array of [Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) instances or as a single\n[FeatureInfo](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/types/#FeatureInfo) object specifying a layer\nand the object IDs of the features."},{"name":"options","type":"EditorStartMergeFeaturesWorkflowOptions","docs":"Options for the merge features workflow."}],"docs":"Starts a [MergeFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/MergeFeaturesWorkflow/) using\nthe provided features. All features must belong to the same layer.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"startSplitFeatureWorkflow","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(feature: Graphic, options: EditorStartSplitFeatureWorkflowOptions): Promise","parameters":[{"name":"feature","type":"Graphic","docs":"The feature to be split."},{"name":"options","type":"EditorStartSplitFeatureWorkflowOptions","docs":"Options for the split feature workflow."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"},"EditorStartSplitFeatureWorkflowOptions":{"location":"import","path":"@arcgis/core/widgets/Editor.js","id":"notImplemented"}}},"signature":"startSplitFeatureWorkflow(feature: Graphic, options: EditorStartSplitFeatureWorkflowOptions): Promise","parameters":[{"name":"feature","type":"Graphic","docs":"The feature to be split."},{"name":"options","type":"EditorStartSplitFeatureWorkflowOptions","docs":"Options for the split feature workflow."}],"docs":"Starts a [SplitFeatureWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/SplitFeatureWorkflow/) using the provided feature.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"startUpdateFeaturesWorkflow","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(features: FeatureInfo | Graphic[]): Promise","parameters":[{"name":"features","type":"FeatureInfo | Graphic[]","docs":"The features to be updated. These can be supplied\neither as an array of [Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) instances or as a single\n[FeatureInfo](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/types/#FeatureInfo) object specifying a layer\nand the object IDs of the features."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"FeatureInfo":{"location":"import","path":"@arcgis/core/widgets/Editor/types.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"signature":"startUpdateFeaturesWorkflow(features: FeatureInfo | Graphic[]): Promise","parameters":[{"name":"features","type":"FeatureInfo | Graphic[]","docs":"The features to be updated. These can be supplied\neither as an array of [Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) instances or as a single\n[FeatureInfo](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/types/#FeatureInfo) object specifying a layer\nand the object IDs of the features."}],"docs":"Starts an [UpdateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/UpdateFeaturesWorkflow/) using\nthe provided features.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"startUpdateWorkflowAtFeatureEdit","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(feature: Graphic): Promise","parameters":[{"name":"feature","type":"Graphic","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"signature":"startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise","parameters":[{"name":"feature","type":"Graphic","docs":""}],"docs":"","docsTags":[]},{"name":"startUpdateWorkflowAtFeatureSelection","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"startUpdateWorkflowAtFeatureSelection(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"startUpdateWorkflowAtMultipleFeatureSelection","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(candidates: Graphic[]): Promise","parameters":[{"name":"candidates","type":"Graphic[]","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"signature":"startUpdateWorkflowAtMultipleFeatureSelection(candidates: Graphic[]): Promise","parameters":[{"name":"candidates","type":"Graphic[]","docs":""}],"docs":"","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"activeWorkflow\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"activeWorkflow\" | \"state\"; }","resolved":"{ name: \"activeWorkflow\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSketchCreate","detail":"EditorSketchCreateEvent","bubbles":true,"complexType":{"original":"EditorSketchCreateEvent","resolved":"EditorSketchCreateEvent","references":{"EditorSketchCreateEvent":{"location":"import","path":"@arcgis/core/widgets/Editor/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user starts drawing a feature, is actively drawing a feature, and completes drawing a feature.","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisSketchUpdate","detail":"EditorSketchUpdateEvent","bubbles":true,"complexType":{"original":"EditorSketchUpdateEvent","resolved":"EditorSketchUpdateEvent","references":{"EditorSketchUpdateEvent":{"location":"import","path":"@arcgis/core/widgets/Editor/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user starts updating a feature's geometry, is actively updating a feature's geometry, and completes updating a feature's geometry.","docsTags":[{"name":"since","text":"4.34"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/elevation-profile/elevation-profile.tsx","tag":"arcgis-elevation-profile","overview":"","readme":"","usage":{},"docs":"The Elevation Profile component manages an [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/) and displays its elevation profiles.\n\n[![elevation profile poster](https://developers.arcgis.com/javascript/latest/assets/references/components/elevation-profile/elevation_profile_poster.avif)](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n\nThe component can visualize multiple profile lines, depending on whether it is used in an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) component or an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component and on the available elevation source data:\n\n* [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineGround/): represents a profile line that uses elevation from [arcgis-map.ground](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#ground) of the connected Map or Scene component. The profile recomputes automatically when ground layers are added, removed, or their visibility changes.\n* [**ElevationProfileLineInput**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineInput/): represents a profile line that reads elevation from the analysis geometry itself; typically used for polylines with z values. If the line lacks z values but is displayed with a non-draped elevation mode, a profile is still computed. If `elevationInfo` is set to `on-the-ground`, elevation comes from the Ground (when ground layers are present). An elevation offset can be applied. In a Map this requires client-side graphics that already contain z values.\n* [**ElevationProfileLineQuery**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineQuery/): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineQuery/#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/) or an object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/#queryElevation).\n* [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineScene/): represents a profile line that derives elevation from the `Scene` and all its volumetric objects (e.g. SceneLayer, IntegratedMeshLayer).\n\nYou can choose to display one or several profile lines in the chart, by setting them in the [profiles](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#profiles) property.\n\nHovering over the chart shows an overlaid tooltip with elevation values of all profiles, and displays colored dot markers at the matching positions.\n\nCheckboxes in the legend allow hiding individual profiles. Chart units can be set via the settings menu to metric, imperial or a specific unit.\n\nScrolling the chart zooms in to a specific part of the profile chart. When zoomed in, click the minus button to reset the zoom. On touch devices, pinch to zoom in and out.\n\nHow distance values are computed depends on the map's spatial reference:\n\n* In geographic coordinate systems (GCS) and in Web Mercator, distances are computed geodetically.\n* In projected coordinate systems (PCS), apart from Web Mercator, distances are computed in a Euclidean manner (in their respective PCS).\n\n**Known limitations**\n\n- [ElevationProfileLineInput](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineInput/) in 2D is only valid when the analysis [geometry](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#geometry) has z values, `hasZ===true` and no [elevationInfo](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#elevationInfo) is set.\n- [ElevationProfileLineScene](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineScene/) is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/)\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n- [Sample - Elevation Profile analysis](https://developers.arcgis.com/javascript/latest/sample-code/analysis-elevation-profile/)","docsTags":[{"name":"since","text":"4.28"},{"name":"example","text":"```html\n\n \n Show all layers\n \n \n\n```"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"analysis","type":"ElevationProfileAnalysis","complexType":{"original":"ElevationProfileAnalysis","resolved":"ElevationProfileAnalysis","references":{"default":{"location":"import","path":"@arcgis/core/analysis/ElevationProfileAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Elevation Profile component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\nor [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponents, it automatically creates an empty analysis and adds it to the Map's\n[arcgis-map.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#analyses) collection or the Scene's\n[arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses) collection.\nYou can then wait for the [ElevationProfileAnalysisView2D](https://developers.arcgis.com/javascript/latest/references/core/views/2d/analysis/ElevationProfileAnalysisView2D/)\nor [ElevationProfileAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ElevationProfileAnalysisView3D/)\nto be created (depending on whether you are using a Map or Scene component) before accessing the analysis results.\n\n```js\n// Get the Scene component and the Elevation Profile component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst elevationProfileElement = document.querySelector(\"arcgis-elevation-profile\");\nawait elevationProfileElement.componentOnReady();\n\n// Get the ElevationProfileAnalysis created by the Elevation Profile component.\nconst analysis = elevationProfileElement.analysis;\n\n// Get the ElevationProfileAnalysisView3D and watch for results.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysisView?.results,\n () => {\n console.log(\"Analysis results:\", analysisView.results);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Map or Scene component.\n\n```js\n// Create the ElevationProfileAnalysis.\nconst analysis = new ElevationProfileAnalysis({\n profiles: [{ type: \"ground\" }, { type: \"scene\" }]\n});\n\n// Get the Scene component and the Elevation Profile component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst elevationProfileElement = document.querySelector(\"arcgis-elevation-profile\");\nawait elevationProfileElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Scene component.\nviewElement.analyses.add(analysis);\n\n// Connect the analysis to the elevation profile component.\nelevationProfileElement.analysis = analysis;\n```","docsTags":[{"name":"since","text":"5.0"}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"distanceUnit","type":"SystemOrLengthUnit | undefined","complexType":{"original":"SystemOrLengthUnit | undefined","resolved":"SystemOrLengthUnit | undefined","references":{"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"distance-unit","reflectToAttr":false,"docs":"The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display distance values\nin the chart, results and legend.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"metric"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"},{"type":"string","value":"imperial"}],"optional":true,"required":false},{"name":"distanceUnitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units unit systems (imperial, metric) and specific units (e.g. feet, kilometers) for displaying\nthe distance values. These are the options displayed in the distance unit dropdown in the settings popover.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"effectiveDisplayUnits","type":"ElevationProfileEffectiveDisplayUnits | undefined","complexType":{"original":"ElevationProfileEffectiveDisplayUnits | undefined","resolved":"ElevationProfileEffectiveDisplayUnits | undefined","references":{"ElevationProfileEffectiveDisplayUnits":{"location":"import","path":"@arcgis/core/views/analysis/ElevationProfile/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Units which have been selected according to the magnitude of the elevations and distances that are to be displayed\nin the component, according to the selected elevation and distance units or unit systems.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"elevationInfo","type":"ElevationInfo | null | undefined","complexType":{"original":"ElevationInfo | null | undefined","resolved":"ElevationInfo | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/symbols/support/ElevationInfo.js","id":"notImplemented"},"ElevationInfoMode":{"location":"import","path":"@arcgis/core/symbols/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies how the geometry Z values are interpreted, for example to compute elevations for an\n[input](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineInput/)\nprofile line. This property can only be used in a\n[SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#elevationInfo)","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"elevationUnit","type":"SystemOrLengthUnit | undefined","complexType":{"original":"SystemOrLengthUnit | undefined","resolved":"SystemOrLengthUnit | undefined","references":{"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"elevation-unit","reflectToAttr":false,"docs":"The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display elevation values\nin the chart, results and legend.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"metric"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"},{"type":"string","value":"imperial"}],"optional":true,"required":false},{"name":"elevationUnitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units unit systems (imperial, metric) and specific units (e.g. feet, kilometers) for displaying\nthe elevation values. These are the options displayed in the elevation unit dropdown in the settings popover.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"feature","type":"Graphic | undefined","complexType":{"original":"Graphic | undefined","resolved":"Graphic | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The feature which is currently selected for display in the elevation profile. The feature is highlighted in the\nview and its geometry is used as the profile line. When the user starts drawing a new profile line, this feature\nis cleared.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"geometry","type":"Polyline | null | undefined","complexType":{"original":"Polyline | null | undefined","resolved":"Polyline | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Polyline.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Path along which elevation will be queried in order to generate an elevation profile. It should be a\nPolyline geometry.\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#geometry)","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"hideChart","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-chart","reflectToAttr":false,"docs":"If true, the elevation profile chart will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideClearButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-clear-button","reflectToAttr":false,"docs":"If true, the clear button will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDistanceDisplayUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-distance-display-unit-select","reflectToAttr":false,"docs":"If true, the distance display unit dropdown will be hidden in the settings popover.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideElevationDisplayUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-elevation-display-unit-select","reflectToAttr":false,"docs":"If true, the elevation display unit dropdown will be hidden in the settings popover.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLegend","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-legend","reflectToAttr":false,"docs":"If true, the legend will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSelectButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-select-button","reflectToAttr":false,"docs":"If true, the button to select features in the view will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSettingsButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-settings-button","reflectToAttr":false,"docs":"If true, the button which opens the settings popover will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStartButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-start-button","reflectToAttr":false,"docs":"If true, the button to start sketching a new profile line will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUniformChartScalingToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-uniform-chart-scaling-toggle","reflectToAttr":false,"docs":"If true, the uniform chart scaling toggle will be hidden in the settings popover.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualization","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization","reflectToAttr":false,"docs":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlightDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"highlight-disabled","reflectToAttr":false,"docs":"If true, the component will not highlight features selected in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"altitude\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"indicatorRelativePosition","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Relative position along the current elevation profile line, in the range [0, 1].\nThe component updates this value as the user hovers the chart.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ElevationProfileAnalysisView3D/#indicatorRelativePosition)","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"profiles","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/analysis/ElevationProfile/ElevationProfileGroup.js","id":"notImplemented"},"ElevationProfileLineUnion":{"location":"import","path":"@arcgis/core/analysis/ElevationProfile/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The collection of profiles to compute and display. Top-level entries can be either individual profile lines or\ngroups that organize multiple lines under a shared title in the legend.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#profiles)","docsTags":[],"values":[],"optional":true,"required":false},{"name":"progress","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The progress, between 0 and 1 of generating all the configured elevation profiles.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ElevationProfileAnalysisView3D/#progress)","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"\"disabled\" | \"ready\" | \"selected\" | \"created\" | \"creating\" | \"selecting\"","complexType":{"original":"\"disabled\" | \"ready\" | \"selected\" | \"created\" | \"creating\" | \"selecting\"","resolved":"\"disabled\" | \"ready\" | \"selected\" | \"created\" | \"creating\" | \"selecting\"","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready; no path configured and no interactive operation ongoing\n* `creating` - user is creating a new input path\n* `created` - input path is configured but no interactive operation is ongoing\n* `selecting` - user is selecting an existing input path\n* `selected` - user selected an existing input path","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"selected"},{"type":"string","value":"created"},{"type":"string","value":"creating"},{"type":"string","value":"selecting"}],"optional":true,"required":false},{"name":"uniformChartScaling","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"uniform-chart-scaling","reflectToAttr":false,"docs":"Whether the chart should use a uniform scale for the X and Y axes.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-elevation-profile component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Clear the current elevation profile. If an interactive operation is in progress, it will also be stopped.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisElevationProfile = document.createElement(\"arcgis-elevation-profile\");\ndocument.body.append(arcgisElevationProfile);\nawait arcgisElevationProfile.componentOnReady();\nconsole.log(\"arcgis-elevation-profile is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"select","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"select(): Promise","parameters":[],"docs":"Start an interactive operation to pick an existing polyline feature in the view to use as the input for the\nelevation profile. The operation ends when the user presses the Escape key.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#stop) method.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"start","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"start(): Promise","parameters":[],"docs":"Start an interactive operation that lets the user sketch a new path in the view along which the elevation profile\nwill be generated. The operation completes when the user double-clicks, presses the Escape key or clicks\nthe Done button in the UI.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#stop) method.","docsTags":[]},{"name":"stop","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"stop(): Promise","parameters":[],"docs":"Stop any ongoing interactive operation (for example, selecting or sketching a profile line). This can be used to\nprogrammatically cancel operations started by [start()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#start) or\n[select()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#select).","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"analysis\" | \"effectiveDisplayUnits\" | \"elevationInfo\" | \"feature\" | \"geometry\" | \"indicatorRelativePosition\" | \"progress\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"analysis\" | \"effectiveDisplayUnits\" | \"elevationInfo\" | \"feature\" | \"geometry\" | \"indicatorRelativePosition\" | \"progress\" | \"state\"; }","resolved":"{ name: \"analysis\" | \"effectiveDisplayUnits\" | \"elevationInfo\" | \"feature\" | \"geometry\" | \"indicatorRelativePosition\" | \"progress\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[{"name":"settings-start","docs":"Slot for adding custom UI before the built-in settings controls."},{"name":"settings-end","docs":"Slot for adding custom UI after the built-in settings controls."}],"parts":[],"listeners":[]},{"filePath":"src/components/expand/expand.tsx","tag":"arcgis-expand","overview":"","readme":"","usage":{},"docs":"Expand acts as a clickable button for displaying interactive content, most commonly other components.","docsTags":[{"name":"see","text":"[Samples with the Expand component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-expand)"},{"name":"since","text":"4.28"},{"name":"example","text":"```html\n\n \n \n \n\n```"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoCollapse","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-collapse","reflectToAttr":false,"docs":"Automatically collapses the Expand component when the\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/core/views/View/#viewpoint) updates.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-expand/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"closeOnEscDisabled","type":"boolean | ((event: KeyboardEvent) => boolean)","complexType":{"original":"boolean | ((event: KeyboardEvent) => boolean)","resolved":"boolean | ((event: KeyboardEvent) => boolean)","references":{"KeyboardEvent":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"attr":"close-on-esc-disabled","reflectToAttr":false,"docs":"When `true`, the Expand component will not close itself if the Escape key is pressed while its content has keyboard focus.\nThis property can also be set to a function that returns a boolean, allowing for more customization for when to allow the\nExpand component to be closed via the Escape key.","docsTags":[{"name":"since","text":"4.34"},{"name":"example","text":"```html\n\n \n\n```"},{"name":"example","text":"```html\n\n \n\n\n\n```"}],"default":"false","values":[{"type":"boolean"},{"type":"object"}],"optional":true,"required":false},{"name":"collapseIcon","type":"IconName | null | undefined","complexType":{"original":"IconName | null | undefined","resolved":"IconName | null | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"collapse-icon","reflectToAttr":true,"docs":"Calcite icon used to style the Expand when it can be collapsed.","docsTags":[{"name":"see","text":"[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"chevrons-right\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"collapseTooltip","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"collapse-tooltip","reflectToAttr":false,"docs":"Tooltip to display to indicate the Expand can be collapsed.","docsTags":[],"default":"\"Collapse\" (English locale)","values":[{"type":"string"}],"optional":true,"required":false},{"name":"expanded","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"expanded","reflectToAttr":true,"docs":"Indicates whether the component is currently expanded or not.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"expandIcon","type":"IconName | null | undefined","complexType":{"original":"IconName | null | undefined","resolved":"IconName | null | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"expand-icon","reflectToAttr":true,"docs":"Calcite icon used to style the Expand when it can be expanded.\nThe component will automatically use the icon of the component placed within the Expand if it has one.","docsTags":[{"name":"see","text":"[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"chevrons-left\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"expandTooltip","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"expand-tooltip","reflectToAttr":false,"docs":"Tooltip to display to indicate Expand can be expanded.","docsTags":[],"default":"\"Expand\" (English locale)","values":[{"type":"string"}],"optional":true,"required":false},{"name":"focusTrapDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"focus-trap-disabled","reflectToAttr":false,"docs":"Whether the user's keyboard focus should be trapped in the expanded panel state. If `true`, tabbing\nforward or backward will cycle through elements only within the panel content.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"group","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"group","reflectToAttr":false,"docs":"This value associates two or more Expand components with each other, allowing one\ncomponent to auto collapse when another in the same group is expanded. For auto collapsing\nto take effect, all components in the group must be included in the same Map, Scene, or Link Chart component.\n\nFor example, if you place multiple Expand components in the `top-left` slot of the Map, you can assign them to a\ngroup called `top-left`. If one Expand component is expanded and the user clicks on a different component in the\n`top-left` group, then the first component is collapsed, allowing the content of the second component to be\nfully visible.","docsTags":[{"name":"example","text":"```html\n\n \n \n \n \n \n \n"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"iconNumber","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"icon-number","reflectToAttr":false,"docs":"A number to display at the corner of the component to indicate the number of, for example, open issues or unread notices.\n\n![expand component icon number](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/expand-with-iconnumber.avif)","docsTags":[],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"mode","type":"\"auto\" | \"drawer\" | \"floating\"","complexType":{"original":"\"auto\" | \"drawer\" | \"floating\"","resolved":"\"auto\" | \"drawer\" | \"floating\"","references":{}},"mutable":true,"attr":"mode","reflectToAttr":false,"docs":"The mode in which the component displays. These modes are listed below:\n\n- `auto`: This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application.\n- `floating`: Use this mode if you wish to always display the component as floating in a [Calcite Popover component](https://developers.arcgis.com/calcite-design-system/components/popover/) regardless of browser size.\n- `drawer`: Use this mode if you wish to always display the component in a [Calcite Sheet component](https://developers.arcgis.com/calcite-design-system/components/sheet/) regardless of browser size.","docsTags":[],"default":"\"auto\"","values":[{"type":"string","value":"auto"},{"type":"string","value":"drawer"},{"type":"string","value":"floating"}],"optional":true,"required":false},{"name":"placement","type":"Panel[\"menuPlacement\"] | undefined","complexType":{"original":"Panel[\"menuPlacement\"] | undefined","resolved":"Panel[\"menuPlacement\"] | undefined","references":{"Panel":{"location":"import","path":"@esri/calcite-components/components/calcite-panel","id":"notImplemented"}}},"mutable":true,"attr":"placement","reflectToAttr":false,"docs":"The placement used by the [Calcite Popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.","docsTags":[],"values":[{"type":"string","value":"top-start"},{"type":"string","value":"top-end"},{"type":"string","value":"bottom-start"},{"type":"string","value":"bottom-end"},{"type":"string","value":"bottom"},{"type":"string","value":"left"},{"type":"string","value":"right"},{"type":"string","value":"top"},{"type":"string","value":"auto"},{"type":"string","value":"auto-start"},{"type":"string","value":"auto-end"},{"type":"string","value":"right-start"},{"type":"string","value":"right-end"},{"type":"string","value":"left-start"},{"type":"string","value":"left-end"},{"type":"string","value":"leading-start"},{"type":"string","value":"leading"},{"type":"string","value":"leading-end"},{"type":"string","value":"trailing-end"},{"type":"string","value":"trailing"},{"type":"string","value":"trailing-start"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"ExpandState","complexType":{"original":"ExpandState","resolved":"ExpandState","references":{"ExpandState":{"location":"local","path":"components/arcgis-expand/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"since","text":"4.34"},{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"topLayerDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"top-layer-disabled","reflectToAttr":false,"docs":"When true, disables rendering in the top layer (above overlays and modals).\nThis can be useful for controlling stacking context in complex UI layouts.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"LinkChartView | MapView | SceneView | null | undefined","complexType":{"original":"LinkChartView | MapView | SceneView | null | undefined","resolved":"LinkChartView | MapView | SceneView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-expand component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Action[\"scale\"]","complexType":{"original":"Action[\"scale\"]","resolved":"Action[\"scale\"]","references":{"Action":{"location":"import","path":"@esri/calcite-components/components/calcite-action","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Specifies the size of the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"collapse","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"collapse(): Promise","parameters":[],"docs":"Collapse the component.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisExpand = document.createElement(\"arcgis-expand\");\ndocument.body.append(arcgisExpand);\nawait arcgisExpand.componentOnReady();\nconsole.log(\"arcgis-expand is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"expand","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"expand(): Promise","parameters":[],"docs":"Expand the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"expanded\"; }","bubbles":true,"complexType":{"original":"{ name: \"expanded\"; }","resolved":"{ name: \"expanded\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/feature/feature.tsx","tag":"arcgis-feature","overview":"","readme":"","usage":{},"docs":"The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\nThis component is useful in instances where you want to display information about a feature but without\nthe use of an [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/).\n\nIf wanting to show a feature's content with [actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), [related](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/), or [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate), etc., then use the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) component.\n\nWhen Arcade expressions that use `$map` or [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) are defined in any popup template content or as expression elements,\nthe [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#map) and [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#spatialReference) properties need to be defined in the Feature component.\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) will be updated under the hood to that of [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/), and deprecated properties on this component will be removed. We encourage using the [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/) component and providing feedback.","docsTags":[{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"},{"name":"see","text":"[Arcade - expression language](https://developers.arcgis.com/javascript/latest/arcade/)"},{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"chartAnimationDisabled","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"chart-animation-disabled","reflectToAttr":false,"docs":"Disables chart animation within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"defaultPopupTemplateEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"default-popup-template-enabled","reflectToAttr":false,"docs":"Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined. Automatic popup templates are supported for layers that\nsupport the `createPopupTemplate()` method. (Supported for\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OGCFeatureLayer/)\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/PointCloudLayer/),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer/), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/)).\n\n**Note:**\nStarting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat)\nrather than `long-month-day-year` in the default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"graphic","type":"Graphic | null | undefined","complexType":{"original":"Graphic | null | undefined","resolved":"Graphic | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) used to represent the feature.","docsTags":[{"name":"see","text":"[PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content)"},{"name":"example","text":"```js\nlet graphic = new Graphic({\n geometry: view.center,\n attributes: {\n name: \"Spruce\",\n family: \"Pinaceae\",\n count: 126\n },\n symbol: new SimpleMarkerSymbol({\n style: \"square\",\n color: \"blue\",\n size: \"8px\"\n }),\n popupTemplate: {\n content: [\n {\n // Set popup template content\n }\n ]\n }\n});\n```"}],"default":"null","values":[],"optional":true,"required":false},{"name":"heading","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The title for the feature. This can be disabled by setting the [hideHeading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#hideHeading) property to `true`.","docsTags":[{"name":"since","text":"4.34"},{"name":"see","text":"[headingLevel](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#headingLevel)"},{"name":"see","text":"[hideHeading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#hideHeading)"},{"name":"readonly","text":""}],"default":"null","values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#heading) of the component.\nBy default, the title is rendered\nas a level 2 heading (e.g. `

Title of content

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"example","text":"```\n// feature title will render as an

\nfeature.headingLevel = 3;\n```"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideAttachmentsContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-attachments-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show content within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCustomContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-custom-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideExpressionContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-expression-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFieldsContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-fields-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-heading","reflectToAttr":false,"docs":"This property provides the ability to hide or show the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#heading).","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLastEditedInfo","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-last-edited-info","reflectToAttr":false,"docs":"This property provides the ability to hide or show the last edited info within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMediaContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-media-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTextContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-text-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"icon\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"isFeatureFromTable","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the current graphic resides in a non-spatial table.","docsTags":[{"name":"since","text":"4.34"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"location","type":"Point | null | undefined","complexType":{"original":"Point | null | undefined","resolved":"Point | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) representing the location of the map interaction used to trigger the opening of the component.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[PopupTemplate#content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"}],"values":[],"optional":true,"required":false},{"name":"map","type":"Map | null | undefined","complexType":{"original":"Map | null | undefined","resolved":"Map | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Map.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A map is required when the input [graphic](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#graphic) has a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use the `$map` profile variable to access data from layers within a map. Without a map, expressions that use `$map` will throw an error.","docsTags":[{"name":"see","text":"[Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"},{"name":"example","text":"```\n// The building footprints represent the buildings that intersect a clicked parcel\nlet buildingFootprints = Intersects($feature, FeatureSetByName($map, \"Building Footprints\"));\n```"}],"default":"null","values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"showRelationshipContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-relationship-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showUtilityNetworkContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-utility-network-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"spatialReference","type":"SpatialReference | null | undefined","complexType":{"original":"SpatialReference | null | undefined","resolved":"SpatialReference | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/SpatialReference.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.\nThis property should be set if the component executes Arcade expressions that contain [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/).","docsTags":[{"name":"see","text":"[Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"}],"default":"null","values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/Feature/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"since","text":"4.21"},{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"error"}],"optional":true,"required":false},{"name":"timeZone","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from [MapView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#timeZone). When a MapView is not associated with the component,\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and time are not adjusted for any timezone.\n- Specified IANA timezone: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","docsTags":[{"name":"since","text":"4.29"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-feature component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"viewModel","type":"FeatureViewModel","complexType":{"original":"FeatureViewModel","resolved":"FeatureViewModel","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Feature/FeatureViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"since","text":"4.34"}],"deprecation":"since 5.1. Use properties directly on the component instead of accessing them through the `viewModel`. For example, instead of `viewModel.graphic`, use `graphic`.","values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeature = document.createElement(\"arcgis-feature\");\ndocument.body.append(arcgisFeature);\nawait arcgisFeature.componentOnReady();\nconsole.log(\"arcgis-feature is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"nextMedia","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(contentElementIndex: number): Promise","parameters":[{"name":"contentElementIndex","type":"number","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"nextMedia(contentElementIndex: number): Promise","parameters":[{"name":"contentElementIndex","type":"number","docs":""}],"docs":"Paginates to the next [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.","docsTags":[]},{"name":"previousMedia","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(contentElementIndex: number): Promise","parameters":[{"name":"contentElementIndex","type":"number","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"previousMedia(contentElementIndex: number): Promise","parameters":[{"name":"contentElementIndex","type":"number","docs":""}],"docs":"Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.","docsTags":[]},{"name":"setActiveMedia","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(contentElementIndex: number, mediaInfoIndex: number): Promise","parameters":[{"name":"contentElementIndex","type":"number","docs":""},{"name":"mediaInfoIndex","type":"number","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise","parameters":[{"name":"contentElementIndex","type":"number","docs":""},{"name":"mediaInfoIndex","type":"number","docs":""}],"docs":"Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.","docsTags":[]},{"name":"updateGeometry","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"updateGeometry(): Promise","parameters":[],"docs":"Updates the geometry of the graphic.","docsTags":[{"name":"since","text":"4.34"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"flowItems\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"flowItems\" | \"state\"; }","resolved":"{ name: \"flowItems\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/feature-form/feature-form.tsx","tag":"arcgis-feature-form","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"editType","type":"EditType","complexType":{"original":"EditType","resolved":"EditType","references":{"EditType":{"location":"import","path":"@arcgis/core/widgets/support/forms/types.js","id":"notImplemented"}}},"mutable":true,"attr":"edit-type","reflectToAttr":false,"docs":"The edit type for the form, which determines the editing context and behavior.\n\nThis property is used in two primary ways:\n\n1. **Arcade Expressions Context**: When evaluating [Arcade expressions](https://developers.arcgis.com/javascript/latest/arcade/#form-calculation),\nthe value of this property is assigned to the `$editContext.editType` variable.\n This allows Arcade expressions to adapt their behavior based on the type of edit\n being performed (e.g., \"INSERT\", \"UPDATE\", \"DELETE\", or \"NA\").\n\n2. **Layer Editing Capabilities**: This property is also used to determine whether\n the layer allows the specified type of edit. For example:\n - If `editType` is set to `\"INSERT\"` but the layer has `supportsAdd: false`,\n all inputs in the form will be read-only.\n - If `editType` is set to `\"UPDATE\"` but the layer has `supportsUpdate: false`,\n all inputs will also be read-only.\n\nThis behavior applies regardless of whether a form template or Arcade expressions\nare present. For instance:\n- If a layer has `{ supportsAdd: true, supportsUpdate: false }` and no form template,\n setting `editType` to `\"INSERT\"` will allow the user to modify all fields, while\n setting it to `\"UPDATE\"` will make all fields read-only.\n- If a form template is present with field elements that include `editableExpression`\n or `valueExpression`, the `editType` still determines whether the layer permits\n editing in the given context.","docsTags":[{"name":"since","text":"4.33"},{"name":"see","text":"[Arcade Form Calculation - profile variables](https://developers.arcgis.com/arcade/profiles/form-calculation/#profile-variables)"}],"default":"\"NA\"","values":[{"type":"string","value":"INSERT"},{"type":"string","value":"UPDATE"},{"type":"string","value":"DELETE"},{"type":"string","value":"NA"}],"optional":true,"required":false},{"name":"feature","type":"Graphic | null | undefined","complexType":{"original":"Graphic | null | undefined","resolved":"Graphic | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The associated feature containing the editable attributes.\nA common way to access this is via the [MapView#hitTest()](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#hitTest)\nor [SceneView's](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#hitTest) `hitTest()`\nmethod.","docsTags":[{"name":"example","text":"// Check if a user clicked on an incident feature.\nview.on(\"click\", function(event) {\n view.hitTest(event).then(function(response) {\n // Display the attributes of selected incident feature in the form\n if (response.results[0].graphic && response.results[0].graphic.layer.id == \"incidentsLayer\") {\n formVM.feature = result.results[0].graphic\n }\n });\n});"}],"values":[],"optional":true,"required":false},{"name":"formTemplate","type":"FormTemplate | null | undefined","complexType":{"original":"FormTemplate | null | undefined","resolved":"FormTemplate | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/form/FormTemplate.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The associated [template](https://developers.arcgis.com/javascript/latest/references/core/form/FormTemplate/) used for the form.\n\nThe [FormTemplate](https://developers.arcgis.com/javascript/latest/references/core/form/FormTemplate/) is used to configure how the form should display and set any associated properties for the form, e.g. title, description, field elements, etc.","docsTags":[{"name":"since","text":"4.16"},{"name":"see","text":"[Sample - Update Feature Attributes](https://developers.arcgis.com/javascript/latest/sample-code/editing-groupedfeatureform/)"},{"name":"see","text":"[Sample - Advanced Attribute Editing](https://developers.arcgis.com/javascript/latest/sample-code/editing-featureform-fieldvisibility/)"},{"name":"example","text":"// Create the Form template and pass in elements\nconst formTemplate = new FormTemplate({\n title: \"Inspector report\",\n description: \"Enter all relevant information below\",\n elements: [groupElement] // Add the grouped elements to the template\n});\n\n// Add a new feature form with grouped fields\nconst form = new FeatureForm({\n container: \"form\",\n groupDisplay: \"sequential\", // only display one group at a time\n formTemplate: formTemplate // set it to template created above\n});"}],"values":[],"optional":true,"required":false},{"name":"groupDisplay","type":"\"all\" | \"sequential\"","complexType":{"original":"\"all\" | \"sequential\"","resolved":"\"all\" | \"sequential\"","references":{}},"mutable":true,"attr":"group-display","reflectToAttr":false,"docs":"String indicating the\n[groupDisplay](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureForm/#groupDisplay) and how they will be displayed to the end user. This only applies if using [grouped field elements](https://developers.arcgis.com/javascript/latest/references/core/form/elements/GroupElement/) configured in the Editor's [layer infos](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/types/#LayerInfo).\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nall | All groups will be expanded.\nsequential | A single group will be expanded at a time.","docsTags":[{"name":"since","text":"4.10"},{"name":"see","text":"[Sample - Update Feature Attributes](https://developers.arcgis.com/javascript/latest/sample-code/editing-groupedfeatureform/)"}],"default":"\"all\"","values":[{"type":"string","value":"all"},{"type":"string","value":"sequential"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the [FormTemplate#title](https://developers.arcgis.com/javascript/latest/references/core/form/FormTemplate/#title) of the form.\nBy default, the title is rendered as a level 2 heading (e.g. `

Form title

`).\nIn addition, group element labels default to a level 3 heading (e.g. `

Group element label

`).\nDepending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[{"name":"since","text":"4.20"},{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"example","text":"// form title will render as an

\n// group element labels will render as an

\nfeatureForm.headingLevel = 3;"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideReadOnlyNotice","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-read-only-notice","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"form-field\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layer","type":"FeatureFormLayerUnion | null | undefined","complexType":{"original":"FeatureFormLayerUnion | null | undefined","resolved":"FeatureFormLayerUnion | null | undefined","references":{"FeatureFormLayerUnion":{"location":"import","path":"@arcgis/core/widgets/FeatureForm/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Layer containing the editable feature attributes.\nIf this layer is not specified, it is the same as the\n[graphic's layer](https://developers.arcgis.com/javascript/latest/references/core/Graphic/#layer).","docsTags":[{"name":"example","text":"const form = new FeatureForm({\n container: \"formDiv\", // HTML div\n layer: featureLayer // Feature layer\n});"}],"values":[],"optional":true,"required":false},{"name":"map","type":"Map | null | undefined","complexType":{"original":"Map | null | undefined","resolved":"Map | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Map.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A map is required when the input [layer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form/#layer) has a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use the `$map` profile variable to access data from layers within a map. Without a map, expressions that use `$map` will throw an error.","docsTags":[{"name":"see","text":"[Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"},{"name":"since","text":"5.0"},{"name":"example","text":"```\n// The building footprints represent the buildings that intersect a clicked parcel\nlet buildingFootprints = Intersects($feature, FeatureSetByName($map, \"Building Footprints\"));\n```"}],"default":"null","values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"FeatureFormViewModelState","complexType":{"original":"FeatureFormViewModelState","resolved":"FeatureFormViewModelState","references":{"FeatureFormViewModelState":{"location":"import","path":"@arcgis/core/widgets/FeatureForm/FeatureFormViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"timeZone","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"The timezone displayed within the form. If `unknown`, it first checks if the layer has a [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#preferredTimeZone). If so, it displays this. If not, it will default to UTC.","docsTags":[{"name":"since","text":"4.28"}],"values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeatureForm = document.createElement(\"arcgis-feature-form\");\ndocument.body.append(arcgisFeatureForm);\nawait arcgisFeatureForm.componentOnReady();\nconsole.log(\"arcgis-feature-form is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"getValues","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"getValues(): Promise","parameters":[],"docs":"Returns all of the field values, regardless of update status.","docsTags":[]},{"name":"submit","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"submit(): Promise","parameters":[],"docs":"Fires the submit event.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSubmit","detail":"SubmitEvent","bubbles":true,"complexType":{"original":"SubmitEvent","resolved":"SubmitEvent","references":{"SubmitEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureForm/FeatureFormViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the [submit()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form/#submit) method is called.","docsTags":[]},{"event":"arcgisValueChange","detail":"ValueChangeEvent","bubbles":true,"complexType":{"original":"ValueChangeEvent","resolved":"ValueChangeEvent","references":{"ValueChangeEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureForm/FeatureFormViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a field value is updated.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/feature-next/feature-next.tsx","tag":"arcgis-feature-next","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n> The Feature (next) component is the successor to the Feature component, provided to you early for testing and feedback. In version 6.0, the implementation of [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) will be updated under the hood to that of [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/), and this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Feature (next) component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\nThis component is useful in instances where you want to display information about a graphic but without\nthe use of an [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/).\n\nTo show a graphic's content with [actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), [related records](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/), aggregate feature browser ([clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate) or [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate)), etc., then use the [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/) component.\n\nWhen Arcade expressions that use `$map` or [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) are defined in any popup template content or as expression elements,\nthe [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#map) and [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#spatialReference) properties need to be defined in the Feature (next) component.","docsTags":[{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"},{"name":"see","text":"[Arcade - expression language](https://developers.arcgis.com/javascript/latest/arcade/)"},{"name":"beta"},{"name":"since","text":"5.1"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"chartAnimationDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"chart-animation-disabled","reflectToAttr":false,"docs":"Indicates whether to disable chart animation in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"defaultPopupTemplateEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"default-popup-template-enabled","reflectToAttr":false,"docs":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"graphic","type":"Graphic | null | undefined","complexType":{"original":"Graphic | null | undefined","resolved":"Graphic | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) used to represent the feature.","docsTags":[{"name":"see","text":"[PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content)"},{"name":"example","text":"```js\nlet graphic = new Graphic({\n geometry: view.center,\n attributes: {\n name: \"Spruce\",\n family: \"Pinaceae\",\n count: 126\n },\n symbol: new SimpleMarkerSymbol({\n style: \"square\",\n color: \"blue\",\n size: \"8px\"\n }),\n popupTemplate: {\n content: [\n {\n // Set popup template content\n }\n ]\n }\n});\n```"}],"default":"null","values":[],"optional":true,"required":false},{"name":"heading","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The title for the feature. This can be disabled by setting the [hideHeading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#hideHeading) property to `true`.","docsTags":[{"name":"see","text":"[headingLevel](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#headingLevel)"},{"name":"see","text":"[hideHeading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#hideHeading)"},{"name":"readonly","text":""}],"default":"null","values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the headings in the component.","docsTags":[],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideAttachmentsContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-attachments-content","reflectToAttr":false,"docs":"Indicates whether to hide [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-content","reflectToAttr":false,"docs":"Indicates whether to hide the component's content.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCustomContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-custom-content","reflectToAttr":false,"docs":"Indicates whether to hide [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideExpressionContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-expression-content","reflectToAttr":false,"docs":"Indicates whether to hide [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFieldsContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-fields-content","reflectToAttr":false,"docs":"Indicates whether to hide [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-heading","reflectToAttr":false,"docs":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#heading).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLastEditedInfo","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-last-edited-info","reflectToAttr":false,"docs":"Indicates whether to hide the last edited info in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMediaContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-media-content","reflectToAttr":false,"docs":"Indicates whether to hide [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTextContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-text-content","reflectToAttr":false,"docs":"Indicates whether to hide [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"icon\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"isFeatureFromTable","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the current graphic resides in a non-spatial table.","docsTags":[{"name":"since","text":"5.1"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"location","type":"Point | null | undefined","complexType":{"original":"Point | null | undefined","resolved":"Point | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) representing the location of the map interaction used to trigger the opening of the component.","docsTags":[{"name":"since","text":"5.1"},{"name":"see","text":"[PopupTemplate#content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"},{"name":"example","text":"view.on(\"click\", (event) => {\n const { mapPoint } = event;\n feature.viewModel.location = mapPoint;\n});"}],"values":[],"optional":true,"required":false},{"name":"map","type":"Map | null | undefined","complexType":{"original":"Map | null | undefined","resolved":"Map | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Map.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A map is required when the input [graphic](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#graphic) has a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use the `$map` profile variable to access data from layers within a map. Without a map, expressions that use `$map` will throw an error.","docsTags":[{"name":"see","text":"[Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"},{"name":"example","text":"```js\n// The building footprints represent the buildings that intersect a clicked parcel\nlet buildingFootprints = Intersects($feature, FeatureSetByName($map, \"Building Footprints\"));\n```"}],"default":"null","values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"showRelationshipContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-relationship-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showUtilityNetworkContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-utility-network-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"spatialReference","type":"SpatialReference | null | undefined","complexType":{"original":"SpatialReference | null | undefined","resolved":"SpatialReference | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/SpatialReference.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.\nThis property should be set if the component executes Arcade expressions that contain [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/).","docsTags":[{"name":"see","text":"[Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"}],"default":"null","values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/popup/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"error"}],"optional":true,"required":false},{"name":"timeZone","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from [MapView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#timeZone). When a MapView is not associated with the component,\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and time are not adjusted for any timezone.\n- Specified IANA timezone: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-feature-next component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeatureNext = document.createElement(\"arcgis-feature-next\");\ndocument.body.append(arcgisFeatureNext);\nawait arcgisFeatureNext.componentOnReady();\nconsole.log(\"arcgis-feature-next is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"nextMedia","returns":{"type":"void","docs":""},"complexType":{"signature":"(contentElementIndex: number): void","parameters":[{"name":"contentElementIndex","type":"number","docs":""}],"return":"void","references":{}},"signature":"nextMedia(contentElementIndex: number): void","parameters":[{"name":"contentElementIndex","type":"number","docs":""}],"docs":"Paginates to the next [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.","docsTags":[]},{"name":"previousMedia","returns":{"type":"void","docs":""},"complexType":{"signature":"(contentElementIndex: number): void","parameters":[{"name":"contentElementIndex","type":"number","docs":""}],"return":"void","references":{}},"signature":"previousMedia(contentElementIndex: number): void","parameters":[{"name":"contentElementIndex","type":"number","docs":""}],"docs":"Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.","docsTags":[]},{"name":"setActiveMedia","returns":{"type":"void","docs":""},"complexType":{"signature":"(contentElementIndex: number, mediaInfoIndex: number): void","parameters":[{"name":"contentElementIndex","type":"number","docs":""},{"name":"mediaInfoIndex","type":"number","docs":""}],"return":"void","references":{}},"signature":"setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): void","parameters":[{"name":"contentElementIndex","type":"number","docs":""},{"name":"mediaInfoIndex","type":"number","docs":""}],"docs":"Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.","docsTags":[]},{"name":"updateGeometry","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"updateGeometry(): Promise","parameters":[],"docs":"Updates the geometry of the graphic.","docsTags":[{"name":"since","text":"5.1"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"flowItems\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"flowItems\" | \"state\"; }","resolved":"{ name: \"flowItems\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/feature-table/feature-table.tsx","tag":"arcgis-feature-table","overview":"","readme":"","usage":{},"docs":"The Feature Table component provides an interactive tabular view of each feature's attributes in a feature layer.","docsTags":[{"name":"since","text":"4.31"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"actionColumn","type":"ActionColumn | null | undefined","complexType":{"original":"ActionColumn | null | undefined","resolved":"ActionColumn | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/ActionColumn.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Reference to the current [action column](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/ActionColumn/). This column is only generated if a [configuration](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#actionColumnConfig) has been provided.","docsTags":[{"name":"since","text":"4.33"},{"name":"see","text":"[actionColumnConfig](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#actionColumnConfig)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"actionColumnConfig","type":"ActionColumnConfig | null | undefined","complexType":{"original":"ActionColumnConfig | null | undefined","resolved":"ActionColumnConfig | null | undefined","references":{"ActionColumnConfig":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Configuration for the [ActionColumn](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/ActionColumn/).\nThis property allows for customizing the action column's appearance and behavior.\nThe action column is a column that contains interactive buttons for each row.\nThese buttons can be used to perform actions such as editing, deleting, or\nviewing additional information about a feature. This column is displayed as the\nlast column in the table and is only displayed if this property is set.\n\n![featuretable action column](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/featuretable/action-column.avif)","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[actionColumn](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#actionColumn)"},{"name":"see","text":"[ActionColumn](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/ActionColumn/)"},{"name":"see","text":"[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"},{"name":"see","text":"[Sample - FeatureTable with row highlighting](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-row-highlights/)"},{"name":"example","text":"// The following snippet demonstrates how to configure an action column that adds a button\n// to each row which allows an end-user to zoom to the associated row's feature within the view.\nfeatureTable.actionColumnConfig = {\n label: \"Go to feature\",\n icon: \"zoom-to-object\",\n callback: (params) => {\n view.goTo(params.feature);\n }\n}"}],"values":[],"optional":true,"required":false},{"name":"activeFilters","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"FeatureTableSupportedFilters":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A read-only property indicating the type of filter used by the table.\nIt returns either filters by geometry or selections using a row's object ID.","docsTags":[{"name":"see","text":"[Sample - FeatureTable using a map](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-map/)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"activeSortOrders","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"ColumnSortOrder":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Use this read-only property if needing to query features while retaining\na column's sort order.","docsTags":[{"name":"since","text":"4.25"},{"name":"readonly","text":""}],"default":"[]","values":[],"optional":true,"required":false},{"name":"allColumns","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/Column.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A flattened array of all [columns](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/Grid/Column/) within the table, including nested columns. Take note that [group columns](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/Grid/GroupColumn/) are separate entries. This property is useful when applying\nupdates to all columns, including nested columns, as it provides ease of use when iterating through all columns in the table.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"allRelatedTablesVisible","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates the table is displaying all related tables in \"show all\" mode.","docsTags":[{"name":"since","text":"4.31"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"allVisibleColumns","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/Column.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A flattened array of all visible [columns](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/Grid/Column/) within the table, including nested columns. [Group columns](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/Grid/GroupColumn/) are separate entries.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"attachmentsColumns","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/AttachmentsColumn.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A flattened array of all [attachment columns](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/AttachmentsColumn/) within the table, including nested columns.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"attachmentsEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"attachments-enabled","reflectToAttr":false,"docs":"Indicates whether to display the `Attachments` field in the table. It displays the count of attachments per feature and is only applicable if the feature layer [supports attachments](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities).\n\n![featuretable attachmentsEnabled](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/featuretable/attachments-enabled.avif)","docsTags":[{"name":"see","text":"[FeatureLayer.capabilities.data.supportsAttachment](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"attachmentsViewOptions","type":"AttachmentsViewOptions","complexType":{"original":"AttachmentsViewOptions","resolved":"AttachmentsViewOptions","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/support/AttachmentsViewOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This read-only property provides the the configuration options for the attachments view.","docsTags":[{"name":"since","text":"4.33"}],"values":[],"optional":true,"required":false},{"name":"attributeTableTemplate","type":"AttributeTableTemplate | null | undefined","complexType":{"original":"AttributeTableTemplate | null | undefined","resolved":"AttributeTableTemplate | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/tables/AttributeTableTemplate.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Use this property to configure how columns display within the table in regard to visibility, column order, and sorting.\n\n> [!WARNING]\n>\n> This property differs from the [tableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#tableTemplate) property. The `tableTemplate` property provides more fine-grained control over how the table is rendered within the application by offering more advanced configurations such as custom cell rendering, column formatting, and more. It is useful for application-level development that remains within an application. Use the [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#attributeTableTemplate) property to access the table's settings across different applications. By using this property, the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/tables/AttributeTableTemplate/) and [TableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/TableTemplate/) documentation for more information.","docsTags":[{"name":"since","text":"4.31"},{"name":"see","text":"[Sample - FeatureTable Component](https://developers.arcgis.com/javascript/latest/sample-code/feature-table/)"}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"autoRefreshDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-refresh-disabled","reflectToAttr":false,"docs":"Indicates whether the table should automatically refresh when the underlying data changes.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"autoSaveDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-save-disabled","reflectToAttr":false,"docs":"Indicates whether the table should automatically save when the underlying data changes.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canAddRelatedFeature","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the table supports adding a related record based on the current relationship\nconfiguration. This accounts for whether table is currently configured to show related features.\nIf the table is not displaying related features, then the value of this property is always false.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"closed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closed","reflectToAttr":false,"docs":"Indicates whether the primary panel is closed. Once the panel is closed, the panel must be re-opened programmatically.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapsed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"collapsed","reflectToAttr":false,"docs":"Indicates whether the primary panel is collapsed. This only applies if the 'showCollapse' property has also been set to true.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"columnPerformanceModeDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"column-performance-mode-disabled","reflectToAttr":false,"docs":"Indicates whether to enable the table's column performance mode.\nThis mode is designed to improve the performance of the table when working with a large number of columns.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"columnReorderingDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"column-reordering-disabled","reflectToAttr":false,"docs":"Indicates whether the table should allow reordering of columns.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"columns","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/Column.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A read-only collection of column, field, group, action, attachment,\nand relationship columns that are displayed within the table.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"definitionExpression","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"definition-expression","reflectToAttr":false,"docs":"The SQL where clause used to filter features visible in the table. Only the features that satisfy the definition\nexpression are displayed in the table. This value takes priority over any definition expression set on the\nassociated layer.","docsTags":[{"name":"since","text":"4.33"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"description","type":"string | FeatureTableDescriptionFunction | null | undefined","complexType":{"original":"string | FeatureTableDescriptionFunction | null | undefined","resolved":"string | FeatureTableDescriptionFunction | null | undefined","references":{"FeatureTableDescriptionFunction":{"location":"import","path":"@arcgis/core/widgets/FeatureTable.js","id":"notImplemented"}}},"mutable":true,"attr":"description","reflectToAttr":false,"docs":"Text displayed in the table header, under the title. This can be a basic string or custom function that returns a string. This is useful in situations where additional context is needed for the table.","docsTags":[{"name":"since","text":"4.30"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":true,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"editingEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"editing-enabled","reflectToAttr":false,"docs":"Indicates whether [editing](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#editing-in-featuretable) is enabled on the data within the feature table. Double-clicking in a cell will enable editing for that value. In order to edit a feature, the layer must be editable and the user must have the appropriate permissions. In addition, the layer must contain an object ID field.","docsTags":[{"name":"since","text":"4.16"},{"name":"see","text":"[Editing within the FeatureTable](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#editing-in-featuretable)"},{"name":"see","text":"[Sample - FeatureTable with editing enabled](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-editing/)"},{"name":"see","text":"[Sample - FeatureTable with related data](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-relates/)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"effectiveSize","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Total number of records displayed in the table's current view.","docsTags":[{"name":"since","text":"4.31"},{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"fieldColumns","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/FieldColumn.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A flattened array of all [field columns](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/FieldColumn/) within the table, including nested columns.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"filterByLayerScaleRange","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"filter-by-layer-scale-range","reflectToAttr":false,"docs":"Indicates whether the table respects layer view scale visibility. If no view is provided, this property is ignored.\nThe table is empty when no layer view is available or when the layer view is not visible at the current scale.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterBySelectionEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"filter-by-selection-enabled","reflectToAttr":false,"docs":"Indicates whether the table only displays rows that are considered selected. Row selection can be modified by adding or removing associated object IDs from `highlightIds`. This will cause the store to fetch fresh features to ensure the expected sort order is honored.","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[Sample - FeatureTable with related data](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-relates/)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterByViewExtent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"filter-by-view-extent","reflectToAttr":false,"docs":"Indicates that the table should only display rows for features that are currently in the view's extent.\nThis property has no effect if the table has not been provided a view. If this property is true, the view's extent\nwill overwrite the current value of [filterGeometry](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#filterGeometry).","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterGeometry","type":"GeometryUnion | null | undefined","complexType":{"original":"GeometryUnion | null | undefined","resolved":"GeometryUnion | null | undefined","references":{"GeometryUnion":{"location":"import","path":"@arcgis/core/geometry/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Set this property to filter the features displayed in the table. It accepts a [Geometry](https://developers.arcgis.com/javascript/latest/references/core/geometry/Geometry/), e.g. [Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/), and uses it as a spatial filter. When modifying this property, the `FeatureTable` will completely refresh and re-query for all features.","docsTags":[{"name":"since","text":"4.19"},{"name":"see","text":"[Sample - FeatureTable using a map](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-map/)"},{"name":"see","text":"[Sample - FeatureTable with related data](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-relates/)"},{"name":"example","text":"// Listen for when the view is stationary.\n// If true, check the view's extent and set\n// the table to display only the attributes\n// for the features falling within this extent.\n\nreactiveUtils.when( () => view.stationary === true,\n() => {\n // Get the new extent of view/map whenever map is updated.\n if (view.extent) {\n // Filter out and show only the visible features in the feature table.\n featureTable.filterGeometry = view.extent;\n }\n}, { initial: true });"}],"values":[],"optional":true,"required":false},{"name":"groupColumns","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/GroupColumn.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A flattened array of all [group columns](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/Grid/GroupColumn/) within the table.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"hasContingentValues","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Convenience property indicating the data set contains contingent values. This includes contingent values in a related table.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hasInvalidPendingEdits","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates there are unsaved edits and that they are invalid. This includes invalid pending edits in a related table.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hasPendingEdits","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates there are unsaved edits. This includes edits in a related table.\nThis does not account for whether the edits are valid or not.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hiddenFields","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"TODO","docsTags":[{"name":"since","text":"4.16"},{"name":"see","text":"[TableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/TableTemplate/)"},{"name":"see","text":"[FieldColumnTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/FieldColumnTemplate/)"},{"name":"example","text":"const featureTable = new FeatureTable({\n layer: featureLayer,\n view: view,\n hiddenFields: [\"Primary_Type\", \"incident_date\"], // will not show these two fields within the table\n container: document.getElementById(\"tableDiv\")\n});"},{"name":"example","text":"// Set this syntax if needing to display a default hidden field, e.g. 'CreationDate`\nconst featureTable = new FeatureTable({\n layer: featureLayer,\n view: view,\n tableTemplate: { // autocastable to TableTemplate\n columnTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate\n { //autocastable to FieldColumnTemplate\n type: \"field\",\n fieldName: \"date_created\",\n label: \"Date created\",\n visible: true\n }]\n }\n container: document.getElementById(\"tableDiv\")\n});"}],"values":[],"optional":true,"required":false},{"name":"hideColumnDescriptions","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-column-descriptions","reflectToAttr":false,"docs":"Indicates whether to display descriptions in the header cells of individual columns.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideColumnMenuItemsSortAscending","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-column-menu-items-sort-ascending","reflectToAttr":false,"docs":"Indicates whether to display the 'Sort Ascending' menu item in column menus.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideColumnMenuItemsSortDescending","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-column-menu-items-sort-descending","reflectToAttr":false,"docs":"Indicates whether to display the 'Sort Descending' menu item in column menus.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideColumnMenus","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-column-menus","reflectToAttr":false,"docs":"Indicates whether to display the menu items within the individual columns.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideColumnVisibilityMenu","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-column-visibility-menu","reflectToAttr":false,"docs":"Indicates whether to display the column visibility menu in the table header.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideColumnVisibilityMenuItemsFilter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-column-visibility-menu-items-filter","reflectToAttr":false,"docs":"Indicates whether to display the filter in column visibility menu.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideColumnVisibilityMenuItemsHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-column-visibility-menu-items-header","reflectToAttr":false,"docs":"Indicates whether to display the header in column visibility menu.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideColumnVisibilityMenuItemsToggleAll","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-column-visibility-menu-items-toggle-all","reflectToAttr":false,"docs":"Indicates whether to display the 'toggle all' button in column visibility menu.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-header","reflectToAttr":false,"docs":"Indicates whether to display the feature table's header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLayerDropdownIcons","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-layer-dropdown-icons","reflectToAttr":false,"docs":"Indicates whether to display layer-specific icons in the layer drop down menu.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenu","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu","reflectToAttr":false,"docs":"Indicates whether to display the feature table's menu.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenuItemsClearSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu-items-clear-selection","reflectToAttr":false,"docs":"Indicates whether to display the 'Clear selection' menu item.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenuItemsDeleteSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu-items-delete-selection","reflectToAttr":false,"docs":"Indicates whether to display the' Delete Selection' menu item.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenuItemsExportSelectionToCsv","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu-items-export-selection-to-csv","reflectToAttr":false,"docs":"Indicates whether to display the 'Export selection to CSV' menu item.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenuItemsRefreshData","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu-items-refresh-data","reflectToAttr":false,"docs":"Indicates whether to display the 'Refresh data' menu item.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenuItemsSelectedRecordsShowAllToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu-items-selected-records-show-all-toggle","reflectToAttr":false,"docs":"Indicates whether to toggle between showing only selected records in the table to showing all of the records.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenuItemsSelectedRecordsShowSelectedToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu-items-selected-records-show-selected-toggle","reflectToAttr":false,"docs":"Indicates whether to display the 'Show selected records' menu item.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenuItemsToggleColumns","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu-items-toggle-columns","reflectToAttr":false,"docs":"Indicates whether to display the column visibility menu in the table header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","deprecation":"since 5.1. Use the 'hideColumnVisibilityMenu' property instead.","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenuItemsZoomToSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu-items-zoom-to-selection","reflectToAttr":false,"docs":"Indicates whether to display the 'Zoom to selection' menu item.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideProgress","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-progress","reflectToAttr":false,"docs":"Indicates whether to display the progress indicator when the table is querying or syncing data.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSelectionColumn","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-selection-column","reflectToAttr":false,"docs":"Indicates whether to display the selection column in the table.\nEach row has a checkbox that selects its corresponding feature.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTooltips","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-tooltips","reflectToAttr":false,"docs":"Indicates whether to display the tooltip for the Show/hide columns button.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlightDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"highlight-disabled","reflectToAttr":false,"docs":"Indicates whether to highlight the associated feature when a row is selected by checking the corresponding checkbox. This property is only applicable when working with a map and the [view](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#view) property is set.","docsTags":[{"name":"since","text":"4.25"},{"name":"see","text":"[Sample - FeatureTable with related data](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-relates/)"},{"name":"see","text":"[Sample - FeatureTable with popup interaction](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-popup-interaction/)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlightIds","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"ObjectId":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property accepts and returns a collection of feature object IDs. Use this to access and control which features are currently selected in the table and subsequently highlighted within the map. Once an application sets a collection of object IDs, the table will select the corresponding row and highlight its feature within the map.","docsTags":[{"name":"since","text":"4.25"},{"name":"see","text":"[highlightEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#highlightEnabled)"},{"name":"see","text":"[Sample - FeatureTable using a map](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-map/)"},{"name":"see","text":"[Sample - FeatureTable with popup interaction](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-popup-interaction/)"},{"name":"see","text":"[Sample - FeatureTable with related data](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-relates/)"},{"name":"see","text":"[Sample - FeatureTable with row highlighting](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-row-highlights/)"},{"name":"example","text":"// This example instantiates the table with highlighted features\nconst featureTable = new FeatureTable({\n view: view,\n layer: featureLayer,\n container: \"tableDiv\",\n highlightIds\n});\n\n// Push the object IDs into a collection and select\nfeatureTable.highlightIds.push(2, 3, 4);\n\n// Listen for changes in the collection of highlighted features\nfeatureTable.highlightIds.on(\"change\", (event) => {\n console.log(\"features selected\", event.added);\n console.log(\"features deselected\", event.removed);\n});"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Sample - FeatureTable with related data](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-relates/)"},{"name":"see","text":"[Sample - FeatureTable with custom content](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-custom-content/)"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"table\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"initialSize","type":"number | null | undefined","complexType":{"original":"number | null | undefined","resolved":"number | null | undefined","references":{}},"mutable":true,"attr":"initial-size","reflectToAttr":false,"docs":"The user-provided number of total features accessed from the data source. This is used for initial load of the data store as opposed to querying a specified layer. Additionally, the table will query data counts to verify the data's integrity, or when requested via [refresh()](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#refresh).","docsTags":[{"name":"since","text":"4.31"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"isQueryingOrSyncing","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"A read-only property which indicates if the table is querying or syncing data.","docsTags":[{"name":"since","text":"4.31"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"isSyncingAttachments","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates the table is syncing attachment edits.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The components label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layer","type":"FeatureTableSupportedLayer | null | undefined","complexType":{"original":"FeatureTableSupportedLayer | null | undefined","resolved":"FeatureTableSupportedLayer | null | undefined","references":{"FeatureTableSupportedLayer":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The associated [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/catalog/CatalogFootprintLayer/), [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/), [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/), [ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/),\n[KnowledgeGraphSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/knowledgeGraph/KnowledgeGraphSublayer/), [ParquetLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ParquetLayer/) [SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/), [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/), [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OrientedImageryLayer/)\nor [Sublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Sublayer/) containing the fields and attributes to display within the component.\n\n> [!WARNING]\n>\n> The table's pagination defaults to `50` records at a time. If the layer contains less than 50 records, it will use whatever count it has. Note that 0 records do not apply.\n> Support for [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/catalog/CatalogFootprintLayer/) was added at version 4.30.\n> Support for [ParquetLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ParquetLayer/) was added at version 4.34. Column sorting is not supported for ParquetLayer.\n> Support for [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/), [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/), [ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/), and [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/) was added at version 4.21.\n> For an [ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/) to work with FeatureTable, it must have a mosaic dataset.\n\n> [!WARNING]\n> Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.","docsTags":[{"name":"see","text":"[pageSize](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#pageSize)"}],"values":[],"optional":true,"required":false},{"name":"layerId","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"layer-id","reflectToAttr":false,"docs":"The layer ID of a layer in the service.\nUse with `layerUrl` when the service contains multiple layers and you want to specify which layer to use.","docsTags":[{"name":"since","text":"5.1"},{"name":"internal"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"layerItemId","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"layer-item-id","reflectToAttr":false,"docs":"The portal item ID of a layer.\n\n> [!WARNING]\n> Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layers","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"FeatureTableSupportedLayer":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Group of layers displayed in the dropdown component in the table's header,\nwhich allows changing what layer is currently displayed in the table.","docsTags":[{"name":"since","text":"4.30"}],"values":[],"optional":true,"required":false},{"name":"layerUrl","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"layer-url","reflectToAttr":false,"docs":"The URL to a layer's REST endpoint.\n\n> [!WARNING]\n> Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layerView","type":"LayerView | null | undefined","complexType":{"original":"LayerView | null | undefined","resolved":"LayerView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The layer view associated with the table's layer.","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[Sample - FeatureTable with row highlighting](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-row-highlights/)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"mapLayerId","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"map-layer-id","reflectToAttr":false,"docs":"The layer ID of a layer in the associated map.\nWhen set, the component will attempt to find and use the layer with the provided ID from the map.\n\n> [!WARNING]\n> Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.","docsTags":[{"name":"since","text":"5.1"},{"name":"example","text":"```html\n\n\n\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"maxSize","type":"number | null | undefined","complexType":{"original":"number | null | undefined","resolved":"number | null | undefined","references":{}},"mutable":true,"attr":"max-size","reflectToAttr":false,"docs":"This property is applicable when working with layers that contain a large number of features, as it provides the ability to limit the displayed total feature count. If [paginationEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#paginationEnabled) is `true`, and `maxSize` is greater than the current value of [pageSize](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#pageSize), multiple pages usually display. If `maxSize` is less than [pageSize](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#pageSize), a single page shows the total number of features limited to `maxSize`.","docsTags":[{"name":"since","text":"4.31"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"menuConfig","type":"TableMenuConfig | null | undefined","complexType":{"original":"TableMenuConfig | null | undefined","resolved":"TableMenuConfig | null | undefined","references":{"TableMenuConfig":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Set this object to customize the feature table's menu content.","docsTags":[{"name":"since","text":"4.16"}],"values":[],"optional":true,"required":false},{"name":"multipleSelectionDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"multiple-selection-disabled","reflectToAttr":false,"docs":"Controls whether the table allows multiple selected rows.","docsTags":[{"name":"since","text":"4.30\n\n> [!WARNING]\n>\n> This selection mode does not apply to the two default sort column menu items."}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"multipleSortEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"multiple-sort-enabled","reflectToAttr":false,"docs":"Indicates whether sorting multiple columns is supported within the table.","docsTags":[{"name":"since","text":"4.23"},{"name":"see","text":"[FieldColumnTemplate#initialSortPriority](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/FieldColumnTemplate/#initialSortPriority)"},{"name":"see","text":"[FieldColumnTemplate#direction](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/FieldColumnTemplate/#direction)"},{"name":"see","text":"[sortColumn()](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#sortColumn)"},{"name":"see","text":"[Sample - FeatureTable with editing enabled](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable-editing/)"},{"name":"see","text":"[Sample - FeatureTable](https://developers.arcgis.com/javascript/latest/sample-code/widgets-featuretable/)"},{"name":"example","text":"const featureTableVM = new FeatureTable({\n layer: featureLayer,\n multiSortEnabled: true,\n tableTemplate: { // autocastable to TableTemplate\n columnTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate\n { // autocastable to FieldColumnTemplate\n type: \"field\",\n fieldName: \"ObjectId\",\n direction: \"asc\", // In order to use initialSortPriority, make sure direction is set\n initialSortPriority: 1, // This field's sort order takes second-highest priority.\n },\n {\n type: \"field\",\n fieldName: \"Name\",\n direction: \"asc\", // In order to use initialSortPriority, make sure direction is set\n initialSortPriority: 0, // This field's sort order takes the highest priority.\n },\n {\n type: \"field\",\n fieldName: \"Status\",\n direction: \"asc\", // In order to use initialSortPriority, make sure direction is set\n initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.\n }]\n },\n container: \"tableDiv\"\n});"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"multipleSortPriority","type":"GridMultiSortPriority","complexType":{"original":"GridMultiSortPriority","resolved":"GridMultiSortPriority","references":{"GridMultiSortPriority":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"mutable":true,"attr":"multiple-sort-priority","reflectToAttr":false,"docs":"This property can be used to determine how newly sorted columns are prioritized. By default, newly sorted columns are\ngiven the highest sort priority.","docsTags":[{"name":"since","text":"4.33"}],"default":"\"prepend\"","values":[{"type":"string","value":"append"},{"type":"string","value":"prepend"}],"optional":true,"required":false},{"name":"navigationScale","type":"\"s\" | \"m\" | \"l\"","complexType":{"original":"\"s\" | \"m\" | \"l\"","resolved":"\"s\" | \"m\" | \"l\"","references":{}},"mutable":true,"attr":"navigation-scale","reflectToAttr":false,"docs":"This property controls the scale of all components in the navigation bar displayed when\nviewing attachments or related records.","docsTags":[{"name":"since","text":"4.33"}],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false},{"name":"noDataMessage","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"no-data-message","reflectToAttr":false,"docs":"This property can be used to override the text displayed when the table is fully loaded but no rows are available.","docsTags":[{"name":"since","text":"4.33"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"objectIds","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"ObjectId":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property accepts and returns a collection of feature object IDs. Use this to access and control which features are currently visible in the table.\nWhen the collection is empty, all potential rows are displayed. Modifying object IDs is not supported while [filterBySelectionEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#filterBySelectionEnabled) is `true` as these properties are mutually exclusive.\nThis filter can also be combined with [filterGeometry](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#filterGeometry) to display features that satisfy both conditions.","docsTags":[{"name":"since","text":"4.30"}],"values":[],"optional":true,"required":false},{"name":"outFields","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of field names from the table's data source to include when the table requests data. By default, all fields are requested. This property is useful when working with many fields and only a subset of them is needed for the table. Take note that doing so can improve the table's load time.","docsTags":[{"name":"since","text":"4.31"}],"values":[],"optional":true,"required":false},{"name":"pageCount","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Number of pages of features to be displayed in the table, based on the total [number of features](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#size) and configured [pageSize](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#pageSize).","docsTags":[{"name":"since","text":"4.31"},{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"pageIndex","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"page-index","reflectToAttr":false,"docs":"Represents the index of the page of the feature currently being displayed. The number of features per page can be adjusted by modifying the [pageSize](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#pageSize). [Pagination](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#paginationEnabled) must be enabled or the value of this property may not be not reliable due to virtualization of visible pages.","docsTags":[{"name":"since","text":"4.31"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"pageSize","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"page-size","reflectToAttr":false,"docs":"The default page size used when displaying features within the table. By default, the page loads the first 50 features returned by the service. It can be used with [paginationEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#paginationEnabled) to display a subset of features.\n\n> [!WARNING]\n>\n> It is not possible to overwrite the maximum page size on the server, ie. `maxRecordCount`, as this property only applies to set values less than the maximum page size, i.e. `maxRecordCount`, set on the service.","docsTags":[{"name":"since","text":"4.19"},{"name":"see","text":"[ArcGIS REST API - FeatureLayer - maxRecordCount](https://developers.arcgis.com/rest/services-reference/feature-layer.htm)"}],"default":"50","values":[{"type":"number"}],"optional":true,"required":false},{"name":"paginationEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"pagination-enabled","reflectToAttr":false,"docs":"Controls whether the table should only display a single page of features at any time. Current page can be determined via the [pageIndex](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#pageIndex) property. The current page can be modified by calling the [goToPage()](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#goToPage) method and passing in the desired [page index](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#pageIndex).","docsTags":[{"name":"since","text":"4.31"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"relatedRecordsEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"related-records-enabled","reflectToAttr":false,"docs":"Indicates whether to display any related records associated with rows within the table. Take note that related layers must be provided via the [layers](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#layers) property when there is no associated [view](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#view).","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[FeatureLayer.capabilities.data.supportsRelationships](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities)"},{"name":"see","text":"[FeatureLayer#relationships](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#relationships)"},{"name":"see","text":"[RelationshipColumn](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/RelationshipColumn/)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"relatedTable","type":"FeatureTable | null | undefined","complexType":{"original":"FeatureTable | null | undefined","resolved":"FeatureTable | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Reference to a nested table instance representing a relationship with another table.","docsTags":[{"name":"since","text":"4.31"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"relatedTables","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of nested table instances. This is typically used to represent relationships between each other.\nThese are configured and managed by a single table component instance. Only applies if this particular table instance is responsible for managing all nested tables.\nNested tables reference the main table controller via the [tableController](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#tableController) property.","docsTags":[{"name":"since","text":"4.31"}],"values":[],"optional":true,"required":false},{"name":"relationship","type":"Relationship | null | undefined","complexType":{"original":"Relationship | null | undefined","resolved":"Relationship | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/support/Relationship.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Reference to the relationship represented by the table.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"relationshipColumns","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/RelationshipColumn.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A flattened array of all [relationship columns](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/RelationshipColumn/) within the table, including nested columns.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"returnGeometryEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"return-geometry-enabled","reflectToAttr":false,"docs":"Indicates whether to fetch geometries for the corresponding features displayed in the table.\n\n> [!WARNING]\n>\n> Setting this to `true` can potentially impact the component's performance.","docsTags":[{"name":"since","text":"4.27"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"returnMEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"return-m-enabled","reflectToAttr":false,"docs":"Indicates whether geometries fetched for the corresponding features contain M values, if supported.\nThe [returnGeometryEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#returnGeometryEnabled) property must also be true.\n\n> [!WARNING]\n>\n> Setting this to `true` can potentially impact the component's performance.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"returnZEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"return-z-enabled","reflectToAttr":false,"docs":"Indicates whether the fetched features' geometries contain Z values. This is only applicable if Z-values are supported.\nThe [returnGeometryEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#returnGeometryEnabled) property must also be true.\n\n> [!WARNING]\n>\n> Setting this to `true` can potentially impact the component's performance.","docsTags":[{"name":"since","text":"4.30"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"rowHighlightIds","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"ObjectId":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property accepts and returns a collection of feature object IDs. It is used to access and control which rows display a darker background, i.e., highlighted. Take note that highlighted rows are not considered selected as this property is independent of the table's selection state. Use the [highlightIds](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#highlightIds) property to choose rows. Setting `rowHighlightIds` applies an alternative highlight style to an entire row or rows.\n\n>\n> Use this property to highlight rows based on an event or action from another component (e.g. the view). For example, purposefully highlighting rows when hovering over a feature on the map or applying a \"filter\" via another component to call out specific rows in the table. Generally, this property is not modified based on table events but rather an event or action from a different component.","docsTags":[{"name":"since","text":"4.30"},{"name":"example","text":"// This snippet adds an event listener which highlights (not selects) a row in the table\n// when a mouse pointer hovers over its corresponding row.\nfeatureTable.on(\"cell-pointerover\", (event) => {\n// Add the event's feature to the rowHighlightIds collection if it's not already included\n if (!featureTable.rowHighlightIds.includes(event.objectId)) {\n featureTable.rowHighlightIds.push(event.objectId);\n }\n});\n// This snippet adds an event listener which removes the highlight from a row in the table\n// when a mouse pointer moves out of its corresponding row.\nfeatureTable.on(\"cell-pointerout\", (event) => {\n // Remove the event's feature from the rowHighlightIds collection if it's included\n const index = featureTable.rowHighlightIds.indexOf(event.objectId);\n if (index > -1) {\n featureTable.rowHighlightIds.splice(index, 1);\n }\n});"}],"values":[],"optional":true,"required":false},{"name":"selectionManager","type":"SelectionManager | null | undefined","complexType":{"original":"SelectionManager | null | undefined","resolved":"SelectionManager | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SelectionManager.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Use this property to supply a custom [SelectionManager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) that overrides the default selection manager.\nThis is useful when applications want to share selection sets between components, without relying on the view's selection manager. This property is ignored if [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#syncViewSelection) is `true`.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"}],"values":[],"optional":true,"required":false},{"name":"showClose","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-close","reflectToAttr":false,"docs":"Indicates whether to display a close button in the table panel header.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCollapse","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse","reflectToAttr":false,"docs":"Indicates whether to display a collapse button in the table panel header.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showLayerDropdown","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-layer-dropdown","reflectToAttr":false,"docs":"Indicates whether to display the feature table's layer switch drop down menu.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"size","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Total number of records currently displayed in the table.","docsTags":[{"name":"since","text":"4.30"},{"name":"readonly","text":""}],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"state","type":"FeatureTableState","complexType":{"original":"FeatureTableState","resolved":"FeatureTableState","references":{"FeatureTableState":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loaded"},{"type":"string","value":"loading"},{"type":"string","value":"error"}],"optional":true,"required":false},{"name":"supportsAddAttachments","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the table and associated layer support adding attachments with the current configuration.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"supportsAttachments","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the table and associated layer support viewing attachments with the current configuration.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"supportsDeleteAttachments","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the table and associated layer support deleting attachments with the current configuration.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"supportsResizeAttachments","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Defines whether or not the feature supports resizing\nattachments. This depends on whether the\nfeature layer's [capabilities.attachment.supportsResize](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities) is set to `true`.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"supportsUpdateAttachments","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the table and associated layer support updating attachments with the current configuration.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"syncTemplateOnChangesDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"sync-template-on-changes-disabled","reflectToAttr":false,"docs":"Indicates whether the table should synchronize the current attributeTableTemplate\nbeing used based on changes made to the table's UI.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"syncViewSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"sync-view-selection","reflectToAttr":false,"docs":"Controls whether the table should sync with the view's selection manager.\nThis does not include selection sources, which must be configured independently\non the view's selection manager.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"tableController","type":"FeatureTable | null | undefined","complexType":{"original":"FeatureTable | null | undefined","resolved":"FeatureTable | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Reference to top-level controller table, if this table is a related table, nested within and controlled by another table.","docsTags":[{"name":"since","text":"4.31"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"tableDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"table-disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","deprecation":"since 5.0, use `element.disabled` instead.","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"tableParent","type":"FeatureTable | null | undefined","complexType":{"original":"FeatureTable | null | undefined","resolved":"FeatureTable | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Reference to a table instance that this table is directly related to.","docsTags":[{"name":"since","text":"4.31"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"tableTemplate","type":"TableTemplate | null | undefined","complexType":{"original":"TableTemplate | null | undefined","resolved":"TableTemplate | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/support/TableTemplate.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The associated [template](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/TableTemplate/) used for the feature table.\n\nThe [TableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/TableTemplate/) is where you configure how the feature table should display and set any associated properties for the table and its columns.\n\n> [!WARNING]\n>\n> The `TableTemplate` provides more fine-grained control over how the table is rendered within the application by offering more advanced configurations such as custom cell rendering, column formatting, and more. `TableTemplate` is useful for application-level development that remains within an application. This property differs from the [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#attributeTableTemplate) property as that property should be used to access the table's settings across different applications. By using [attributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#attributeTableTemplate), the settings can be saved within a webmap or layer. Please refer to the [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/references/core/tables/AttributeTableTemplate/) and [TableTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/support/TableTemplate/) documentation for more information.\n\n> [!WARNING]\n>\n> Take note that it is required to set the `type` property when creating column templates.","docsTags":[{"name":"since","text":"4.24\n\n> [!WARNING]\n>\n> Take note that it is required to set the `type` property when creating column templates."},{"name":"example","text":"const tableTemplate = new TableTemplate({\n columnTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate\n { // autocasts to FieldColumnTemplate\n type: \"field\", // This must be set when creating field column templates\n fieldName: \"ObjectId\",\n direction: \"asc\", // In order to use initialSortPriority, make sure direction is set\n initialSortPriority: 1 // This field's sort order takes the second-highest priority.\n },\n {\n type: \"field\",\n fieldName: \"NAME\",\n label: \"Name\",\n direction: \"asc\", // In order to use initialSortPriority, make sure direction is set\n initialSortPriority: 0 // This field's sort order takes the highest priority\n },\n {\n type: \"field\",\n fieldName: \"STATUS\",\n label: \"Status\",\n direction: \"asc\", // In order to use initialSortPriority, make sure direction is set\n initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.\n }]\n});"}],"values":[],"optional":true,"required":false},{"name":"tableTitle","type":"string | FeatureTableTitleFunction | null | undefined","complexType":{"original":"string | FeatureTableTitleFunction | null | undefined","resolved":"string | FeatureTableTitleFunction | null | undefined","references":{"FeatureTableTitleFunction":{"location":"import","path":"@arcgis/core/widgets/FeatureTable.js","id":"notImplemented"}}},"mutable":true,"attr":"table-title","reflectToAttr":false,"docs":"Replacement title for the table. This can be a basic string or custom function that returns a string. This is useful in situations where it may be necessary to dynamically update titles based on the current state of the table.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"timeExtent","type":"TimeExtent | null | undefined","complexType":{"original":"TimeExtent | null | undefined","resolved":"TimeExtent | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/time/TimeExtent.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [TimeExtent](https://developers.arcgis.com/javascript/latest/references/core/time/TimeExtent/) in which to filter and display data within the FeatureTable component. Setting this property directly on the component or its [viewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/FeatureTableViewModel/#timeExtent) takes precedence over the layer's [FeatureLayer#timeExtent](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#timeExtent). If this property is set directly on the component, the table will not refresh when the layer's [TimeExtent](https://developers.arcgis.com/javascript/latest/references/core/time/TimeExtent/) changes.","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[FeatureLayer#timeExtent](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#timeExtent)"},{"name":"example","text":"// Filters the table to display only features that fit within the time extent\nreactiveUtils.watch(\n () => timeSlider.timeExtent,\n (extent) => {\n featureTable.timeExtent = extent;\n }\n);"}],"values":[],"optional":true,"required":false},{"name":"timeZone","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"Dates and times displayed in the component will be in terms of this time zone. If not supplied, the view's time zone is used (if available). Depending on the field type, individual columns may have their own unique time zone behavior when the time zone itself is `unknown`.\n\n> [!WARNING]\n>\n> The following considerations apply when working with date, time, and big integer field types:\n>\n> By default, the [FeatureTable](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/) displays timezones for `date` and `timestamp-offset` field [types](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Field/#type) reflecting the MapView's timezone. This timezone can be overridden by setting the table's [timeZone](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#timeZone) property.\n> If the table's [view](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#view) isn't set, and the table's [Feature#timeZone](https://developers.arcgis.com/javascript/latest/references/core/widgets/Feature/#timeZone) isn't set, the table defaults to `system` time. The only time that this is not the case is when there is a [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#preferredTimeZone) set on the table's layer. If the latter is true, the preferred time zone is used as opposed to `system`.","docsTags":[{"name":"since","text":"4.28"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"view","type":"LinkChartView | MapViewOrSceneView | null | undefined","complexType":{"original":"LinkChartView | MapViewOrSceneView | null | undefined","resolved":"LinkChartView | MapViewOrSceneView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/LinkChartView.js","id":"notImplemented"},"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-feature-table component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visibleColumns","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/Column.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A flattened array of all top-level visible columns. Take note that this does not include nested columns.","docsTags":[{"name":"since","text":"4.33"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false}],"methods":[{"name":"addPendingEdits","returns":{"type":"void","docs":""},"complexType":{"signature":"(edits: FeatureStoreEdits[]): void","parameters":[{"name":"edits","type":"FeatureStoreEdits[]","docs":"Pending edits to be cached. Edits must include a valid objectId and field name."}],"return":"void","references":{"FeatureStoreEdits":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"signature":"addPendingEdits(edits: FeatureStoreEdits[]): void","parameters":[{"name":"edits","type":"FeatureStoreEdits[]","docs":"Pending edits to be cached. Edits must include a valid objectId and field name."}],"docs":"Creates a pending edit with the specified parameters.\nA pending edit is not immediately saved to the layer.","docsTags":[{"name":"since","text":"5.0"},{"name":"example","text":"// Add pending edits for two cells in a single row\ntable.addPendingEdits(\n [\n {\n objectId: 1,\n updates: [\n { fieldName: \"Hotel_Name\", value: \"My Hotel\" },\n { fieldName: \"Address\", value: \"123 Hotel Street\" },\n ]\n }\n ]\n);"}]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeatureTable = document.createElement(\"arcgis-feature-table\");\ndocument.body.append(arcgisFeatureTable);\nawait arcgisFeatureTable.componentOnReady();\nconsole.log(\"arcgis-feature-table is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"deleteSelection","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(showWarningPrompt?: boolean): Promise","parameters":[{"name":"showWarningPrompt","type":"boolean","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"deleteSelection(showWarningPrompt?: boolean): Promise","parameters":[{"name":"showWarningPrompt","type":"boolean","docs":""}],"docs":"","docsTags":[]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"discardPendingEdits","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(edits?: DiscardPendingEditsParameters[] | null, showWarningPrompt?: boolean): Promise","parameters":[{"name":"edits","type":"DiscardPendingEditsParameters[] | null","docs":"Information about which pending edits should be canceled. If nothing is provided, all pending edits are discarded."},{"name":"showWarningPrompt","type":"boolean","docs":"Indicates the table should display a warning prompt, which allows users to confirm if pending edits should be discarded."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"DiscardPendingEditsParameters":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"signature":"discardPendingEdits(edits?: DiscardPendingEditsParameters[] | null, showWarningPrompt?: boolean): Promise","parameters":[{"name":"edits","type":"DiscardPendingEditsParameters[] | null","docs":"Information about which pending edits should be canceled. If nothing is provided, all pending edits are discarded."},{"name":"showWarningPrompt","type":"boolean","docs":"Indicates the table should display a warning prompt, which allows users to confirm if pending edits should be discarded."}],"docs":"Cancels any pending edits. This might be edits for a specific field or column, or\nall pending edits for a specific feature. If no parameters are supplied, all pending edits\nfor all features are discarded. Additionally, if showWarningPrompt is 'true', the value returned\nfrom this method will reflect whether or not the user chose to discard the pending edits.","docsTags":[{"name":"since","text":"5.0"},{"name":"example","text":"// Discard pending edits for single cell in a given row\ntable.discardPendingEdits([{ objectId: 1, fieldName: \"Address\" }]);\n\n// Discard pending edits for all cells in a given row\ntable.discardPendingEdits([{ objectId: 1 }]);\n\n// Discard all pending edits\ntable.discardPendingEdits();\n\n// Displays a confirmation prompt before discarding all pending edits\n// Returns 'true' if edits were discarded\nconst editsWereDiscarded = await table.discardPendingEdits(undefined, true);"}]},{"name":"exportSelectionToCSV","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(includeGeometry?: boolean): Promise","parameters":[{"name":"includeGeometry","type":"boolean","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"exportSelectionToCSV(includeGeometry?: boolean): Promise","parameters":[{"name":"includeGeometry","type":"boolean","docs":""}],"docs":"","docsTags":[]},{"name":"findColumn","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(fieldName: string): Promise","parameters":[{"name":"fieldName","type":"string","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/RelationshipColumn.js","id":"notImplemented"}}},"signature":"findColumn(fieldName: string): Promise","parameters":[{"name":"fieldName","type":"string","docs":""}],"docs":"","docsTags":[]},{"name":"getFeatureStoreItemByObjectId","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(objectId: number | string): Promise","parameters":[{"name":"objectId","type":"number | string","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"FeatureStoreItem":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/support/types.js","id":"notImplemented"}}},"signature":"getFeatureStoreItemByObjectId(objectId: number | string): Promise","parameters":[{"name":"objectId","type":"number | string","docs":""}],"docs":"Returns information about the feature with the provided object ID from the internal store.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"goToPage","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(index: number): Promise","parameters":[{"name":"index","type":"number","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"goToPage(index: number): Promise","parameters":[{"name":"index","type":"number","docs":""}],"docs":"","docsTags":[]},{"name":"hideColumn","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(fieldName: string): Promise","parameters":[{"name":"fieldName","type":"string","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"hideColumn(fieldName: string): Promise","parameters":[{"name":"fieldName","type":"string","docs":""}],"docs":"","docsTags":[]},{"name":"nextPage","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"nextPage(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"previousPage","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"previousPage(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"refresh","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"refresh(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"refreshCellContent","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"refreshCellContent(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"savePendingEdits","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"savePendingEdits(): Promise","parameters":[],"docs":"Attempts to save any pending edits. If any edits are invalid, the save will be rejected until the edits are in a valid state.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"scrollToBottom","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"scrollToBottom(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"scrollToIndex","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(index: number): Promise","parameters":[{"name":"index","type":"number","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"scrollToIndex(index: number): Promise","parameters":[{"name":"index","type":"number","docs":""}],"docs":"","docsTags":[]},{"name":"scrollToLeft","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"scrollToLeft(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"scrollToRow","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(objectId: number | string): Promise","parameters":[{"name":"objectId","type":"number | string","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"scrollToRow(objectId: number | string): Promise","parameters":[{"name":"objectId","type":"number | string","docs":""}],"docs":"","docsTags":[]},{"name":"scrollToTop","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"scrollToTop(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"showAllColumns","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"showAllColumns(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"showColumn","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(fieldName: string): Promise","parameters":[{"name":"fieldName","type":"string","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"showColumn(fieldName: string): Promise","parameters":[{"name":"fieldName","type":"string","docs":""}],"docs":"","docsTags":[]},{"name":"sortColumn","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(path: string, direction: \"asc\" | \"desc\"): Promise","parameters":[{"name":"path","type":"string","docs":""},{"name":"direction","type":"\"asc\" | \"desc\"","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"sortColumn(path: string, direction: \"asc\" | \"desc\"): Promise","parameters":[{"name":"path","type":"string","docs":""},{"name":"direction","type":"\"asc\" | \"desc\"","docs":""}],"docs":"","docsTags":[]},{"name":"toggleColumnVisibility","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(fieldName: string): Promise","parameters":[{"name":"fieldName","type":"string","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"toggleColumnVisibility(fieldName: string): Promise","parameters":[{"name":"fieldName","type":"string","docs":""}],"docs":"","docsTags":[]},{"name":"zoomToSelection","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomToSelection(): Promise","parameters":[],"docs":"","docsTags":[]}],"events":[{"event":"arcgisCellClick","detail":"TableInteractionCellClickEvent","bubbles":true,"complexType":{"original":"TableInteractionCellClickEvent","resolved":"TableInteractionCellClickEvent","references":{"TableInteractionCellClickEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a cell within the table is clicked.","docsTags":[]},{"event":"arcgisCellDblClick","detail":"TableInteractionCellDblclickEvent","bubbles":true,"complexType":{"original":"TableInteractionCellDblclickEvent","resolved":"TableInteractionCellDblclickEvent","references":{"TableInteractionCellDblclickEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a cell within the table is double-clicked.","docsTags":[{"name":"since","text":"5.1"}]},{"event":"arcgisCellKeydown","detail":"TableInteractionCellKeydownEvent","bubbles":true,"complexType":{"original":"TableInteractionCellKeydownEvent","resolved":"TableInteractionCellKeydownEvent","references":{"TableInteractionCellKeydownEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a key is pressed down within a cell within the table.","docsTags":[]},{"event":"arcgisCellPointerout","detail":"TableInteractionCellPointeroutEvent","bubbles":true,"complexType":{"original":"TableInteractionCellPointeroutEvent","resolved":"TableInteractionCellPointeroutEvent","references":{"TableInteractionCellPointeroutEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the mouse pointer is moved out of a cell within the table. This event is useful for scenarios highlighting for things like highlighting a feature in the view, while hovering, without requiring manual interaction to select a row. Another example: these events can also be used to show information about the cell in a tooltip attached to the mouse.","docsTags":[]},{"event":"arcgisCellPointerover","detail":"TableInteractionCellPointeroverEvent","bubbles":true,"complexType":{"original":"TableInteractionCellPointeroverEvent","resolved":"TableInteractionCellPointeroverEvent","references":{"TableInteractionCellPointeroverEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the mouse pointer is moved over a cell within the table.","docsTags":[]},{"event":"arcgisColumnReorder","detail":"TableInteractionColumnReorderEvent","bubbles":true,"complexType":{"original":"TableInteractionColumnReorderEvent","resolved":"TableInteractionColumnReorderEvent","references":{"TableInteractionColumnReorderEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureTable/Grid/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a column is reordered via drag-and-drop.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"effectiveSize\" | \"isQueryingOrSyncing\" | \"layerView\" | \"size\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"effectiveSize\" | \"isQueryingOrSyncing\" | \"layerView\" | \"size\" | \"state\"; }","resolved":"{ name: \"effectiveSize\" | \"isQueryingOrSyncing\" | \"layerView\" | \"size\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSelectionChange","detail":"CollectionChangeEvent","bubbles":true,"complexType":{"original":"CollectionChangeEvent","resolved":"CollectionChangeEvent","references":{"CollectionChangeEvent":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a row selection is added or removed.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/feature-templates/feature-templates.tsx","tag":"arcgis-feature-templates","overview":"","readme":"","usage":{},"docs":"The FeatureTemplates component is part of an editing workflow. Its main purpose is to display [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) templates from one or more feature layers.","docsTags":[{"name":"since","text":"5.1"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"applicationDisabledFunction","type":"((template: TemplateListItem) => boolean) | undefined","complexType":{"original":"((template: TemplateListItem) => boolean) | undefined","resolved":"((template: TemplateListItem) => boolean) | undefined","references":{"default":{"location":"import","path":"@arcgis/core/editing/templates/TemplateListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Provide a function to dynamically enable or disable templates in the component.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"applicationFilterFunction","type":"((template: TemplateListItem) => boolean) | undefined","complexType":{"original":"((template: TemplateListItem) => boolean) | undefined","resolved":"((template: TemplateListItem) => boolean) | undefined","references":{"default":{"location":"import","path":"@arcgis/core/editing/templates/TemplateListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Provide a function to dynamically hide/remove templates from the component.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"applicationTemplates","type":"Array | undefined","complexType":{"original":"Array | undefined","resolved":"Array | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"ITemplateSection":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Provide a list of sections and templates. If not supplied, the component will load the templates from the layers in the view.","docsTags":[],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-templates/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disableTemplatesMode","type":"\"never\" | \"scale\" | \"visible\"","complexType":{"original":"\"never\" | \"scale\" | \"visible\"","resolved":"\"never\" | \"scale\" | \"visible\"","references":{}},"mutable":true,"attr":"disable-templates-mode","reflectToAttr":false,"docs":"Decide if templates should be disabled when the layer is not visible, or not visible at the current scale.","docsTags":[],"default":"\"never\"","values":[{"type":"string","value":"never"},{"type":"string","value":"scale"},{"type":"string","value":"visible"}],"optional":true,"required":false},{"name":"display","type":"\"flat\" | \"grouped\"","complexType":{"original":"\"flat\" | \"grouped\"","resolved":"\"flat\" | \"grouped\"","references":{}},"mutable":true,"attr":"display","reflectToAttr":false,"docs":"Determine if templates should be shown grouped, or in a single flat list","docsTags":[],"default":"\"grouped\"","values":[{"type":"string","value":"flat"},{"type":"string","value":"grouped"}],"optional":true,"required":false},{"name":"effectiveTemplates","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"ITemplateSection":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The list of templates in the component","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"excludeTables","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"exclude-tables","reflectToAttr":false,"docs":"Determines if feature templates for tables should be shown","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"favorites","type":"Set","complexType":{"original":"Set","resolved":"Set","references":{"Set":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The list of templates in the component","docsTags":[{"name":"interface"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"favoritesEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"favorites-enabled","reflectToAttr":false,"docs":"Include a favorites used tab","docsTags":[{"name":"internal"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"favoritesFilterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"favorites-filter-text","reflectToAttr":false,"docs":"The text the user has entered to filter the list on the favorites tab","docsTags":[{"name":"internal"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"filterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-text","reflectToAttr":false,"docs":"The text the user has entered to filter the list","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"groupBy","type":"\"geometry\" | \"layer\"","complexType":{"original":"\"geometry\" | \"layer\"","resolved":"\"geometry\" | \"layer\"","references":{}},"mutable":true,"attr":"group-by","reflectToAttr":false,"docs":"When templates are grouped, determine the group by policy. Note: if the component has been supplied with applicationTemplates, the templates will keep the supplied groupings.","docsTags":[],"default":"\"layer\"","values":[{"type":"string","value":"geometry"},{"type":"string","value":"layer"}],"optional":true,"required":false},{"name":"groupByFunction","type":"((template: TemplateListItem) => string) | undefined","complexType":{"original":"((template: TemplateListItem) => string) | undefined","resolved":"((template: TemplateListItem) => string) | undefined","references":{"default":{"location":"import","path":"@arcgis/core/editing/templates/TemplateListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"If a group by function is supplied, then the templates will be grouped by this function.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"hideTemplateDescription","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-template-description","reflectToAttr":false,"docs":"Determine if the template description should be displayed","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTemplatesMode","type":"\"never\" | \"scale\" | \"visible\"","complexType":{"original":"\"never\" | \"scale\" | \"visible\"","resolved":"\"never\" | \"scale\" | \"visible\"","references":{}},"mutable":true,"attr":"hide-templates-mode","reflectToAttr":false,"docs":"Decide if templates should be hidden when the layer is not visible, or not visible at the current scale.","docsTags":[],"default":"\"never\"","values":[{"type":"string","value":"never"},{"type":"string","value":"scale"},{"type":"string","value":"visible"}],"optional":true,"required":false},{"name":"layers","type":"(LayerWithFeatureTemplatesUnion | SubtypeGroupLayer)[] | undefined","complexType":{"original":"(LayerWithFeatureTemplatesUnion | SubtypeGroupLayer)[] | undefined","resolved":"(LayerWithFeatureTemplatesUnion | SubtypeGroupLayer)[] | undefined","references":{"LayerWithFeatureTemplatesUnion":{"location":"import","path":"@arcgis/core/layers/types.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/layers/SubtypeGroupLayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of layers for which to show Templates. If not provided, the layers will be derived from the View.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"minRequiredFilterCount","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-required-filter-count","reflectToAttr":false,"docs":"Automatically hide the filter if below a certain number of templates.","docsTags":[{"name":"internal"}],"default":"2","values":[{"type":"number"}],"optional":true,"required":false},{"name":"recentFilterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"recent-filter-text","reflectToAttr":false,"docs":"The text the user has entered to filter the list on the recent tab","docsTags":[{"name":"internal"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"recentlyUsed","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The list of recently used template ids.","docsTags":[{"name":"interface"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"recentlyUsedEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"recently-used-enabled","reflectToAttr":false,"docs":"Include a recently used tab","docsTags":[{"name":"internal"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"restoreFavorites","type":"(() => Promise>) | undefined","complexType":{"original":"(() => Promise>) | undefined","resolved":"(() => Promise>) | undefined","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"Array":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function which restores the list of favorites from a previous session","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"restoreRecentlyUsed","type":"(() => Promise>) | undefined","complexType":{"original":"(() => Promise>) | undefined","resolved":"(() => Promise>) | undefined","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"Array":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function which restores the list of recently used templates from a previous session","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"sectionSortBy","type":"\"alphabetical\" | \"system\"","complexType":{"original":"\"alphabetical\" | \"system\"","resolved":"\"alphabetical\" | \"system\"","references":{}},"mutable":true,"attr":"section-sort-by","reflectToAttr":false,"docs":"When templates are grouped, determine how the groups are sorted. If the component has been supplied with a sectionSortByFunction then this will be used instead.","docsTags":[],"default":"\"system\"","values":[{"type":"string","value":"alphabetical"},{"type":"string","value":"system"}],"optional":true,"required":false},{"name":"sectionSortByFunction","type":"((sections: ITemplateSection[]) => ITemplateSection[]) | undefined","complexType":{"original":"((sections: ITemplateSection[]) => ITemplateSection[]) | undefined","resolved":"((sections: ITemplateSection[]) => ITemplateSection[]) | undefined","references":{"ITemplateSection":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"If provided, this function can be used to re-order the sections.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"selectedTemplate","type":"TemplateListItem | undefined","complexType":{"original":"TemplateListItem | undefined","resolved":"TemplateListItem | undefined","references":{"default":{"location":"import","path":"@arcgis/core/editing/templates/TemplateListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Currently selected template","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedTemplateId","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"selected-template-id","reflectToAttr":false,"docs":"Currently selected template id","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"sharedTemplatesDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"shared-templates-disabled","reflectToAttr":false,"docs":"Fetch shared templates, if the layer's in the view have shared Templates.","docsTags":[{"name":"internal"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse-button","reflectToAttr":false,"docs":"Indicates whether to display the collapse button.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showFilter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-filter","reflectToAttr":false,"docs":"Indicates whether to show the templates filter","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"templateSortBy","type":"\"alphabetical\" | \"system\"","complexType":{"original":"\"alphabetical\" | \"system\"","resolved":"\"alphabetical\" | \"system\"","references":{}},"mutable":true,"attr":"template-sort-by","reflectToAttr":false,"docs":"Determines how templates are ordered. This will either be in alphabetical order\nor the order they are defined in the layer schema.","docsTags":[],"default":"\"alphabetical\"","values":[{"type":"string","value":"alphabetical"},{"type":"string","value":"system"}],"optional":true,"required":false},{"name":"templateSortByFunction","type":"((templates: TemplateListItem[]) => TemplateListItem[]) | undefined","complexType":{"original":"((templates: TemplateListItem[]) => TemplateListItem[]) | undefined","resolved":"((templates: TemplateListItem[]) => TemplateListItem[]) | undefined","references":{"default":{"location":"import","path":"@arcgis/core/editing/templates/TemplateListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"If provided, this function can be used to re-order the templates.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"updating","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Determine if the templates list is updating.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-feature-templates component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeatureTemplates = document.createElement(\"arcgis-feature-templates\");\ndocument.body.append(arcgisFeatureTemplates);\nawait arcgisFeatureTemplates.componentOnReady();\nconsole.log(\"arcgis-feature-templates is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"effectiveTemplates\" | \"filterText\" | \"recentlyUsed\" | \"favorites\"; }","bubbles":true,"complexType":{"original":"{ name: \"effectiveTemplates\" | \"filterText\" | \"recentlyUsed\" | \"favorites\"; }","resolved":"{ name: \"effectiveTemplates\" | \"filterText\" | \"recentlyUsed\" | \"favorites\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSelectTemplate","detail":"{ template: TemplateListItem; }","bubbles":true,"complexType":{"original":"{ template: TemplateListItem; }","resolved":"{ template: TemplateListItem; }","references":{"default":{"location":"import","path":"@arcgis/core/editing/templates/TemplateListItem.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"The user has selected a template","docsTags":[]},{"event":"arcgisTemplatesChanged","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"The source of templates has changed.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/feature-templates/components/template-image/template-image.tsx","tag":"arcgis-template-image","overview":"","readme":"","usage":{},"docs":"The Template Image component generates a feature swatch representing a\nFeature Template.","docsTags":[{"name":"since","text":"5.1"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"template","type":"TemplateListItem | undefined","complexType":{"original":"TemplateListItem | undefined","resolved":"TemplateListItem | undefined","references":{"default":{"location":"import","path":"@arcgis/core/editing/templates/TemplateListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisTemplateImage = document.createElement(\"arcgis-template-image\");\ndocument.body.append(arcgisTemplateImage);\nawait arcgisTemplateImage.componentOnReady();\nconsole.log(\"arcgis-template-image is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/feature-templates-legacy/feature-templates-legacy.tsx","tag":"arcgis-feature-templates-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe FeatureTemplates component is part of an editing workflow. Its main purpose is to display [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) templates from one or more feature layers.","docsTags":[{"name":"since","text":"5.0"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-templates-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabledItemFunction","type":"DisabledItemFunction","complexType":{"original":"DisabledItemFunction","resolved":"DisabledItemFunction","references":{"DisabledItemFunction":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function that can be defined to disable specific\n[template items](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/)\nwithin the component. The function takes an object containing a\n[layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/#layer)\nand [template](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/#template). If the function returns `true`, the item is disabled.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"enableListScroll","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"enable-list-scroll","reflectToAttr":false,"docs":"Indicates whether the list of available feature [template items](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/) should scroll within its containing element.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterFunction","type":"Filter | null | undefined","complexType":{"original":"Filter | null | undefined","resolved":"Filter | null | undefined","references":{"Filter":{"location":"import","path":"@arcgis/core/widgets/FeatureTemplates/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A defined [function](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/types/#Filter) used to help filter\n[template items](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/) within the component.\nA custom function can be used to aid when searching for templates. It takes a function which passes in\nan object containing a [name](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/#label)\nproperty of the [template item](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/).\n\n![featureTemplatesFilterFunction](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/featureTemplatesFilterFunction.avif)","docsTags":[{"name":"example","text":"// Filter and display templates only if their labels contain the word `Street`\nfunction myFilterFunction(filter) {\n let containsName = filter.label.includes(\"Street\");\n return containsName;\n}\n\n// Create the FeatureTemplates widget\ntemplates = new FeatureTemplates({\n container: \"templatesDiv\",\n visibleElements: {\n filter: false, // disable the default filter UI\n },\n layers: [featureLayer], // in this example, one layer is used\n filterFunction: myFilterFunction\n});"}],"values":[],"optional":true,"required":false},{"name":"filterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-text","reflectToAttr":false,"docs":"Text used to filter items.","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"groupBy","type":"GroupByType | null | undefined","complexType":{"original":"GroupByType | null | undefined","resolved":"GroupByType | null | undefined","references":{"GroupByType":{"location":"import","path":"@arcgis/core/widgets/FeatureTemplates/types.js","id":"notImplemented"}}},"mutable":true,"attr":"group-by","reflectToAttr":false,"docs":"It is possible to group [template items](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/). This can aid\nin managing various template items and how they display within the component. The values are discussed below.\n\nType | Description | Example\n----- | ----------- | -------\nlayer | This is the *default* grouping. Groups template items by layers. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupByLayers.avif)\ngeometry | Groups template items by geometry type. | ![FeatureTemplatesGroupByGeometry](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupByGeometry.avif)\nnone | The component displays everything in one list with no grouping. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupByNone.avif)\n[GroupByFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/types/#GroupByFunction) | Custom function that takes an object containing a [FeatureTemplate](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureTemplate/) and [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/). | ![FeatureTemplatesGroupByCustomGroupFunction](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupCustomGroup.avif)","docsTags":[{"name":"example","text":"// This example shows using a function to check if\n// the layer title contains the word 'military'. If so,\n// return a group of items called \"All Military Templates\"\nfunction customGroup(grouping) {\n // Consolidate all military layers\n if (grouping.layer.title.toLowerCase().indexOf(\"military\") > -1) {\n return \"All Military Templates\"\n }\n// Otherwise, group by layer title\n return grouping.layer.title;\n}\n\n// Create the FeatureTemplates widget\ntemplates = new FeatureTemplates({\n container: \"templatesDiv\",\n layers: layers,\n groupBy: customGroup\n});"}],"default":"\"layer\"","values":[{"type":"string","value":"layer"},{"type":"string","value":"none"},{"type":"string","value":"geometry"},{"type":"object"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the labels of grouped feature templates.\nBy default, the group label is rendered\nas a level 4 heading (e.g. `

Group label

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[{"name":"since","text":"4.20"},{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"example","text":"// Group label will render as an

\nfeatureTemplates.headingLevel = 3;"}],"default":"4","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideFilter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-filter","reflectToAttr":false,"docs":"Indicates whether the templates filter displays.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"list-rectangle\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"items","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTemplates/TemplateItemGroup.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layers","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/layers/SubtypeGroupLayer.js","id":"notImplemented"},"LayerWithFeatureTemplatesUnion":{"location":"import","path":"@arcgis/core/layers/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/)\nto display within the component. The order in which these layers are\nset in the array dictates how they display within the component.\n\n> [!WARNING]\n>\n> The component is designed to only display layers that are enabled for editing.\n> It will not display layers that are enabled to only edit attributes.","docsTags":[{"name":"example","text":"// The layers to display within the widget\nlet militaryUnits = new FeatureLayer({\n url: \"http://sampleserver6.arcgisonline.com/arcgis/rest/services/Military/FeatureServer/2\"\n});\n\nlet militaryHostile = new FeatureLayer({\n url: \"http://sampleserver6.arcgisonline.com/arcgis/rest/services/Military/FeatureServer/6\"\n});\n\nlet layers = [militaryUnits, militaryHostile];\n\n// Create FeatureTemplates widget\ntemplates = new FeatureTemplates({\n container: \"templatesDiv\",\n layers: layers\n});"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedItem","type":"TemplateItem | undefined","complexType":{"original":"TemplateItem | undefined","resolved":"TemplateItem | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTemplates/TemplateItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectionMode","type":"\"single\" | \"none\" | null | undefined","complexType":{"original":"\"single\" | \"none\" | null | undefined","resolved":"\"single\" | \"none\" | null | undefined","references":{}},"mutable":true,"attr":"selection-mode","reflectToAttr":false,"docs":"Specifies the selection behavior of list items. The `\"single\"` selection mode keeps the clicked list item selected. Whereas, `\"none\"` does not preserve the selection after clicking the list item.","docsTags":[],"default":"\"none\"","values":[{"type":"string","value":"single"},{"type":"string","value":"none"}],"optional":true,"required":false},{"name":"state","type":"FeatureTemplatesViewModelState","complexType":{"original":"FeatureTemplatesViewModelState","resolved":"FeatureTemplatesViewModelState","references":{"FeatureTemplatesViewModelState":{"location":"import","path":"@arcgis/core/widgets/FeatureTemplates/FeatureTemplatesViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A reference to the MapView or SceneView.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeatureTemplatesLegacy = document.createElement(\"arcgis-feature-templates-legacy\");\ndocument.body.append(arcgisFeatureTemplatesLegacy);\nawait arcgisFeatureTemplatesLegacy.componentOnReady();\nconsole.log(\"arcgis-feature-templates-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"select","returns":{"type":"void","docs":""},"complexType":{"signature":"(item: null | undefined | TemplateItem): void","parameters":[{"name":"item","type":"null | undefined | TemplateItem","docs":"The template item to select."}],"return":"void","references":{"default":{"location":"import","path":"@arcgis/core/widgets/FeatureTemplates/TemplateItem.js","id":"notImplemented"}}},"signature":"select(item: null | undefined | TemplateItem): void","parameters":[{"name":"item","type":"null | undefined | TemplateItem","docs":"The template item to select."}],"docs":"Selects the template item to use.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSelect","detail":"SelectEvent","bubbles":true,"complexType":{"original":"SelectEvent","resolved":"SelectEvent","references":{"SelectEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureTemplates/FeatureTemplatesViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/features/features.tsx","tag":"arcgis-features","overview":"","readme":"","usage":{},"docs":"The Features component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without having to be tied to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component,\nhowever unlike Popup, the Features component can be placed outside of the map or scene component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features component, the same information that Popup provides is shown in a separate container from the map, such as\na HTML div within a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the map or scene component. To show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) component.\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) will be updated under the hood to that of [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/), and deprecated properties on this component will be removed. We encourage using the [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/) component and providing feedback.","docsTags":[{"name":"see","text":"[PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)"},{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"actions","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"PopupAction":{"location":"import","path":"@arcgis/core/widgets/Popup/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [action button](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionButton/) or [action toggle](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionToggle/) objects. Each action may be executed by clicking the icon or image symbolizing them.\nThere is a default `Zoom To` action styled with a magnifying glass icon to zoom in four LODs and center the map on the selected feature. This default action can be removed by setting [includeDefaultActionsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#includeDefaultActionsDisabled) to `true`, or by setting the [`overwriteActions`](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\n\nThe order of each action is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/). The [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#event-arcgisTriggerAction) event fires each time an action is clicked.","docsTags":[{"name":"see","text":"[@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#event-arcgisTriggerAction)"},{"name":"see","text":"[Popup actions sample](https://developers.arcgis.com/javascript/latest/sample-code/popup-actions/)"}],"values":[],"optional":true,"required":false},{"name":"active","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates if the component is active when it is visible and is not [waiting](https://developers.arcgis.com/javascript/latest/references/core/widgets/Features/FeaturesViewModel/#waitingForResult) for results.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"chartAnimationDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"chart-animation-disabled","reflectToAttr":false,"docs":"Disables chart animation within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapsed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"collapsed","reflectToAttr":false,"docs":"Indicates whether the component displays its content. If `true`, only the header displays.\nThis property is only honored if [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#showCollapseButton) is `true`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapseDirection","type":"\"down\" | \"up\" | undefined","complexType":{"original":"\"down\" | \"up\" | undefined","resolved":"\"down\" | \"up\" | undefined","references":{}},"mutable":true,"attr":"collapse-direction","reflectToAttr":false,"docs":"Controls the direction the content collapses when the collapse button is used.\nWhen unset, the component chooses a direction based on the [feature navigation placement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#featureNavigationTop).","docsTags":[{"name":"since","text":"5.1"},{"name":"see","text":"[showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#showCollapseButton)"},{"name":"see","text":"[collapsed](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#collapsed)"},{"name":"see","text":"[featureNavigationTop](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#featureNavigationTop)"}],"values":[{"type":"string","value":"down"},{"type":"string","value":"up"}],"optional":true,"required":false},{"name":"content","type":"string | HTMLElement | Widget | null | undefined","complexType":{"original":"string | HTMLElement | Widget | null | undefined","resolved":"string | HTMLElement | Widget | null | undefined","references":{"HTMLElement":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/Widget.js","id":"notImplemented"}}},"mutable":true,"attr":"content","reflectToAttr":false,"docs":"The content of the component. When set directly on the component, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content).","docsTags":[{"name":"example","text":"```js\n// This sets generic instructions in the component that will always be displayed\n// unless it is overridden by a PopupTemplate.\ncomponent.content = \"Click a feature on the map to view its attributes\";\n```"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"defaultPopupTemplateEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"default-popup-template-enabled","reflectToAttr":false,"docs":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"effectiveHeading","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The heading currently displayed for the selected feature. This value resolves to the selected feature's [PopupTemplate title](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#title) when available, otherwise it falls back to the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading).","docsTags":[{"name":"since","text":"5.1"},{"name":"see","text":"[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading)"},{"name":"see","text":"[selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature)"},{"name":"readonly","text":""}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"featureCount","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"feature-count","reflectToAttr":false,"docs":"The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) available in the component.","docsTags":[{"name":"since","text":"4.34"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"featureMenuOpen","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"feature-menu-open","reflectToAttr":false,"docs":"This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#initialDisplayMode) is set to \"feature\".","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"featureMenuTitle","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"feature-menu-title","reflectToAttr":false,"docs":"Sets the title to display on the component while viewing the feature menu.","docsTags":[{"name":"since","text":"4.34"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"featureNavigationTop","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"feature-navigation-top","reflectToAttr":false,"docs":"Indicates whether the feature navigation arrows are displayed at the top of the component.\nBy default, the navigation arrows are displayed at the bottom of the component.\nThis property also controls the collapse button's icon direction when the [collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#collapseDirection) property is not set. When `featureNavigationTop` is `true`, the collapse button icon defaults to collapsing \"up\" and when `false` it defaults to collapsing \"down\".","docsTags":[{"name":"since","text":"4.34"},{"name":"see","text":"[collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#collapseDirection)"},{"name":"see","text":"[showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#showCollapseButton)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"features","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of graphics associated with the component. Each graphic in this array must have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) set. They may share the same [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) or have unique [PopupTemplates](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) depending on their attributes. The [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#content) and [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading) of the component is set based on the `content` and `title` properties of each graphic's respective [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\n \nWhen more than one graphic exists in this array, the current content of the component is set based on the value of the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).\n\nThis value is `null` if no features are associated with the component.","docsTags":[{"name":"example","text":"```js\n// When setting the features property, the graphics pushed to this property\n// must have a PopupTemplate set.\nlet g1 = new Graphic();\ng1.popupTemplate = new PopupTemplate({\n title: \"Results title\",\n content: \"Results: {ATTRIBUTE_NAME}\"\n});\n// Set the graphics as an array to the popup instance. The content and title of\n// the component will be set depending on the PopupTemplate of the graphics.\n// Each graphic may share the same PopupTemplate or have a unique PopupTemplate\nlet graphics = [g1, g2, g3, g4, g5];\ncomponent.features = graphics;\n```"}],"values":[],"optional":true,"required":false},{"name":"featuresPerPage","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"features-per-page","reflectToAttr":false,"docs":"The number of features to fetch at one time.","docsTags":[],"default":"20","values":[{"type":"number"}],"optional":true,"required":false},{"name":"featureViewModelAbilities","type":"Abilities | null | undefined","complexType":{"original":"Abilities | null | undefined","resolved":"Abilities | null | undefined","references":{"Abilities":{"location":"import","path":"@arcgis/core/widgets/Feature/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/references/core/widgets/Feature/FeatureViewModel/#Abilities) that can be used when querying and displaying content.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | null | undefined","complexType":{"original":"GoToOverride | null | undefined","resolved":"GoToOverride | null | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"headerActions","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/support/actions/ActionToggle.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The actions that are displayed in the header of the component.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"heading","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"heading","reflectToAttr":false,"docs":"The title of the Features component. This can be set to any string value no\nmatter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the\ncorresponding template is used here.","docsTags":[{"name":"see","text":"[headingLevel](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#headingLevel)"},{"name":"since","text":"4.34"},{"name":"example","text":"```js\n// This title will display in the component unless a selected feature's\n// PopupTemplate overrides it.\nfeaturesComponent.title = \"Population by zip codes in Southern California\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading) of the component.\nBy default, the heading is rendered\nas a level 2 heading (e.g. `

Popup title

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideActionBar","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-action-bar","reflectToAttr":false,"docs":"Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#actions).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideAttachmentsContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-attachments-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-close-button","reflectToAttr":false,"docs":"Indicates whether to hide the close button in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show content within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCustomContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-custom-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideExpressionContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-expression-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureListLayerTitle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-list-layer-title","reflectToAttr":false,"docs":"Indicates whether to hide the group heading for a list of multiple features.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureMenuHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-menu-heading","reflectToAttr":false,"docs":"Indicates whether to hide the feature menu heading and description in the component's feature menu list.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureNavigation","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-navigation","reflectToAttr":false,"docs":"Indicates whether to hide the feature navigation in the component. This allows the user to scroll through various [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) using pagination arrows.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFieldsContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-fields-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-heading","reflectToAttr":false,"docs":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLastEditedInfo","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-last-edited-info","reflectToAttr":false,"docs":"This property provides the ability to hide or show the last edited info within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMediaContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-media-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideRelationshipContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-relationship-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSelectFeature","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-select-feature","reflectToAttr":false,"docs":"Indicates whether to hide the *select feature* action when viewing associated and related features.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSpinner","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-spinner","reflectToAttr":false,"docs":"Indicates whether to hide the spinner in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTextContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-text-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUtilityNetworkContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-utility-network-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlightDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"highlight-disabled","reflectToAttr":false,"docs":"Indicates whether to highlight the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature) in the associated\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName | undefined","complexType":{"original":"IconName | undefined","resolved":"IconName | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"includeDefaultActionsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"include-default-actions-disabled","reflectToAttr":false,"docs":"Indicates whether to include the default actions in the component.\nIn order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"initialDisplayMode","type":"InitialDisplayOptions","complexType":{"original":"InitialDisplayOptions","resolved":"InitialDisplayOptions","references":{"InitialDisplayOptions":{"location":"import","path":"@arcgis/core/widgets/Popup/types.js","id":"notImplemented"}}},"mutable":true,"attr":"initial-display-mode","reflectToAttr":false,"docs":"Indicates whether to initially display a list of features, or the content for one feature.","docsTags":[],"default":"\"feature\"","values":[{"type":"string","value":"list"},{"type":"string","value":"feature"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"map","type":"Map | null | undefined","complexType":{"original":"Map | null | undefined","resolved":"Map | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Map.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A map is required when the input [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) have a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use the `$map` profile variable to access data from layers within a map. Without a map, expressions that use `$map` will throw an error.\n\nAlternatively, the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#view) property can be used to provide the map instance for this property.","docsTags":[{"name":"see","text":"[Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"},{"name":"example","text":"```js\n// The building footprints represent the buildings that intersect a clicked parcel\nlet buildingFootprints = Intersects($feature, FeatureSetByName($map, \"Building Footprints\"));\n```"}],"default":"null","values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"open","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"open","reflectToAttr":false,"docs":"Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.","docsTags":[{"name":"see","text":"[active](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#active)"},{"name":"see","text":"[clear()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#clear)"},{"name":"since","text":"5.0"},{"name":"example","text":"```js\n// Listen for clicks on the view and open the component at the clicked location with custom content.\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n const { mapPoint } = event.detail;\n component.location = mapPoint;\n component.heading = \"You clicked here\";\n component.content = \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3);\n component.open = true;\n});\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"promises","type":"Array>>","complexType":{"original":"Array>>","resolved":"Array>>","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of pending Promises that have not yet been fulfilled. If there are\nno pending promises, the value is `null`. When the pending promises are\nresolved they are removed from this array and the features they return\nare pushed into the [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) array.","docsTags":[],"deprecation":"since 5.1.","values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedDrillInFeature","type":"Graphic | undefined","complexType":{"original":"Graphic | undefined","resolved":"Graphic | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The feature that the component has drilled into.\nThis feature is either associated with the selected feature in a [relationship](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/)\nor [utility network](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) element.","docsTags":[{"name":"since","text":"4.34"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedFeature","type":"Graphic | null","complexType":{"original":"Graphic | null","resolved":"Graphic | null","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The selected feature accessed by the Features component. The content displayed in the component is\ndetermined based on the [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) assigned to this feature.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedFeatureComponent","type":"ArcgisFeature | undefined","complexType":{"original":"ArcgisFeature | undefined","resolved":"ArcgisFeature | undefined","references":{"ArcgisFeature":{"location":"local","path":"components/arcgis-feature","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Returns a reference to the current [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) component.\nThis is useful if needing to get a reference to the Feature component in order to make any changes to it.","docsTags":[{"name":"since","text":"4.34"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedFeatureIndex","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"selected-feature-index","reflectToAttr":false,"docs":"Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) are set,\nthe first index is automatically selected.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"showCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse-button","reflectToAttr":false,"docs":"Indicates whether to show the collapse button in the component.","docsTags":[{"name":"see","text":"[collapsed](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#collapsed)"},{"name":"see","text":"[collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#collapseDirection)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"spatialReference","type":"SpatialReference | null | undefined","complexType":{"original":"SpatialReference | null | undefined","resolved":"SpatialReference | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/SpatialReference.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.\nThis property should be set if the Features component executes Arcade expressions that contain [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/).\n\nAlternatively, the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#view) property can be used to provide the spatial reference instance for this property.","docsTags":[{"name":"see","text":"[Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"}],"default":"null","values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/Popup/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"timeZone","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) if the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#view) property is set. When a MapView is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and time are not adjusted for any timezone.\n- `Specified IANA timezone`: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","docsTags":[{"name":"since","text":"4.30"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"updateLocationEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"update-location-enabled","reflectToAttr":false,"docs":"Indicates whether to update the component's location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex) changes.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A reference to the [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) or [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).\nThe Features component requires a `view` to be set if:\n- The [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) have a popupTemplate containing Arcade expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) or reference the `$map` profile variable (i.e. access data from layers within a map). Alternatively, set the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#map) property.\n- Content is displayed from the popup template of an [aggregate feature](https://developers.arcgis.com/javascript/latest/references/core/Graphic/#isAggregate) (i.e. a [cluster](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/) or [bin](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/)).\n- Values from `date` and `timestamp-offset` fields should respect the view's [time zone](https://developers.arcgis.com/javascript/latest/references/core/views/View/#timeZone).\nAlternatively, set the [timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#timeZone) property.\n- Using the `Zoom to` default action. If the `view` is not specified, set the [includeDefaultActionsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#includeDefaultActionsDisabled) property to `true` to remove this default action.","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"viewModel","type":"FeaturesViewModel","complexType":{"original":"FeaturesViewModel","resolved":"FeaturesViewModel","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Features/FeaturesViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"since","text":"4.34"}],"deprecation":"since 5.1. Use properties directly on the component instead of accessing them through the `viewModel`. For example, instead of `viewModel.active`, use `active`.","values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Removes [promises](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#promises), [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#content), and\n[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading) from the Features component.","docsTags":[]},{"name":"close","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"close(): Promise","parameters":[],"docs":"A convenience method to close the component.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeatures = document.createElement(\"arcgis-features\");\ndocument.body.append(arcgisFeatures);\nawait arcgisFeatures.componentOnReady();\nconsole.log(\"arcgis-features is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"fetchFeatures","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(screenPoint?: ScreenPoint, options?: FetchFeaturesOptions): Promise","parameters":[{"name":"screenPoint","type":"ScreenPoint","docs":""},{"name":"options","type":"FetchFeaturesOptions","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"FetchFeaturesOptions":{"location":"import","path":"@arcgis/core/widgets/Popup/types.js","id":"notImplemented"}}},"signature":"fetchFeatures(screenPoint?: ScreenPoint, options?: FetchFeaturesOptions): Promise","parameters":[{"name":"screenPoint","type":"ScreenPoint","docs":""},{"name":"options","type":"FetchFeaturesOptions","docs":""}],"docs":"Use this method to return feature(s) at a given screen location. These features are fetched from all of the [LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) in the [view](https://developers.arcgis.com/javascript/latest/references/core/views/View/). In order to use this, a layer must already have an associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled). This method allows a developer to control how the input location is handled. For example, you may want to fetch features on a `click` event or on a `pointer-move` event. This method automatically sets the location based on the input event's screen coordinates.","docsTags":[{"name":"deprecated"},{"name":"see","text":"[open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#open)"}],"deprecation":"since 5.1. Use the `fetchPopupFeatures` method on the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#fetchPopupFeatures), [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#fetchPopupFeatures), or [Link Chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#fetchPopupFeatures) component to fetch features based on a screen location."},{"name":"next","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/Features/FeaturesViewModel.js","id":"notImplemented"}}},"signature":"next(): Promise","parameters":[],"docs":"Selects the feature at the next index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).\n\n> [!WARNING]\n> The return type of `FeaturesViewModel` on the `next()` method is deprecated. At 6.0, this method will return void. See [arcgis-features-next.next()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#next) for the updated usage.","docsTags":[{"name":"see","text":"[selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex)"}]},{"name":"previous","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/Features/FeaturesViewModel.js","id":"notImplemented"}}},"signature":"previous(): Promise","parameters":[],"docs":"Selects the feature at the previous index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).\n\n> [!WARNING]\n> The return type of `FeaturesViewModel` on the `previous()` method is deprecated. At 6.0, this method will return void. See [arcgis-features-next.previous()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#previous) for the updated usage.","docsTags":[{"name":"see","text":"[selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex)"}]},{"name":"setFocus","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setFocus(): Promise","parameters":[],"docs":"Use this method to give focus to the Component if the component is able to be focused.","docsTags":[{"name":"since","text":"4.34"}]},{"name":"triggerAction","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(action: ActionButton | ActionToggle): Promise","parameters":[{"name":"action","type":"ActionButton | ActionToggle","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/support/actions/ActionToggle.js","id":"notImplemented"}}},"signature":"triggerAction(action: ActionButton | ActionToggle): Promise","parameters":[{"name":"action","type":"ActionButton | ActionToggle","docs":""}],"docs":"Triggers the [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#event-arcgisTriggerAction) event and executes the specified default action.","docsTags":[],"deprecation":"since 5.1. Trigger actions with manual user interaction within the component."}],"events":[{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"active\" | \"collapsed\" | \"effectiveHeading\" | \"featureCount\" | \"featureMenuOpen\" | \"features\" | \"promises\" | \"selectedDrillInFeature\" | \"selectedFeature\" | \"selectedFeatureComponent\" | \"selectedFeatureIndex\" | \"state\" | \"open\"; }","bubbles":true,"complexType":{"original":"{ name: \"active\" | \"collapsed\" | \"effectiveHeading\" | \"featureCount\" | \"featureMenuOpen\" | \"features\" | \"promises\" | \"selectedDrillInFeature\" | \"selectedFeature\" | \"selectedFeatureComponent\" | \"selectedFeatureIndex\" | \"state\" | \"open\"; }","resolved":"{ name: \"active\" | \"collapsed\" | \"effectiveHeading\" | \"featureCount\" | \"featureMenuOpen\" | \"features\" | \"promises\" | \"selectedDrillInFeature\" | \"selectedFeature\" | \"selectedFeatureComponent\" | \"selectedFeatureIndex\" | \"state\" | \"open\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTriggerAction","detail":"ActionEvent","bubbles":true,"complexType":{"original":"ActionEvent","resolved":"ActionEvent","references":{"ActionEvent":{"location":"import","path":"@arcgis/core/widgets/Popup/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after the user clicks on an action in the component.\nThis event may be used to define a custom function to execute when particular actions are clicked.","docsTags":[{"name":"see","text":"[actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#actions)"},{"name":"see","text":"[PopupTemplate.actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions)"},{"name":"see","text":"[open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#open)"},{"name":"example","text":"```js\n// Fires each time an action is clicked\nreactiveUtils.on(()=> component, \"arcgisTriggerAction\", (event)=>{\n // If the zoom-out action is clicked, execute the following code\n if(event.detail.action.id === \"zoom-out\"){\n // Zoom out two levels (LODs)\n viewElement.goTo({\n center: viewElement.center,\n zoom: viewElement.zoom - 2\n });\n }\n});\n```"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/features-next/features-next.tsx","tag":"arcgis-features-next","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n> The Features (next) component is the successor to the Features component, provided to you early for testing and feedback. In version 6.0, the implementation of [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) will be updated under the hood to that of [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/), and this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Features (next) component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without living inside a view component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component,\nhowever unlike Popup, the Features (next) component can be placed outside of a view component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features (next) component, the same information that Popup provides is shown in a separate container from the map, such as a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features (next) component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate).\n\nThe Features (next) component should be used if needing to use the Popup functionality outside of the map or scene component. To show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/) component.","docsTags":[{"name":"see","text":"[PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)"},{"name":"see","text":"[arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/)"},{"name":"see","text":"[arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/)"},{"name":"beta"},{"name":"since","text":"5.1"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"actions","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"PopupAction":{"location":"import","path":"@arcgis/core/popup/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [action button](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionButton/) or [action toggle](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionToggle/) objects. Each action may be executed by clicking the icon or image symbolizing them.\nThere is a default `Zoom To` action styled with a magnifying glass icon to zoom in four LODs and center the map on the selected feature. This default action can be removed by setting [includeDefaultActionsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#includeDefaultActionsDisabled) to `true`, or by setting the [`overwriteActions`](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\n\nThe order of each action is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/). The [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#event-arcgisTriggerAction) event fires each time an action is clicked.","docsTags":[{"name":"see","text":"[@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#event-arcgisTriggerAction)"},{"name":"see","text":"[Popup actions sample](https://developers.arcgis.com/javascript/latest/sample-code/popup-actions/)"}],"values":[],"optional":true,"required":false},{"name":"active","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates if the component is active when it is visible and is not [waiting](https://developers.arcgis.com/javascript/latest/references/core/popup/Features/#waitingForResult) for results.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"chartAnimationDisabled","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"chart-animation-disabled","reflectToAttr":false,"docs":"Indicates whether to disable chart animation in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapsed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"collapsed","reflectToAttr":false,"docs":"Indicates whether the component displays its content. If `true`, only the header displays.\nThis property is only honored if [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#showCollapseButton) is `true`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapseDirection","type":"\"down\" | \"up\" | undefined","complexType":{"original":"\"down\" | \"up\" | undefined","resolved":"\"down\" | \"up\" | undefined","references":{}},"mutable":true,"attr":"collapse-direction","reflectToAttr":false,"docs":"Controls the direction the content collapses when the collapse button is used.\nWhen unset, the component chooses a direction based on the [feature navigation placement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#featureNavigationTop).","docsTags":[{"name":"see","text":"[showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#showCollapseButton)"},{"name":"see","text":"[collapsed](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#collapsed)"},{"name":"see","text":"[featureNavigationTop](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#featureNavigationTop)"}],"values":[{"type":"string","value":"down"},{"type":"string","value":"up"}],"optional":true,"required":false},{"name":"content","type":"string | HTMLElement | null | undefined","complexType":{"original":"string | HTMLElement | null | undefined","resolved":"string | HTMLElement | null | undefined","references":{"HTMLElement":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"attr":"content","reflectToAttr":false,"docs":"The content of the component. When set directly on the component, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content).","docsTags":[{"name":"example","text":"```js\n// This sets generic instructions in the component that will always be displayed\n// unless it is overridden by a PopupTemplate.\ncomponent.content = \"Click a feature on the map to view its attributes\";\n```"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"defaultPopupTemplateEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"default-popup-template-enabled","reflectToAttr":false,"docs":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"effectiveHeading","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The heading currently displayed for the selected feature. This value resolves to the selected feature's [PopupTemplate title](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#title) when available, otherwise it falls back to the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading).","docsTags":[{"name":"since","text":"5.1"},{"name":"see","text":"[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading)"},{"name":"see","text":"[selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature)"},{"name":"readonly","text":""}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"featureCount","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"feature-count","reflectToAttr":false,"docs":"The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) available in the component.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"featureItemAbilities","type":"FeatureAbilities | null | undefined","complexType":{"original":"FeatureAbilities | null | undefined","resolved":"FeatureAbilities | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/popup/support/FeatureAbilities.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FeatureAbilities/) that can be used when querying and displaying content.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"featureMenuOpen","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"feature-menu-open","reflectToAttr":false,"docs":"This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#initialDisplayMode) is set to \"feature\".","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"featureMenuTitle","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"feature-menu-title","reflectToAttr":false,"docs":"Sets the title to display on the component while viewing the feature menu.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"featureNavigationTop","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"feature-navigation-top","reflectToAttr":false,"docs":"Indicates whether the feature navigation arrows are displayed at the top of the component.\nBy default, the navigation arrows are displayed at the bottom of the component.\nThis property also controls the collapse button's icon direction when the [collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#collapseDirection) property is not set. When `featureNavigationTop` is `true`, the collapse button icon defaults to collapsing \"up\" and when `false` it defaults to collapsing \"down\".","docsTags":[{"name":"see","text":"[collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#collapseDirection)"},{"name":"see","text":"[showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#showCollapseButton)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"features","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of graphics associated with the component. Each graphic in this array must have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) set. They may share the same [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) or have unique [PopupTemplates](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) depending on their attributes. The [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#content) and [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading) of the component is set based on the `content` and `title` properties of each graphic's respective [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\n \nWhen more than one graphic exists in this array, the current content of the component is set based on the value of the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).\n\nThis value is `null` if no features are associated with the component.","docsTags":[{"name":"example","text":"```js\n// When setting the features property, the graphics pushed to this property\n// must have a PopupTemplate set.\nlet g1 = new Graphic();\ng1.popupTemplate = new PopupTemplate({\n title: \"Results title\",\n content: \"Results: {ATTRIBUTE_NAME}\"\n});\n// Set the graphics as an array to the popup instance. The content and title of\n// the component will be set depending on the PopupTemplate of the graphics.\n// Each graphic may share the same PopupTemplate or have a unique PopupTemplate\nlet graphics = [g1, g2, g3, g4, g5];\ncomponent.features = graphics;\n```"}],"values":[],"optional":true,"required":false},{"name":"featuresPerPage","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"features-per-page","reflectToAttr":false,"docs":"The number of features to fetch at one time.","docsTags":[],"default":"20","values":[{"type":"number"}],"optional":true,"required":false},{"name":"focusTrapEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"focus-trap-enabled","reflectToAttr":false,"docs":"When `true`, the component will trap focus when opened.\nThis ensures that keyboard navigation is contained within the component when it opens.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | null | undefined","complexType":{"original":"GoToOverride | null | undefined","resolved":"GoToOverride | null | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"headerActions","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/support/actions/ActionToggle.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [action buttons](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionButton/) or [action toggles](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionToggle/) that are displayed in the header of the component. Each action may be executed by clicking the icon or image symbolizing them. The order of each action is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/). The [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#event-arcgisTriggerAction) event fires each time an action is clicked.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"heading","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"heading","reflectToAttr":false,"docs":"The title of the Features component. This can be set to any string value no\nmatter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the corresponding template is used here.","docsTags":[{"name":"see","text":"[headingLevel](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#headingLevel)"},{"name":"example","text":"```js\n// This title will display in the component unless a selected feature's\n// PopupTemplate overrides it.\nfeaturesComponent.title = \"Population by zip codes in Southern California\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the headings in the component.","docsTags":[],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideActionBar","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-action-bar","reflectToAttr":false,"docs":"Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideAttachmentsContent","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-attachments-content","reflectToAttr":false,"docs":"Indicates whether to hide [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-close-button","reflectToAttr":false,"docs":"Indicates whether to hide the close button in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-content","reflectToAttr":false,"docs":"Indicates whether to hide the component's content.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCustomContent","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-custom-content","reflectToAttr":false,"docs":"Indicates whether to hide [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideExpressionContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-expression-content","reflectToAttr":false,"docs":"Indicates whether to hide [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureListLayerTitle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-list-layer-title","reflectToAttr":false,"docs":"Indicates whether to hide the group heading for a list of multiple features.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureMenuHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-menu-heading","reflectToAttr":false,"docs":"Indicates whether to hide the feature menu heading and description in the component's feature menu list.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureNavigation","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-navigation","reflectToAttr":false,"docs":"Indicates whether to hide the feature navigation in the component. This allows the user to scroll through various [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) using pagination arrows.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFieldsContent","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-fields-content","reflectToAttr":false,"docs":"Indicates whether to hide [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-heading","reflectToAttr":false,"docs":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLastEditedInfo","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-last-edited-info","reflectToAttr":false,"docs":"Indicates whether to hide the last edited info in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMediaContent","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-media-content","reflectToAttr":false,"docs":"Indicates whether to hide [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideRelationshipContent","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-relationship-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSelectFeature","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-select-feature","reflectToAttr":false,"docs":"Indicates whether to hide the *select feature* action when viewing associated and related features.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSpinner","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-spinner","reflectToAttr":false,"docs":"Indicates whether to hide the spinner in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTextContent","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-text-content","reflectToAttr":false,"docs":"Indicates whether to hide [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUtilityNetworkContent","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-utility-network-content","reflectToAttr":false,"docs":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlightDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"highlight-disabled","reflectToAttr":false,"docs":"Indicates whether to highlight the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature) in the associated\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName | undefined","complexType":{"original":"IconName | undefined","resolved":"IconName | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"includeDefaultActionsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"include-default-actions-disabled","reflectToAttr":false,"docs":"Indicates whether to include the default actions in the component.\nIn order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"initialDisplayMode","type":"InitialDisplayOptions","complexType":{"original":"InitialDisplayOptions","resolved":"InitialDisplayOptions","references":{"InitialDisplayOptions":{"location":"import","path":"@arcgis/core/popup/types.js","id":"notImplemented"}}},"mutable":true,"attr":"initial-display-mode","reflectToAttr":false,"docs":"Indicates whether to initially display a list of features, or the content for one feature.","docsTags":[],"default":"\"feature\"","values":[{"type":"string","value":"list"},{"type":"string","value":"feature"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"map","type":"Map | null | undefined","complexType":{"original":"Map | null | undefined","resolved":"Map | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Map.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A map is required when the input [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) have a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use the `$map` profile variable to access data from layers within a map. Without a map, expressions that use `$map` will throw an error.\n\nAlternatively, the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property can be used to provide the map instance for this property.","docsTags":[{"name":"see","text":"[Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"},{"name":"example","text":"```js\n// The building footprints represent the buildings that intersect a clicked parcel\nlet buildingFootprints = Intersects($feature, FeatureSetByName($map, \"Building Footprints\"));\n```"}],"default":"null","values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"open","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"open","reflectToAttr":false,"docs":"Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.","docsTags":[{"name":"see","text":"[active](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#active)"},{"name":"see","text":"[clear()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#clear)"},{"name":"since","text":"5.0"},{"name":"example","text":"```js\n// Listen for clicks on the view and open the component at the clicked location with custom content.\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n const { mapPoint } = event.detail;\n component.location = mapPoint;\n component.heading = \"You clicked here\";\n component.content = \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3);\n component.open = true;\n});\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedDrillInFeature","type":"Graphic | undefined","complexType":{"original":"Graphic | undefined","resolved":"Graphic | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The feature that the component has drilled into.\nThis feature is either associated with the selected feature in a [relationship](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/)\nor [utility network](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) element.","docsTags":[{"name":"since","text":"5.1"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedFeature","type":"Graphic | null","complexType":{"original":"Graphic | null","resolved":"Graphic | null","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The selected feature accessed by the Features component. The content displayed in the component is\ndetermined based on the [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) assigned to this feature.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedFeatureComponent","type":"ArcgisFeatureNext | undefined","complexType":{"original":"ArcgisFeatureNext | undefined","resolved":"ArcgisFeatureNext | undefined","references":{"ArcgisFeatureNext":{"location":"local","path":"components/arcgis-feature-next","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Returns a reference to the current [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) component.\nThis is useful if needing to get a reference to the Feature component in order to make any changes to it.","docsTags":[{"name":"since","text":"5.1"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedFeatureIndex","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"selected-feature-index","reflectToAttr":false,"docs":"Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) are set,\nthe first index is automatically selected.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"showCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse-button","reflectToAttr":false,"docs":"Indicates whether to show the collapse button in the component.","docsTags":[{"name":"see","text":"[collapsed](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#collapsed)"},{"name":"see","text":"[collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#collapseDirection)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"spatialReference","type":"SpatialReference | null | undefined","complexType":{"original":"SpatialReference | null | undefined","resolved":"SpatialReference | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/SpatialReference.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.\nThis property should be set if the Features component executes Arcade expressions that contain [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/).\n\nAlternatively, the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property can be used to provide the spatial reference instance for this property.","docsTags":[{"name":"see","text":"[Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)"},{"name":"see","text":"[Arcade Profiles: Popup](https://developers.arcgis.com/arcade/profiles/popup/)"}],"default":"null","values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/popup/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"error"}],"optional":true,"required":false},{"name":"timeZone","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) if the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property is set. When a MapView is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and time are not adjusted for any timezone.\n- `Specified IANA timezone`: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","docsTags":[{"name":"since","text":"5.1"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"updateLocationEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"update-location-enabled","reflectToAttr":false,"docs":"Indicates whether to update the feature location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeatureIndex) changes.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A reference to the [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) or [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).\nThe Features component requires a `view` to be set if:\n- The [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) have a popupTemplate containing Arcade expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) or reference the `$map` profile variable (i.e. access data from layers within a map). Alternatively, set the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#map) property.\n- Content is displayed from the popup template of an [aggregate feature](https://developers.arcgis.com/javascript/latest/references/core/Graphic/#isAggregate) (i.e. a [cluster](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/) or [bin](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/)).\n- Values from `date` and `timestamp-offset` fields should respect the view's [time zone](https://developers.arcgis.com/javascript/latest/references/core/views/View/#timeZone).\nAlternatively, set the [timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#timeZone) property.\n- Using the `Zoom to` default action. If the `view` is not specified, set the [includeDefaultActionsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#includeDefaultActionsDisabled) property to `true` to remove this default action.","docsTags":[{"name":"since","text":"5.1"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"clear(): void","parameters":[],"docs":"Removes [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#content), and\n[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading) from the component.","docsTags":[]},{"name":"close","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"close(): void","parameters":[],"docs":"A convenience method to close the component.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeaturesNext = document.createElement(\"arcgis-features-next\");\ndocument.body.append(arcgisFeaturesNext);\nawait arcgisFeaturesNext.componentOnReady();\nconsole.log(\"arcgis-features-next is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"next","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"next(): void","parameters":[],"docs":"Selects the feature at the next index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).","docsTags":[{"name":"see","text":"[selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeatureIndex)"}]},{"name":"previous","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"previous(): void","parameters":[],"docs":"Selects the feature at the previous index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).","docsTags":[{"name":"see","text":"[selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeatureIndex)"}]},{"name":"setFocus","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setFocus(): Promise","parameters":[],"docs":"Use this method to give focus to the Component if the component is able to be focused.","docsTags":[{"name":"since","text":"5.1"}]}],"events":[{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"active\" | \"collapsed\" | \"effectiveHeading\" | \"featureCount\" | \"featureMenuOpen\" | \"features\" | \"promises\" | \"selectedDrillInFeature\" | \"selectedFeature\" | \"selectedFeatureComponent\" | \"selectedFeatureIndex\" | \"state\" | \"open\"; }","bubbles":true,"complexType":{"original":"{ name: \"active\" | \"collapsed\" | \"effectiveHeading\" | \"featureCount\" | \"featureMenuOpen\" | \"features\" | \"promises\" | \"selectedDrillInFeature\" | \"selectedFeature\" | \"selectedFeatureComponent\" | \"selectedFeatureIndex\" | \"state\" | \"open\"; }","resolved":"{ name: \"active\" | \"collapsed\" | \"effectiveHeading\" | \"featureCount\" | \"featureMenuOpen\" | \"features\" | \"promises\" | \"selectedDrillInFeature\" | \"selectedFeature\" | \"selectedFeatureComponent\" | \"selectedFeatureIndex\" | \"state\" | \"open\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTriggerAction","detail":"ActionEvent","bubbles":true,"complexType":{"original":"ActionEvent","resolved":"ActionEvent","references":{"ActionEvent":{"location":"import","path":"@arcgis/core/widgets/Popup/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after the user clicks on an action in the component.\nThis event may be used to define a custom function to execute when particular actions are clicked.","docsTags":[{"name":"see","text":"[actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions)"},{"name":"see","text":"[PopupTemplate.actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions)"},{"name":"see","text":"[open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#open)"},{"name":"example","text":"```js\n// Fires each time an action is clicked\nreactiveUtils.on(()=> component, \"arcgisTriggerAction\", (event)=>{\n // If the zoom-out action is clicked, execute the following code\n if(event.detail.action.id === \"zoom-out\"){\n // Zoom out two levels (LODs)\n viewElement.goTo({\n center: viewElement.center,\n zoom: viewElement.zoom - 2\n });\n }\n});\n```"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/floor-filter/floor-filter.tsx","tag":"arcgis-floor-filter","overview":"","readme":"","usage":{},"docs":"The Floor Filter component simplifies visualization of GIS data for a specific floor of a\nbuilding in your application. It allows you to filter down the floor plan data displayed in your\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) to a [site](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#site), a [facility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#facility) in the site,\nor a [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#level) in the facility.\n\nTo visualize your data based on [site](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#site), [facility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#facility), or [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#level), your map must contain the related\nfloor plan layers, with features linked together in a floor plan hierarchy.\nOnce you define your map as floor-aware in the map properties, the interactive, on-screen\nFloor Filter component appears and can be used to explore the floor-aware data based on the\nconfigured site, facility, and levels layers.\nThe Floor Filter component currently supports\n[FeatureLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[SceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/) and\n[MapImageLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/) (map services).\n\nThe component can also be used alongside other filtering functionalities, such as definition queries,\nselection, range, and time, to further control visualization.\nFor example, you may want to visualize all of the features on a specific level in a facility,\nor all the office units within a range of levels in a facility.\n\n**Note**\n\nIf a default site, facility, or level is selected in the floor filter when sharing a floor-aware web map from ArcGIS Pro,\nit will also be the default selection within the Floor Filter component.","docsTags":[{"name":"since","text":"4.28"},{"name":"example","text":"```html\n\n \n\n```"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"facility","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"facility","reflectToAttr":true,"docs":"The currently selected facility.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | null | undefined","complexType":{"original":"GoToOverride | null | undefined","resolved":"GoToOverride | null | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"5.0"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":true,"docs":"Indicates the heading level to use for the headings separating floors in buildings.\nBy default, the building name is rendered\nas a level 2 heading (e.g. `

Building name

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[{"name":"since","text":"4.20"},{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"example","text":"// building headings will render as an

\nfloorFilter.headingLevel = 3;"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"icon","type":"IconName | undefined","complexType":{"original":"IconName | undefined","resolved":"IconName | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"urban-model\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"level","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"level","reflectToAttr":true,"docs":"The currently selected floor level.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"longNames","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"long-names","reflectToAttr":true,"docs":"Determines if the component is expanded or collapsed.\nIf the value is `true`, the component is expanded and the long names appear.\nOtherwise, short names are used and icons appear alone on buttons.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"site","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"site","reflectToAttr":true,"docs":"The currently selected site.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-floor-filter component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFloorFilter = document.createElement(\"arcgis-floor-filter\");\ndocument.body.append(arcgisFloorFilter);\nawait arcgisFloorFilter.componentOnReady();\nconsole.log(\"arcgis-floor-filter is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"updateWebDocument","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(webMap: WebMap | WebScene): Promise","parameters":[{"name":"webMap","type":"WebMap | WebScene","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/WebScene.js","id":"notImplemented"}}},"signature":"updateWebDocument(webMap: WebMap | WebScene): Promise","parameters":[{"name":"webMap","type":"WebMap | WebScene","docs":""}],"docs":"","docsTags":[]}],"events":[{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/fullscreen/fullscreen.tsx","tag":"arcgis-fullscreen","overview":"","readme":"","usage":{},"docs":"The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\nUse the escape key (`esc`) to exit fullscreen mode.\n\n**Known limitations**\n\n* Fullscreen only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/docs/Web/API/Fullscreen_API) API.\n Thus, iOS Safari is not supported.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"element","type":"Element | string | undefined","complexType":{"original":"Element | string | undefined","resolved":"Element | string | undefined","references":{"Element":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"attr":"element","reflectToAttr":false,"docs":"The [HTMLElement](https://developer.mozilla.org/docs/Web/API/HTMLElement) to present in fullscreen mode.","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"\"active\" | \"disabled\" | \"ready\" | \"unsupported\"","complexType":{"original":"\"active\" | \"disabled\" | \"ready\" | \"unsupported\"","resolved":"\"active\" | \"disabled\" | \"ready\" | \"unsupported\"","references":{}},"mutable":true,"attr":"state","reflectToAttr":true,"docs":"","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"active"},{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"unsupported"}],"optional":true,"required":false},{"name":"view","type":"LinkChartView | MapView | SceneView | undefined","complexType":{"original":"LinkChartView | MapView | SceneView | undefined","resolved":"LinkChartView | MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Specifies the size of the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFullscreen = document.createElement(\"arcgis-fullscreen\");\ndocument.body.append(arcgisFullscreen);\nawait arcgisFullscreen.componentOnReady();\nconsole.log(\"arcgis-fullscreen is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/grid-controls/grid-controls.tsx","tag":"arcgis-grid-controls","overview":"","readme":"","usage":{},"docs":"The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in a 2D Map component.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.","docsTags":[{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"customColor","type":"Color | undefined","complexType":{"original":"Color | undefined","resolved":"Color | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"attr":"custom-color","reflectToAttr":true,"docs":"The custom color used for drawing the grid, if any.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"displayEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Returns `true` if the grid is enabled for display.\nUse [trySetDisplayEnabled()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#trySetDisplayEnabled) to enable or disable grid display.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"dynamicScaling","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"dynamic-scaling","reflectToAttr":false,"docs":"Returns `true` if the grid is set to scale dynamically. When dynamic scaling is enabled,\ngrid cells are added or removed to ensure that grid cells are a reasonable size on screen as the user zooms.\nThe way additional grid lines are shown is controlled by the [majorLineInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#majorLineInterval) property.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"effectiveSpacingAfterDynamicScaling","type":"number | null","complexType":{"original":"number | null","resolved":"number | null","references":{}},"mutable":true,"attr":"effective-spacing-after-dynamic-scaling","reflectToAttr":true,"docs":"Returns the actual spacing of grid lines after dynamic scaling has been applied at the current scale.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"gridColor","type":"Color | null | undefined","complexType":{"original":"Color | null | undefined","resolved":"Color | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"attr":"grid-color","reflectToAttr":true,"docs":"Controls the color of the major grid lines. Minor grid lines are a slightly transparent version of this color.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"gridControlsEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Returns `true` if the grid is in a valid state for manually setting grid properties or starting an interactive placement.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"gridOutOfScale","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"grid-out-of-scale","reflectToAttr":true,"docs":"True if the grid is currently not displayed (and therefore also not a valid snap target),\nbecause [dynamicScaling](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#dynamicScaling) is off and the grid cells are too small\nto render at the current scale.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideColorSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-color-selection","reflectToAttr":false,"docs":"Controls display of the color and theme selection options.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDynamicScaleToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-dynamic-scale-toggle","reflectToAttr":false,"docs":"Controls display of the dynamic scaling toggle. Dynamic scaling adjusts the size of the grid to work\nwell regardless of view scale.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-enabled-toggle","reflectToAttr":false,"docs":"Controls display of the grid enabled toggle. This toggle controls whether the grid is displayed.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridSnapEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-snap-enabled-toggle","reflectToAttr":false,"docs":"Controls display of the grid snapping enabled toggle. This toggle controls whether snapping is enabled.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLineIntervalInput","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-line-interval-input","reflectToAttr":false,"docs":"Controls display of the line interval input field for setting the interval between major grid lines.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideNumericInputs","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-numeric-inputs","reflectToAttr":false,"docs":"Controls display of the numeric input fields for setting grid spacing and rotation.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideOutOfScaleWarning","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-out-of-scale-warning","reflectToAttr":false,"docs":"Controls display of the out of scale warning. This warning is displayed when the grid is not shown\nbecause it would be too small at the current scale and dynamic scaling is disabled.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePlacementButtons","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-placement-buttons","reflectToAttr":false,"docs":"Controls display of the grid placement buttons. These buttons allow the user to start interactive\nconfiguration of the grid.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideRotateWithMapToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-rotate-with-map-toggle","reflectToAttr":false,"docs":"Controls display of the rotate with map toggle. This toggle controls whether the grid rotates with the map.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"grid-unit\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"interactivePlacementState","type":"GridPlacementState2 | null | undefined","complexType":{"original":"GridPlacementState2 | null | undefined","resolved":"GridPlacementState2 | null | undefined","references":{"GridPlacementState":{"location":"import","path":"@arcgis/core/widgets/support/GridControls/types.js","id":"notImplemented"}}},"mutable":true,"attr":"interactive-placement-state","reflectToAttr":true,"docs":"Sets the interactive placement state, either starting or ending a draw operation that implicitly adjusts the grid.\nInteractive placement allows the user to define the center of the grid, then the scale and rotation of the grid by\ndrawing a second point. Setting this to \"place\" allows the user to move the grid center only. Setting this to \"rotate\"\nkeeps the scale and center of the grid constant while rotating the grid by defining a second point.","docsTags":[],"default":"null","values":[{"type":"string","value":"rotate"},{"type":"string","value":"place"},{"type":"string","value":"interactive"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"majorLineInterval","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"major-line-interval","reflectToAttr":true,"docs":"Controls the number of grid cells shown between major grid lines. Can be anything between 1 and 15.\nNo minor grid lines are shown when this is set to 1.","docsTags":[],"default":"10","values":[{"type":"number"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"placementDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"placement-disabled","reflectToAttr":false,"docs":"Use this property to disable the interactive grid placement buttons as needed.\nAn example use case might be to block interaction while another interactive operation\n(e.g. sketching) is in progress.","docsTags":[{"name":"since","text":"4.33"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"rotateWithMap","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"rotate-with-map","reflectToAttr":false,"docs":"Controls whether the grid rotates with the map, or stays fixed to the screen.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"rotation","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"rotation","reflectToAttr":true,"docs":"Rotation of the grid in radians. NOTE: UI controls convert to and from degrees automatically.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"snappingEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"snapping-enabled","reflectToAttr":false,"docs":"Controls snapping behavior if [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#snappingOptions) has been defined.\nIf [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#snappingOptions) have been defined, disabling or enabling grid snapping will\nalso disable or enable grid display.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"snappingOptions","type":"SnappingOptions | null | undefined","complexType":{"original":"SnappingOptions | null | undefined","resolved":"SnappingOptions | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/snapping/SnappingOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/)\nthat will be controlled by this component if the snapping toggle is enabled for display.\nIf SnappingOptions are provided, grid display will be automatically enabled or disabled to match snapping state.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"spacing","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"spacing","reflectToAttr":true,"docs":"Length of a grid cell. Grid cells are always square. Defined in [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#unit).","docsTags":[],"default":"1","values":[{"type":"number"}],"optional":true,"required":false},{"name":"theme","type":"GridTheme | null | undefined","complexType":{"original":"GridTheme | null | undefined","resolved":"GridTheme | null | undefined","references":{"GridTheme":{"location":"local","path":"components/arcgis-grid-controls/types","id":"notImplemented"}}},"mutable":true,"attr":"theme","reflectToAttr":false,"docs":"The color scheme used to display the grid. This will be light, dark, or custom. When theme is set to custom,\nthe [customColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#customColor) is shown, otherwise a default light or dark theme color is used.","docsTags":[],"default":"\"dark\"","values":[{"type":"string","value":"dark"},{"type":"string","value":"light"},{"type":"string","value":"custom"}],"optional":true,"required":false},{"name":"unit","type":"LengthUnit | undefined","complexType":{"original":"LengthUnit | undefined","resolved":"LengthUnit | undefined","references":{"LengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"unit","reflectToAttr":false,"docs":"Unit of measure (foot, meter, etc) used when defining the [spacing](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#spacing) grid cell.\nNote that units are defined relatively to the map's spatial reference length unit,\nwhich will not correspond to geographic distance unless using a special-purpose basemap\nwithin a supported target area.\n\nWhen using Web Mercator, the projection defines the length of a meter in projection system units;\nthis length is equal to a geographic meter only at the equator. On screen, the size of the grid cells is constant\nfrom the equator to the poles, but the real-world size of the grid cell is much larger further from the equator.\n\nThe length of the grid cells can usefully correspond to a geographic length when the Grid is used with an\nappropriate spatial reference (for example a local system or a State Plane system) within the reference's area of interest.","docsTags":[],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"}],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-grid-controls component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisGridControls = document.createElement(\"arcgis-grid-controls\");\ndocument.body.append(arcgisGridControls);\nawait arcgisGridControls.componentOnReady();\nconsole.log(\"arcgis-grid-controls is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"trySetDisplayEnabled","returns":{"type":"void","docs":""},"complexType":{"signature":"(enabled: boolean): void","parameters":[{"name":"enabled","type":"boolean","docs":"Desired end state for grid display."}],"return":"void","references":{}},"signature":"trySetDisplayEnabled(enabled: boolean): void","parameters":[{"name":"enabled","type":"boolean","docs":"Desired end state for grid display."}],"docs":"Call this to turn the grid on/off.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"customColor\" | \"theme\" | \"spacing\" | \"rotation\" | \"majorLineInterval\" | \"rotateWithMap\" | \"dynamicScaling\" | \"snappingEnabled\" | \"interactivePlacementState\" | \"displayEnabled\" | \"gridOutOfScale\" | \"effectiveSpacingAfterDynamicScaling\" | \"gridControlsEnabled\" | \"gridColor\"; }","bubbles":true,"complexType":{"original":"{ name: \"customColor\" | \"theme\" | \"spacing\" | \"rotation\" | \"majorLineInterval\" | \"rotateWithMap\" | \"dynamicScaling\" | \"snappingEnabled\" | \"interactivePlacementState\" | \"displayEnabled\" | \"gridOutOfScale\" | \"effectiveSpacingAfterDynamicScaling\" | \"gridControlsEnabled\" | \"gridColor\"; }","resolved":"{ name: \"customColor\" | \"theme\" | \"spacing\" | \"rotation\" | \"majorLineInterval\" | \"rotateWithMap\" | \"dynamicScaling\" | \"snappingEnabled\" | \"interactivePlacementState\" | \"displayEnabled\" | \"gridOutOfScale\" | \"effectiveSpacingAfterDynamicScaling\" | \"gridControlsEnabled\" | \"gridColor\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/histogram-range-slider/histogram-range-slider.tsx","tag":"arcgis-histogram-range-slider","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-histogram-range-slider/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"average","type":"number | null | undefined","complexType":{"original":"number | null | undefined","resolved":"number | null | undefined","references":{}},"mutable":true,"attr":"average","reflectToAttr":false,"docs":"The statistical average of the data in the histogram. You would typically\nget this value from the `avg` property of\n[SummaryStatisticsResult](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/types/#SummaryStatisticsResult),\nwhich is the result of the\n[summaryStatistics](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/summaryStatistics/) function.\n\nWhen set, this value will render on the histogram with a line and an average symbol.","docsTags":[{"name":"example","text":"// sets result returned from a smart mapping method\n// to the histogram\nslider.average = response.statistics.avg;"},{"name":"example","text":"slider.average = 34.5;"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"barCreatedFunction","type":"BarCreatedFunction | null | undefined","complexType":{"original":"BarCreatedFunction | null | undefined","resolved":"BarCreatedFunction | null | undefined","references":{"BarCreatedFunction":{"location":"import","path":"@arcgis/core/widgets/Histogram/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function for styling bars representing histogram bins.\nThis can be used to color bins with the same color of features in the\nview that fall into bins representing the same range of data.","docsTags":[{"name":"example","text":"slider.barCreatedFunction = function(index, element){\n const bin = slider.bins[index];\n element.addEventListener(\"focus\", function(){\n layerView.filter = {\n where: `POPULATION >= ${bin.minValue} AND POPULATION < ${bin.maxValue}`\n };\n });\n element.addEventListener(\"blur\", function(){\n layerView.filter = null;\n });\n};"}],"values":[],"optional":true,"required":false},{"name":"bins","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"HistogramBin":{"location":"import","path":"@arcgis/core/smartMapping/statistics/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of objects representing each bin in the histogram. This\ninformation is typically returned from the\n[histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) function.","docsTags":[{"name":"example","text":"// sets the bins of the histogram from the bins in the histogram() result\nhistogram.bins = histogramResult.bins;"},{"name":"example","text":"// Creates a histogram with 7 bins.\nhistogram.bins = [\n { minValue: 0, maxValue: 10, count: 4 },\n { minValue: 10.1, maxValue: 20, count: 14 },\n { minValue: 20.1, maxValue: 30, count: 9 },\n { minValue: 30.1, maxValue: 40, count: 34 },\n { minValue: 40.1, maxValue: 50, count: 351 },\n { minValue: 50.1, maxValue: 60, count: 100 },\n { minValue: 60.1, maxValue: 70, count: 1 }\n];"}],"values":[],"optional":true,"required":false},{"name":"dataLineCreatedFunction","type":"DataLineCreatedFunction | null | undefined","complexType":{"original":"DataLineCreatedFunction | null | undefined","resolved":"DataLineCreatedFunction | null | undefined","references":{"DataLineCreatedFunction":{"location":"import","path":"@arcgis/core/widgets/Histogram/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function that fires each time a data line is created.\nYou can use this to style individual [dataLines](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#dataLines) on the data axis.","docsTags":[{"name":"example","text":"histogram.dataLineCreatedFunction = function (lineElement, labelElement) {\n lineElement.setAttribute(\"y2\", \"25%\");\n lineElement.classList.add(\"line-style\");\n};"}],"values":[],"optional":true,"required":false},{"name":"dataLines","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"DataLineInfos":{"location":"import","path":"@arcgis/core/widgets/Histogram/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"When set, renders lines on the histogram that indicate important or\nmeaningful values to the end user.","docsTags":[{"name":"example","text":"// will render lines at the 25th, 50th, 75th, and 99th percentiles\nhistogram.dataLines = [{\n value: 30,\n label: \"25 pctl\"\n}, {\n value: 45,\n label: \"50 pctl\"\n}, {\n value: 65,\n label: \"75 pctl\"\n}, {\n value: 89,\n label: \"99 pctl\"\n}];"},{"name":"example","text":"// calculate standard deviations from mean using stats\n// returned from smart mapping statistic methods\nconst stddevs = smartMappingUtils.getDeviationValues(stats.stddev, stats.avg, 2);\nhistogram.dataLines = stddevs.map(function(stddev){\n return {\n value: stddev\n };\n});"}],"values":[],"optional":true,"required":false},{"name":"excludedBarColor","type":"ColorLike","complexType":{"original":"ColorLike","resolved":"ColorLike","references":{"ColorLike":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"attr":"excluded-bar-color","reflectToAttr":false,"docs":"Sets the color of the histogram bars that are excluded based on the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType). For example, when a rangeType of `between` is used,\nall bars **not** between the slider thumbs will be rendered with the color set here.\n\nTo change the style of histogram bars representing included data based on the\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType), use the [includedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor) property.","docsTags":[{"name":"see","text":"[includedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor)"},{"name":"see","text":"[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType)"},{"name":"example","text":"slider.excludedBarColor = \"black\";"}],"default":"\"#d7e5f0\"","values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"arrow-double-horizontal\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"includedBarColor","type":"ColorLike","complexType":{"original":"ColorLike","resolved":"ColorLike","references":{"ColorLike":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"attr":"included-bar-color","reflectToAttr":false,"docs":"Sets the color of the histogram bars that are included in the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType). For example, when a rangeType of `between` is used,\nall bars between the slider thumbs will be rendered with the color set here.\n\nTo change the style of histogram bars representing excluded data based on the\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType), use the [excludedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#excludedBarColor) property.","docsTags":[{"name":"see","text":"[excludedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#excludedBarColor)"},{"name":"see","text":"[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType)"},{"name":"example","text":"slider.includedBarColor = \"green\";"}],"default":"\"#599dd4\"","values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"labelFormatFunction","type":"LabelFormatFunction","complexType":{"original":"LabelFormatFunction","resolved":"LabelFormatFunction","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format labels. Overrides the default label formatter.\n\nBy default labels are formatted in the following way:\n\n- When the data range is less than `10` (`(max - min) < 10`), labels\n are rounded based on the value set in the [precision](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#precision) property.\n- When the data range is larger than `10`, [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel/#labels) display with a precision of\n no more than two decimal places, though actual slider thumb values will maintain the\n precision specified in [precision](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#precision).\n\nUse this property to override the behavior defined above.","docsTags":[{"name":"example","text":"// For thumb values, rounds each label to whole numbers.\n// Note the actual value of the thumb continues to be stored\n// based on the indicated data `precision` despite this formatting\nslider.labelFormatFunction = function(value, type) {\n return (type === \"value\") ? value.toFixed(0) : value;\n}"},{"name":"example","text":"// Format thumb values as dates\nslider.labelFormatFunction = function(value, type) {\n return new Date(value).toLocaleDateString();\n}"}],"values":[],"optional":true,"required":false},{"name":"max","type":"number | null | undefined","complexType":{"original":"number | null | undefined","resolved":"number | null | undefined","references":{}},"mutable":true,"attr":"max","reflectToAttr":false,"docs":"The maximum value or upper bound of the slider. If the largest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) _in the constructor_ is greater than the `maxValue` set in\nthis property, then the `maxValue` will update to match the largest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values).","docsTags":[{"name":"example","text":"slider.max = 150;"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number | null | undefined","complexType":{"original":"number | null | undefined","resolved":"number | null | undefined","references":{}},"mutable":true,"attr":"min","reflectToAttr":false,"docs":"The minimum value or lower bound of the slider. If the smallest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) _in the constructor_ is greater than the `minValue` set in\nthis property, then the `minValue` will update to match the smallest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values).","docsTags":[{"name":"example","text":"slider.min = -150;"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"precision","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"precision","reflectToAttr":false,"docs":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb values should round to when they have been moved.\n\nThis value also indicates the precision of thumb [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel/#labels) when the data range\n([max](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#max) - [min](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#min)) is less than `10`.\n\nWhen the data range is larger than `10`, [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel/#labels) display with a precision of\nno more than two decimal places, though actual slider thumb values will maintain the\nprecision specified in this property.\n\nFor example, given the default precision of `4`, and the following slider configuration,\nThe label of the thumb will display two decimal places, but the precision of the actual\nthumb value will not be lost even when the user slides or moves the thumb.\n\n```js\nconst slider = new HistogramRangeSliderViewModel({\n min: 20,\n max: 100, // data range of 80\n values: [50.4331],\n // thumb label will display 50.43\n // thumb value will maintain precision, so\n // value will remain at 50.4331\n});\n```\n\nIf the user manually enters a value that has a higher precision than what's indicated by\nthis property, the precision of that thumb value will be maintained until the thumb\nis moved by the user. At that point, the value will be rounded according to the indicated precision.\n\nKeep in mind this property rounds thumb [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) and shouldn't be used exclusively\nfor formatting purposes. To format thumb `labels`, use the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#labelFormatFunction)\nproperty.","docsTags":[{"name":"example","text":"histogramRangeSlider.precision = 7;"}],"default":"4","values":[{"type":"number"}],"optional":true,"required":false},{"name":"rangeType","type":"RangeType","complexType":{"original":"RangeType","resolved":"RangeType","references":{"RangeType":{"location":"import","path":"@arcgis/core/widgets/HistogramRangeSlider/types.js","id":"notImplemented"}}},"mutable":true,"attr":"range-type","reflectToAttr":false,"docs":"Indicates how the histogram bins should be rendered as the user slides the thumbs. By default,\nblue bars indicate data bins included in the range. Gray bars indicate data bins excluded from\nthe range. These colors can be customized with the [includedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor) and\n[excludedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor) properties.\n\nThis property also determines the SQL where clause generated in [generateWhereClause()](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#generateWhereClause)\nfor filtering purposes. The value set here determines the number of [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values)\nallowed on the slider.\n\nSee the table below for a description and requirements of all possible values. `value1` refers to\nthe value of the first thumb position. `value2` refers to the value of the final thumb position, if applicable.\n\nPossible Value | Number of [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) | [Where clause](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#generateWhereClause)\n---------------|----------------------------|----------------------\nequal | 1 | `${field} = ${value1}`\nnot-equal | 1 | `${field} <> ${value1}`\nless-than | 1 | `${field} < ${value1}`\ngreater-than | 1 | `${field} > ${value1}`\nat-most | 1 | `${field} <= ${value1}`\nat-least | 1 | `${field} >= ${value1}`\nbetween | 2 | `${field} BETWEEN ${value1} AND ${value2}`\nnot-between | 2 | `${field} NOT BETWEEN ${value1} AND ${value2}`","docsTags":[{"name":"see","text":"[values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values)"},{"name":"see","text":"[generateWhereClause()](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#generateWhereClause)"},{"name":"example","text":"// renders the histogram so that all bins between\n// the two handles are shaded with a blue color\nslider.rangeType = \"between\";\n\n// filters the layer view based on the configuration\n// of the slider\nlayerView.filter = {\n where: slider.generateWhereClause(\"POPULATION\")\n}"}],"values":[{"type":"string","value":"equal"},{"type":"string","value":"not-equal"},{"type":"string","value":"less-than"},{"type":"string","value":"greater-than"},{"type":"string","value":"at-most"},{"type":"string","value":"at-least"},{"type":"string","value":"between"},{"type":"string","value":"not-between"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"standardDeviation","type":"number | null | undefined","complexType":{"original":"number | null | undefined","resolved":"number | null | undefined","references":{}},"mutable":true,"attr":"standard-deviation","reflectToAttr":false,"docs":"Indicates the standard deviation of the dataset.\nWhen set, computed [dataLines](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#dataLines) will render on the histogram\nat the location of the given standard deviation\nabove and below the `average`.","docsTags":[{"name":"example","text":"// stddev returned from summaryStatistics\nslider.standardDeviation = stats.stddev;"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"standardDeviationCount","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"standard-deviation-count","reflectToAttr":false,"docs":"Indicates the number of standard deviation lines to render on the histogram\nfrom the [average].","docsTags":[{"name":"example","text":"slider.standardDeviationCount = 2;"}],"default":"1","values":[{"type":"number"}],"optional":true,"required":false},{"name":"state","type":"SliderViewModelState","complexType":{"original":"SliderViewModelState","resolved":"SliderViewModelState","references":{"SliderViewModelState":{"location":"import","path":"@arcgis/core/widgets/Slider/SliderViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"values","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of either one or two numbers representing thumb positions on the slider.\nThe number of values that should be indicated here depends on the associated [rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType).","docsTags":[{"name":"see","text":"[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType)"},{"name":"example","text":"const slider = new HistogramRangeSlider({\n min: 20,\n max: 100, // data range of 80\n values: [50.4331],\n rangeType: \"at-least\"\n container: \"sliderDiv\"\n});"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisHistogramRangeSlider = document.createElement(\"arcgis-histogram-range-slider\");\ndocument.body.append(arcgisHistogramRangeSlider);\nawait arcgisHistogramRangeSlider.componentOnReady();\nconsole.log(\"arcgis-histogram-range-slider is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"generateWhereClause","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(field: string): Promise","parameters":[{"name":"field","type":"string","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"generateWhereClause(field: string): Promise","parameters":[{"name":"field","type":"string","docs":""}],"docs":"Generates a SQL where clause based on a given field and the slider's\nrangeType","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/home/home.tsx","tag":"arcgis-home","overview":"","readme":"","usage":{},"docs":"The Home component is a button that navigates back to the\ninitial [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/)\nor a previously defined `viewpoint`.","docsTags":[{"name":"since","text":"4.28"},{"name":"example","text":"```js\n// Create viewpoint centered on extent of a polygon geometry\n\nlet vp = new Viewpoint({\n targetGeometry: geom.extent\n});\n\n// Sets the Home's viewpoint to that Viewpoint\nhome.viewpoint = vp;\n```"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-home/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | undefined","complexType":{"original":"GoToOverride | undefined","resolved":"GoToOverride | undefined","references":{"GoToOverride":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName | undefined","complexType":{"original":"IconName | undefined","resolved":"IconName | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon displayed in the component's button.","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"home\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"\"disabled\" | \"going-home\" | \"ready\"","complexType":{"original":"\"disabled\" | \"going-home\" | \"ready\"","resolved":"\"disabled\" | \"going-home\" | \"ready\"","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"going-home"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-home component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"viewpoint","type":"null | undefined | Viewpoint","complexType":{"original":"null | undefined | Viewpoint","resolved":"null | undefined | Viewpoint","references":{"default":{"location":"import","path":"@arcgis/core/Viewpoint.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/)\nto go to when going \"home\".\nThe initial value is determined in a few different ways:\n\nIf no `referenceElement` is provided, the value is `null`.\nOnce the `referenceElement` is ready, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/).","docsTags":[{"name":"example","text":"```js\n// Create viewpoint centered on extent of a polygon geometry\n\nlet viewpoint = new Viewpoint({\n targetGeometry: geom.extent\n});\n\n// Sets the Home's viewpoint to that Viewpoint\nhome.viewpoint = viewpoint;\n```"}],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Specifies the size of the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"cancelGo","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"cancelGo(): Promise","parameters":[],"docs":"This function provides the ability to interrupt and cancel the process\nof navigating back to the initial extent.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisHome = document.createElement(\"arcgis-home\");\ndocument.body.append(arcgisHome);\nawait arcgisHome.componentOnReady();\nconsole.log(\"arcgis-home is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"go","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"go(): Promise","parameters":[],"docs":"Animates the map or scene to its initial Viewpoint or the\nvalue of `viewpoint`.","docsTags":[]}],"events":[{"event":"arcgisGo","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the go() method is called.","docsTags":[{"name":"example","text":"```js\nhome.addEventListener(\"arcgisGo\", (event) => {\n console.log(\"updating viewpoint\");\n});\n```"}]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\" | \"viewpoint\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\" | \"viewpoint\"; }","resolved":"{ name: \"state\" | \"viewpoint\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/layer-list/layer-list.tsx","tag":"arcgis-layer-list","overview":"","readme":"","usage":{},"docs":"The Layer List provides a way to display a list of layers and switch on/off their visibility.\nThe [listItemCreatedFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#listItemCreatedFunction) and the [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\n\n> **Notes**\n>\n> - The Layer List does not emit an event when the visibility of a layer changes. To respond to layer visibility changes, watch the [visible](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#visible) property of layers in the [allLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#allLayers) property with [reactiveUtils](https://developers.arcgis.com/javascript/latest/references/core/core/reactiveUtils/).\n> - To hide layers in the map from the Layer List, you must set the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property on the desired layers to `hide`.\n> - When a [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/) is present in the map, the Layer List will display the [tables](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/#tables) as a [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#tableList) ListItem.\n> - When a [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) is present in the map, the Layer List will display the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#catalogLayerList) ListItem.\n\n> **Keyboard Navigation**\n>\n> - The Layer List supports keyboard navigation using the [Treegrid Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid/) for improved accessibility. Refer to the Calcite List component documentation for detailed keyboard interaction guidelines: [Calcite List Keyboard Navigation](https://developers.arcgis.com/calcite-design-system/components/list/#keyboard-navigation).\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/) will be updated under the hood to that of [arcgis-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/), and the way events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#catalogLayerList) and [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#tableList) are handled will change. We encourage using the [arcgis-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/) component and providing feedback.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"catalogLayerList","type":"CatalogLayerList | null | undefined","complexType":{"original":"CatalogLayerList | null | undefined","resolved":"CatalogLayerList | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/CatalogLayerList.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The CatalogLayerList that displays a catalog layer's dynamic group layer.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"catalogOptions","type":"CatalogLayerListProperties | null | undefined","complexType":{"original":"CatalogLayerListProperties | null | undefined","resolved":"CatalogLayerListProperties | null | undefined","references":{"CatalogLayerListProperties":{"location":"import","path":"@arcgis/core/widgets/CatalogLayerList.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"[CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) specific properties.\nCatalog layers will display their [CatalogLayer#dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) as an expandable [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#catalogLayerList) in the LayerList component.\nThis list item will only be displayed when catalog layers with dynamic group layers are loaded in the map.\nThese are the properties that are used to configure the [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#catalogLayerList).","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#catalogLayerList)"},{"name":"example","text":"```js\nlayerListElement.catalogOptions = {\n listItemCreatedFunction: (event) => {\n const { item } = event;\n item.actionsSections = [\n [\n {\n title: \"Add layer to map\",\n icon: \"add-layer\",\n id: \"add-layer\"\n }\n ]\n ];\n },\n selectionMode: \"single\",\n visibleElements: {\n filter: true\n }\n };\n```"}],"values":[],"optional":true,"required":false},{"name":"closed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closed","reflectToAttr":false,"docs":"Indicates whether a component is closed. When `true`, the component will be hidden.","docsTags":[{"name":"since","text":"4.33"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapsed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"collapsed","reflectToAttr":true,"docs":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#showCollapseButton)"},{"name":"example","text":"```js\nlayerListElement.collapsed = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"dragEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"drag-enabled","reflectToAttr":false,"docs":"Indicates whether [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) may be reordered within the list by dragging and dropping.\nMapImageLayer [MapImageLayer#sublayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.\nDrag won't be enabled until the number of list items is equal to or greater than than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#minDragEnabledItems).","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#minDragEnabledItems)"},{"name":"example","text":"```js\nlayerListElement.dragEnabled = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterPlaceholder","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-placeholder","reflectToAttr":false,"docs":"Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#visibleElements) is true.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#showFilter)"},{"name":"example","text":"```js\nlayerListElement.filterPlaceholder = \"Filter layers\";\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"filterPredicate","type":"FilterPredicate | null | undefined","complexType":{"original":"FilterPredicate | null | undefined","resolved":"FilterPredicate | null | undefined","references":{"FilterPredicate":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/).","docsTags":[{"name":"since","text":"4.32"},{"name":"example","text":"```js\nlayerListElement.filterPredicate = (item) => item.title.toLowerCase().includes(\"streets\");\n```"}],"values":[],"optional":true,"required":false},{"name":"filterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-text","reflectToAttr":false,"docs":"The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#visibleElements) is true.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#showFilter)"},{"name":"example","text":"```js\nreactiveUtils.watch(\n () => layerListElement.filterText,\n (filterText) => console.log(filterText)\n);\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the heading of the component.\nBy default, the heading is rendered as a level 2 heading (e.g., `

Layer List

`).\nDepending on the component's placement in your app, you may need to adjust this heading for proper semantics.\nThis is important for meeting accessibility standards.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showHeading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#showHeading)"},{"name":"example","text":"```js\nlayerListElement.headingLevel = 3;\n```"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideCatalogLayerList","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-catalog-layer-list","reflectToAttr":false,"docs":"Indicates whether to display the [LayerList#catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#catalogLayerList).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStatusIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-status-indicators","reflectToAttr":false,"docs":"Indicates whether the status indicators will be displayed.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"layers\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"knowledgeGraphOptions","type":"TableListProperties | null | undefined","complexType":{"original":"TableListProperties | null | undefined","resolved":"TableListProperties | null | undefined","references":{"TableListProperties":{"location":"import","path":"@arcgis/core/widgets/TableList.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"[KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/) specific properties.\nKnowledge graph layers will display [KnowledgeGraphLayer#tables](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/#tables)\nas an expandable [tableList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#tableList) in the LayerList component.\nThis tables list item will only be displayed when knowledge graph layers with tables are loaded in the map.\nThese are the properties that are used to configure the [tableList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#tableList).","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[tableList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#tableList)"},{"name":"example","text":"```js\nlayerListElement.knowledgeGraphOptions = {\n filterPlaceholder: \"Filter tables\",\n listItemCreatedFunction: (event) => {\n const { item } = event;\n item.actionsSections = [\n [\n {\n icon: \"table\",\n id: \"open-table\",\n title: \"Show table\"\n },\n {\n icon: \"information\",\n id: \"information\",\n title: \"Show information\"\n }\n ]\n ];\n },\n minFilterItems: 1,\n visibleElements: {\n errors: true,\n filter: true,\n statusIndicators: true\n }\n}\n```"}],"values":[],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.7"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"listItemCreatedFunction","type":"ListItemModifier | null | undefined","complexType":{"original":"ListItemModifier | null | undefined","resolved":"ListItemModifier | null | undefined","references":{"ListItemModifier":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) is created.\nUse this function to add actions and panels to list items, and to override\nthe default settings of a list item. Actions can be added to list items\nusing the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/#actionsSections)\nproperty of the ListItem.","docsTags":[{"name":"since","text":"4.4"},{"name":"see","text":"[Sample - LayerList component with actions](https://developers.arcgis.com/javascript/latest/sample-code/widgets-layerlist-actions/)"},{"name":"example","text":"```js\nlayerListElement.listItemCreatedFunction = async function (event) {\n\n // The event object contains properties of the\n // layer in the LayerList component.\n\n let item = event.item;\n\n // Wait for the layer to load and the item title to become available\n await item.layer.when();\n\n if (item.title === \"US Demographics\") {\n // open the list item in the LayerList component\n item.open = true;\n // change the title to something more descriptive\n item.title = \"Population by county\";\n // set an action for zooming to the full extent of the layer\n item.actionsSections = [[{\n title: \"Go to full extent\",\n icon: \"zoom-out-fixed\",\n id: \"full-extent\"\n }]];\n }\n };\n```"}],"values":[],"optional":true,"required":false},{"name":"minDragEnabledItems","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-drag-enabled-items","reflectToAttr":false,"docs":"The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#dragEnabled).","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[dragEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#dragEnabled)"},{"name":"example","text":"```js\nlayerListElement.dragEnabled = true;\nlayerListElement.minDragEnabledItems = 5;\n```"}],"default":"2","values":[{"type":"number"}],"optional":true,"required":false},{"name":"minFilterItems","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-filter-items","reflectToAttr":false,"docs":"The minimum number of list items required to display the [visibleElements.filter](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/LayerListVisibleElements/) input box.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#showFilter)"},{"name":"example","text":"```js\nlayerListElement.showFilter = true;\nlayerListElement.minFilterItems = 5;\n```"}],"default":"10","values":[{"type":"number"}],"optional":true,"required":false},{"name":"openedLayers","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"FlowLayer":{"location":"import","path":"@arcgis/core/widgets/LayerList.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of [Layer](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/)s that are opened\nin a [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#catalogLayerList) or [tableList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#tableList) flow item.\nThis property is useful for backing out of the catalog layer list or table list\nprogrammatically to the parent layer list.","docsTags":[{"name":"since","text":"4.31"},{"name":"see","text":"[catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#catalogLayerList)"},{"name":"see","text":"[tableList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#tableList)"},{"name":"example","text":"```js\n// back out of the catalog layer list to the main layer list\nlayerListElement.openedLayers.pop();\n```"},{"name":"readonly","text":""}],"default":"[]","values":[],"optional":true,"required":false},{"name":"operationalItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of ListItems representing operational layers.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/)s representing operational layers\nselected by the user.","docsTags":[{"name":"see","text":"[selectionMode](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#selectionMode)"}],"values":[],"optional":true,"required":false},{"name":"selectionMode","type":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","complexType":{"original":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","resolved":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","references":{}},"mutable":true,"attr":"selection-mode","reflectToAttr":false,"docs":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#selectedItems) property.\n\n| Value | Description |\n| ----- | ----------- |\n| multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |\n| none | Disables selection. Use this when you want to prevent selecting items. |\n| single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |\n| single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#selectedItems)"},{"name":"example","text":"```js\nlayerListElement.selectionMode = \"multiple\";\n```"}],"default":"\"none\"","values":[{"type":"string","value":"multiple"},{"type":"string","value":"single"},{"type":"string","value":"none"},{"type":"string","value":"single-persist"}],"optional":true,"required":false},{"name":"showCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-close-button","reflectToAttr":false,"docs":"Indicates whether to display a close button in the header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse-button","reflectToAttr":false,"docs":"Indicates whether to display a collapse button in the header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showErrors","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-errors","reflectToAttr":false,"docs":"Indicates whether to display layers with load errors.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showFilter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-filter","reflectToAttr":false,"docs":"Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [LayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#minFilterItems), allowing users to filter layers by their title.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-heading","reflectToAttr":false,"docs":"Indicates whether to display the layer list heading. The heading text is \"Layer List\". The heading level can be set with the [LayerList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#headingLevel).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showTemporaryLayerIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-temporary-layer-indicators","reflectToAttr":false,"docs":"Indicates whether temporary layer indicators will be displayed for layers with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the layer title.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"tableList","type":"TableList | null | undefined","complexType":{"original":"TableList | null | undefined","resolved":"TableList | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/TableList.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The TableList that displays the tables associated with a KnowledgeGraphLayer.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-layer-list component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visibilityAppearance","type":"VisibilityAppearance","complexType":{"original":"VisibilityAppearance","resolved":"VisibilityAppearance","references":{"VisibilityAppearance":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"attr":"visibility-appearance","reflectToAttr":false,"docs":"Determines the icons used to indicate visibility.\n\n| Value | Description | Example |\n| ----- | ----------- | ------- |\n| default | Displays view icons on the far side. Icons are hidden except on hover or if they have keyboard focus. See [view-visible](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-visible&library=Calcite%20UI&query=view) and [view-hide](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-hide&library=Calcite%20UI&query=view) calcite icons. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\n| checkbox | Displays checkbox icons on the near side. See [check-square-f](https://developers.arcgis.com/calcite-design-system/icons/?icon=check-square-f&library=Calcite%20UI&query=check) and [square](https://developers.arcgis.com/calcite-design-system/icons/?icon=square&library=Calcite%20UI&query=square) calcite icons. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |","docsTags":[{"name":"since","text":"4.29"},{"name":"example","text":"```js\nlayerListElement.visibilityAppearance = \"checkbox\";\n```"}],"default":"\"default\"","values":[{"type":"string","value":"checkbox"},{"type":"string","value":"default"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisLayerList = document.createElement(\"arcgis-layer-list\");\ndocument.body.append(arcgisLayerList);\nawait arcgisLayerList.componentOnReady();\nconsole.log(\"arcgis-layer-list is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"triggerAction","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(action: ActionButton | ActionToggle, item: ListItem): Promise","parameters":[{"name":"action","type":"ActionButton | ActionToggle","docs":""},{"name":"item","type":"ListItem","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"signature":"triggerAction(action: ActionButton | ActionToggle, item: ListItem): Promise","parameters":[{"name":"action","type":"ActionButton | ActionToggle","docs":""},{"name":"item","type":"ListItem","docs":""}],"docs":"","docsTags":[]}],"events":[{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[{"name":"since","text":"4.33"}]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTriggerAction","detail":"LayerListViewModelTriggerActionEvent","bubbles":true,"complexType":{"original":"LayerListViewModelTriggerActionEvent","resolved":"LayerListViewModelTriggerActionEvent","references":{"LayerListViewModelTriggerActionEvent":{"location":"import","path":"@arcgis/core/widgets/LayerList/LayerListViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when an action is triggered on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/layer-list-next/layer-list-next.tsx","tag":"arcgis-layer-list-next","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n> The Layer List (next) component is the successor to the Layer List component, provided to you early for testing and feedback. In version 6.0, the implementation of [arcgis-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/) will be updated under the hood to that of [arcgis-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/), and this component will be removed. There is a breaking change in how events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#catalogLayerList) and [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList) are handled compared to Layer List. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Layer List (next) provides a way to display a list of layers and switch on/off their visibility.\nThe [listItemCreatedFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#listItemCreatedFunction) and the [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\n\n> **Notes**\n>\n> - The Layer List does not emit an event when the visibility of a layer changes. To respond to layer visibility changes, watch the [visible](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#visible) property of layers in the [allLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#allLayers) property with [reactiveUtils](https://developers.arcgis.com/javascript/latest/references/core/core/reactiveUtils/).\n> - To hide layers in the map from the Layer List, you must set the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property on the desired layers to `hide`.\n> - When a [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/) is present in the map, the Layer List will display the [tables](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/#tables) as a [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList) ListItem.\n> - When a [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) is present in the map, the Layer List will display the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#catalogLayerList) ListItem.\n\n> **Keyboard Navigation**\n>\n> - The Layer List supports keyboard navigation using the [Treegrid Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid/) for improved accessibility. Refer to the Calcite List component documentation for detailed keyboard interaction guidelines: [Calcite List Keyboard Navigation](https://developers.arcgis.com/calcite-design-system/components/list/#keyboard-navigation).","docsTags":[{"name":"since","text":"5.1"},{"name":"beta"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"catalogLayerList","type":"ArcgisCatalogLayerList | undefined","complexType":{"original":"ArcgisCatalogLayerList | undefined","resolved":"ArcgisCatalogLayerList | undefined","references":{"ArcgisCatalogLayerList":{"location":"local","path":"components/arcgis-catalog-layer-list","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The CatalogLayerList that displays a catalog layer's [dynamic group layer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer).\nThe catalog layer list will be displayed as an expandable ListItem in the root of the layer list when a CatalogLayer is present in the map.\nThis property is set when a catalog layer's dynamic group layer is expanded in the LayerList. Otherwise, it is `null`.\nThis property is useful for listening to the [arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#event-arcgisTriggerAction) event and managing selections in catalog layers.\n\n![CatalogLayerList](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/catalog-layer-list.avif)","docsTags":[{"name":"example","text":"```js\n// Use reactiveUtils to respond to the layerListElement.catalogLayerList \"arcgisTriggerAction\" event\nconst catalogLayerListActionHandle = reactiveUtils.on(\n () => layerListElement.catalogLayerList,\n \"arcgisTriggerAction\",\n async (event) => {\n const { action, item } = event.detail;\n if (action.id === \"add-layer\") {\n try {\n const parentCatalogLayer = getCatalogLayerForLayer(item.layer);\n if (!parentCatalogLayer) {\n return;\n }\n await addLayerFromDynamicGroup(item.layer);\n alert(`Added ${item.layer.title} to the map`);\n } catch (error) {\n console.error(\"Failed to add layer from dynamic group\", error);\n alert(`Unable to add ${item.layer.title} to the map`);\n }\n layerListElement?.openedLayers?.pop();\n }\n },\n);\nlayerListHandles.push(catalogLayerListActionHandle);\n\n// Use reactiveUtils to watch for a selected item in the layerListElement.catalogLayerList\nconst catalogSelectionWatchHandle = reactiveUtils.watch(\n () =>\n layerListElement.catalogLayerList?.selectedItems?.at(0)?.layer as Layer,\n (layer) => {\n layer && handleLayerSelection(layer);\n },\n);\nlayerListHandles.push(catalogSelectionWatchHandle);\n```"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"catalogOptions","type":"CatalogLayerListParams | undefined","complexType":{"original":"CatalogLayerListParams | undefined","resolved":"CatalogLayerListParams | undefined","references":{"CatalogLayerListParams":{"location":"local","path":"components/arcgis-layer-list-next/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"[CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) specific properties.\nCatalog layers will display their [CatalogLayer#dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) as an expandable [arcgis-catalog-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/) in the Layer List component.\nThis list item will only be displayed when catalog layers with dynamic group layers are loaded in the map.\nThese are the properties that are used to configure the [arcgis-catalog-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/).","docsTags":[{"name":"see","text":"[arcgis-catalog-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/) for more details on the catalog layer list and its properties."},{"name":"example","text":"```js\nlayerListElement.catalogOptions = {\n listItemCreatedFunction: (event) => {\n const { item } = event;\n item.actionsSections = [\n [\n {\n title: \"Add layer to map\",\n icon: \"add-layer\",\n id: \"add-layer\"\n }\n ]\n ];\n },\n selectionMode: \"single\"\n };\n```"}],"values":[],"optional":true,"required":false},{"name":"closed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closed","reflectToAttr":false,"docs":"Indicates whether a component is closed. When `true`, the component will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapsed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"collapsed","reflectToAttr":false,"docs":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","docsTags":[{"name":"see","text":"[showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#showCollapseButton)"},{"name":"example","text":"```js\nlayerListElement.collapsed = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"dragEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"drag-enabled","reflectToAttr":false,"docs":"Indicates whether [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) may be reordered within the list by dragging and dropping.\nMapImageLayer [MapImageLayer#sublayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.\nDrag won't be enabled until the number of list items is equal to or greater than than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#minDragEnabledItems).","docsTags":[{"name":"see","text":"[minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#minDragEnabledItems)"},{"name":"example","text":"```js\nlayerListElement.dragEnabled = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterPlaceholder","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-placeholder","reflectToAttr":false,"docs":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#showFilter) is true.","docsTags":[{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#showFilter)"},{"name":"example","text":"```js\nlayerListElement.filterPlaceholder = \"Filter layers\";\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"filterPredicate","type":"((item: ListItem | TableListListItem) => boolean) | undefined","complexType":{"original":"((item: ListItem | TableListListItem) => boolean) | undefined","resolved":"((item: ListItem | TableListListItem) => boolean) | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/TableList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/).","docsTags":[{"name":"example","text":"```js\nlayerListElement.filterPredicate = (item) => item.title.toLowerCase().includes(\"streets\");\n```"}],"values":[],"optional":true,"required":false},{"name":"filterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-text","reflectToAttr":false,"docs":"The value of the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#showFilter) is true.","docsTags":[{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#showFilter)"},{"name":"example","text":"```js\nreactiveUtils.watch(\n () => layerListElement.filterText,\n (filterText) => console.log(filterText)\n);\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the heading of the component.\nBy default, the heading is rendered as a level 2 heading (e.g., `

Layer List

`).\nDepending on the component's placement in your app, you may need to adjust this heading for proper semantics.\nThis is important for meeting accessibility standards.","docsTags":[{"name":"see","text":"[showHeading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#showHeading)"},{"name":"example","text":"```js\nlayerListElement.headingLevel = 3;\n```"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideCatalogLayerList","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-catalog-layer-list","reflectToAttr":false,"docs":"This property provides the ability to show or hide the catalog layer list.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStatusIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-status-indicators","reflectToAttr":false,"docs":"This property provides the ability to show or hide status indicators.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"layers\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"knowledgeGraphOptions","type":"TableListParams | undefined","complexType":{"original":"TableListParams | undefined","resolved":"TableListParams | undefined","references":{"TableListParams":{"location":"local","path":"components/arcgis-layer-list-next/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"[KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/) specific properties.\n[KnowledgeGraphLayer#tables](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/#tables)\nas an expandable [arcgis-table-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/) in the Layer List component and can be accessed with the [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList) property.\nThis tables list item will only be displayed when knowledge graph layers with tables are loaded in the map.\nThese are the properties that are used to configure the [arcgis-table-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/).","docsTags":[{"name":"see","text":"[arcgis-table-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/) for more details on the table list and its properties."},{"name":"example","text":"```js\nlayerListElement.knowledgeGraphOptions = {\n filterPlaceholder: \"Filter tables\",\n listItemCreatedFunction: (event) => {\n const { item } = event;\n item.actionsSections = [\n [\n {\n icon: \"table\",\n id: \"open-table\",\n title: \"Show table\"\n },\n {\n icon: \"information\",\n id: \"information\",\n title: \"Show information\"\n }\n ]\n ];\n },\n minFilterItems: 1\n}\n```"}],"values":[],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layerTablesAvailable","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"TableSupportedLayers":{"location":"local","path":"utils/layer-list-utils","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"listItemCanGiveFunction","type":"CanSortFunction | undefined","complexType":{"original":"CanSortFunction | undefined","resolved":"CanSortFunction | undefined","references":{"CanSortFunction":{"location":"local","path":"utils/layer-list-utils","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"listItemCanReceiveFunction","type":"CanSortFunction | undefined","complexType":{"original":"CanSortFunction | undefined","resolved":"CanSortFunction | undefined","references":{"CanSortFunction":{"location":"local","path":"utils/layer-list-utils","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"listItemCreatedFunction","type":"ListItemModifier | null | undefined","complexType":{"original":"ListItemModifier | null | undefined","resolved":"ListItemModifier | null | undefined","references":{"ListItemModifier":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) is created.\nUse this function to add actions and panels to list items, and to override\nthe default settings of a list item. Actions can be added to list items\nusing the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/#actionsSections)\nproperty.","docsTags":[{"name":"see","text":"[Sample - LayerList component with actions](https://developers.arcgis.com/javascript/latest/sample-code/layer-list-actions/)"},{"name":"example","text":"```js\nlayerListElement.listItemCreatedFunction = async function (event) {\n // The event object contains an item property.\n // It is a ListItem referencing the associated layer\n // and other properties. You can control the visibility of the\n // item, its title, and actions using this object.\n const item = event.item;\n\n await item.layer.when();\n\n if (item.title === \"US Demographics\") {\n // An array of objects defining actions to place in the LayerList.\n // By making this array two-dimensional, you can separate similar\n // actions into separate groups with a breaking line.\n item.actionsSections = [\n [\n {\n title: \"Go to full extent\",\n icon: \"zoom-out-fixed\",\n id: \"full-extent\",\n },\n {\n title: \"Layer information\",\n icon: \"information\",\n id: \"information\",\n },\n ],\n [\n {\n title: \"Increase opacity\",\n icon: \"chevron-up\",\n id: \"increase-opacity\",\n },\n {\n title: \"Decrease opacity\",\n icon: \"chevron-down\",\n id: \"decrease-opacity\",\n },\n ],\n ];\n }\n}\n```"}],"values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Overwrite localized strings for this component","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"minDragEnabledItems","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-drag-enabled-items","reflectToAttr":false,"docs":"The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#dragEnabled).","docsTags":[{"name":"see","text":"[dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#dragEnabled)"},{"name":"example","text":"```js\nlayerListElement.dragEnabled = true;\nlayerListElement.minDragEnabledItems = 5;\n```"}],"default":"2","values":[{"type":"number"}],"optional":true,"required":false},{"name":"minFilterItems","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-filter-items","reflectToAttr":false,"docs":"The minimum number of list items required to display the [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#showFilter) input box.","docsTags":[{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#showFilter)"},{"name":"example","text":"```js\nlayerListElement.showFilter = true;\nlayerListElement.minFilterItems = 5;\n```"}],"default":"10","values":[{"type":"number"}],"optional":true,"required":false},{"name":"openedLayers","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"FlowLayer":{"location":"local","path":"components/arcgis-layer-list-next/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of [Layer](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/)s that are opened\nin a [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#catalogLayerList) or [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList) flow item.\nThis property is useful for backing out of the catalog layer list or table list\nprogrammatically to the parent layer list.","docsTags":[{"name":"see","text":"[catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#catalogLayerList)"},{"name":"see","text":"[tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList)"},{"name":"example","text":"```js\n// back out of the catalog layer list to the main layer list\nlayerListElement.openedLayers.pop();\n```"},{"name":"readonly","text":""}],"default":"[]","values":[],"optional":true,"required":false},{"name":"operationalItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/)s representing the operational layers in the layer list.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/LayerList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/)s representing operational layers\nselected by the user in the layer list.","docsTags":[{"name":"see","text":"[selectionMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#selectionMode)"}],"values":[],"optional":true,"required":false},{"name":"selectionMode","type":"List[\"selectionMode\"]","complexType":{"original":"List[\"selectionMode\"]","resolved":"List[\"selectionMode\"]","references":{"List":{"location":"import","path":"@esri/calcite-components/components/calcite-list","id":"notImplemented"}}},"mutable":true,"attr":"selection-mode","reflectToAttr":false,"docs":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#selectedItems) property.\n\n| Value | Description |\n| ----- | ----------- |\n| multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |\n| none | Disables selection. Use this when you want to prevent selecting items. |\n| single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |\n| single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |","docsTags":[{"name":"see","text":"[selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#selectedItems)"},{"name":"example","text":"```js\nlayerListElement.selectionMode = \"multiple\";\n```"}],"default":"\"none\"","values":[{"type":"string","value":"multiple"},{"type":"string","value":"single"},{"type":"string","value":"none"},{"type":"string","value":"single-persist"}],"optional":true,"required":false},{"name":"showCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-close-button","reflectToAttr":false,"docs":"This property provides the ability to show or hide the close button.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse-button","reflectToAttr":false,"docs":"This property provides the ability to show or hide the collapse button.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showErrors","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-errors","reflectToAttr":false,"docs":"This property provides the ability to show or hide error indicators.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showFilter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-filter","reflectToAttr":false,"docs":"This property provides the ability to show or hide the filter input.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-heading","reflectToAttr":false,"docs":"This property provides the ability to show or hide the heading.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showTemporaryLayerIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-temporary-layer-indicators","reflectToAttr":false,"docs":"This property provides the ability to show or hide temporary layer indicators.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/LayerList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"tableList","type":"ArcgisTableList | undefined","complexType":{"original":"ArcgisTableList | undefined","resolved":"ArcgisTableList | undefined","references":{"ArcgisTableList":{"location":"local","path":"components/arcgis-table-list","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [arcgis-table-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/) component instance that displays the tables associated with a [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/).\nThe table list will be displayed as an expandable list item.\nThis property is set when a knowledge graph layer's tables list item is expanded in the LayerList.\nOtherwise, it is `null`.\nThis list item will only be displayed when knowledge graph layers with tables are loaded in the map and will be displayed as a child of the knowledge graph layer.\nThis property is useful for listening to the [arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#event-arcgisTriggerAction) event and managing selections in knowledge graph tables.\n\n![tableList](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list-tableList.avif)","docsTags":[{"name":"see","text":"[knowledgeGraphOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#knowledgeGraphOptions) for configuring the table list and its items."},{"name":"example","text":"// Use reactiveUtils to respond to the layerListElement.tableList \"arcgisTriggerAction\" event\nconst tableListActionHandle = reactiveUtils.on(\n () => layerListElement.tableList,\n \"arcgisTriggerAction\",\n (event: any) => {\n const { action, item } = event.detail;\n if (action.id === \"information\") {\n alert(`${item.layer?.title}`);\n }\n },\n);\nlayerListHandles.push(tableListActionHandle);\n\n// Use reactiveUtils to watch for a selected item in the layerListElement.tableList\nconst tableSelectionWatchHandle = reactiveUtils.watch(\n () => layerListElement.tableList?.selectedItems?.at(0)?.layer,\n (layer) => {\n layer && handleLayerSelection(layer);\n },\n);\nlayerListHandles.push(tableSelectionWatchHandle);"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-layer-list-next component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visibilityAppearance","type":"VisibilityAppearance","complexType":{"original":"VisibilityAppearance","resolved":"VisibilityAppearance","references":{"VisibilityAppearance":{"location":"local","path":"utils/action-utils","id":"notImplemented"}}},"mutable":true,"attr":"visibility-appearance","reflectToAttr":false,"docs":"Determines the icons used to indicate visibility.\n\n| Value | Description | Example |\n| ----- | ----------- | ------- |\n| default | Displays view icons on the far side. Icons are hidden except on hover or if they have keyboard focus. See [view-visible](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-visible&library=Calcite%20UI&query=view) and [view-hide](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-hide&library=Calcite%20UI&query=view) calcite icons. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\n| checkbox | Displays checkbox icons on the near side. See [check-square-f](https://developers.arcgis.com/calcite-design-system/icons/?icon=check-square-f&library=Calcite%20UI&query=check) and [square](https://developers.arcgis.com/calcite-design-system/icons/?icon=square&library=Calcite%20UI&query=square) calcite icons. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |","docsTags":[{"name":"example","text":"```js\nlayerListElement.visibilityAppearance = \"checkbox\";\n```"}],"default":"\"default\"","values":[{"type":"string","value":"checkbox"},{"type":"string","value":"default"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisLayerListNext = document.createElement(\"arcgis-layer-list-next\");\ndocument.body.append(arcgisLayerListNext);\nawait arcgisLayerListNext.componentOnReady();\nconsole.log(\"arcgis-layer-list-next is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTriggerAction","detail":"LayerListViewModelEvents[\"trigger-action\"]","bubbles":true,"complexType":{"original":"LayerListViewModelEvents[\"trigger-action\"]","resolved":"LayerListViewModelEvents[\"trigger-action\"]","references":{"LayerListViewModelEvents":{"location":"import","path":"@arcgis/core/widgets/LayerList/LayerListViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when an action is triggered on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/legend/legend.tsx","tag":"arcgis-legend","overview":"","readme":"","usage":{},"docs":"The Legend component displays the symbols and labels used to represent layers in an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\nOnly layers and sublayers visible in the view are shown, unless [ignoreLayerVisibility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#ignoreLayerVisibility) is set to `true`.\n\nThe legend automatically updates when:\n - the visibility of a layer or sublayer changes\n - a layer is added or removed from the map\n - a layer's `renderer`, `opacity`, or `title` is changed\n - the `legendEnabled` property is changed (set to `true` or `false` on the layer)\n\n## Known Limitations\n\n* Currently, the legend component does not support the following layer types:\n[ElevationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMeshLayer/),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KMLLayer/),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapNotesLayer/),\n[OpenStreetMapLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OpenStreetMapLayer/),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/), and\n[WebTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WebTileLayer/).\n* [Symbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/Symbol3D/) with more than one\n[symbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/Symbol3DLayer/) are not supported.\n* [DictionaryRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/DictionaryRenderer/) is not supported.\n* [TrackInfo](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TrackInfo/) is not supported.\n* CIM Symbol [primitiveOverride](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/#PrimitiveOverride) is not supported.\n* RasterStretchRenderer [dynamicRangeAdjustment](https://developers.arcgis.com/javascript/latest/references/core/renderers/RasterStretchRenderer/#dynamicRangeAdjustment) is not supported.\n\n## Various examples of legends based on renderer type.\n\n### Unique values\n\n[![Unique values](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-unique-values.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-location-types/)\n\n### Continuous color\n\n[![Continuous color](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-color-vv.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-vv-color/)\n\n### Classed color\n\n[![Classed color](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-class-breaks.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-classbreaks/)\n\n### Continuous size\n\n[![Continuous size](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-size.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size/)\n\n### Size - above and below\n\n[![Size - above and below](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-size-themes.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size-themes/)\n\n### Dot density\n\n[![Dot density](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-dot-density.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-dot-density/)\n\n### Predominance\n\n[![Predominance](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-predominance.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-arcade/)\n\n### Relationship\n\n[![Relationship](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-relationship.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-relationship/)\n\n\n## Legend labels\n\nLegend text is directly controlled through the [layer](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/) and [renderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/Renderer/) properties. For example, `layer.title` is directly used by the legend to present a layer's symbology to the end user. To override this text, you can directly update `layer.title`.\n\nFurthermore, you can control date and number formatting in Legend by using the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) formatting options on the layer. As an alternative to this, you can override Legend text via the renderer's properties. For example, the renderer may have a [legendOptions](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#legendOptions) property (or a label property in the case of visual variable stops or UniqueValueInfos) that can be used to override default legend text describing the renderer element in question. The [Update legend text sample](https://developers.arcgis.com/javascript/latest/sample-code/legend-update/) provides an example of overriding legend text via the renderer.\n\nNote that when you override legend text, all formatting and localization that would otherwise be dynamically applied to labels will no longer apply.","docsTags":[{"name":"see","text":"[Sample - Legend component](https://developers.arcgis.com/javascript/latest/sample-code/legend/)"},{"name":"see","text":"[Sample - Add a Legend to the LayerList](https://developers.arcgis.com/javascript/latest/sample-code/layerlist-legend/)"},{"name":"see","text":"[Sample - Legend component card style](https://developers.arcgis.com/javascript/latest/sample-code/legend-card/)"},{"name":"see","text":"[Sample - Update legend text](https://developers.arcgis.com/javascript/latest/sample-code/legend-update/)"},{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"activeLayerInfos","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Legend/support/ActiveLayerInfo.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Collection of [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/references/core/widgets/Legend/support/ActiveLayerInfo/) objects used by the legend view to\ndisplay data in the legend. The legend component watches this property to hide or display the layer's legend when\nan [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/references/core/widgets/Legend/support/ActiveLayerInfo/) is removed from or added to this collection.","docsTags":[],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"basemapLegendVisible","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"basemap-legend-visible","reflectToAttr":false,"docs":"Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) layers in the Legend. If you set this property to\n`true` and specify [layerInfos](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#layerInfos) that include the basemap layers, the basemap will be displayed in the legend.\n\n> **Known limitation:**\n>\n> [VectorTileLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer/) in the basemap are not currently supported in the legend.\n> This includes most Esri basemaps such as \"Streets\", \"Topographic\", \"Navigation\", and others that use vector tiles.","docsTags":[{"name":"example","text":"Show basemap layers in the legend\n\n```js\nconst mapElement = document.querySelector(\"arcgis-map\");\nconst basemapLayer = mapElement.map.basemap.baseLayers.getItemAt(0);\nconst legend = document.querySelector(\"arcgis-legend\");\nlegend.layerInfos = [{ layer: basemapLayer }];\nlegend.basemapLegendVisible = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"cardStyleLayout","type":"\"auto\" | \"side-by-side\" | \"stack\" | undefined","complexType":{"original":"\"auto\" | \"side-by-side\" | \"stack\" | undefined","resolved":"\"auto\" | \"side-by-side\" | \"stack\" | undefined","references":{}},"mutable":true,"attr":"card-style-layout","reflectToAttr":false,"docs":"Indicates the layout of the legend when the [legendStyle](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#legendStyle) is set to the string value of `\"card\"`.\nThe layout determines how the legend's content is arranged.\n\n[![card-style-layout](https://developers.arcgis.com/javascript/latest/assets/references/components/legend/card-style-layout.avif)](https://developers.arcgis.com/javascript/latest/sample-code/legend-card/)","docsTags":[{"name":"since","text":"4.34"},{"name":"example","text":"Renders the legend in the card style with a \"stack\" layout\n\n```html\n\n```\n\n```js\nconst legend = document.querySelector(\"arcgis-legend\");\nlegend.legendStyle = \"card\";\nlegend.cardStyleLayout = \"stack\";\n```"}],"values":[{"type":"string","value":"auto"},{"type":"string","value":"side-by-side"},{"type":"string","value":"stack"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the legend title. By default, legend titles are rendered as level 3 headings (e.g. `

Legend title

`). Depending on the legend placement\nin your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","docsTags":[{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"example","text":"Legend title will render as an `

`\n\n```html\n\n```\n\n```js\ndocument.querySelector(\"arcgis-legend\").headingLevel = 2;\n```"}],"default":"3","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideLayersNotInCurrentView","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-layers-not-in-current-view","reflectToAttr":false,"docs":"When `true`, layers will only be shown in the legend if they are visible in the view's extent. When data from a layer\nis not visible in the view, the layer's legend information will be hidden. Only layers that implement the `createQuery()`\nand `queryFeatureCount()` methods are supported by `hideLayersNotInCurrentView`.\n\nTo hide layers completely from the legend, you should set the `legendEnabled` property of the layer to `false`.","docsTags":[{"name":"see","text":"[ignoreLayerVisibility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#ignoreLayerVisibility)"},{"name":"example","text":"Layers not displayed in the current map extent will not be shown in the legend\n\n```html\n\n```\n\n```js\ndocument.querySelector(\"arcgis-legend\").hideLayersNotInCurrentView = true;\n```"},{"name":"since","text":"4.21"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"legend\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"ignoreLayerVisibility","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"ignore-layer-visibility","reflectToAttr":false,"docs":"Determines whether to respect the properties of the layers in the map that control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`).\nBy default, a layer's legend elements **will not render** in the legend given the following conditions:\n\n- The layer's [legendEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#legendEnabled) property\nis set to `false`.\n- If the view's scale is outside the visibility range\ndefined by the layer's [minScale](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#minScale) and\n[maxScale](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#maxScale) properties.\n\nWhen the `ignoreLayerVisibility` property of the legend is set to `true`, the legend elements for each\nlayer in the map will always display, thus disregarding the `minScale`, `maxScale`,\nand `legendEnabled` properties for each layer in the map.","docsTags":[{"name":"since","text":"4.34"},{"name":"see","text":"[hideLayersNotInCurrentView](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#hideLayersNotInCurrentView)"},{"name":"example","text":"Always displays legend elements for the map's layers regardless of their minScale, maxScale, and legendEnabled properties.\n\n```html\n\n```\n\n```js\ndocument.querySelector(\"arcgis-legend\").ignoreLayerVisibility = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"default":"\"Legend\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"layerInfos","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"LayerInfo":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a subset of the layers to display in the legend. This includes any basemap layers\nyou want to be visible in the legend. If this property is not set, all layers in the map will display in the legend, including\nbasemap layers if [basemapLegendVisible](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#basemapLegendVisible) is `true`. Objects in this array are defined with the properties in the example below.","docsTags":[{"name":"example","text":"Only show a specific sublayer in the legend\n\n```js\nconst subtypeGroupLayer = webmap.layers.getItemAt(0);\nconst subtypeSubLayer = subtypeGroupLayer.sublayers.getItemAt(1);\nconst subtypeSublayerId = parseInt(subtypeSubLayer.subtypeCode);\ndocument.querySelector(\"arcgis-legend\").layerInfos = [\n {\n layer: subtypeGroupLayer,\n sublayerIds: [subtypeSublayerId]\n }\n];\n});\n```"}],"values":[],"optional":true,"required":false},{"name":"legendStyle","type":"\"card\" | \"classic\" | {\n type: \"card\" | \"classic\";\n layout?: \"auto\" | \"side-by-side\" | \"stack\";\n}","complexType":{"original":"\"card\" | \"classic\" | {\n type: \"card\" | \"classic\";\n layout?: \"auto\" | \"side-by-side\" | \"stack\";\n}","resolved":"\"card\" | \"classic\" | {\n type: \"card\" | \"classic\";\n layout?: \"auto\" | \"side-by-side\" | \"stack\";\n}","references":{}},"mutable":true,"attr":"legend-style","reflectToAttr":false,"docs":"Indicates the style of the legend. The style determines the legend's layout and behavior.\nYou can either specify a string or an object to indicate the style. The known string values are the same values listed in\nthe table within the `type` property.\n\n[![legend-style](https://developers.arcgis.com/javascript/latest/assets/references/components/legend/legend-style.avif)](https://developers.arcgis.com/javascript/latest/sample-code/legend-card/)","docsTags":[{"name":"see","text":"[cardStyleLayout](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#cardStyleLayout)"},{"name":"example","text":"Renders the legend in the card style with a stack layout\n\n```js\ndocument.querySelector(\"arcgis-legend\").legendStyle = {\n type: \"card\",\n layout: \"stack\"\n};\n```"}],"default":"\"classic\"","values":[{"type":"string","value":"card"},{"type":"string","value":"classic"},{"type":"object"}],"optional":true,"required":false},{"name":"loading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loading","reflectToAttr":true,"docs":"Indicates whether the legend is currently loading.","docsTags":[{"name":"since","text":"4.34"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"respectLayerDefinitionExpression","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"respect-layer-definition-expression","reflectToAttr":false,"docs":"If a layer uses a unique value render, only features that satisfy the layer's\n[definition](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#definitionExpression)\nwill be displayed in the legend when set to true.","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[definitionExpression](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#definitionExpression)"},{"name":"example","text":"Only display features that satisfy the layer's definitionExpression.\n\n```html\n\n```\n\n```js\ndocument.querySelector(\"arcgis-legend\").respectLayerDefinitionExpression = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"LegendViewModelState","complexType":{"original":"LegendViewModelState","resolved":"LegendViewModelState","references":{"LegendViewModelState":{"location":"import","path":"@arcgis/core/widgets/Legend/LegendViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"LinkChartView | MapViewOrSceneView | null | undefined","complexType":{"original":"LinkChartView | MapViewOrSceneView | null | undefined","resolved":"LinkChartView | MapViewOrSceneView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/LinkChartView.js","id":"notImplemented"},"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-legend component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisLegend = document.createElement(\"arcgis-legend\");\ndocument.body.append(arcgisLegend);\nawait arcgisLegend.componentOnReady();\nconsole.log(\"arcgis-legend is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/line-of-sight/line-of-sight.tsx","tag":"arcgis-line-of-sight","overview":"","readme":"","usage":{},"docs":"The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysis/)\nin an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including the ground, integrated meshes, and 3D objects such as buildings or trees.\n\n![line-of-sight](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/line-of-sight.avif)\n\nThe analysis results are displayed as colored lines, where areas visible to the observer are\nshown green and occluded parts are marked in red. Also, the color of the target points indicates their visibility.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis, the first click in the Scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysisObserver/)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysisTarget/).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Known limitation**\n\nLine Of Sight is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysis/)\n- [Sample - Line of sight component](https://developers.arcgis.com/javascript/latest/sample-code/line-of-sight/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"analysis","type":"LineOfSightAnalysis","complexType":{"original":"LineOfSightAnalysis","resolved":"LineOfSightAnalysis","references":{"default":{"location":"import","path":"@arcgis/core/analysis/LineOfSightAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Line Of Sight component to the [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses) collection.\nYou can then wait for the [LineOfSightAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/LineOfSightAnalysisView3D/)\nto be created before accessing the analysis results.\n\n```js\n// Get the Scene component and the Line Of Sight component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst lineOfSightElement = document.querySelector(\"arcgis-line-of-sight\");\nawait lineOfSightElement.componentOnReady();\n\n// Get the LineOfSightAnalysis created by the Line Of Sight component.\nconst analysis = lineOfSightElement.analysis;\n\n// Get the LineOfSightAnalysisView3D and watch for updates.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysisView?.results,\n () => {\n console.log(\"Analysis results:\", analysisView.results);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.\n\n```js\n// Create the LineOfSightAnalysis.\nconst lineOfSightAnalysis = new LineOfSightAnalysis({\n observer: new LineOfSightAnalysisObserver({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624828.3377593,\n y: 4550305.319405007,\n z: 105.55410975124687\n }),\n }),\n targets: [ new LineOfSightAnalysisTarget({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624944.17687458,\n y: 4550420.577689567,\n z: 0\n }),\n })\n]\n});\n\n// Get the Scene component and the Line Of Sight component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst lineOfSightElement = document.querySelector(\"arcgis-line-of-sight\");\nawait lineOfSightElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Scene component.\nviewElement.analyses.add(lineOfSightAnalysis);\n\n// Connect the analysis to the component:\nlineOfSightElement.analysis = lineOfSightAnalysis;\n```","docsTags":[],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-line-of-sight/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideContinueButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-continue-button","reflectToAttr":false,"docs":"If true, the button that allows the user to continue placing more targets.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDoneButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-done-button","reflectToAttr":false,"docs":"If true, the button that ends the current placement will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStartButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-start-button","reflectToAttr":false,"docs":"If true, the button that starts a new analysis will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualization","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization","reflectToAttr":false,"docs":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"line-of-sight\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"\"created\" | \"creating\" | \"disabled\" | \"ready\"","complexType":{"original":"\"created\" | \"creating\" | \"disabled\" | \"ready\"","resolved":"\"created\" | \"creating\" | \"disabled\" | \"ready\"","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for analysis\n* `creating` - observer/target points are being placed\n* `created` - finished analysis","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"created"},{"type":"string","value":"creating"},{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-line-of-sight component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Clear the current analysis results. After calling this method, the user can set a new observer and targets.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisLineOfSight = document.createElement(\"arcgis-line-of-sight\");\ndocument.body.append(arcgisLineOfSight);\nawait arcgisLineOfSight.componentOnReady();\nconsole.log(\"arcgis-line-of-sight is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"continue","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"continue(): Promise","parameters":[],"docs":"After [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-line-of-sight/#stop) was called, this method allows to continue the line of sight analysis and add more targets.","docsTags":[]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"start","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"start(): Promise","parameters":[],"docs":"Start a new line of sight analysis.","docsTags":[]},{"name":"stop","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"stop(): Promise","parameters":[],"docs":"Stop the current placing of line of sight analysis. Any lines added this far are kept in the view.\nUsers can still interact with existing targets and the observer, but they cannot place new target points.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"analysis\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"analysis\" | \"state\"; }","resolved":"{ name: \"analysis\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/link-chart/link-chart.tsx","tag":"arcgis-link-chart","overview":"","readme":"","usage":{},"docs":"Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/references/core/WebLinkChart/) from an [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/).\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`","docsTags":[{"name":"since","text":"4.32"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"allLayerViews","type":"ReadonlyCollection","complexType":{"original":"ReadonlyCollection","resolved":"ReadonlyCollection","references":{"ReadonlyCollection":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Collection containing a flat list of all the created LayerViews\nrelated to the basemap, operational layers, and group layers in this view.","docsTags":[{"name":"see","text":"[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"analyses","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/analysis/Analysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of analyses associated with the view.","docsTags":[{"name":"since","text":"4.34"},{"name":"example","text":"// Adds an analysis to the View\nview.analyses.add(elevationProfileAnalysis);"},{"name":"example","text":"// Removes an analysis from the View\nview.analyses.remove(elevationProfileAnalysis);"}],"values":[],"optional":true,"required":false},{"name":"animationsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"animations-disabled","reflectToAttr":false,"docs":"Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/FlowRenderer/)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#goTo)).\nSetting this property to `true` disables all animations in the view.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"aria","type":"LinkChartView[\"aria\"]","complexType":{"original":"LinkChartView[\"aria\"]","resolved":"LinkChartView[\"aria\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/LinkChartView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The ARIA attributes for the view container. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements).","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"attributionItems","type":"LinkChartView[\"attributionItems\"]","complexType":{"original":"LinkChartView[\"attributionItems\"]","resolved":"LinkChartView[\"attributionItems\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/LinkChartView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The attribution items displayed in the view's attribution.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"attributionMode","type":"\"dark\" | \"light\" | null | undefined","complexType":{"original":"\"dark\" | \"light\" | null | undefined","resolved":"\"dark\" | \"light\" | null | undefined","references":{}},"mutable":true,"attr":"attribution-mode","reflectToAttr":false,"docs":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"dark"},{"type":"string","value":"light"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"background","type":"ColorBackground | null | undefined","complexType":{"original":"ColorBackground | null | undefined","resolved":"ColorBackground | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/webmap/background/ColorBackground.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The background color of the LinkChartView. If the view's link chart changes, the view's `background` is reset to the link chart's background,\neven if the user set it previously.","docsTags":[{"name":"example","text":"let view = new LinkChartView({\n container: \"viewDiv\",\n map: map,\n background: { // autocasts new ColorBackground()\n color: \"magenta\" // autocasts as new Color()\n }\n});"},{"name":"example","text":"let view = new MapView({\n container: \"viewDiv\",\n map: map,\n background: { // autocasts new ColorBackground()\n color: \"magenta\" // autocasts as new Color()\n }\n});"}],"default":"new ColorBackground({ color: [255, 255, 255, 1] })","values":[],"optional":true,"required":false},{"name":"baseCypherQuery","type":"null | undefined | string","complexType":{"original":"null | undefined | string","resolved":"null | undefined | string","references":{}},"mutable":true,"attr":"base-cypher-query","reflectToAttr":true,"docs":"A Knowledge Open Cypher Query that will be used to generate the link chart. The serviceUrl property must also be set\n\nPlease note that this query only runs once and is used to initialize the link chart. Once link charts are generated, their membership is \"locked\" unless modified by the WebLinkChart API. Refresh events on the link chart canvas do not re-run the query for new data","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"basemap","type":"Basemap | string | undefined","complexType":{"original":"Basemap | string | undefined","resolved":"Basemap | string | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Basemap.js","id":"notImplemented"}}},"mutable":true,"attr":"basemap","reflectToAttr":false,"docs":"Specifies a basemap for the link chart. The basemap is only visible when the link\nchart is set to a geographic layout. See\n[documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm)\nfor more detail. The basemap is a set of layers that give\ngeographic context to the LinkChartView and the other operational layers\nin the link chart.","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"basemapView","type":"BasemapView","complexType":{"original":"BasemapView","resolved":"BasemapView","references":{"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Represents the view for a single basemap after it has been added to the link chart.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"canZoomIn","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates if the view component can zoom in.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canZoomOut","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates if the view component can zoom out.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"center","type":"LinkChartView[\"center\"] | null | undefined | number[] | string","complexType":{"original":"LinkChartView[\"center\"] | null | undefined | number[] | string","resolved":"LinkChartView[\"center\"] | null | undefined | number[] | string","references":{"default":{"location":"import","path":"@arcgis/core/views/LinkChartView.js","id":"notImplemented"}}},"mutable":true,"attr":"center","reflectToAttr":false,"docs":"Represents the view's center point; when setting the center, you may pass a\nesri/geometry/Point instance or a string representing\na longitude/latitude pair (`\"-100.4593, 36.9014\"`).\nSetting the center immediately changes the current view.\nFor animating the view, see this component's goTo() method.","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"constraints","type":"MapViewConstraints","complexType":{"original":"MapViewConstraints","resolved":"MapViewConstraints","references":{"default":{"location":"import","path":"@arcgis/core/views/2d/MapViewConstraints.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies constraints to scale, zoom, and rotation that may be applied to the Link Chart.","docsTags":[{"name":"see","text":"[MapViewConstraints](https://developers.arcgis.com/javascript/latest/references/core/views/2d/MapViewConstraints/)"},{"name":"see","text":"[TileInfo#create()](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TileInfo/#create)"},{"name":"see","text":"[Zoom and LODs](https://developers.arcgis.com/javascript/latest/references/core/views/View2D/#mapview-lods)"},{"name":"example","text":"view.constraints = new MapViewConstraints({\n geometry: { // Constrain lateral movement to Lower Manhattan\n type: \"extent\",\n xmin: -74.020,\n ymin: 40.700,\n xmax: -73.971,\n ymax: 40.73\n },\n minScale: 500000, // User cannot zoom out beyond a scale of 1:500,000\n maxScale: 0, // User can overzoom tiles\n rotationEnabled: false // Disables map rotation\n});"},{"name":"example","text":"// This snippet shows how to set the Link Chart scale 1:1 while generating additional LODs for the constraints.\nconst spatialReference = new SpatialReference({\n wkid: 2154\n});\nconst center = new Point({\n x: 0,\n y: 0,\n spatialReference\n});\n\n// Create LODs from level 0 to 31\nconst tileInfo = TileInfo.create({\n spatialReference,\n numLODs: 32\n});\nconst lods = tileInfo.lods;\n\nconst constraints = new MapViewConstraints({\n snapToZoom: false,\n lods\n});\n\nconst arcgisLinkChart = document.querySelector(\"arcgis-link-chart\");\narcgisLinkChart.spatialReference = spatialReference;\narcgisLinkChart.center = center;\narcgisLinkChart.scale = 1;\narcgisLinkChart.constraints = constraints;"}],"values":[],"optional":true,"required":false},{"name":"displayFilterDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"display-filter-disabled","reflectToAttr":false,"docs":"Indicates whether layer's displayFilter are honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"extent","type":"LinkChartView[\"extent\"]","complexType":{"original":"LinkChartView[\"extent\"]","resolved":"LinkChartView[\"extent\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/LinkChartView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The extent represents the visible portion of a link chart within the view as an instance of\n[Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/).\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's goTo() method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the link chart.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"fatalError","type":"Error | null | undefined","complexType":{"original":"Error | null | undefined","resolved":"Error | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/core/Error.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A rejected view indicates a fatal error making it unable to display.","docsTags":[{"name":"since","text":"4.12"},{"name":"see","text":"[tryFatalErrorRecovery()](https://developers.arcgis.com/javascript/latest/references/core/views/View/#tryFatalErrorRecovery)"},{"name":"example","text":"reactiveUtils.when(\n () => view.fatalError,\n () => {\n console.error(\"Fatal Error! View has lost its WebGL context. Attempting to recover...\");\n view.tryFatalErrorRecovery();\n }\n);"}],"values":[],"optional":true,"required":false},{"name":"graphics","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Allows for adding graphics directly to the default graphics in the View.","docsTags":[{"name":"example","text":"```js\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n```"},{"name":"example","text":"```js\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```"},{"name":"see","text":"[Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/)"},{"name":"see","text":"[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/)"},{"name":"see","text":"[Intro to graphics](https://developers.arcgis.com/javascript/latest/sample-code/intro-graphics/)"}],"values":[],"optional":true,"required":false},{"name":"hideAttribution","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-attribution","reflectToAttr":false,"docs":"Indicates whether the attribution is hidden in the view.\n\nEsri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.\nFor detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.\nFor information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlights","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/views/support/HighlightOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The highlights property is a collection of HighlightGroup objects that\nallow you to visually emphasize specific features on the link chart.","docsTags":[{"name":"since","text":"4.32"},{"name":"see","text":"[Sample: Highlight features by geometry](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)"},{"name":"see","text":"[Sample: Highlight SceneLayer](https://developers.arcgis.com/javascript/latest/sample-code/highlight-scenelayer/)"},{"name":"example","text":"// Use the default highlights collection to apply a highlight to features when you hover over them\n\n// A handler can be used to remove any previous highlight when applying a new one\nlet hoverHighlight;\n\nview.on(\"pointer-move\", (event) => {\n // Search for the first feature in the featureLayer at the hovered location\n view.hitTest(event, { include: featureLayer }).then((response) => {\n if (response.results[0]) {\n const graphic = response.results[0].graphic;\n view.whenLayerView(graphic.layer).then((layerView) => {\n // Remove any previous highlight, if it exists\n hoverHighlight?.remove();\n // Highlight the hit features with the temporary highlight options, which are pre-configured for this use case\n hoverHighlight = layerView.highlight(graphic, { name: \"temporary\"});\n });\n }\n });\n});"},{"name":"example","text":"// Override the default highlights collection\n\nconst view = new MapView({\n map: map,\n container: \"viewDiv\",\n\n // Set the highlight options to be used in the view\n highlights: [\n { name: \"default\", color: \"orange\" },\n { name: \"temporary\", color: \"magenta\" },\n { name: \"table\", color: \"cyan\", fillOpacity: 0.5, haloOpacity: 0}\n ]\n});"},{"name":"example","text":"// Add highlight options to the collection after initialization\n\nconst selectionHighlightOptions = {\n name: \"selection\",\n color: \"#ff00ff\", // bright fuchsia\n haloOpacity: 0.8,\n fillOpacity: 0.2\n};\n\n// Add the options to the highlights collection at the first position\nview.highlights.add(selectionGroup, 0);"}],"values":[],"optional":true,"required":false},{"name":"interacting","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indication whether the view is being interacted with (for example when panning or by an interactive tool).","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"itemId","type":"null | undefined | string","complexType":{"original":"null | undefined | string","resolved":"null | undefined | string","references":{}},"mutable":true,"attr":"item-id","reflectToAttr":true,"docs":"The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl) before the Link Chart component loads.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layerViews","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection containing a hierarchical list of all the created\n[LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/references/core/WebLinkChart/#layers) in the link chart.","docsTags":[{"name":"see","text":"[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"loadErrorSources","type":"LoadErrorSource[] | undefined","complexType":{"original":"LoadErrorSource[] | undefined","resolved":"LoadErrorSource[] | undefined","references":{"LoadErrorSource":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of objects that encountered an error while loading the component or any of its dependencies (e.g., basemap, ground, layers, tables). You may inspect the errors by accessing each object's `loadError` property.","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"magnifier","type":"Magnifier","complexType":{"original":"Magnifier","resolved":"Magnifier","references":{"default":{"location":"import","path":"@arcgis/core/views/Magnifier.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The magnifier allows for showing a portion of the view as a magnifier image on top of the view.","docsTags":[{"name":"since","text":"4.19"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"map","type":"WebLinkChart","complexType":{"original":"WebLinkChart","resolved":"WebLinkChart","references":{"default":{"location":"import","path":"@arcgis/core/WebLinkChart.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An instance of a [WebLinkChart](https://developers.arcgis.com/javascript/latest/references/core/WebLinkChart/)\n object to display in the view.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"navigating","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indication whether the view is being navigated (for example when panning).","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"navigation","type":"Navigation","complexType":{"original":"Navigation","resolved":"Navigation","references":{"default":{"location":"import","path":"@arcgis/core/views/navigation/Navigation.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Options to configure the navigation behavior of the View.","docsTags":[{"name":"since","text":"4.9"},{"name":"example","text":"// Disable the gamepad usage, single touch panning, panning momentum and mouse wheel zooming.\nconst view = new MapView({\n container: \"viewDiv\",\n map: new Map({\n basemap: \"satellite\"\n }),\n center: [176.185, -37.643],\n zoom: 13,\n navigation: {\n gamepad: {\n enabled: false\n },\n actionMap: {\n dragSecondary: \"none\", // Disable rotating the view with the right mouse button\n mouseWheel: \"none\" // Disable zooming with the mouse wheel\n },\n browserTouchPanEnabled: false,\n momentumEnabled: false,\n }\n});"}],"values":[],"optional":true,"required":false},{"name":"padding","type":"ViewPadding","complexType":{"original":"ViewPadding","resolved":"ViewPadding","references":{"ViewPadding":{"location":"import","path":"@arcgis/core/views/ui/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#center),\nand [extent](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#extent), etc. work off a\nsubsection of the full view. This is particularly useful when layering UI\nelements or semi-transparent content on top of portions of the view.","docsTags":[],"default":"{left: 0, top: 0, right: 0, bottom: 0}","values":[],"optional":true,"required":false},{"name":"popup","type":"Popup | null | undefined","complexType":{"original":"Popup | null | undefined","resolved":"Popup | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Popup.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/) widget object that displays general content or attributes from [layers](https://developers.arcgis.com/javascript/latest/references/core/Map/#layers) in the [map](https://developers.arcgis.com/javascript/latest/references/core/views/View/#map). Consider using the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) (beta), which represents the Popup component, instead.\n\nBy default, the `popup` property is an empty object that allows you to set the popup options. A [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/) instance is automatically created and assigned to the view's [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popup) when the user clicks on the view and [popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/PopupView/#popupEnabled) is `true`, when the [openPopup()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#openPopup) method is called, or when some widgets need the popup, such as [Search](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/). If [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popup) is `null`, the popup instance will not be created.","docsTags":[{"name":"see","text":"[popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement)"},{"name":"see","text":"[popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupDisabled)"},{"name":"see","text":"[openPopup()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#openPopup)"}],"values":[],"optional":true,"required":false},{"name":"popupComponentEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"popup-component-enabled","reflectToAttr":false,"docs":"Indicates whether the [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) (beta) is enabled as the default popup. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) property (representing the component) will be used for popups instead of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popup) property (representing the widget).\n\n**Note:** This is a beta feature and may change in future releases. At version 6.0, the Popup component will be used by default instead of the Popup widget and the `popup-component-enabled` attribute will no longer be necessary.","docsTags":[{"name":"beta"},{"name":"since","text":"5.0"},{"name":"see","text":"[popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement)"},{"name":"example","text":"```html\n\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"popupDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"popup-disabled","reflectToAttr":false,"docs":"Controls whether the default popup opens automatically when users click on the view. This controls both the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) and [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popup) properties. When set to `true`, the popup will not open on click or when triggered programmatically.","docsTags":[{"name":"see","text":"[openPopup()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#openPopup)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"popupElement","type":"ArcgisPopup | null","complexType":{"original":"ArcgisPopup | null","resolved":"ArcgisPopup | null","references":{"ArcgisPopup":{"location":"local","path":"components/arcgis-popup","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A reference to the current [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) (beta). The [popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupComponentEnabled) property must be set to `true` to use this property.\n\n**Note:** This is a beta feature and may change in future releases.","docsTags":[{"name":"beta"},{"name":"since","text":"5.0"},{"name":"see","text":"[popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupComponentEnabled)"},{"name":"example","text":"```html\n\n\n```"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"ready","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"When `true`, this property indicates whether the view successfully satisfied all dependencies,\nsignaling that the following conditions are met.","docsTags":[{"name":"see","text":"[when()](https://developers.arcgis.com/javascript/latest/references/core/views/View/#when)"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"resizeAlign","type":"ResizeAlign","complexType":{"original":"ResizeAlign","resolved":"ResizeAlign","references":{"ResizeAlign":{"location":"import","path":"@arcgis/core/views/2d/types.js","id":"notImplemented"}}},"mutable":true,"attr":"resize-align","reflectToAttr":false,"docs":"Defines which anchor stays still while resizing the browser window. The default, `center`,\nensures the view's center point remains constantly visible as the window size changes. The other\noptions allow the respective portion of the view to remain visible when the window's size is changed.","docsTags":[],"default":"\"center\"","values":[{"type":"string","value":"top-left"},{"type":"string","value":"top-right"},{"type":"string","value":"bottom-left"},{"type":"string","value":"bottom-right"},{"type":"string","value":"center"},{"type":"string","value":"bottom"},{"type":"string","value":"left"},{"type":"string","value":"right"},{"type":"string","value":"top"}],"optional":true,"required":false},{"name":"resolution","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Represents the current value of one pixel in the unit of the view's spatialReference.\nThe value of resolution is calculated by dividing the view's extent width\nby its width.","docsTags":[{"name":"since","text":"4.9"},{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"rotation","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"rotation","reflectToAttr":false,"docs":"The clockwise rotation of due north in relation to the top of the view in degrees.\nThe view may be rotated by directly setting\nthe rotation or by using the following mouse event: `Right-click + Drag`.\nWebLinkChart rotation may be disabled by setting the `rotationEnabled` property\nin [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#constraints) to `false`.","docsTags":[{"name":"example","text":"// Due north is rotated 90 degrees, pointing to the right side of the view\nview.rotation = 90;"},{"name":"example","text":"// Due north is rotated 180 degrees, pointing to the bottom of the view\nview.rotation = 180;"},{"name":"example","text":"// Due north is rotated 270 degrees, pointing to the left side of the view\nview.rotation = 270;"},{"name":"example","text":"// Due north is rotated 0 degrees, pointing to the top of the view (the default)\nview.rotation = 0; // 360 or multiple of 360 (e.g. 720) works here as well."},{"name":"example","text":"// Disables map rotation\nview.constraints = {\n rotationEnabled: false\n};"}],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"scale","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"scale","reflectToAttr":false,"docs":"Represents the link chart scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's goTo() method.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"selectionManager","type":"SelectionManager","complexType":{"original":"SelectionManager","resolved":"SelectionManager","references":{"default":{"location":"import","path":"@arcgis/core/views/SelectionManager.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The default [SelectionManager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) for this view. Used to manage selections of features across layers.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"serviceUrl","type":"null | undefined | string","complexType":{"original":"null | undefined | string","resolved":"null | undefined | string","references":{}},"mutable":true,"attr":"service-url","reflectToAttr":true,"docs":"The URL of the Knowledge Graph Service to load the link chart from.\n\nIf no Base Cypher Query is defined, then the entire dataset will be used to generate the link chart.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"slotGroupRefs","type":"SlotGroupRefs","complexType":{"original":"SlotGroupRefs","resolved":"SlotGroupRefs","references":{"SlotGroupRefs":{"location":"local","path":"support/slots","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"spatialReference","type":"SpatialReference","complexType":{"original":"SpatialReference","resolved":"SpatialReference","references":{"default":{"location":"import","path":"@arcgis/core/geometry/SpatialReference.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The spatial reference of the view.\nThis indicates the projected or geographic coordinate system used\nto locate geographic features in the link chart.","docsTags":[{"name":"see","text":"[spatialReferenceLocked](https://developers.arcgis.com/javascript/latest/references/core/views/View2D/#spatialReferenceLocked)"},{"name":"example","text":"// check if the projectOperator is loaded\nif (!projectOperator.isLoaded()) {\n projectOperator.load().then(() => {\n // change the spatial reference of the view to equal earth projection\n view.spatialReference = new SpatialReference({\n wkid: 54035 //equal earth projection\n });\n });\n} else {\n // the projectOperator is already loaded.\n // change the spatial reference of the view to equal earth projection\n view.spatialReference = new SpatialReference({\n wkid: 54035 //equal earth projection\n });\n}"},{"name":"example","text":"const basemap = await changeBasemap();\nconst spatialReference = await findSpatialReference(basemap);\n\n// check if basemap has the same spatial reference as the view if they are not equal\n// then check if the projectOperator is loaded, and load the projectOperator if it is not loaded.\n// If loaded, then simply change view.spatialReference to match the basemap spatialReference\nif (spatialReference && !view.spatialReference.equals(spatialReference)) {\n if (!projectOperator.isLoaded()) {\n await projectOperator.load();\n }\n view.spatialReference = spatialReference;\n}\n\n// change the basemap\nmap.basemap = basemap;\n\nasync function changeBasemap() {\n let basemap;\n if (map.basemap.title === \"OpenStreetMap Vector Basemap (Blueprint - WGS84)\"){\n basemap = new Basemap({\n portalItem: { // Spilhaus - one ocean basemap\n id: \"5639ccf22d4c4830ab815c4f9c9319bb\"\n }\n });\n } else {\n basemap = osm84;\n }\n return basemap;\n}\n\nasync function findSpatialReference(basemap) {\n await basemap.load();\n\n if (basemap.spatialReference) {\n return basemap.spatialReference;\n }\n\n const layer = basemap.baseLayers.at(0);\n\n if (!layer) {\n return null;\n }\n\n await layer.load();\n\n return layer.spatialReference;\n}"}],"values":[],"optional":true,"required":false},{"name":"stationary","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indication whether the view is animating, being navigated with or resizing.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"suspended","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"suspended","reflectToAttr":true,"docs":"Indicates if the view is visible on the page.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"theme","type":"Theme | null | undefined","complexType":{"original":"Theme | null | undefined","resolved":"Theme | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/Theme.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property specifies the base colors used by some components\nand components to render graphics and labels.","docsTags":[{"name":"since","text":"4.28"},{"name":"see","text":"[Theme](https://developers.arcgis.com/javascript/latest/references/core/views/Theme/)"},{"name":"see","text":"[Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)"},{"name":"example","text":"// Update the theme to use purple graphics\n// and slightly transparent green text\nview.theme = new Theme({\n accentColor: \"purple\",\n textColor: [125, 255, 13, 0.9]\n});"}],"values":[],"optional":true,"required":false},{"name":"timeExtent","type":"TimeExtent | null | undefined","complexType":{"original":"TimeExtent | null | undefined","resolved":"TimeExtent | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/time/TimeExtent.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view's time extent. Time-aware layers display their temporal data that falls within\nthe view's time extent. Setting the view's time extent is similar to setting the spatial\nextent because once the time extent is set, the\nview updates automatically to conform to the change.","docsTags":[{"name":"since","text":"4.12"},{"name":"example","text":"// Create a csv layer from an online spreadsheet.\nlet csvLayer = new CSVLayer({\n url: \"http://test.com/daily-magazines-sold-in-new-york.csv\",\n timeInfo: {\n startField: \"SaleDate\" // The csv field contains date information.\n }\n});\n\n// Create a mapview showing sales for the last week of March 2019 only.\nconst view = new MapView({\n map: map,\n container: \"viewDiv\",\n timeExtent: {\n start: new Date(\"2019, 2, 24\"),\n end: new Date(\"2019, 2, 31\")\n }\n});"}],"values":[],"optional":true,"required":false},{"name":"timeZone","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"Defines the time zone of the view.\nThe time zone property determines how dates and times are represented to the user,\nbut the underlying data is unchanged.","docsTags":[{"name":"see","text":"[wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"},{"name":"example","text":"// Date and time will be displayed in Pacific/Auckland (NZ) time zone\nconst view = new MapView({\n map: map,\n container: \"viewDiv\",\n timeZone: \"Pacific/Auckland\"\n});"}],"default":"\"system\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"updating","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the view is being updated by additional data requests to the network,\nor by processing received data.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"LinkChartView","complexType":{"original":"LinkChartView","resolved":"LinkChartView","references":{"default":{"location":"import","path":"@arcgis/core/views/LinkChartView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Internal view of the component.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"viewpoint","type":"Viewpoint","complexType":{"original":"Viewpoint","resolved":"Viewpoint","references":{"default":{"location":"import","path":"@arcgis/core/Viewpoint.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Represents the current view as a Viewpoint or point of observation on the view.\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's goTo() method.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"zoom","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"zoom","reflectToAttr":false,"docs":"Represents the level of detail (LOD) at the center of the view.\nA zoom level (or scale) is a number that defines how large or small the contents of a link chart appear in a link chart view.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the view has no LODs.\nWhen setting the zoom value, the LinkChartView converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\nLinkChartView can display link charts with different projections at a full range of scales, and so use the scale property on this component rather than zoom level.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's goTo() method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false}],"methods":[{"name":"closePopup","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"closePopup(): Promise","parameters":[],"docs":"Closes the popup.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisLinkChart = document.createElement(\"arcgis-link-chart\");\ndocument.body.append(arcgisLinkChart);\nawait arcgisLinkChart.componentOnReady();\nconsole.log(\"arcgis-link-chart is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Destroys the view, and any associated resources, including its map, popup, and UI elements.","docsTags":[]},{"name":"fetchPopupFeatures","returns":{"type":"Promise>","docs":""},"complexType":{"signature":"(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise>","parameters":[{"name":"hitTarget","type":"ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"FetchPopupFeaturesOptions","docs":""}],"return":"Promise>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"AsyncGenerator":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"ScreenRect":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"FetchPopupFeaturesOptions":{"location":"import","path":"@arcgis/core/views/PopupView.js","id":"notImplemented"}}},"signature":"fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise>","parameters":[{"name":"hitTarget","type":"ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"FetchPopupFeaturesOptions","docs":""}],"docs":"Use this method to query for features at a given screen location. These features come from origins (layers and sublayers) configured with a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [FeatureLayer.popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled) set. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer to control how the input location is handled, and then subsequently, what to do with the results.\n> [!WARNING]\n> Using [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) as the hit target is considered **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** functionality.","docsTags":[{"name":"since","text":"5.1"},{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-map\");\n// Get viewElement's click event\nviewElement.addEventListener(\"arcgisViewClick\", async (event) => {\n const generator = await viewElement.fetchPopupFeatures(event.detail.screenPoint, {\n pointerType: event.detail.pointerType\n });\n // Access the features returned from the generator\n for await (const feature of generator) {\n console.log(feature);\n }\n});\n```"},{"name":"example","text":"```js\n// Wait for all the features to be available\nview.on(\"click\", async (event) => {\n const generator = view.fetchPopupFeatures(event.screenPoint, {\n pointerType: event.pointerType\n });\n\n const features = await Array.fromAsync(generator);\n});"}]},{"name":"goTo","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(target: GoToTarget2D, options?: GoToOptions2D): Promise","parameters":[{"name":"target","type":"GoToTarget2D","docs":""},{"name":"options","type":"GoToOptions2D","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"GoToTarget2D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"},"GoToOptions2D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"goTo(target: GoToTarget2D, options?: GoToOptions2D): Promise","parameters":[{"name":"target","type":"GoToTarget2D","docs":""},{"name":"options","type":"GoToOptions2D","docs":""}],"docs":"Sets the view to a given target.","docsTags":[]},{"name":"openPopup","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(options?: ViewPopupOpenOptions): Promise","parameters":[{"name":"options","type":"ViewPopupOpenOptions","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ViewPopupOpenOptions":{"location":"import","path":"@arcgis/core/views/PopupView.js","id":"notImplemented"}}},"signature":"openPopup(options?: ViewPopupOpenOptions): Promise","parameters":[{"name":"options","type":"ViewPopupOpenOptions","docs":""}],"docs":"Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.","docsTags":[]},{"name":"toMap","returns":{"type":"Point","docs":""},"complexType":{"signature":"(screenPoint: MouseEvent | ScreenPoint): Point","parameters":[{"name":"screenPoint","type":"MouseEvent | ScreenPoint","docs":""}],"return":"Point","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"},"MouseEvent":{"location":"global","path":"global:","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"}}},"signature":"toMap(screenPoint: MouseEvent | ScreenPoint): Point","parameters":[{"name":"screenPoint","type":"MouseEvent | ScreenPoint","docs":""}],"docs":"","docsTags":[]},{"name":"toScreen","returns":{"type":"ScreenPoint | null | undefined","docs":""},"complexType":{"signature":"(point: Point, options?: ToScreenOptions2D): ScreenPoint | null | undefined","parameters":[{"name":"point","type":"Point","docs":""},{"name":"options","type":"ToScreenOptions2D","docs":""}],"return":"ScreenPoint | null | undefined","references":{"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"},"ToScreenOptions2D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"toScreen(point: Point, options?: ToScreenOptions2D): ScreenPoint | null | undefined","parameters":[{"name":"point","type":"Point","docs":""},{"name":"options","type":"ToScreenOptions2D","docs":""}],"docs":"","docsTags":[]},{"name":"tryFatalErrorRecovery","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"tryFatalErrorRecovery(): Promise","parameters":[],"docs":"Call this method to clear any fatal errors resulting from a lost WebGL context.","docsTags":[]},{"name":"viewOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(callback?: () => void, errback?: (error: Error) => void): Promise","parameters":[{"name":"callback","type":"() => void","docs":""},{"name":"errback","type":"(error: Error) => void","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/core/Error.js","id":"notImplemented"}}},"signature":"viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise","parameters":[{"name":"callback","type":"() => void","docs":""},{"name":"errback","type":"(error: Error) => void","docs":""}],"docs":"`viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.","docsTags":[{"name":"since","text":"4.33"},{"name":"see","text":"[Watch for changes - waiting for components or views to be ready](https://developers.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"},{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-link-chart\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\n```"}]},{"name":"whenAnalysisView","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(analysis: Analysis): Promise","parameters":[{"name":"analysis","type":"Analysis","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"AnalysisView2DUnion":{"location":"import","path":"@arcgis/core/views/2d/analysis/types.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/analysis/Analysis.js","id":"notImplemented"}}},"signature":"whenAnalysisView(analysis: Analysis): Promise","parameters":[{"name":"analysis","type":"Analysis","docs":""}],"docs":"Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#whenAnalysisView)","docsTags":[{"name":"since","text":"4.34"}]},{"name":"whenLayerView","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(layer: Layer): Promise","parameters":[{"name":"layer","type":"Layer","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/layers/Layer.js","id":"notImplemented"}}},"signature":"whenLayerView(layer: Layer): Promise","parameters":[{"name":"layer","type":"Layer","docs":""}],"docs":"Gets the LayerView created on the view for the given layer.","docsTags":[]},{"name":"zoomIn","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomIn(): Promise","parameters":[],"docs":"Zooms in the view component by a factor of 2.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"zoomOut","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomOut(): Promise","parameters":[],"docs":"Zooms out the view component by a factor of 2.","docsTags":[{"name":"since","text":"5.0"}]}],"events":[{"event":"arcgisLoadError","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when an arcgis-link-chart fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).","docsTags":[{"name":"since","text":"4.34"},{"name":"see","text":"[loadErrorSources](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#loadErrorSources)"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisLoadError\", () => {\n console.log(viewElement.loadErrorSources);\n});\n```"}]},{"event":"arcgisViewAnalysisViewCreate","detail":"AnalysisViewCreateEvent","bubbles":true,"complexType":{"original":"AnalysisViewCreateEvent","resolved":"AnalysisViewCreateEvent","references":{"AnalysisViewCreateEvent":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-create)","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisViewAnalysisViewCreateError","detail":"AnalysisViewCreateErrorEvent","bubbles":true,"complexType":{"original":"AnalysisViewCreateErrorEvent","resolved":"AnalysisViewCreateErrorEvent","references":{"AnalysisViewCreateErrorEvent":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-create-error)","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisViewAnalysisViewDestroy","detail":"AnalysisViewDestroyEvent","bubbles":true,"complexType":{"original":"AnalysisViewDestroyEvent","resolved":"AnalysisViewDestroyEvent","references":{"AnalysisViewDestroyEvent":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-destroy)","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisViewChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.","docsTags":[]},{"event":"arcgisViewClick","detail":"ClickEvent","bubbles":true,"complexType":{"original":"ClickEvent","resolved":"ClickEvent","references":{"ClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a user clicks on the view.","docsTags":[]},{"event":"arcgisViewDoubleClick","detail":"DoubleClickEvent","bubbles":true,"complexType":{"original":"DoubleClickEvent","resolved":"DoubleClickEvent","references":{"DoubleClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after double-clicking on the view.","docsTags":[]},{"event":"arcgisViewDoubleTapDrag","detail":"DoubleTapDragEvent","bubbles":true,"complexType":{"original":"DoubleTapDragEvent","resolved":"DoubleTapDragEvent","references":{"DoubleTapDragEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires while the pointer is dragged following a double-tap gesture on the view.","docsTags":[{"name":"since","text":"5.0"}]},{"event":"arcgisViewDrag","detail":"DragEvent","bubbles":true,"complexType":{"original":"DragEvent","resolved":"DragEvent","references":{"DragEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires during a pointer drag on the view.","docsTags":[]},{"event":"arcgisViewHold","detail":"HoldEvent","bubbles":true,"complexType":{"original":"HoldEvent","resolved":"HoldEvent","references":{"HoldEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires during a pointer drag on the view.","docsTags":[]},{"event":"arcgisViewImmediateClick","detail":"ImmediateClickEvent","bubbles":true,"complexType":{"original":"ImmediateClickEvent","resolved":"ImmediateClickEvent","references":{"ImmediateClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires right after a user clicks on the view.","docsTags":[]},{"event":"arcgisViewImmediateDoubleClick","detail":"ImmediateDoubleClickEvent","bubbles":true,"complexType":{"original":"ImmediateDoubleClickEvent","resolved":"ImmediateDoubleClickEvent","references":{"ImmediateDoubleClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Is emitted after two consecutive immediate-click events.","docsTags":[]},{"event":"arcgisViewKeyDown","detail":"KeyDownEvent","bubbles":true,"complexType":{"original":"KeyDownEvent","resolved":"KeyDownEvent","references":{"KeyDownEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a keyboard key is pressed.","docsTags":[]},{"event":"arcgisViewKeyUp","detail":"KeyUpEvent","bubbles":true,"complexType":{"original":"KeyUpEvent","resolved":"KeyUpEvent","references":{"KeyUpEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a keyboard key is pressed.","docsTags":[]},{"event":"arcgisViewLayerviewCreate","detail":"LayerViewCreateEvent","bubbles":true,"complexType":{"original":"LayerViewCreateEvent","resolved":"LayerViewCreateEvent","references":{"LayerViewCreateEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.","docsTags":[]},{"event":"arcgisViewLayerviewCreateError","detail":"LayerViewCreateErrorEvent","bubbles":true,"complexType":{"original":"LayerViewCreateErrorEvent","resolved":"LayerViewCreateErrorEvent","references":{"LayerViewCreateErrorEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.","docsTags":[]},{"event":"arcgisViewLayerviewDestroy","detail":"LayerViewDestroyEvent","bubbles":true,"complexType":{"original":"LayerViewDestroyEvent","resolved":"LayerViewDestroyEvent","references":{"LayerViewDestroyEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a LayerView is destroyed and is no longer rendered in the view.","docsTags":[]},{"event":"arcgisViewMouseWheel","detail":"ViewMouseWheelEvent","bubbles":true,"complexType":{"original":"ViewMouseWheelEvent","resolved":"ViewMouseWheelEvent","references":{"ViewMouseWheelEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.","docsTags":[]},{"event":"arcgisViewPointerDown","detail":"PointerDownEvent","bubbles":true,"complexType":{"original":"PointerDownEvent","resolved":"PointerDownEvent","references":{"PointerDownEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse button is pressed, or a finger touches the display.","docsTags":[]},{"event":"arcgisViewPointerEnter","detail":"PointerEnterEvent","bubbles":true,"complexType":{"original":"PointerEnterEvent","resolved":"PointerEnterEvent","references":{"PointerEnterEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse cursor enters the view, or a display touch begins.","docsTags":[]},{"event":"arcgisViewPointerLeave","detail":"PointerLeaveEvent","bubbles":true,"complexType":{"original":"PointerLeaveEvent","resolved":"PointerLeaveEvent","references":{"PointerLeaveEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse cursor leaves the view, or a display touch ends.","docsTags":[]},{"event":"arcgisViewPointerMove","detail":"PointerMoveEvent","bubbles":true,"complexType":{"original":"PointerMoveEvent","resolved":"PointerMoveEvent","references":{"PointerMoveEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after the mouse or a finger on the display moves.","docsTags":[]},{"event":"arcgisViewPointerUp","detail":"PointerUpEvent","bubbles":true,"complexType":{"original":"PointerUpEvent","resolved":"PointerUpEvent","references":{"PointerUpEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse button is released, or a display touch ends.","docsTags":[]},{"event":"arcgisViewReadyChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.","docsTags":[]},{"event":"arcgisViewReadyError","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires if the view encounters a content or rendering error.","docsTags":[{"name":"since","text":"4.34"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewReadyError\", () => {\n // handle error\n});\n```"}]},{"event":"arcgisViewVerticalTwoFingerDrag","detail":"VerticalTwoFingerDragEvent","bubbles":true,"complexType":{"original":"VerticalTwoFingerDragEvent","resolved":"VerticalTwoFingerDragEvent","references":{"VerticalTwoFingerDragEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires while the two pointers are dragged vertically on the view.","docsTags":[{"name":"since","text":"5.0"}]}],"styles":[{"name":"--arcgis-layout-overlay-space-top","annotation":"prop","docs":"_Since 4.34_ Specifies the top padding for the layout."},{"name":"--arcgis-layout-overlay-space-bottom","annotation":"prop","docs":"_Since 4.34_ Specifies the bottom padding for the layout."},{"name":"--arcgis-layout-overlay-space-left","annotation":"prop","docs":"_Since 4.34_ Specifies the left padding for the layout."},{"name":"--arcgis-layout-overlay-space-right","annotation":"prop","docs":"_Since 4.34_ Specifies the right padding for the layout."},{"name":"--arcgis-view-color-focus","annotation":"prop","docs":"_Since 5.0_ Specifies the focus outline color for the view."},{"name":"--arcgis-table-row-background-color","annotation":"prop","docs":"_Since 5.1_ Specifies the background color for table rows."},{"name":"--arcgis-table-row-alt-background-color","annotation":"prop","docs":"_Since 5.1_ Specifies the background color for alternate table rows."}],"slots":[{"name":"","docs":"Default slot for adding components to the link chart. User is responsible for positioning the content via CSS."},{"name":"top-left","docs":"Slot for components positioned in the top-left corner."},{"name":"top-right","docs":"Slot for components positioned in the top-right corner."},{"name":"bottom-left","docs":"Slot for components positioned in the bottom-left corner."},{"name":"bottom-right","docs":"Slot for components positioned in the bottom-right corner."},{"name":"top-start","docs":"Slot for components positioned at the top-start (top-left in LTR, top-right in RTL)."},{"name":"top-end","docs":"Slot for components positioned at the top-end (top-right in LTR, top-left in RTL)."},{"name":"bottom-start","docs":"Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL)."},{"name":"bottom-end","docs":"Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."},{"name":"popup","docs":"Slot for the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot."}],"parts":[],"listeners":[]},{"filePath":"src/components/link-chart-layout-switcher/link-chart-layout-switcher.tsx","tag":"arcgis-link-chart-layout-switcher","overview":"","readme":"","usage":{},"docs":"A component for use in link charts that allows users to switch between different layouts. See [documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm) for more details.\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`","docsTags":[{"name":"since","text":"4.32"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"appearance","type":"\"dropdown\" | \"menu-bar\"","complexType":{"original":"\"dropdown\" | \"menu-bar\"","resolved":"\"dropdown\" | \"menu-bar\"","references":{}},"mutable":true,"attr":"appearance","reflectToAttr":false,"docs":"The appearance of the layout switcher. `dropdown` displays a button that is clicked to reveal a dropdown menu, while `menu-bar` displays a menu bar.","docsTags":[{"name":"since","text":"4.33"}],"default":"\"dropdown\"","values":[{"type":"string","value":"dropdown"},{"type":"string","value":"menu-bar"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart-layout-switcher/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"closeOnSelectDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"close-on-select-disabled","reflectToAttr":false,"docs":"When `true`, the layout menu will not close when a layout is selected. Only applicable when `appearance` is `dropdown`.","docsTags":[{"name":"since","text":"4.33"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName | undefined","complexType":{"original":"IconName | undefined","resolved":"IconName | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon displayed in the component's button, when `appearance` is `dropdown`.","docsTags":[{"name":"see","text":"[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"nodes-link\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layout","type":"DiagramLayoutType","complexType":{"original":"DiagramLayoutType","resolved":"DiagramLayoutType","references":{"DiagramLayoutType":{"location":"local","path":"components/arcgis-link-chart-layout-switcher/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current selected link chart layout.","docsTags":[{"name":"readonly","text":""}],"default":"\"organic-standard\"","values":[{"type":"string","value":"basic-grid"},{"type":"string","value":"chronological-mono-timeline"},{"type":"string","value":"chronological-multi-timeline"},{"type":"string","value":"geographic-organic-standard"},{"type":"string","value":"hierarchical-bottom-to-top"},{"type":"string","value":"organic-community"},{"type":"string","value":"organic-standard"},{"type":"string","value":"radial-root-centric"},{"type":"string","value":"tree-left-to-right"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"preventExtentUpdate","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"prevent-extent-update","reflectToAttr":false,"docs":"Prevents extent from updating on changes to the layout.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"LinkChartLayoutSwitcherViewModelState","complexType":{"original":"LinkChartLayoutSwitcherViewModelState","resolved":"LinkChartLayoutSwitcherViewModelState","references":{"LinkChartLayoutSwitcherViewModelState":{"location":"import","path":"@arcgis/core/widgets/LinkChartLayoutSwitcher/LinkChartLayoutSwitcherViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"loading\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"view","type":"LinkChartView | null | undefined","complexType":{"original":"LinkChartView | null | undefined","resolved":"LinkChartView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/LinkChartView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-link-chart-layout-switcher component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisLinkChartLayoutSwitcher = document.createElement(\"arcgis-link-chart-layout-switcher\");\ndocument.body.append(arcgisLinkChartLayoutSwitcher);\nawait arcgisLinkChartLayoutSwitcher.componentOnReady();\nconsole.log(\"arcgis-link-chart-layout-switcher is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"switchLayout","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(newLayout: \"basic-grid\" | \"chronological-mono-timeline\" | \"chronological-multi-timeline\" | \"geographic-organic-standard\" | \"hierarchical-bottom-to-top\" | \"organic-community\" | \"organic-standard\" | \"radial-root-centric\" | \"tree-left-to-right\"): Promise","parameters":[{"name":"newLayout","type":"\"basic-grid\" | \"chronological-mono-timeline\" | \"chronological-multi-timeline\" | \"geographic-organic-standard\" | \"hierarchical-bottom-to-top\" | \"organic-community\" | \"organic-standard\" | \"radial-root-centric\" | \"tree-left-to-right\"","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"switchLayout(newLayout: \"basic-grid\" | \"chronological-mono-timeline\" | \"chronological-multi-timeline\" | \"geographic-organic-standard\" | \"hierarchical-bottom-to-top\" | \"organic-community\" | \"organic-standard\" | \"radial-root-centric\" | \"tree-left-to-right\"): Promise","parameters":[{"name":"newLayout","type":"\"basic-grid\" | \"chronological-mono-timeline\" | \"chronological-multi-timeline\" | \"geographic-organic-standard\" | \"hierarchical-bottom-to-top\" | \"organic-community\" | \"organic-standard\" | \"radial-root-centric\" | \"tree-left-to-right\"","docs":""}],"docs":"Switches the layout of the link chart to the value provided.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSwitchLayout","detail":"LinkChartLayoutSwitcherViewModelEvents[\"switchLayout\"]","bubbles":true,"complexType":{"original":"LinkChartLayoutSwitcherViewModelEvents[\"switchLayout\"]","resolved":"LinkChartLayoutSwitcherViewModelEvents[\"switchLayout\"]","references":{"LinkChartLayoutSwitcherViewModelEvents":{"location":"import","path":"@arcgis/core/widgets/LinkChartLayoutSwitcher/LinkChartLayoutSwitcherViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when component has completed the layout switch","docsTags":[{"name":"example","text":"```js\nlayoutswitcher.addEventListener(\"arcgisSwitchLayout\", (event) => {\n console.log(\"Layout Switched\");\n});\n```"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/link-chart-nonspatial-visibility-toggle/link-chart-nonspatial-visibility-toggle.tsx","tag":"arcgis-link-chart-nonspatial-visibility-toggle","overview":"","readme":"","usage":{},"docs":"The component is for use in link charts that allows users to switch whether or not nonspatial data is visible in the view. Spatial entities are those with a value in a defined geometry property in a traditional map context. A Spatial relationship is one where both endpoints are spatial\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`","docsTags":[{"name":"since","text":"5.0"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart-nonspatial-visibility-toggle/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName | undefined","complexType":{"original":"IconName | undefined","resolved":"IconName | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the LinkChart component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the LinkChart.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"local","path":"components/arcgis-link-chart-nonspatial-visibility-toggle/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"loading\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"LinkChartView | undefined","complexType":{"original":"LinkChartView | undefined","resolved":"LinkChartView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/LinkChartView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-link-chart-nonspatial-visibility-toggle component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"\"l\" | \"m\" | \"s\"","complexType":{"original":"\"l\" | \"m\" | \"s\"","resolved":"\"l\" | \"m\" | \"s\"","references":{}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Specifies the size of the component.","docsTags":[],"default":"\"m\"","values":[{"type":"string","value":"l"},{"type":"string","value":"m"},{"type":"string","value":"s"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisLinkChartNonspatialVisibilityToggle = document.createElement(\"arcgis-link-chart-nonspatial-visibility-toggle\");\ndocument.body.append(arcgisLinkChartNonspatialVisibilityToggle);\nawait arcgisLinkChartNonspatialVisibilityToggle.componentOnReady();\nconsole.log(\"arcgis-link-chart-nonspatial-visibility-toggle is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"switchNonspatialVisibility","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(nonspatialVisibilitySetting: NonspatialMode): Promise","parameters":[{"name":"nonspatialVisibilitySetting","type":"NonspatialMode","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"NonspatialMode":{"location":"local","path":"components/arcgis-link-chart-nonspatial-visibility-toggle/types","id":"notImplemented"}}},"signature":"switchNonspatialVisibility(nonspatialVisibilitySetting: NonspatialMode): Promise","parameters":[{"name":"nonspatialVisibilitySetting","type":"NonspatialMode","docs":""}],"docs":"Switches the nonspatial visibility setting","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/locate/locate.tsx","tag":"arcgis-locate","overview":"","readme":"","usage":{},"docs":"The Locate component animates the Map or Scene to the user's current location.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/docs/Web/Security/Defenses/Secure_Contexts), such as HTTPS.\n`localhost` is considered \"potentially secure\" and can be used for testing.\n\n> [!WARNING]\n>\n> **Note**\n>\n> To avoid unexpected navigation, especially when using custom spatial references, configure the view [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#constraints)\n> such as `extent`, `minZoom`, and `maxZoom`.\n> This helps when the geolocated position is inaccurate or causes the map to navigate\n> to a location that is no longer visible because it is outside of\n> a layer's `fullExtent`.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-locate/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"geolocationOptions","type":"PositionOptions | undefined","complexType":{"original":"PositionOptions | undefined","resolved":"PositionOptions | undefined","references":{"PositionOptions":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"goToLocationDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"go-to-location-disabled","reflectToAttr":true,"docs":"Indicates whether to navigate the view to the position and scale of the geolocated result.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | undefined","complexType":{"original":"GoToOverride | undefined","resolved":"GoToOverride | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"graphic","type":"Graphic","complexType":{"original":"Graphic","resolved":"Graphic","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The graphic used to show the user's location on the map.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName | undefined","complexType":{"original":"IconName | undefined","resolved":"IconName | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon displayed in the component's button.","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"gps-off\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"popupDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"popup-disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"scale","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"scale","reflectToAttr":false,"docs":"Indicates the scale to set on the view when navigating to the position of the geolocated\nresult, after a location is returned from the [@arcgisSuccess](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-locate/#event-arcgisSuccess) event.","docsTags":[],"default":"null","values":[{"type":"number"}],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"local","path":"components/arcgis-locate/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"error"},{"type":"string","value":"feature-unsupported"},{"type":"string","value":"locating"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-locate component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Specifies the size of the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"cancelLocate","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"cancelLocate(): Promise","parameters":[],"docs":"This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisLocate = document.createElement(\"arcgis-locate\");\ndocument.body.append(arcgisLocate);\nawait arcgisLocate.componentOnReady();\nconsole.log(\"arcgis-locate is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"locate","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"GeolocationPosition":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"locate(): Promise","parameters":[],"docs":"","docsTags":[]}],"events":[{"event":"arcgisError","detail":"{ error: GeolocationPositionError; }","bubbles":true,"complexType":{"original":"{ error: GeolocationPositionError; }","resolved":"{ error: GeolocationPositionError; }","references":{"GeolocationPositionError":{"location":"global","path":"global:","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSuccess","detail":"{ position: GeolocationPosition; }","bubbles":true,"complexType":{"original":"{ position: GeolocationPosition; }","resolved":"{ position: GeolocationPosition; }","references":{"GeolocationPosition":{"location":"global","path":"global:","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/map/map.tsx","tag":"arcgis-map","overview":"","readme":"","usage":{},"docs":"The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\n\n#### Initializing the Map component\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/)\nand can be initialized in one of three ways:\n\n##### 1. Using a WebMap\nLoad a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/) from [ArcGIS Online](https://www.arcgis.com/home/index.html)\nor an [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html) by specifying the [itemId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#itemId) attribute.\n\n```html\n\n```\n\n##### 2. Setting Map component attributes directly\nDefine the Map component using attributes like [basemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#basemap), [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#center), and [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#zoom) directly.\n\n```html\n\n```\n\n##### 3. Providing a Map instance\nAlternatively, you can provide your own [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/) instance to the component.\nThis allows full control over map configuration, including [basemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#basemap), operational [layers](https://developers.arcgis.com/javascript/latest/references/core/Map/#layers)\nand [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference). See the [Select features by rectangle sample](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)\nfor an example of this approach in action.\n\n```html\n\n\n```\n#### Adding components and customizing the Map\n\nOther components can be added and connected to the Map component.\n\n```html\n\n \n \n\n```\n\nThe Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/references/core/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My Layer\" });\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"allLayerViews","type":"ReadonlyCollection","complexType":{"original":"ReadonlyCollection","resolved":"ReadonlyCollection","references":{"ReadonlyCollection":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Collection containing a flat list of all the created LayerViews\nrelated to the basemap, operational layers, and group layers in this view.","docsTags":[{"name":"see","text":"[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"analyses","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/analysis/Analysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of analyses associated with the view.","docsTags":[{"name":"since","text":"4.34"},{"name":"example","text":"```js\n// Adds an analysis to the View\nview.analyses.add(elevationProfileAnalysis);\n```"},{"name":"example","text":"```js\n// Removes an analysis from the View\nview.analyses.remove(elevationProfileAnalysis);\n```"}],"values":[],"optional":true,"required":false},{"name":"animationsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"animations-disabled","reflectToAttr":false,"docs":"Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/FlowRenderer/)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#goTo)).\nSetting this property to `true` disables all animations in the view.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"aria","type":"MapView[\"aria\"]","complexType":{"original":"MapView[\"aria\"]","resolved":"MapView[\"aria\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The ARIA attributes for the view container. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements).","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"attributionItems","type":"MapView[\"attributionItems\"]","complexType":{"original":"MapView[\"attributionItems\"]","resolved":"MapView[\"attributionItems\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The attribution items displayed in the view's attribution.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"attributionMode","type":"\"dark\" | \"light\" | null | undefined","complexType":{"original":"\"dark\" | \"light\" | null | undefined","resolved":"\"dark\" | \"light\" | null | undefined","references":{}},"mutable":true,"attr":"attribution-mode","reflectToAttr":false,"docs":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"dark"},{"type":"string","value":"light"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"background","type":"ColorBackground | null | undefined","complexType":{"original":"ColorBackground | null | undefined","resolved":"ColorBackground | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/webmap/background/ColorBackground.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The background color of the Map component.","docsTags":[{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.background = new ColorBackground ({\n color: \"magenta\" // autocasts as new Color()\n});\n```"}],"values":[],"optional":true,"required":false},{"name":"basemap","type":"Basemap | string | undefined","complexType":{"original":"Basemap | string | undefined","resolved":"Basemap | string | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Basemap.js","id":"notImplemented"}}},"mutable":true,"attr":"basemap","reflectToAttr":false,"docs":"Specifies a basemap for the map. The basemap is a set of layers that give\ngeographic context to the view and the other operational layers\nin the map.\n\nThe basemap can be set from a basemap ID string from the [basemap styles service](https://developers.arcgis.com/javascript/latest/references/core/support/BasemapStyle/), such as `arcgis/navigation`, or from the [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) class.\n\n> [!NOTE]\n> Accessing the basemap styles service requires authentication, see [Authentication and access tokens](https://developers.arcgis.com/javascript/latest/authentication/access-tokens/) for more information.","docsTags":[{"name":"example","text":"```html\n\n\n```"},{"name":"example","text":"```js\n// Basemap set using a Basemap instance\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.basemap = new Basemap({\n title: \"Terrain\",\n baseLayers: [\n new VectorTileLayer({\n url: \"https://arcgis.com/sharing/rest/content/items/b5676525747f499687f12746441101ef/resources/styles/root.json\",\n })\n ]\n});\n```"},{"name":"see","text":"[Map.basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap)"},{"name":"see","text":"[Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)"},{"name":"see","text":"[BasemapStyle](https://developers.arcgis.com/javascript/latest/references/core/support/BasemapStyle/)"},{"name":"see","text":"[Authentication and access tokens](https://developers.arcgis.com/javascript/latest/authentication/access-tokens/)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"basemapView","type":"BasemapView","complexType":{"original":"BasemapView","resolved":"BasemapView","references":{"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Represents the view for a single basemap after it has been added to the map.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"canZoomIn","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates if the view component can zoom in.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canZoomOut","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates if the view component can zoom out.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"center","type":"MapView[\"center\"] | null | undefined | number[] | string","complexType":{"original":"MapView[\"center\"] | null | undefined | number[] | string","resolved":"MapView[\"center\"] | null | undefined | number[] | string","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"attr":"center","reflectToAttr":false,"docs":"Represents the view's center point; when setting the center, you may pass a\n[Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) instance, numbers representing\na longitude/latitude pair (`[-100.4593, 36.9014]`), or a string attribute representing a longitude/latitude pair (\"-100.4593, 36.9014\").\nSetting the `center` immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.\n\nThe returned [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) object is always\nin the spatial reference of the view and may be modified internally.\nTo persist the returned object, create a clone using [clone()](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/#clone) method.\n\n**Notes**\n\n* If the spatial reference of `center` set in the constructor does not match the [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference) of the view, then the\n[projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) will be loaded dynamically.\n* At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) must be\n[loaded](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) when\nsetting the `center` to a spatial reference that doesn't match the view spatial reference. You can check if the projectOperator is\nloaded prior to setting the center by calling [isLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#isLoaded)\nmethod. If it is not yet loaded, you can call [load()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) method.","docsTags":[{"name":"example","text":"```html\n\n```"},{"name":"example","text":"```js\n// Sets the initial center point of the map component to lon/lat coordinates\n// lon/lat will be projected to match the spatial reference of the view\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.center = [-98, 39]; // lon, lat\n```"},{"name":"example","text":"```js\n// Updates the view's center point to a pre-determined Point object\nlet centerPoint = new Point({\n x: 12804.24,\n y: -1894032.09,\n spatialReference: {\n wkid: viewElement.spatialReference // wkid 2027\n }\n});\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.center = centerPoint;\n```"},{"name":"example","text":"```js\n// the point's spatialReference does not match the view's spatialReference\n// the projectOperator will be used to project the point to match\n// the view's spatialReference\nconst centerPoint = new Point({\n x: -8746995,\n y: 4352308,\n spatialReference: {\n wkid: 8857\n }\n});\nif (!projectOperator.isLoaded()) {\n await projectOperator.load();\n}\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.center = centerPoint;\n```"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"constraints","type":"MapViewConstraints","complexType":{"original":"MapViewConstraints","resolved":"MapViewConstraints","references":{"default":{"location":"import","path":"@arcgis/core/views/2d/MapViewConstraints.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies constraints to scale, zoom, and rotation that may be applied to the Map.","docsTags":[{"name":"see","text":"[MapViewConstraints](https://developers.arcgis.com/javascript/latest/references/core/views/2d/MapViewConstraints/)"},{"name":"see","text":"[TileInfo#create()](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TileInfo/#create)"},{"name":"see","text":"[Zoom and LODs](https://developers.arcgis.com/javascript/latest/references/core/views/View2D/#mapview-lods)"},{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.constraints = new MapViewConstraints({\n geometry: { // Constrain lateral movement to Lower Manhattan\n type: \"extent\",\n xmin: -74.020,\n ymin: 40.700,\n xmax: -73.971,\n ymax: 40.73\n },\n minScale: 500000, // User cannot zoom out beyond a scale of 1:500,000\n maxScale: 0, // User can overzoom tiles\n rotationEnabled: false // Disables map rotation\n});\n```"},{"name":"example","text":"```js\n// This snippet shows how to set the Map scale 1:1 while generating additional LODs for the constraints.\nconst spatialReference = new SpatialReference({\n wkid: 2154\n});\nconst center = new Point({\n x: 0,\n y: 0,\n spatialReference\n});\n\n// Create LODs from level 0 to 31\nconst tileInfo = TileInfo.create({\n spatialReference,\n numLODs: 32\n});\nconst lods = tileInfo.lods;\n\nconst constraints = new MapViewConstraints({\n snapToZoom: false,\n lods\n});\n\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.spatialReference = spatialReference;\nviewElement.center = center;\nviewElement.scale = 1;\nviewElement.constraints = constraints;\n```"}],"values":[],"optional":true,"required":false},{"name":"displayFilterDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"display-filter-disabled","reflectToAttr":false,"docs":"Indicates whether a layer's `displayFilterInfo` is honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"extent","type":"MapView[\"extent\"]","complexType":{"original":"MapView[\"extent\"]","resolved":"MapView[\"extent\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The extent represents the visible portion of a map within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/).\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the map.\n\n**Notes**\n\n* If the spatial reference of `extent` set does not match the [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference) of the view, then the\n[projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) will be loaded dynamically.\n* At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/)\nmust be [loaded](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) when\nsetting the `extent` to a spatial reference that doesn't match the view spatial reference. You can check if the projectOperator is\nloaded prior to setting the extent by calling [isLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#isLoaded)\nmethod. If it is not yet loaded, you can call the [load](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) method.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"fatalError","type":"Error | null | undefined","complexType":{"original":"Error | null | undefined","resolved":"Error | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/core/Error.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A rejected view indicates a fatal error making it unable to display.","docsTags":[{"name":"since","text":"4.12"},{"name":"see","text":"[tryFatalErrorRecovery()](https://developers.arcgis.com/javascript/latest/references/core/views/View/#tryFatalErrorRecovery)"},{"name":"example","text":"```js\nreactiveUtils.when(\n () => viewElement.fatalError,\n () => {\n console.error(\"Fatal Error! View has lost its WebGL context. Attempting to recover...\");\n viewElement.tryFatalErrorRecovery();\n }\n);\n```"}],"values":[],"optional":true,"required":false},{"name":"floors","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Applies a display filter on the view for a specific set of floor levels.\nIt can filter the map display on floor-aware layers by zero or more level IDs.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"gamepad","type":"GamepadSettings","complexType":{"original":"GamepadSettings","resolved":"GamepadSettings","references":{"default":{"location":"import","path":"@arcgis/core/views/input/gamepad/GamepadSettings.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Gamepad input specific configuration settings.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"graphics","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Allows for adding graphics directly to the default graphics in the map component.","docsTags":[{"name":"example","text":"```js\n// Adds a graphic to the map component.\nviewElement.graphics.add(pointGraphic);\n```"},{"name":"example","text":"```js\n// Removes a graphic from the map component.\nviewElement.graphics.remove(pointGraphic);\n```"},{"name":"see","text":"[Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/)"},{"name":"see","text":"[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/)"},{"name":"see","text":"[Intro to graphics](https://developers.arcgis.com/javascript/latest/sample-code/intro-graphics/)"}],"values":[],"optional":true,"required":false},{"name":"ground","type":"Ground | string","complexType":{"original":"Ground | string","resolved":"Ground | string","references":{"default":{"location":"import","path":"@arcgis/core/Ground.js","id":"notImplemented"}}},"mutable":true,"attr":"ground","reflectToAttr":false,"docs":"Specifies the surface properties for the map.","docsTags":[{"name":"see","text":"[ElevationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/)"},{"name":"see","text":"[Ground](https://developers.arcgis.com/javascript/latest/references/core/Ground/)"},{"name":"example","text":"```js\n// Create a map with the world elevation layer overlaid by a custom elevation layer\nconst worldElevation = new ElevationLayer({\n url: \"//elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer\"\n});\nconst customElevation = new ElevationLayer({\n url: \"https://my.server.com/arcgis/rest/service/MyElevationService/ImageServer\"\n});\nconst map = new Map({\n basemap: \"topo-vector\",\n ground: new Ground({\n layers: [ worldElevation, customElevation ]\n })\n});\n\nviewElement.map = map;\n```"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"hideAttribution","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-attribution","reflectToAttr":false,"docs":"Indicates whether the attribution is hidden in the view.\n\nEsri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.\nFor detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.\nFor information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlights","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/views/support/HighlightOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Represents a collection of [HighlightOptions](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/)\nobjects which can be used to highlight features throughout an application. Highlighting works by applying highlight options to one or\nmore features. You can configure these options (such as color or opacity) to define how a feature will be visually\nemphasized.\n\nA maximum of six [HighlightOptions](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/)\nobjects are supported in the collection, and they can be added, removed, and reordered freely. Their order in the collection determines priority, with the last\nobject having the highest priority. If you apply more than one highlight to a feature, the one that is last within\nthe collection will be applied. The [HighlightOptions](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/)\nobject must be part of this collection in order to be applied to features.\n\nTo highlight a feature, use the [highlight()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#highlight)\nmethod on the relevant [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) instance. To apply specific\n[HighlightOptions](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/), include the\n[name](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/#name) in the `highlight()` method's `options` parameter.\nIf no `name` is provided, the feature will use the `default` highlight options.\n\nThe table below shows the default highlight options in the View's highlights collection if the collection has not\nbeen modified:\n\n| Highlight options name | Description | Default settings |\n| ---------------------- | ----------- | ---------------- |\n| default | The default highlight options. Used when `layerView.highlight()` is called without specifying any particular highlight options. | ` { name: \"default\", color: \"cyan\", haloOpacity: 1, fillOpacity: 0.25, shadowColor: \"black\", shadowOpacity: 0.4, shadowDifference: 0.2}` |\n| temporary | The temporary highlight options, pre-configured for common use cases such as hovering over a feature in the view. | `{ name: \"temporary\", color: \"yellow\", haloOpacity: 1, fillOpacity: 0.25, shadowColor: \"black\", shadowOpacity: 0.4, shadowDifference: 0.2 }` |","docsTags":[{"name":"see","text":"[Sample: Highlight features by geometry](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)"},{"name":"see","text":"[Sample: Highlight point features](https://developers.arcgis.com/javascript/latest/sample-code/highlight-point-features/)"},{"name":"since","text":"4.32"},{"name":"example","text":"```js\n// Use the default highlights collection to apply a highlight to features when you hover over them\n// A handler can be used to remove any previous highlight when applying a new one\nlet hoverHighlight;\n\nviewElement.addEventListener(\"arcgisViewPointerMove\", async (event) => {\n try {\n await updateHoverHighlight(event);\n } catch (error) {\n if (error.name !== \"AbortError\") {\n console.error(error);\n }\n }\n});\n\nconst updateHoverHighlight = promiseUtils.debounce(async (event) => {\n // Search for the first feature in the featureLayer at the hovered location\n const response = await viewElement.hitTest(event.detail, { include: featureLayer });\n const result = response.results[0];\n\n // Remove any previous highlight, if it exists\n hoverHighlight?.remove();\n\n if (result?.type === \"graphic\") {\n // Highlight the hit feature with the temporary highlight options\n hoverHighlight = layerView.highlight(result.graphic, { name: \"temporary\" });\n }\n});\n```"},{"name":"example","text":"```js\n// Override the default highlights collection\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.highlights = new Collection([\n { name: \"default\", color: \"orange\" },\n { name: \"temporary\", color: \"magenta\" },\n { name: \"table\", color: \"cyan\", fillOpacity: 0.5, haloOpacity: 0}\n]);\n```"},{"name":"example","text":"```js\n// Add highlight options to the collection after initialization\n\nconst selectionHighlightOptions = {\n name: \"selection\",\n color: \"#ff00ff\", // bright fuchsia\n haloOpacity: 0.8,\n fillOpacity: 0.2\n};\n\n// Add the options to the highlights collection at the first position\nviewElement.highlights.add(selectionGroup, 0);\n```"}],"values":[],"optional":true,"required":false},{"name":"interacting","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the view is being interacted with (for example, when panning or via an interactive tool).","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"ipsInfo","type":"IPSInfo | null | undefined","complexType":{"original":"IPSInfo | null | undefined","resolved":"IPSInfo | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/webdoc/IPSInfo.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Contains indoor positioning system information for the map.","docsTags":[{"name":"since","text":"4.31"}],"values":[],"optional":true,"required":false},{"name":"itemId","type":"null | undefined | string","complexType":{"original":"null | undefined | string","resolved":"null | undefined | string","references":{}},"mutable":true,"attr":"item-id","reflectToAttr":true,"docs":"The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl) before the Map component loads.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layerViews","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection containing a hierarchical list of all the created\n[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)s of the\n[operational layers](https://developers.arcgis.com/javascript/latest/references/core/Map/#layers) in the map.","docsTags":[{"name":"see","text":"[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"loadErrorSources","type":"LoadErrorSource[] | undefined","complexType":{"original":"LoadErrorSource[] | undefined","resolved":"LoadErrorSource[] | undefined","references":{"LoadErrorSource":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of objects that encountered an error while loading the component or any of its dependencies (e.g., basemap, ground, layers, tables). You may inspect the errors by accessing each object's `loadError` property.","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"magnifier","type":"Magnifier","complexType":{"original":"Magnifier","resolved":"Magnifier","references":{"default":{"location":"import","path":"@arcgis/core/views/Magnifier.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The magnifier allows for showing a portion of the view as a magnifier image on top of the view.","docsTags":[{"name":"since","text":"4.19"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"map","type":"Map | null | undefined","complexType":{"original":"Map | null | undefined","resolved":"Map | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Map.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An instance of a [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/) object to display in the view.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"navigating","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indication whether the view is being navigated (for example when panning).","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"navigation","type":"Navigation","complexType":{"original":"Navigation","resolved":"Navigation","references":{"default":{"location":"import","path":"@arcgis/core/views/navigation/Navigation.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Options to configure the navigation behavior of the View.","docsTags":[{"name":"since","text":"4.9"},{"name":"example","text":"```js\n// Disable the gamepad usage, single touch panning, panning momentum and mouse wheel zooming.\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.navigation = {\n gamepad: {\n enabled: false\n },\n actionMap: {\n dragSecondary: \"none\", // Disable rotating the view with the right mouse button\n mouseWheel: \"none\" // Disable zooming with the mouse wheel\n },\n browserTouchPanEnabled: false,\n momentumEnabled: false,\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"padding","type":"ViewPadding","complexType":{"original":"ViewPadding","resolved":"ViewPadding","references":{"ViewPadding":{"location":"import","path":"@arcgis/core/views/ui/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Padding to make the map's center and extent work off a\nsubsection of the full map. This is particularly useful when layering UI\nelements or semi-transparent content on top of portions of the map.","docsTags":[{"name":"see","text":"[Sample: Map padding](https://developers.arcgis.com/javascript/latest/sample-code/map-padding/)"}],"default":"{left: 0, top: 0, right: 0, bottom: 0}","values":[],"optional":true,"required":false},{"name":"popup","type":"Popup | null | undefined","complexType":{"original":"Popup | null | undefined","resolved":"Popup | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Popup.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/) widget object that displays general content or attributes from [layers](https://developers.arcgis.com/javascript/latest/references/core/Map/#layers) in the [map](https://developers.arcgis.com/javascript/latest/references/core/views/View/#map). Consider using the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) (beta), which represents the Popup component, instead.\n\nBy default, the `popup` property is an empty object that allows you to set the popup options. A [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/) instance is automatically created and assigned to the view's [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popup) when the user clicks on the view and [popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/PopupView/#popupEnabled) is `true`, when the [openPopup()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#openPopup) method is called, or when some widgets need the popup, such as [Search](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/). If [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popup) is `null`, the popup instance will not be created.","docsTags":[{"name":"see","text":"[popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement)"},{"name":"see","text":"[popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupDisabled)"},{"name":"see","text":"[openPopup()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#openPopup)"}],"values":[],"optional":true,"required":false},{"name":"popupComponentEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"popup-component-enabled","reflectToAttr":false,"docs":"Indicates whether the [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) (beta) is enabled as the default popup. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) property (representing the component) will be used for popups instead of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popup) property (representing the widget).\n\n**Note:** This is a beta feature and may change in future releases. At version 6.0, the Popup component will be used by default instead of the Popup widget and the `popup-component-enabled` attribute will no longer be necessary.","docsTags":[{"name":"beta"},{"name":"since","text":"5.0"},{"name":"see","text":"[popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement)"},{"name":"example","text":"```html\n\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"popupDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"popup-disabled","reflectToAttr":false,"docs":"Controls whether the default popup opens automatically when users click on the view. This controls both the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) and [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popup) properties. When set to `true`, the popup will not open on click or when triggered programmatically.","docsTags":[{"name":"see","text":"[openPopup()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#openPopup)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"popupElement","type":"ArcgisPopup | null","complexType":{"original":"ArcgisPopup | null","resolved":"ArcgisPopup | null","references":{"ArcgisPopup":{"location":"local","path":"components/arcgis-popup","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A reference to the current [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) (beta). The [popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled) property must be set to `true` to use this property.\n\n**Note:** This is a beta feature and may change in future releases.","docsTags":[{"name":"beta"},{"name":"since","text":"5.0"},{"name":"see","text":"[popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled)"},{"name":"example","text":"```html\n\n\n```"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"ready","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"When `true`, this property indicates whether the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#view) has successfully satisfied all dependencies, signaling that the following conditions are met:\n\n* The view has a [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#map). If [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#map)\nis a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/), then the map\nmust be [loaded](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#loaded).\n* The view has a [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference), a [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#center), and a [scale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#scale).\nThese also can be inferred by setting an [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#extent).\n\nWhen a view becomes ready it will resolve itself and invoke\nthe callback defined in [viewOnReady()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#viewOnReady) where code can execute on a working view.","docsTags":[{"name":"see","text":"[when()](https://developers.arcgis.com/javascript/latest/references/core/views/View/#when)"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"resizeAlign","type":"ResizeAlign","complexType":{"original":"ResizeAlign","resolved":"ResizeAlign","references":{"ResizeAlign":{"location":"import","path":"@arcgis/core/views/2d/types.js","id":"notImplemented"}}},"mutable":true,"attr":"resize-align","reflectToAttr":false,"docs":"Defines which anchor stays still while resizing the browser window. The default, `center`,\nensures the view's center point remains constantly visible as the window size changes. The other\noptions allow the respective portion of the view to remain visible when the window's size is changed.","docsTags":[],"default":"\"center\"","values":[{"type":"string","value":"top-left"},{"type":"string","value":"top-right"},{"type":"string","value":"bottom-left"},{"type":"string","value":"bottom-right"},{"type":"string","value":"center"},{"type":"string","value":"bottom"},{"type":"string","value":"left"},{"type":"string","value":"right"},{"type":"string","value":"top"}],"optional":true,"required":false},{"name":"resolution","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Represents the current value of one pixel in the unit of the view's spatialReference.\nThe value of resolution is calculated by dividing the view's extent width\nby its width.","docsTags":[{"name":"since","text":"4.9"},{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"rotation","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"rotation","reflectToAttr":false,"docs":"The clockwise rotation of due north in relation to the top of the view in degrees.\nThe view may be rotated by directly setting\nthe rotation or by using the following mouse event: `Right-click + Drag`.\nMap rotation may be disabled by setting the `rotationEnabled` property\nin [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#constraints) to `false`. See the code snippet below for\nan example of this.","docsTags":[{"name":"example","text":"```html\n\n\n```"},{"name":"example","text":"```js\n// Due north is rotated 180 degrees, pointing to the bottom of the view\nviewElement.rotation = 180;\n```"},{"name":"example","text":"```js\n// Due north is rotated 270 degrees, pointing to the left side of the view\nviewElement.rotation = 270;\n```"},{"name":"example","text":"```js\n// Due north is rotated 0 degrees, pointing to the top of the view (the default)\nviewElement.rotation = 0; // 360 or multiple of 360 (e.g. 720) works here as well.\n```"},{"name":"example","text":"```js\n// Disables map rotation\nviewElement.constraints = {\n rotationEnabled: false\n};\n```"}],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"scale","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"scale","reflectToAttr":false,"docs":"Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"selectionManager","type":"SelectionManager","complexType":{"original":"SelectionManager","resolved":"SelectionManager","references":{"default":{"location":"import","path":"@arcgis/core/views/SelectionManager.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The default [SelectionManager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) for this view. Used to manage selections of features across layers.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"slotGroupRefs","type":"SlotGroupRefs","complexType":{"original":"SlotGroupRefs","resolved":"SlotGroupRefs","references":{"SlotGroupRefs":{"location":"local","path":"support/slots","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"spatialReference","type":"SpatialReference","complexType":{"original":"SpatialReference","resolved":"SpatialReference","references":{"default":{"location":"import","path":"@arcgis/core/geometry/SpatialReference.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The spatial reference of the view. This indicates the projected or geographic coordinate system used to locate geographic features in the map.\nYou can change the spatialReference of the view after it is initialized by either directly changing\nthis property, or by changing the basemap from the [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/)\nand [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/) components.\nSet [spatialReferenceLocked](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReferenceLocked) property to `true` to prevent users from changing the view's spatial reference at runtime.\n\nPrior to changing the spatial reference, check if the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/)\nis loaded by calling [projectOperator.isLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#isLoaded) method.\nIf it is not yet loaded, call [projectOperator.load()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) method.\nIf the `projectOperator` is not loaded, the view's [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#center) will default to `[0, 0]` in the new spatial reference of the view and a console error will be thrown.\n\n**Notes**\n\n* [LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) not compatible with the view's spatial reference\nare not displayed. In such case, the layer view's [suspended](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/#suspended)\nproperty is `true` and [spatialReferenceSupported](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/#spatialReferenceSupported)\nproperty is `false`.\n* When setting view's spatial reference, the [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#center), [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#extent) or [viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#viewpoint) properties are projected to the new spatial\nreference. The [scale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#scale) and [rotation](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#rotation) properties are adjusted to keep the content of the map at the same size and orientation on screen.\n* To ensure [TileLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/TileLayer/) and\n[VectorTileLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer/)\nare displayed in a [basemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#basemap) correctly, the spatialReference of the view must be set match their\n[tileInfo's](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TileInfo/) spatial reference.\n* Switching spatial reference with an [imageCoordinateSystem](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/#imageCoordinateSystem)\nis not supported.","docsTags":[{"name":"see","text":"[spatialReferenceLocked](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReferenceLocked)"},{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-map\");\n// check if the projectOperator is loaded\nif (!projectOperator.isLoaded()) {\n // load the projectOperator if it is not loaded\n projectOperator.load().then(() => {\n // change the spatial reference of the map component to equal earth projection\n viewElement.spatialReference = new SpatialReference({\n wkid: 54035 //equal earth projection\n });\n });\n} else {\n // the projectOperator is already loaded.\n // change the spatial reference of the view to equal earth projection\n viewElement.spatialReference = new SpatialReference({\n wkid: 54035 //equal earth projection\n });\n}\n```"}],"values":[],"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 map's [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference) can be changed after it is ready.\nThe default is `false`, indicating the map's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the map's spatial reference\nwill be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"stationary","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indication whether the view is animating, being navigated with or resizing.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"suspended","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"suspended","reflectToAttr":true,"docs":"Indicates if the view is visible on the page.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"theme","type":"Theme | null | undefined","complexType":{"original":"Theme | null | undefined","resolved":"Theme | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/Theme.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property specifies the base colors used by some components to render graphics and labels.","docsTags":[{"name":"since","text":"4.28"},{"name":"see","text":"[Theme](https://developers.arcgis.com/javascript/latest/references/core/views/Theme/)"},{"name":"see","text":"[Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)"},{"name":"example","text":"```js\n// Update the theme to use purple graphics\n// and slightly transparent green text\nview.theme = new Theme({\n accentColor: \"purple\",\n textColor: [125, 255, 13, 0.9]\n});\n```"}],"values":[],"optional":true,"required":false},{"name":"timeExtent","type":"TimeExtent | null | undefined","complexType":{"original":"TimeExtent | null | undefined","resolved":"TimeExtent | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/time/TimeExtent.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view's time extent. Time-aware layers display their temporal data that falls within\nthe view's time extent. Setting the view's time extent is similar to setting the spatial\nextent because once the time extent is set, the\nview updates automatically to conform to the change.","docsTags":[{"name":"since","text":"4.12"},{"name":"example","text":"```js\n// Create a csv layer from an online spreadsheet.\nconst csvLayer = new CSVLayer({\n url: \"http://test.com/daily-magazines-sold-in-new-york.csv\",\n timeInfo: {\n startField: \"SaleDate\" // The csv field contains date information.\n }\n});\nviewElement.map.add(csvLayer);\n\nviewElement.timeExtent = {\n start: new Date(\"2019, 2, 24\"),\n end: new Date(\"2019, 2, 31\")\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"timeZone","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"Defines the time zone of the view.\nThe time zone property determines how dates and times are represented to the user,\nbut the underlying data is unchanged.","docsTags":[{"name":"see","text":"[wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"},{"name":"example","text":"```js\n// Date and time will be displayed in Pacific/Auckland (NZ) time zone\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.timeZone = \"Pacific/Auckland\";\n```"}],"default":"\"system\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"updating","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the view is being updated by additional data requests to the network,\nor by processing received data.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapView","complexType":{"original":"MapView","resolved":"MapView","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) instance created and managed by the component. Accessible once the component is fully loaded.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"viewpoint","type":"Viewpoint","complexType":{"original":"Viewpoint","resolved":"Viewpoint","references":{"default":{"location":"import","path":"@arcgis/core/Viewpoint.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Represents the current view as a Viewpoint or point of observation on the view.\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.","docsTags":[{"name":"example","text":"```js\n// Set the viewpoint to the Empire State Building in New York City\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.viewpoint = new Viewpoint({\n targetGeometry: new Point({\n longitude: -73.9857,\n latitude: 40.7484\n }),\n scale: 5000\n});\n```"},{"name":"example","text":"```js\n// Get the initial viewpoint of the view once the view is ready\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\nconst initialViewpoint = viewElement.viewpoint.clone();\n```"}],"values":[],"optional":true,"required":false},{"name":"visibleArea","type":"Polygon | null | undefined","complexType":{"original":"Polygon | null | undefined","resolved":"Polygon | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Polygon.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The visibleArea represents the visible portion of a [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/) within the view as\nan instance of a [Polygon](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon/). This is similar to the view\n[MapView#extent](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#extent) but is a more accurate representation of the visible area especially\nwhen the view is rotated. An example use of the visible area is to spatially filter visible features\nin a layer view query.","docsTags":[{"name":"since","text":"4.31"},{"name":"see","text":"[MapView#extent](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#extent)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"zoom","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"zoom","reflectToAttr":false,"docs":"Represents the level of detail (LOD) at the center of the map.\nA zoom level (or scale) is a number that defines how large or small the contents of a map appear in a Map component.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the map has no LODs.\nWhen setting the zoom value, the component converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false}],"methods":[{"name":"closePopup","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"closePopup(): Promise","parameters":[],"docs":"Closes the popup.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisMap = document.createElement(\"arcgis-map\");\ndocument.body.append(arcgisMap);\nawait arcgisMap.componentOnReady();\nconsole.log(\"arcgis-map is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Destroys the view, and any associated resources, including its map, popup, and UI elements.","docsTags":[]},{"name":"fetchPopupFeatures","returns":{"type":"Promise>","docs":""},"complexType":{"signature":"(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise>","parameters":[{"name":"hitTarget","type":"ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"FetchPopupFeaturesOptions","docs":""}],"return":"Promise>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"AsyncGenerator":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"ScreenRect":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"FetchPopupFeaturesOptions":{"location":"import","path":"@arcgis/core/views/PopupView.js","id":"notImplemented"}}},"signature":"fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise>","parameters":[{"name":"hitTarget","type":"ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"FetchPopupFeaturesOptions","docs":""}],"docs":"Use this method to query for features at a given screen location. These features come from origins (layers and sublayers) configured with a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [FeatureLayer.popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled) set. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer to control how the input location is handled, and then subsequently, what to do with the results.\n> [!WARNING]\n> Using [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) as the hit target is considered **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** functionality.","docsTags":[{"name":"since","text":"5.1"},{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-map\");\n// Get viewElement's click event\nviewElement.addEventListener(\"arcgisViewClick\", async (event) => {\n const generator = await viewElement.fetchPopupFeatures(event.detail.screenPoint, {\n pointerType: event.detail.pointerType\n });\n // Access the features returned from the generator\n for await (const feature of generator) {\n console.log(feature);\n }\n});\n```"},{"name":"example","text":"```js\n// Wait for all the features to be available\nview.on(\"click\", async (event) => {\n const generator = view.fetchPopupFeatures(event.screenPoint, {\n pointerType: event.pointerType\n });\n\n const features = await Array.fromAsync(generator);\n});"}]},{"name":"goTo","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(target: GoToTarget2D, options?: GoToOptions2D): Promise","parameters":[{"name":"target","type":"GoToTarget2D","docs":""},{"name":"options","type":"GoToOptions2D","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"GoToTarget2D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"},"GoToOptions2D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"goTo(target: GoToTarget2D, options?: GoToOptions2D): Promise","parameters":[{"name":"target","type":"GoToTarget2D","docs":""},{"name":"options","type":"GoToOptions2D","docs":""}],"docs":"Sets the view to a given target.","docsTags":[]},{"name":"hitTest","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(hitTarget: MouseEvent | ScreenPoint | ScreenRect, options?: HitTestOptions): Promise","parameters":[{"name":"hitTarget","type":"MouseEvent | ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"HitTestOptions","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ViewHitTestResult":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"},"MouseEvent":{"location":"global","path":"global:","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"ScreenRect":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"HitTestOptions":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"hitTest(hitTarget: MouseEvent | ScreenPoint | ScreenRect, options?: HitTestOptions): Promise","parameters":[{"name":"hitTarget","type":"MouseEvent | ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"HitTestOptions","docs":""}],"docs":"Returns [hit test results](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHitTestResult) from each layer that intersects the specified screen point or screen rectangle.\nThe results are organized as an array of objects containing different [ViewHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHit) result types such as graphics, raster pixels, media elements, or routes.\n\n**2D hitTest() behavior by layer type**\n| Layer type | Hit test behavior |\n| :--- | :--- |\n| [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer), [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/catalog/CatalogFootprintLayer), [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer), [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OGCFeatureLayer), [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OrientedImageryLayer), [ParquetLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ParquetLayer), [StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer), [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SubtypeGroupLayer), [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer) | Returns all intersecting [GraphicHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) features at the hit location. |\n| [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoRSSLayer), [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer), [KMLLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KMLLayer), [MapNotesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapNotesLayer) | Returns all intersecting [GraphicHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) features at the hit location. |\n| [ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer), [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryTileLayer)| Returns [RasterHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RasterHit) result containing raster pixel value used in rendering and bandId info on intersecting pixels. Support was added in version 5.1. The `screenRect` hitTarget returns hit result at the center of the rectangle. |\n| [VectorTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer) | Returns a result for all intersecting [GraphicHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) features containing attributes of style layers (as of version 4.29; in prior releases, only the topmost style layer result was returned). In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/references/core/Graphic#origin) contains the style layer's [id](https://maplibre.org/maplibre-style-spec/layers/#id) and layer index within the [vector tile style](https://doc.arcgis.com/en/arcgis-online/reference/tile-layers.htm#ESRI_SECTION1_8F68399EB47B48FF9EF46719FCC96978). Spatial information about the actual feature represented in the style layer is returned only if the style layer is a [symbol layer](https://maplibre.org/maplibre-style-spec/layers/#symbol). Otherwise, the graphic's geometry is `null`. |\n| [MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer) | Returns [MediaHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#MediaHit) result containing all media elements if the hit is made on intersecting elements. |\n| [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer) | Returns [RouteHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RouteHit) result containing all intersecting route elements if the hit is made on intersecting elements. |\n\n**Note:** If the [Polygon](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon) feature's symbol [SimpleFillSymbol.style](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol#style) is set to \"none\", the hitTest method will not\nreturn results when the fill is clicked. However, it will return results when the outline is clicked. To get results when clicking the fill, set the\n[SimpleFillSymbol.color](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol#color) to a transparent color instead.\n\nRelease-specific changes:\n* At version 5.1, **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** support was added for [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect), allowing hit tests across rectangular screen areas.\n* At version 4.24, [ViewHitTestResult](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHitTestResult) returns an array of objects containing [GraphicHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) graphic, [MediaHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#MediaHit) media element, and [RouteHit](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RouteHit) route.\n* At version 4.23, all hit test features from feature layers are returned in the result. In prior releases, only the top most feature was returned.","docsTags":[{"name":"see","text":"[Sample - Access features with hitTest](https://developers.arcgis.com/javascript/latest/sample-code/map-component-hittest/)"},{"name":"see","text":"[Sample - Hit test features by screen rectangle](https://developers.arcgis.com/javascript/latest/sample-code/map-hittest-screen-rectangle/)"},{"name":"see","text":"[Sample - VectorTileLayer hitTest](https://developers.arcgis.com/javascript/latest/sample-code/layers-vectortilelayer-hittest/)"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewClick\", async (event) => {\n const response = await viewElement.hitTest(event.detail);\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(`Hit graphic at (${longitude}, ${latitude})`, result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n});\n```"},{"name":"example","text":"```js\n// get screenpoint from view's click event\nviewElement.addEventListener(\"arcgisViewClick\", async (event) => {\n // Search for all media elements only on included mediaLayer at the clicked location\n const response = await viewElement.hitTest(event.detail, {\n include: {mediaLayer}\n });\n // if media elements are returned from the mediaLayer, do something with results\n if (response.results.length){\n // do something\n console.log(response.results.length, \"elements returned\");\n }\n});\n```"}]},{"name":"openPopup","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(options?: ViewPopupOpenOptions): Promise","parameters":[{"name":"options","type":"ViewPopupOpenOptions","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ViewPopupOpenOptions":{"location":"import","path":"@arcgis/core/views/PopupView.js","id":"notImplemented"}}},"signature":"openPopup(options?: ViewPopupOpenOptions): Promise","parameters":[{"name":"options","type":"ViewPopupOpenOptions","docs":""}],"docs":"Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.","docsTags":[]},{"name":"takeScreenshot","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(options?: UserSettings): Promise","parameters":[{"name":"options","type":"UserSettings","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"Screenshot":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"},"UserSettings":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"takeScreenshot(options?: UserSettings): Promise","parameters":[{"name":"options","type":"UserSettings","docs":""}],"docs":"Create a screenshot of the current view.","docsTags":[]},{"name":"toMap","returns":{"type":"Point","docs":""},"complexType":{"signature":"(screenPoint: MouseEvent | ScreenPoint): Point","parameters":[{"name":"screenPoint","type":"MouseEvent | ScreenPoint","docs":""}],"return":"Point","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"},"MouseEvent":{"location":"global","path":"global:","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"}}},"signature":"toMap(screenPoint: MouseEvent | ScreenPoint): Point","parameters":[{"name":"screenPoint","type":"MouseEvent | ScreenPoint","docs":""}],"docs":"","docsTags":[]},{"name":"toScreen","returns":{"type":"ScreenPoint | null | undefined","docs":""},"complexType":{"signature":"(point: Point, options?: ToScreenOptions2D): ScreenPoint | null | undefined","parameters":[{"name":"point","type":"Point","docs":""},{"name":"options","type":"ToScreenOptions2D","docs":""}],"return":"ScreenPoint | null | undefined","references":{"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"},"ToScreenOptions2D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"toScreen(point: Point, options?: ToScreenOptions2D): ScreenPoint | null | undefined","parameters":[{"name":"point","type":"Point","docs":""},{"name":"options","type":"ToScreenOptions2D","docs":""}],"docs":"","docsTags":[]},{"name":"tryFatalErrorRecovery","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"tryFatalErrorRecovery(): Promise","parameters":[],"docs":"Call this method to clear any fatal errors resulting from a lost WebGL context.","docsTags":[]},{"name":"viewOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(callback?: () => void, errback?: (error: Error) => void): Promise","parameters":[{"name":"callback","type":"() => void","docs":""},{"name":"errback","type":"(error: Error) => void","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/core/Error.js","id":"notImplemented"}}},"signature":"viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise","parameters":[{"name":"callback","type":"() => void","docs":""},{"name":"errback","type":"(error: Error) => void","docs":""}],"docs":"`viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.","docsTags":[{"name":"since","text":"4.33"},{"name":"see","text":"[Watch for changes - waiting for components or views to be ready](https://developers.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"},{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"}]},{"name":"whenAnalysisView","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(analysis: Analysis): Promise","parameters":[{"name":"analysis","type":"Analysis","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"AnalysisView2DUnion":{"location":"import","path":"@arcgis/core/views/2d/analysis/types.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/analysis/Analysis.js","id":"notImplemented"}}},"signature":"whenAnalysisView(analysis: Analysis): Promise","parameters":[{"name":"analysis","type":"Analysis","docs":""}],"docs":"Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#whenAnalysisView)","docsTags":[{"name":"since","text":"4.34"}]},{"name":"whenLayerView","returns":{"type":"Promise>","docs":""},"complexType":{"signature":"(layer: TLayer): Promise>","parameters":[{"name":"layer","type":"TLayer","docs":""}],"return":"Promise>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"LayerView2DFor":{"location":"import","path":"@arcgis/core/views/2d/types.js","id":"notImplemented"},"TLayer":{"location":"local","id":"notImplemented"}}},"signature":"whenLayerView(layer: TLayer): Promise>","parameters":[{"name":"layer","type":"TLayer","docs":""}],"docs":"Gets the LayerView created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#whenLayerView)","docsTags":[]},{"name":"zoomIn","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomIn(): Promise","parameters":[],"docs":"Zooms in the view component by a factor of 2.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"zoomOut","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomOut(): Promise","parameters":[],"docs":"Zooms out the view component by a factor of 2.","docsTags":[{"name":"since","text":"5.0"}]}],"events":[{"event":"arcgisLoadError","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when an arcgis-map fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).","docsTags":[{"name":"since","text":"4.34"},{"name":"see","text":"[loadErrorSources](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#loadErrorSources)"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisLoadError\", () => {\n console.log(viewElement.loadErrorSources);\n});\n```"}]},{"event":"arcgisViewAnalysisViewCreate","detail":"AnalysisViewCreateEvent","bubbles":true,"complexType":{"original":"AnalysisViewCreateEvent","resolved":"AnalysisViewCreateEvent","references":{"AnalysisViewCreateEvent":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-create)","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisViewAnalysisViewCreateError","detail":"AnalysisViewCreateErrorEvent","bubbles":true,"complexType":{"original":"AnalysisViewCreateErrorEvent","resolved":"AnalysisViewCreateErrorEvent","references":{"AnalysisViewCreateErrorEvent":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-create-error)","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisViewAnalysisViewDestroy","detail":"AnalysisViewDestroyEvent","bubbles":true,"complexType":{"original":"AnalysisViewDestroyEvent","resolved":"AnalysisViewDestroyEvent","references":{"AnalysisViewDestroyEvent":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-destroy)","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisViewChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"This event is triggered when view-related properties change, such as [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#zoom), [scale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#scale), [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#center), [rotation](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#rotation), [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#extent),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#viewpoint), or [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#stationary).\nIt reflects user interactions (e.g. panning or zooming) or programmatic updates to the view.\n\n> The `arcgisViewChange` event may be emitted before the view is fully ready.\n> This means the event can fire before the component's `stationary` property is `true` or before the view has completed its initial setup.\n> For actions that require the view to be ready and stationary, combine this event with checks on the component's `stationary` and `ready` properties.","docsTags":[{"name":"example","text":"```js\n// get the number of features in a layer view whenever the view becomes stationary\nviewElement.addEventListener(\"arcgisViewChange\", async (event) =>{\n if (viewElement.ready && viewElement.stationary) {\n // Returns number of features available for drawing in a given layer view\n const count = await layerView.queryFeatureCount({\n geometry: viewElement.extent\n });\n // use the features count\n }\n});\n```"}]},{"event":"arcgisViewClick","detail":"ClickEvent","bubbles":true,"complexType":{"original":"ClickEvent","resolved":"ClickEvent","references":{"ClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a user clicks on the view. This event emits slightly slower than an [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick)\nevent to make sure that an [@arcgisViewDoubleClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewDoubleClick) event isn't triggered instead. The `arcgisViewImmediateClick`\nevent can be used for responding to an `arcgisViewClick` event without delay.","docsTags":[{"name":"example","text":"```js\n// Listen for clicks on the view and perform a hit test on a feature layer\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n // Return hit test results from the feature layer\n // where it intersects the screen coordinates from the click event.\n // The result is a polygon representing the state that was clicked.\n viewElement.hitTest(event.detail).then((response) => {\n if (response.results.length) {\n const stateBoundaryPolygon = response.results.find((result) => {\n return result.graphic.layer === stateBoundaryFeatureLayer;\n }).graphic.geometry;\n\n getPolygonCentroid(stateBoundaryPolygon);\n }\n });\n});\n```"}]},{"event":"arcgisViewDoubleClick","detail":"DoubleClickEvent","bubbles":true,"complexType":{"original":"DoubleClickEvent","resolved":"DoubleClickEvent","references":{"DoubleClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after double-clicking on the view.","docsTags":[{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewDoubleClick\", async (event) => {\n // Prevent the default zoom-in behavior on double-click\n event.detail.stopPropagation();\n});\n```"}]},{"event":"arcgisViewDoubleTapDrag","detail":"DoubleTapDragEvent","bubbles":true,"complexType":{"original":"DoubleTapDragEvent","resolved":"DoubleTapDragEvent","references":{"DoubleTapDragEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires while the pointer is dragged following a double-tap gesture on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-double-tap-drag)","docsTags":[{"name":"since","text":"5.0"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewDoubleTapDrag\", (event) => {\n // Display the distance moved from the drag origin.\n console.log(\"x distance:\", event.detail.x, \"y distance:\", event.detail.y);\n});\n```"}]},{"event":"arcgisViewDrag","detail":"DragEvent","bubbles":true,"complexType":{"original":"DragEvent","resolved":"DragEvent","references":{"DragEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires during a pointer drag on the view.","docsTags":[]},{"event":"arcgisViewHold","detail":"HoldEvent","bubbles":true,"complexType":{"original":"HoldEvent","resolved":"HoldEvent","references":{"HoldEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after holding either a mouse button or a single finger on the view for a short amount of time.","docsTags":[]},{"event":"arcgisViewImmediateClick","detail":"ImmediateClickEvent","bubbles":true,"complexType":{"original":"ImmediateClickEvent","resolved":"ImmediateClickEvent","references":{"ImmediateClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires right after a user clicks on the view. In contrast to the [@arcgisViewClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewClick) event, the `arcgisViewImmediateClick`\nis emitted as soon as the user clicks on the view, and is not inhibited by a [@arcgisViewDoubleClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewDoubleClick) event.\nThis event is useful for interactive experiences that require feedback without delay.","docsTags":[{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewImmediateClick\", async (event) => {\n // Prevent the default zoom-in behavior on arcgisViewImmediateClick\n event.detail.stopPropagation();\n});\n```"}]},{"event":"arcgisViewImmediateDoubleClick","detail":"ImmediateDoubleClickEvent","bubbles":true,"complexType":{"original":"ImmediateDoubleClickEvent","resolved":"ImmediateDoubleClickEvent","references":{"ImmediateDoubleClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after two consecutive [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick) events. In contrast to [@arcgisViewDoubleClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewDoubleClick),\nan `arcgisViewImmediateDoubleClick` cannot be prevented by use of `stopPropagation()` on the [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick)\nevent and can therefore be used to react to double-clicking independently of usage of the [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick) event.","docsTags":[]},{"event":"arcgisViewKeyDown","detail":"KeyDownEvent","bubbles":true,"complexType":{"original":"KeyDownEvent","resolved":"KeyDownEvent","references":{"KeyDownEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a keyboard key is pressed.","docsTags":[{"name":"example","text":"```js\n// Disable zooming with the keyboard\n// Stop event propagation when `+` and `-` keys are pressed.\nviewElement.addEventListener(\"arcgisViewKeyDown\", function(event){\n console.log(\"key-down\", event);\n\n const prohibitedKeys = [\"+\", \"-\"];\n const keyPressed = event.detail.key;\n if (prohibitedKeys.indexOf(keyPressed) !== -1) {\n event.detail.stopPropagation();\n }\n});\n```"}]},{"event":"arcgisViewKeyUp","detail":"KeyUpEvent","bubbles":true,"complexType":{"original":"KeyUpEvent","resolved":"KeyUpEvent","references":{"KeyUpEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a keyboard key is released.","docsTags":[]},{"event":"arcgisViewLayerviewCreate","detail":"LayerViewCreateEvent","bubbles":true,"complexType":{"original":"LayerViewCreateEvent","resolved":"LayerViewCreateEvent","references":{"LayerViewCreateEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after each layer in the map has a corresponding\n[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\ncreated and rendered in the view.","docsTags":[]},{"event":"arcgisViewLayerviewCreateError","detail":"LayerViewCreateErrorEvent","bubbles":true,"complexType":{"original":"LayerViewCreateErrorEvent","resolved":"LayerViewCreateErrorEvent","references":{"LayerViewCreateErrorEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when an error occurs during the creation of a [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\nafter a layer has been added to the map.","docsTags":[]},{"event":"arcgisViewLayerviewDestroy","detail":"LayerViewDestroyEvent","bubbles":true,"complexType":{"original":"LayerViewDestroyEvent","resolved":"LayerViewDestroyEvent","references":{"LayerViewDestroyEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\nis destroyed and is no longer rendered in the view.","docsTags":[]},{"event":"arcgisViewMouseWheel","detail":"ViewMouseWheelEvent","bubbles":true,"complexType":{"original":"ViewMouseWheelEvent","resolved":"ViewMouseWheelEvent","references":{"ViewMouseWheelEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.","docsTags":[{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewMouseWheel\", async (event) => {\n // Prevent the default zoom-in and zoom-out behavior on arcgisViewMouseWheel\n event.detail.stopPropagation();\n});\n```"}]},{"event":"arcgisViewPointerDown","detail":"PointerDownEvent","bubbles":true,"complexType":{"original":"PointerDownEvent","resolved":"PointerDownEvent","references":{"PointerDownEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse button is pressed, or a finger touches the display.","docsTags":[{"name":"see","text":"[Sample: Access features with hitTest](https://developers.arcgis.com/javascript/latest/sample-code/map-component-hittest/)"}]},{"event":"arcgisViewPointerEnter","detail":"PointerEnterEvent","bubbles":true,"complexType":{"original":"PointerEnterEvent","resolved":"PointerEnterEvent","references":{"PointerEnterEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse cursor enters the view, or a display touch begins.","docsTags":[]},{"event":"arcgisViewPointerLeave","detail":"PointerLeaveEvent","bubbles":true,"complexType":{"original":"PointerLeaveEvent","resolved":"PointerLeaveEvent","references":{"PointerLeaveEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse cursor leaves the view, or a display touch ends.","docsTags":[]},{"event":"arcgisViewPointerMove","detail":"PointerMoveEvent","bubbles":true,"complexType":{"original":"PointerMoveEvent","resolved":"PointerMoveEvent","references":{"PointerMoveEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after the mouse or a finger on the display moves.","docsTags":[{"name":"see","text":"[Sample: Access features with hitTest](https://developers.arcgis.com/javascript/latest/sample-code/map-component-hittest/)"}]},{"event":"arcgisViewPointerUp","detail":"PointerUpEvent","bubbles":true,"complexType":{"original":"PointerUpEvent","resolved":"PointerUpEvent","references":{"PointerUpEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse button is released, or a display touch ends.","docsTags":[]},{"event":"arcgisViewReadyChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"This event is for the `ready` property and is emitted when the view is ready.\nFires also when the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#map) is updated.","docsTags":[]},{"event":"arcgisViewReadyError","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires if the view encounters a content or rendering error.","docsTags":[{"name":"since","text":"4.34"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewReadyError\", () => {\n // handle error\n});\n```"}]},{"event":"arcgisViewVerticalTwoFingerDrag","detail":"VerticalTwoFingerDragEvent","bubbles":true,"complexType":{"original":"VerticalTwoFingerDragEvent","resolved":"VerticalTwoFingerDragEvent","references":{"VerticalTwoFingerDragEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires while the two pointers are dragged vertically on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-vertical-two-finger-drag)","docsTags":[{"name":"since","text":"5.0"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewVerticalTwoFingerDrag\", (event) => {\n // Display the distance moved vertically from the drag origin.\n console.log(\"y distance:\", event.detail.y);\n});\n```"}]}],"styles":[{"name":"--arcgis-layout-overlay-space-top","annotation":"prop","docs":"_Since 4.34_ Specifies the top padding for the layout."},{"name":"--arcgis-layout-overlay-space-bottom","annotation":"prop","docs":"_Since 4.34_ Specifies the bottom padding for the layout."},{"name":"--arcgis-layout-overlay-space-left","annotation":"prop","docs":"_Since 4.34_ Specifies the left padding for the layout."},{"name":"--arcgis-layout-overlay-space-right","annotation":"prop","docs":"_Since 4.34_ Specifies the right padding for the layout."},{"name":"--arcgis-view-color-focus","annotation":"prop","docs":"_Since 5.0_ Specifies the focus outline color for the view."},{"name":"--arcgis-table-row-background-color","annotation":"prop","docs":"_Since 5.1_ Specifies the background color for table rows."},{"name":"--arcgis-table-row-alt-background-color","annotation":"prop","docs":"_Since 5.1_ Specifies the background color for alternate table rows."}],"slots":[{"name":"","docs":"Default slot for adding components to the map. User is responsible for positioning the content via CSS."},{"name":"top-left","docs":"Slot for components positioned in the top-left corner."},{"name":"top-right","docs":"Slot for components positioned in the top-right corner."},{"name":"bottom-left","docs":"Slot for components positioned in the bottom-left corner."},{"name":"bottom-right","docs":"Slot for components positioned in the bottom-right corner."},{"name":"top-start","docs":"Slot for components positioned at the top-start (top-left in LTR, top-right in RTL)."},{"name":"top-end","docs":"Slot for components positioned at the top-end (top-right in LTR, top-left in RTL)."},{"name":"bottom-start","docs":"Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL)."},{"name":"bottom-end","docs":"Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."},{"name":"popup","docs":"Slot for the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot."}],"parts":[],"listeners":[]},{"filePath":"src/components/measurement/measurement.tsx","tag":"arcgis-measurement","overview":"","readme":"","usage":{},"docs":"The Measurement component groups and manages multiple measurement tools and allows you to easily switch between them using\nthe [activeTool](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-measurement/#activeTool) property. The tools correspond to the measurement components for area and distance in 2D\n[arcgis-area-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/), [arcgis-distance-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/) and in 3D\n[arcgis-area-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/), [arcgis-direct-line-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/).\n\nThis component follows a composite pattern that allows developers to configure the UI to best match their specific requirements.\nThe measurement tools, placements, and icons can all be configured, which offers great flexibility to use with tabbed\ninterfaces or other customized UI.\n\nHow distances, areas, and perimeters are computed depends on the view type and its spatial reference.\n\nIn 2D Maps:\n- In geographic coordinate systems (GCS) and in Web Mercator, they are computed geodetically.\n- In projected coordinate systems (PCS), apart from Web Mercator, they are computed\n in a Euclidean manner (in their respective PCS).\n\nIn 3D Scenes:\n- In geographic coordinate systems (GCS) and in Web Mercator:\n - horizontal distance is computed geodetically;\n - vertical distance is computed as a difference in z-values;\n - direct distance is computed in a Euclidean manner;\n - area and perimeter are computed:\n - in a Euclidean manner if the perimeter is below 100km;\n - geodetically if the perimeter is above 100km.\n- In projected coordinate systems (PCS), apart from Web Mercator:\n - all three distances (direct, horizontal, and vertical), areas, and perimeters are computed in a Euclidean manner (in their respective PCS).","docsTags":[{"name":"internal"},{"name":"since","text":"5.0"},{"name":"example","text":"```html\n\n \n\n\n```"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"activeTool","type":"MeasurementComponentType | null | undefined","complexType":{"original":"MeasurementComponentType | null | undefined","resolved":"MeasurementComponentType | null | undefined","references":{"MeasurementComponentType":{"location":"import","path":"@arcgis/core/widgets/Measurement/types.js","id":"notImplemented"}}},"mutable":true,"attr":"active-tool","reflectToAttr":false,"docs":"Specifies the current measurement tool to display. Setting its value to `area` activates\nthe area measurement tool and it works in both [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) and [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). To measure distance in an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/),\nset the property to `distance` and in an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) set it to `direct-line`.\nIf this property is not set, the component will not be displayed.","docsTags":[{"name":"example","text":"```js\n// To use the Measurement component with SceneView's direct-line tool active.\nconst measurementElement = document.querySelector(\"arcgis-measurement\");\nmeasurementElement.activeTool = \"direct-line\";\n\n// To switch between direct line and area measurement tools\nfunction switchTool() {\n const tool = measurementElement.activeTool === \"direct-line\" ? \"area\" : \"direct-line\";\n measurementElement.activeTool = tool;\n}\n```"}],"values":[{"type":"string","value":"area"},{"type":"string","value":"distance"},{"type":"string","value":"direct-line"}],"optional":true,"required":false},{"name":"activeWidget","type":"MeasurementWidget | null | undefined","complexType":{"original":"MeasurementWidget | null | undefined","resolved":"MeasurementWidget | null | undefined","references":{"MeasurementWidget":{"location":"import","path":"@arcgis/core/widgets/Measurement.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The measurement component that is currently being used. Use this property to\nget access to the active component.","docsTags":[{"name":"example","text":"```js\n// Print the active widget to the console.\nconst measurementElement = document.querySelector(\"arcgis-measurement\");\nmeasurementElement.activeTool = \"distance\";\nconsole.log(\"Active Widget: \", measurementElement.activeWidget);\n```"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"areaUnit","type":"SystemOrAreaUnit","complexType":{"original":"SystemOrAreaUnit","resolved":"SystemOrAreaUnit","references":{"SystemOrAreaUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"area-unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the area values.","docsTags":[{"name":"example","text":"```js\n// To use the Measurement component to display area in square US feet\nconst measurementElement = document.querySelector(\"arcgis-measurement\");\nmeasurementElement.activeTool = \"area\";\nmeasurementElement.areaUnit = \"square-us-feet\";\n\n// To display the current area measurement unit\nconsole.log(\"Current unit: \", measurement.areaUnit);\n```"}],"values":[{"type":"string","value":"metric"},{"type":"string","value":"imperial"},{"type":"string","value":"square-inches"},{"type":"string","value":"square-feet"},{"type":"string","value":"square-yards"},{"type":"string","value":"square-miles"},{"type":"string","value":"square-nautical-miles"},{"type":"string","value":"square-us-feet"},{"type":"string","value":"square-millimeters"},{"type":"string","value":"square-centimeters"},{"type":"string","value":"square-decimeters"},{"type":"string","value":"square-meters"},{"type":"string","value":"square-kilometers"},{"type":"string","value":"acres"},{"type":"string","value":"ares"},{"type":"string","value":"hectares"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-measurement/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"measure\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"linearUnit","type":"SystemOrLengthUnit","complexType":{"original":"SystemOrLengthUnit","resolved":"SystemOrLengthUnit","references":{"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"linear-unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the distance values.","docsTags":[{"name":"example","text":"```js\n// To use the Measurement component to display distance in yards\nconst measurementElement = document.querySelector(\"arcgis-measurement\");\nmeasurementElement.activeTool = \"distance\";\nmeasurementElement.linearUnit = \"yards\";\n\n// To display the current linear measurement unit\nconsole.log(\"Current linear unit: \", measurementElement.linearUnit);\n```"}],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"metric"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"},{"type":"string","value":"imperial"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"MeasurementState","complexType":{"original":"MeasurementState","resolved":"MeasurementState","references":{"MeasurementState":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"example","text":"```js\n// To display the state of the AreaMeasurement2D component\nconst measurementElement = document.querySelector(\"arcgis-measurement\");\nmeasurementElement.activeTool = \"area\";\n\nmeasurementElement.addEventListener(\"arcgisPropertyChange\", () => {\n console.log(\"Current state: \", measurementElement.viewModel.state);\n});\n```"},{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"measured"},{"type":"string","value":"measuring"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-measurement component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Removes all measurement widgets and associated graphics.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisMeasurement = document.createElement(\"arcgis-measurement\");\ndocument.body.append(arcgisMeasurement);\nawait arcgisMeasurement.componentOnReady();\nconsole.log(\"arcgis-measurement is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"startMeasurement","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"startMeasurement(): Promise","parameters":[],"docs":"Starts a new measurement for the active measurement widget.","docsTags":[{"name":"example","text":"```js\nconst measurementElement = document.querySelector(\"arcgis-measurement\");\nmeasurementElement.activeTool = \"distance\";\n\nfunction measure() {\n measurementElement.startMeasurement();\n}\n\nmeasure();\n```"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"activeTool\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"activeTool\" | \"state\"; }","resolved":"{ name: \"activeTool\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/navigation-toggle/navigation-toggle.tsx","tag":"arcgis-navigation-toggle","overview":"","readme":"","usage":{},"docs":"The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\n**Known limitations**\n\nNavigation Toggle is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n @since 4.28","docsTags":[{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-navigation-toggle/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layout","type":"\"horizontal\" | \"vertical\"","complexType":{"original":"\"horizontal\" | \"vertical\"","resolved":"\"horizontal\" | \"vertical\"","references":{}},"mutable":true,"attr":"layout","reflectToAttr":true,"docs":"The layout direction of the component.","docsTags":[],"default":"\"vertical\"","values":[{"type":"string","value":"horizontal"},{"type":"string","value":"vertical"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"navigationMode","type":"\"pan\" | \"rotate\"","complexType":{"original":"\"pan\" | \"rotate\"","resolved":"\"pan\" | \"rotate\"","references":{}},"mutable":true,"attr":"navigation-mode","reflectToAttr":true,"docs":"The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.","docsTags":[],"default":"\"pan\"","values":[{"type":"string","value":"pan"},{"type":"string","value":"rotate"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"NavigationToggleState","complexType":{"original":"NavigationToggleState","resolved":"NavigationToggleState","references":{"NavigationToggleState":{"location":"local","path":"components/arcgis-navigation-toggle/types","id":"notImplemented"}}},"mutable":true,"attr":"state","reflectToAttr":true,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-navigation-toggle component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Specifies the size of the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisNavigationToggle = document.createElement(\"arcgis-navigation-toggle\");\ndocument.body.append(arcgisNavigationToggle);\nawait arcgisNavigationToggle.componentOnReady();\nconsole.log(\"arcgis-navigation-toggle is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"toggle","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"toggle(): Promise","parameters":[],"docs":"","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"layout\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"layout\" | \"state\"; }","resolved":"{ name: \"layout\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/oriented-imagery-viewer/oriented-imagery-viewer.tsx","tag":"arcgis-oriented-imagery-viewer","overview":"","readme":"","usage":{},"docs":"The Oriented Imagery Viewer component allows the user to explore and use their oriented images.","docsTags":[{"name":"since","text":"4.31"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"currentCoverageVisible","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"current-coverage-visible","reflectToAttr":false,"docs":"Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer.\nCurrent footprint coverage allows you to better understand how the images in the oriented imagery layer relate to the map.\nThe footprint of the image is symbolized with red fill on the map. If you zoom or pan in the oriented imagery viewer,\nthe footprint coverage graphic will update on the map to highlight the area on the map that is visible in the image.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"dataCaptureEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"data-capture-enabled","reflectToAttr":false,"docs":"Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization.\nWhen set to `true` , the data capture (edit) option will be visible on the digitizable overlayed feature layers available in the image overlays tab.\nOn clicking the data capture option, the digitization tools will appear at the bottom of the viewer once the overlay tab is closed.","docsTags":[{"name":"since","text":"4.32"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When `false`, the view click interaction is enabled for the oriented imagery viewer component. This allows users to pick a location on the map and display the best image to the viewer.\nWhen `true` the view click interaction will be defaulted to map navigation.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"galleryOpened","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"gallery-opened","reflectToAttr":false,"docs":"Indicates if the image gallery functionality is available in the component.\nTo visualize additional images of the same location, select the image gallery from the oriented imagery viewer.\nThe galley is a carousel of low-resolution thumbnails of all images that depict the selected map location. Click a thumbnail to view the full-resolution image in the oriented imagery viewer.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-header","reflectToAttr":false,"docs":"Indicates whether to display the header of the widget.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMenu","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-menu","reflectToAttr":false,"docs":"Indicates whether to display the action bar of the widget.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"oriented-imagery-widget\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"imageEnhancementToolActive","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"image-enhancement-tool-active","reflectToAttr":false,"docs":"Indicates if the image enhancement tool is active. When `true` the component displays the functionalities to adjust the brightness, contrast, and sharpness of the\nimage in the oriented imagery viewer using interactive sliders.\nSettings will be preserved for subsequent images loaded in the oriented imagery viewer.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"imageGalleryEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"When `true`, the image gallery functionality is available in the component.\nImage gallery currently only supports MRF and Tif image formats.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"imageOverlaysOpened","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"image-overlays-opened","reflectToAttr":false,"docs":"Indicates whether the image overlays tab in the oriented imagery viewer is open.\nWhen set to `true` , the overlays tab appears at the bottom of the viewer. It includes two toggle options: overlay camera locations and overlay map features.\nThese options enable users to visualize and overlay map features that intersect with the image’s footprint within the viewer.","docsTags":[{"name":"since","text":"4.32"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"isAdditionalCoverageVisible","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"is-additional-coverage-visible","reflectToAttr":false,"docs":"Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer.\nThe footprint graphics (appearing in blue) show the coverage footprints of all the additional images in the\nlayer that depict the location selected by the user.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"isAdditionalPointSourcesVisible","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"is-additional-point-sources-visible","reflectToAttr":false,"docs":"Indicates if the additional camera locations are visible for the selected image loaded in the viewer.\nThe point location graphics (appearing in blue) show the camera locations for additional images that depict the location the user selects.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layer","type":"OrientedImageryLayer | null | undefined","complexType":{"original":"OrientedImageryLayer | null | undefined","resolved":"OrientedImageryLayer | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/OrientedImageryLayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies the current [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OrientedImageryLayer/) to use. The layer is one the component connects to and utilizes to populate the image.\nThe layer contains the feature data and oriented imagery properties required by the viewer to load the image and generate the associated graphics.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"mapImageConversionToolState","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"map-image-conversion-tool-state","reflectToAttr":false,"docs":"Indicates if the map-image location tool is available in the component.\nWhen `true`, the user can select a point on the map and the corresponding location in pixel space will be displayed in the image, and vice versa.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"mapLayerId","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"map-layer-id","reflectToAttr":false,"docs":"The layer ID of a Oriented Imagery Layer in the associated map.\nWhen set, the component will attempt to find and use the layer with the provided ID from the map.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.","docsTags":[{"name":"since","text":"5.1"},{"name":"example","text":"```html\n\n \n\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"navigationToolActive","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"navigation-tool-active","reflectToAttr":false,"docs":"When `true`, the navigation tool is available in the component.\nThe navigation tool can be used to explore the images that contain the selected location on the map using a compass.\nTo view a different image of the selected map location, click the camera locations (blue dots), or click a segment to view\nthe best image from that segment (segments with images are shown in white; segments without images are gray).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"orientedImageryLayerItemId","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"oriented-imagery-layer-item-id","reflectToAttr":false,"docs":"The portal item ID of an Oriented Imagery Layer to load and use in the component.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"preloadMedia","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"preload-media","reflectToAttr":false,"docs":"When true, loading an image via directional or sequential navigation caches all neighboring images associated with that image.\nNavigating to adjacent images then uses the cached assets, reducing load times and improving viewer performance.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"referencePoint","type":"Point | null","complexType":{"original":"Point | null","resolved":"Point | null","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property provides the location of an image pixel in Map coordinates when using map-image conversion tool.","docsTags":[{"name":"since","text":"4.29"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-oriented-imagery-viewer component will be associated with a map or scene component rather than using the `view` property.","docsTags":[{"name":"since","text":"4.30"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisOrientedImageryViewer = document.createElement(\"arcgis-oriented-imagery-viewer\");\ndocument.body.append(arcgisOrientedImageryViewer);\nawait arcgisOrientedImageryViewer.componentOnReady();\nconsole.log(\"arcgis-oriented-imagery-viewer is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"loadBestImage","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(mapPoint: Point, options?: AbortOptions): Promise","parameters":[{"name":"mapPoint","type":"Point","docs":"The [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) object representing the location on the map for which to load the best image."},{"name":"options","type":"AbortOptions","docs":"Optional parameters for aborting the image loading process. This can be used to cancel the operation if it takes too long or if the user navigates away from the location before the image is loaded."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"},"AbortOptions":{"location":"local","path":"utils/async-utils","id":"notImplemented"}}},"signature":"loadBestImage(mapPoint: Point, options?: AbortOptions): Promise","parameters":[{"name":"mapPoint","type":"Point","docs":"The [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) object representing the location on the map for which to load the best image."},{"name":"options","type":"AbortOptions","docs":"Optional parameters for aborting the image loading process. This can be used to cancel the operation if it takes too long or if the user navigates away from the location before the image is loaded."}],"docs":"Loads the best available image for a given map point and displays it in the viewer. The method takes a `Point` object as an argument, which represents the location on the map for which the best image should be loaded. The viewer will analyze the available images for that location and select the one that best matches the given location.","docsTags":[{"name":"since","text":"5.1"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"imageGalleryEnabled\" | \"layer\"; }","bubbles":true,"complexType":{"original":"{ name: \"imageGalleryEnabled\" | \"layer\"; }","resolved":"{ name: \"imageGalleryEnabled\" | \"layer\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/oriented-imagery-viewer-image-viewer/oriented-imagery-viewer-image-viewer.tsx","tag":"arcgis-oriented-imagery-viewer-image-viewer","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"hideHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-header","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLoader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-loader","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideZoomControls","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-zoom-controls","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"media","type":"NonPanoramicMedia | NonPanoramicMediaProperties | undefined","complexType":{"original":"NonPanoramicMedia | NonPanoramicMediaProperties | undefined","resolved":"NonPanoramicMedia | NonPanoramicMediaProperties | undefined","references":{"default":{"location":"local","path":"components/arcgis-oriented-imagery-viewer-image-viewer/support/NonPanoramicMedia","id":"notImplemented"},"NonPanoramicMediaProperties":{"location":"local","path":"components/arcgis-oriented-imagery-viewer-image-viewer/support/NonPanoramicMedia","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"rotation","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"rotation","reflectToAttr":false,"docs":"","docsTags":[],"default":"0","values":[{"type":"number"}],"optional":true,"required":false}],"methods":[{"name":"addGraphic","returns":{"type":"void","docs":""},"complexType":{"signature":"(graphic: Graphic): void","parameters":[{"name":"graphic","type":"Graphic","docs":""}],"return":"void","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"signature":"addGraphic(graphic: Graphic): void","parameters":[{"name":"graphic","type":"Graphic","docs":""}],"docs":"","docsTags":[]},{"name":"addGraphics","returns":{"type":"void","docs":""},"complexType":{"signature":"(graphics: Graphic[]): void","parameters":[{"name":"graphics","type":"Graphic[]","docs":""}],"return":"void","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"signature":"addGraphics(graphics: Graphic[]): void","parameters":[{"name":"graphics","type":"Graphic[]","docs":""}],"docs":"","docsTags":[]},{"name":"clearGraphics","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"clearGraphics(): void","parameters":[],"docs":"","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisOrientedImageryViewerImageViewer = document.createElement(\"arcgis-oriented-imagery-viewer-image-viewer\");\ndocument.body.append(arcgisOrientedImageryViewerImageViewer);\nawait arcgisOrientedImageryViewerImageViewer.componentOnReady();\nconsole.log(\"arcgis-oriented-imagery-viewer-image-viewer is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"mediaOnLoad","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"local","path":"components/arcgis-oriented-imagery-viewer-image-viewer/support/NonPanoramicMedia","id":"notImplemented"}}},"signature":"mediaOnLoad(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"removeGraphic","returns":{"type":"void","docs":""},"complexType":{"signature":"(graphic: Graphic): void","parameters":[{"name":"graphic","type":"Graphic","docs":""}],"return":"void","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"signature":"removeGraphic(graphic: Graphic): void","parameters":[{"name":"graphic","type":"Graphic","docs":""}],"docs":"","docsTags":[]},{"name":"removeGraphics","returns":{"type":"void","docs":""},"complexType":{"signature":"(graphics: Graphic[]): void","parameters":[{"name":"graphics","type":"Graphic[]","docs":""}],"return":"void","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"signature":"removeGraphics(graphics: Graphic[]): void","parameters":[{"name":"graphics","type":"Graphic[]","docs":""}],"docs":"","docsTags":[]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/paste/paste.tsx","tag":"arcgis-paste","overview":"","readme":"","usage":{},"docs":"The Paste component provides a UX for working with a Clipboard and\ncopy and pasting features and/or geometries.","docsTags":[{"name":"since","text":"5.0"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"activeFlowPage","type":"ActiveFlowPage","complexType":{"original":"ActiveFlowPage","resolved":"ActiveFlowPage","references":{"ActiveFlowPage":{"location":"local","path":"components/arcgis-paste/PasteViewModel","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The active flow page.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"clipboard"},{"type":"string","value":"clipboard-empty-page"},{"type":"string","value":"commands-page"},{"type":"string","value":"form-page"},{"type":"string","value":"gallery-page"},{"type":"string","value":"merge-page"},{"type":"string","value":"no-command-page"}],"optional":true,"required":false},{"name":"alwaysShowFeatureForm","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"always-show-feature-form","reflectToAttr":false,"docs":"Determines if the attributes panel should be shown for newly created paste features. If not set\nthe panel will only be shown if there are mandatory fields that have not been provided.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-paste/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"beforeApply","type":"(() => Promise) | undefined","complexType":{"original":"(() => Promise) | undefined","resolved":"(() => Promise) | undefined","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Called before the the paste is applied.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"clipboard","type":"EsriClipboard","complexType":{"original":"EsriClipboard","resolved":"EsriClipboard","references":{"EsriClipboard":{"location":"import","path":"@arcgis/core/applications/Components/clipboard.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Access the application clipboard","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"closed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closed","reflectToAttr":true,"docs":"Indicates whether a component is closed. When true, the component will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"closeOnApply","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"close-on-apply","reflectToAttr":false,"docs":"Determines if the panel will automatically close after it has applied a Paste.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disableTemplatesMode","type":"\"scale\" | \"never\" | \"visible\"","complexType":{"original":"\"scale\" | \"never\" | \"visible\"","resolved":"\"scale\" | \"never\" | \"visible\"","references":{}},"mutable":true,"attr":"disable-templates-mode","reflectToAttr":false,"docs":"Decide if templates should be disabled when the layer is not visible, or not visible at the current scale.","docsTags":[],"default":"\"never\"","values":[{"type":"string","value":"scale"},{"type":"string","value":"never"},{"type":"string","value":"visible"}],"optional":true,"required":false},{"name":"hideErrorNotice","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-error-notice","reflectToAttr":false,"docs":"Determines if the component should show error notices","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFooter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-footer","reflectToAttr":false,"docs":"Determines if the footer should be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFooterCancelButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-footer-cancel-button","reflectToAttr":false,"docs":"Determines if the attributes panel should have a Cancel button in the Footer, or rely on the close header action","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeaderCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-header-close-button","reflectToAttr":false,"docs":"Determines if the component should have a close button. A close button can be added by using the header-actions-end slot.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTooltips","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-tooltips","reflectToAttr":false,"docs":"Indicates whether to display the tooltip for clipboard and other actions.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideViewClipboard","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-view-clipboard","reflectToAttr":false,"docs":"Determines if the view clipboard action is available","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlightGroup","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"highlight-group","reflectToAttr":false,"docs":"The highlight group to use when highlighting features when they are being created.","docsTags":[],"default":"\"temporary\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"layerPermissionsCheck","type":"{\n canUpdate: (layer: FeatureLayer | SubtypeGroupLayer) => boolean;\n canCreate: (layer: FeatureLayer | SubtypeGroupLayer) => boolean;\n}","complexType":{"original":"{\n canUpdate: (layer: FeatureLayer | SubtypeGroupLayer) => boolean;\n canCreate: (layer: FeatureLayer | SubtypeGroupLayer) => boolean;\n}","resolved":"{\n canUpdate: (layer: FeatureLayer | SubtypeGroupLayer) => boolean;\n canCreate: (layer: FeatureLayer | SubtypeGroupLayer) => boolean;\n}","references":{"default":{"location":"import","path":"@arcgis/core/layers/SubtypeGroupLayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Override how the paste component determines if a layer can be edited.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"maximumFeatureCount","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"maximum-feature-count","reflectToAttr":false,"docs":"The maximum number of features that created by a paste operation.","docsTags":[{"name":"name","text":"maximumFeatureCount"}],"default":"2000","values":[{"type":"number"}],"optional":true,"required":false},{"name":"maximumFeatureCountWithComplexForms","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"maximum-feature-count-with-complex-forms","reflectToAttr":false,"docs":"The maximum number of features that can created by a paste operation,\nwhen there are complex Arcade expressions that must be executed.","docsTags":[{"name":"name","text":"maximumFeatureCountWithComplexForms"}],"default":"50","values":[{"type":"number"}],"optional":true,"required":false},{"name":"pasteCommandsState","type":"Array<{\n id: SupportedPasteCommand;\n disabled: boolean;\n available: boolean;\n}>","complexType":{"original":"Array<{\n id: SupportedPasteCommand;\n disabled: boolean;\n available: boolean;\n}>","resolved":"Array<{\n id: SupportedPasteCommand;\n disabled: boolean;\n available: boolean;\n}>","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SupportedPasteCommand":{"location":"local","path":"components/arcgis-paste/PasteViewModel","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of paste commands and whether they are available to be used.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"pasteWithMultipleFeaturesEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"paste-with-multiple-features-enabled","reflectToAttr":false,"docs":"Determines whether pasting multiple features is supported","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"pasteWithMultipleLayersEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"paste-with-multiple-layers-enabled","reflectToAttr":false,"docs":"Determines whether pasting new features into multiple layers is allowed","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedFeature","type":"Graphic | undefined","complexType":{"original":"Graphic | undefined","resolved":"Graphic | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Certain paste operations require a selected feature. If a feature is not provided, the operation will be disabled.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"supportedCommands","type":"SupportedPasteCommand | SupportedPasteCommand[]","complexType":{"original":"SupportedPasteCommand | SupportedPasteCommand[]","resolved":"SupportedPasteCommand | SupportedPasteCommand[]","references":{"SupportedPasteCommand":{"location":"local","path":"components/arcgis-paste/PasteViewModel","id":"notImplemented"}}},"mutable":true,"attr":"supported-commands","reflectToAttr":false,"docs":"The list of supported paste operations. New types of operations can be registered using the 'registerPasteOperation'","docsTags":[],"values":[{"type":"string","value":"paste"},{"type":"string","value":"paste-append"},{"type":"string","value":"paste-as"},{"type":"string","value":"paste-merge"},{"type":"string","value":"paste-subtract"},{"type":"object"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-paste component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"cancelMoveClipboard","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"cancelMoveClipboard(): Promise","parameters":[],"docs":"Cancels any running Clipboard Move Interaction","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisPaste = document.createElement(\"arcgis-paste\");\ndocument.body.append(arcgisPaste);\nawait arcgisPaste.componentOnReady();\nconsole.log(\"arcgis-paste is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component","docsTags":[]},{"name":"executePasteCommand","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(id: SupportedPasteCommand, options?: {\n silent?: boolean;\n showFeatureForm?: boolean;\n}): Promise","parameters":[{"name":"id","type":"SupportedPasteCommand","docs":""},{"name":"options","type":"{\n silent?: boolean;\n showFeatureForm?: boolean;\n}","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"PasteExecuteResult":{"location":"local","path":"components/arcgis-paste/commands/PasteCommand","id":"notImplemented"},"SupportedPasteCommand":{"location":"local","path":"components/arcgis-paste/PasteViewModel","id":"notImplemented"}}},"signature":"executePasteCommand(id: SupportedPasteCommand, options?: {\n silent?: boolean;\n showFeatureForm?: boolean;\n}): Promise","parameters":[{"name":"id","type":"SupportedPasteCommand","docs":""},{"name":"options","type":"{\n silent?: boolean;\n showFeatureForm?: boolean;\n}","docs":""}],"docs":"Execute a paste command without opening the panel.\n\nparam id - The paste commands identifier\nparam options.silent - Determines if the command is being run without UX, or if it is running with the panel open","docsTags":[]},{"name":"registerPasteCommand","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(pasteCommand: CustomPasteCommand): Promise","parameters":[{"name":"pasteCommand","type":"CustomPasteCommand","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"CustomPasteCommand":{"location":"local","path":"components/arcgis-paste/commands/PasteCustomCommand","id":"notImplemented"}}},"signature":"registerPasteCommand(pasteCommand: CustomPasteCommand): Promise","parameters":[{"name":"pasteCommand","type":"CustomPasteCommand","docs":""}],"docs":"Registers a custom Paste Command","docsTags":[]},{"name":"reset","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"reset(): Promise","parameters":[],"docs":"Resets the Paste panel to its home page","docsTags":[]},{"name":"showClipboardItems","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(visible: boolean): Promise","parameters":[{"name":"visible","type":"boolean","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"showClipboardItems(visible: boolean): Promise","parameters":[{"name":"visible","type":"boolean","docs":""}],"docs":"Method to show the clipboard items on the map","docsTags":[]},{"name":"startMoveClipboard","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(continuous: boolean): Promise","parameters":[{"name":"continuous","type":"boolean","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"startMoveClipboard(continuous: boolean): Promise","parameters":[{"name":"continuous","type":"boolean","docs":""}],"docs":"Start an interactive clipboard move operation","docsTags":[]},{"name":"writeChanges","returns":{"type":"Promise<(ApplySetLayerEditResult | ApplySetServiceEditResult)[]>","docs":""},"complexType":{"signature":"(applySet: ApplySet): Promise<(ApplySetLayerEditResult | ApplySetServiceEditResult)[]>","parameters":[{"name":"applySet","type":"ApplySet","docs":""}],"return":"Promise<(ApplySetLayerEditResult | ApplySetServiceEditResult)[]>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ApplySetLayerEditResult":{"location":"import","path":"@arcgis/core/applications/Components/applySetUtils.js","id":"notImplemented"},"ApplySetServiceEditResult":{"location":"import","path":"@arcgis/core/applications/Components/applySetUtils.js","id":"notImplemented"},"ApplySet":{"location":"import","path":"@arcgis/core/applications/Components/applySetUtils.js","id":"notImplemented"}}},"signature":"writeChanges(applySet: ApplySet): Promise<(ApplySetLayerEditResult | ApplySetServiceEditResult)[]>","parameters":[{"name":"applySet","type":"ApplySet","docs":""}],"docs":"Method to write the paste edits to the geodatabase(s).","docsTags":[]}],"events":[{"event":"arcgisApplyPasteCommand","detail":"{\n command: SupportedPasteCommand;\n completionCallback?: Promise<{\n success: boolean;\n errorCode?: string;\n errorMessage?: string;\n }> | Promise;\n applySet?: ApplySet;\n}","bubbles":true,"complexType":{"original":"{\n command: SupportedPasteCommand;\n completionCallback?: Promise<{\n success: boolean;\n errorCode?: string;\n errorMessage?: string;\n }> | Promise;\n applySet?: ApplySet;\n}","resolved":"{\n command: SupportedPasteCommand;\n completionCallback?: Promise<{\n success: boolean;\n errorCode?: string;\n errorMessage?: string;\n }> | Promise;\n applySet?: ApplySet;\n}","references":{"SupportedPasteCommand":{"location":"local","path":"components/arcgis-paste/PasteViewModel","id":"notImplemented"},"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ApplySet":{"location":"import","path":"@arcgis/core/applications/Components/applySetUtils.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"The user has initiated a paste command.","docsTags":[]},{"event":"arcgisApplyPasteError","detail":"{\n command: SupportedPasteCommand;\n errorMessage: string;\n errorCode: string;\n}","bubbles":true,"complexType":{"original":"{\n command: SupportedPasteCommand;\n errorMessage: string;\n errorCode: string;\n}","resolved":"{\n command: SupportedPasteCommand;\n errorMessage: string;\n errorCode: string;\n}","references":{"SupportedPasteCommand":{"location":"local","path":"components/arcgis-paste/PasteViewModel","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"An error occurred performing a paste command","docsTags":[]},{"event":"arcgisBeforeClipboardMove","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"The clipboard move interactive operation is about to start","docsTags":[]},{"event":"arcgisClipboardMoveStateChanged","detail":"{ change: ClipboardStageChangedReason; }","bubbles":true,"complexType":{"original":"{ change: ClipboardStageChangedReason; }","resolved":"{ change: ClipboardStageChangedReason; }","references":{"ClipboardStageChangedReason":{"location":"local","path":"components/arcgis-paste/ClipboardMove","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"The clipboard move interactive operation has changed state.","docsTags":[]},{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[{"name":"since","text":"5.0"}]},{"event":"arcgisPropertyChange","detail":"{ name: \"pasteCommandsState\" | \"activeFlowPage\"; }","bubbles":true,"complexType":{"original":"{ name: \"pasteCommandsState\" | \"activeFlowPage\"; }","resolved":"{ name: \"pasteCommandsState\" | \"activeFlowPage\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[{"name":"--arcgis-paste-height","annotation":"prop","docs":"Specifies the height of the component."},{"name":"--arcgis-paste-width","annotation":"prop","docs":"Specifies the width of the component."},{"name":"--arcgis-paste-blocks-padding","annotation":"prop","docs":"Specifies the padding for elements within the component."}],"slots":[{"name":"home-header-actions-start","docs":"Slot for adding actions to the start of the header on the entry page."},{"name":"header-actions-end","docs":"Slot for adding actions to the end of the header."},{"name":"gallery-page-message","docs":"Slot for adding content to the template gallery page."},{"name":"commands-page-message","docs":"Slot for adding content to commands page."}],"parts":[],"listeners":[]},{"filePath":"src/components/paste/components/clipboard/clipboard.tsx","tag":"arcgis-clipboard","overview":"","readme":"","usage":{},"docs":"The Feature Clipboard displays the current contents of the clipboard.","docsTags":[{"name":"since","text":"5.0"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"clipboard","type":"EsriClipboard","complexType":{"original":"EsriClipboard","resolved":"EsriClipboard","references":{"EsriClipboard":{"location":"import","path":"@arcgis/core/applications/Components/clipboard.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Access the application clipboard","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"hideTooltips","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-tooltips","reflectToAttr":false,"docs":"Indicates whether to display tooltips on clipboard items.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"maxShowCount","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-show-count","reflectToAttr":false,"docs":"","docsTags":[],"default":"100","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-clipboard component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisClipboard = document.createElement(\"arcgis-clipboard\");\ndocument.body.append(arcgisClipboard);\nawait arcgisClipboard.componentOnReady();\nconsole.log(\"arcgis-clipboard is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/paste/components/feature-image/feature-image.tsx","tag":"arcgis-feature-image","overview":"","readme":"","usage":{},"docs":"The Feature Image component generates a feature swatch representing a\nFeature.\nThe component can be configured to only generate a swatch, when the element\nis within the visible scope of the page.","docsTags":[{"name":"since","text":"5.0"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"actualSymbol","type":"SymbolUnion | undefined","complexType":{"original":"SymbolUnion | undefined","resolved":"SymbolUnion | undefined","references":{"SymbolUnion":{"location":"import","path":"@arcgis/core/symbols/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a symbol. In this mode, the swatch will simply be this symbols preview.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"graphic","type":"Graphic | {\n geometry?: GeometryUnion;\n attributes: Record;\n layer: FeatureLayer;\n} | undefined","complexType":{"original":"Graphic | {\n geometry?: GeometryUnion;\n attributes: Record;\n layer: FeatureLayer;\n} | undefined","resolved":"Graphic | {\n geometry?: GeometryUnion;\n attributes: Record;\n layer: FeatureLayer;\n} | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/FeatureLayer.js","id":"notImplemented"},"GeometryUnion":{"location":"import","path":"@arcgis/core/geometry/types.js","id":"notImplemented"},"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The graphic to generate the swatch for.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"heightInPixels","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"height-in-pixels","reflectToAttr":false,"docs":"The generated thumbnail height","docsTags":[],"default":"16","values":[{"type":"number"}],"optional":true,"required":false},{"name":"layer","type":"FeatureLayer | SubtypeGroupLayer | SubtypeSublayer | undefined","complexType":{"original":"FeatureLayer | SubtypeGroupLayer | SubtypeSublayer | undefined","resolved":"FeatureLayer | SubtypeGroupLayer | SubtypeSublayer | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/support/SubtypeSublayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The layer to which the graphic belongs. This will be used to get the symbol for the feature (using the layer's renderer)","docsTags":[],"values":[],"optional":true,"required":false},{"name":"minWidth","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"min-width","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"tableSymbolIcon","type":"SymbolUnion | undefined","complexType":{"original":"SymbolUnion | undefined","resolved":"SymbolUnion | undefined","references":{"SymbolUnion":{"location":"import","path":"@arcgis/core/symbols/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Symbol to use, if the layer is a Table","docsTags":[],"values":[],"optional":true,"required":false},{"name":"useTrueShape","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"use-true-shape","reflectToAttr":false,"docs":"Specifies whether to use the shape of the feature. If set to false, then a simple symbol swatch will be used.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"widthInPixels","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"width-in-pixels","reflectToAttr":false,"docs":"The generated thumbnail width","docsTags":[],"default":"16","values":[{"type":"number"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeatureImage = document.createElement(\"arcgis-feature-image\");\ndocument.body.append(arcgisFeatureImage);\nawait arcgisFeatureImage.componentOnReady();\nconsole.log(\"arcgis-feature-image is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/paste/components/feature-title/feature-title.tsx","tag":"arcgis-feature-title","overview":"","readme":"","usage":{},"docs":"The Feature Title component generates a feature title for a graphic\nThe component can be configured to only generate a title, when the element\nis within the visible scope of the page.","docsTags":[{"name":"since","text":"5.0"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"graphic","type":"Graphic | undefined","complexType":{"original":"Graphic | undefined","resolved":"Graphic | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The graphic to generate the swatch for.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"isNewFeature","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"is-new-feature","reflectToAttr":false,"docs":"Flag to indicate that the graphic is a new feature and may not have an OID field","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"layer","type":"FeatureLayer | SubtypeGroupLayer | SubtypeSublayer | undefined","complexType":{"original":"FeatureLayer | SubtypeGroupLayer | SubtypeSublayer | undefined","resolved":"FeatureLayer | SubtypeGroupLayer | SubtypeSublayer | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/support/SubtypeSublayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The layer to which the graphic belongs. This will be used to get the title for the layer","docsTags":[],"values":[],"optional":true,"required":false},{"name":"noTitleLabel","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"no-title-label","reflectToAttr":false,"docs":"Label to show if the feature does not have a","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisFeatureTitle = document.createElement(\"arcgis-feature-title\");\ndocument.body.append(arcgisFeatureTitle);\nawait arcgisFeatureTitle.componentOnReady();\nconsole.log(\"arcgis-feature-title is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/paste/components/multi-feature-form/multi-feature-form.tsx","tag":"arcgis-multi-feature-form","overview":"","readme":"","usage":{},"docs":"The Multi Feature Form component provides a Feature Form which works with\nlayer FeatureForm templates. It allows for multiple features to be edited at once.","docsTags":[{"name":"since","text":"5.0"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"activeFeatureIndex","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"active-feature-index","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"number"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-multi-feature-form/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"editType","type":"EditType","complexType":{"original":"EditType","resolved":"EditType","references":{"EditType":{"location":"import","path":"@arcgis/core/widgets/support/forms/types.js","id":"notImplemented"}}},"mutable":true,"attr":"edit-type","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string","value":"INSERT"},{"type":"string","value":"UPDATE"},{"type":"string","value":"DELETE"},{"type":"string","value":"NA"}],"optional":true,"required":false},{"name":"features","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"groupDisplay","type":"\"all\" | \"sequential\"","complexType":{"original":"\"all\" | \"sequential\"","resolved":"\"all\" | \"sequential\"","references":{}},"mutable":true,"attr":"group-display","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string","value":"all"},{"type":"string","value":"sequential"}],"optional":true,"required":false},{"name":"hasTooManyComplexFeatures","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"has-too-many-complex-features","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hasTooManyFeatures","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"has-too-many-features","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the headings in the component.","docsTags":[],"values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"]","complexType":{"original":"Icon[\"icon\"]","resolved":"Icon[\"icon\"]","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"invalidFeatures","type":"Graphic[]","complexType":{"original":"Graphic[]","resolved":"Graphic[]","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"label","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"maximumFeatureCount","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"maximum-feature-count","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"maximumFeatureCountWithComplexForms","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"maximum-feature-count-with-complex-forms","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"position","type":"UIPosition | undefined","complexType":{"original":"UIPosition | undefined","resolved":"UIPosition | undefined","references":{"UIPosition":{"location":"import","path":"@arcgis/core/views/ui/types.js","id":"notImplemented"}}},"mutable":true,"attr":"position","reflectToAttr":false,"docs":"","docsTags":[],"deprecation":"since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.","values":[{"type":"string","value":"top-left"},{"type":"string","value":"top-right"},{"type":"string","value":"bottom-left"},{"type":"string","value":"bottom-right"},{"type":"string","value":"manual"},{"type":"string","value":"top-leading"},{"type":"string","value":"top-trailing"},{"type":"string","value":"bottom-leading"},{"type":"string","value":"bottom-trailing"}],"optional":true,"required":false},{"name":"readOnly","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"read-only","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"status","type":"BatchAttributeFormState","complexType":{"original":"BatchAttributeFormState","resolved":"BatchAttributeFormState","references":{"BatchAttributeFormState":{"location":"import","path":"@arcgis/core/widgets/BatchAttributeForm/types.js","id":"notImplemented"}}},"mutable":true,"attr":"status","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string","value":"loaded"},{"type":"string","value":"loading"},{"type":"string","value":"not-loaded"},{"type":"string","value":"failed"}],"optional":true,"required":false},{"name":"submitHasBeenAttempted","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"submit-has-been-attempted","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"timeZone","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"updating","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"updating","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"valid","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"valid","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-multi-feature-form component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisMultiFeatureForm = document.createElement(\"arcgis-multi-feature-form\");\ndocument.body.append(arcgisMultiFeatureForm);\nawait arcgisMultiFeatureForm.componentOnReady();\nconsole.log(\"arcgis-multi-feature-form is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"getValues","returns":{"type":"Record","docs":""},"complexType":{"signature":"(graphic: Graphic): Record","parameters":[{"name":"graphic","type":"Graphic","docs":""}],"return":"Record","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"signature":"getValues(graphic: Graphic): Record","parameters":[{"name":"graphic","type":"Graphic","docs":""}],"docs":"","docsTags":[]},{"name":"goToFirstError","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"goToFirstError(): void","parameters":[],"docs":"","docsTags":[]},{"name":"userChangesHaveMadeFeatureInvalid","returns":{"type":"boolean","docs":""},"complexType":{"signature":"(feature: Graphic): boolean","parameters":[{"name":"feature","type":"Graphic","docs":""}],"return":"boolean","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"signature":"userChangesHaveMadeFeatureInvalid(feature: Graphic): boolean","parameters":[{"name":"feature","type":"Graphic","docs":""}],"docs":"","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"status\" | \"valid\" | \"updating\" | \"submitHasBeenAttempted\" | \"activeFeatureIndex\"; }","bubbles":true,"complexType":{"original":"{ name: \"status\" | \"valid\" | \"updating\" | \"submitHasBeenAttempted\" | \"activeFeatureIndex\"; }","resolved":"{ name: \"status\" | \"valid\" | \"updating\" | \"submitHasBeenAttempted\" | \"activeFeatureIndex\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSubmit","detail":"SubmitEvent","bubbles":true,"complexType":{"original":"SubmitEvent","resolved":"SubmitEvent","references":{"SubmitEvent":{"location":"import","path":"@arcgis/core/widgets/FeatureForm/FeatureFormViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the [submit()](https://developers.arcgis.com/javascript/latest/references/core/widgets/BatchAttributeForm/#submit) method is called.","docsTags":[]},{"event":"arcgisValueChange","detail":"ValueChangeEvent","bubbles":true,"complexType":{"original":"ValueChangeEvent","resolved":"ValueChangeEvent","references":{"ValueChangeEvent":{"location":"import","path":"@arcgis/core/widgets/BatchAttributeForm/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a field value is updated.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/popup/popup.tsx","tag":"arcgis-popup","overview":"","readme":"","usage":{},"docs":"## Overview\nThe Popup component allows users to view content from feature attributes. Popups enhance web applications\nby providing users with a simple way to interact with and view attributes in a layer.\nThey play an important role in relaying information to the user, which improves the storytelling capabilities of the application.\n\nThe popup component can be added to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) using the `popup` slot.\nWhen added to a view component, the popup is automatically populated with content from the selected feature in the view and displays when clicking on features in the view.\nThe content of the popup is determined based on the [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) assigned to the selected feature.\n\n```html\n\n \n\n```\n\nThe Popup component can also be opened manually at a specific location using the [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open) property.\nTo prevent the popup from opening automatically when clicking on features within view components, set the `popup-disabled` attribute to `true` and add the Popup component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) using the `popup` slot.\nBefore setting the `open` property to `true`, you must set the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) property to specify where the popup should open.\n\nExample of opening the popup at a clicked location with custom content:\n\n```html\n\n\n \n \n\n\n```\n\nAlternatively, you can call the [arcgis-map.fetchPopupFeatures()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#fetchPopupFeatures) method within the view element's click event listener to open the popup with features at the clicked location.\n```html\n\n\n \n \n\n\n```\n\nThe popup component can be used with the view components by default. Set the `popup-component-enabled` attribute to `true` using [arcgis-map.popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled), [arcgis-scene.popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupComponentEnabled), or [arcgis-link-chart.popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupComponentEnabled) to open the popup component automatically when clicking on features.\n\n```html\n\n```\n> At version 6.0, the Popup component will be used by default and setting the `popup-component-enabled` attribute will no longer be necessary.\n\n## Popup UI\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) components contain a default popup.\nThis popup can display generic content, which is set in its [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading)\nand [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content) properties.\nWhen content is set directly on the Popup instance it is not tied to a specific feature or layer.\n\n![popup-basic-example](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popup-basic.avif)\n\nIn the image above, the text \"Marriage in Nassau County Census Tract 5177.01\" is the popup's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading).\nThe remaining text is the popup's [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content).\nA dock button is displayed in the top right corner of the popup allowing the user to dock the popup to one of the sides or corners of the view.\nThe options for docking may be set in the [dockOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#dockOptions) property.\nThe popup may also be collapsed by clicking the collapse button (the down arrow icon) in the top right corner of the popup.\nWhen collapsed, only the heading of the popup displays.\nThe popup may be closed by clicking the close button (the \"x\" icon) in the top right corner of the popup.\n\nPopups can also contain [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions) which execute a function defined by the developer when clicked.\nBy default, every popup has a \"Zoom to\" action (as shown in the image above with the magnifying glass) that allows users to zoom to the selected feature.\nSee the [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions) property for information about adding custom actions to a popup.\n\nThe Popup component is tied to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) component, whether it's docked or anchored to the selected feature.\nIf wanting to utilize the Popup functionality outside of [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) component can be used to display the same content\nin its own container.\n\n## Popup and PopupTemplate\n[PopupTemplates](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/)\nand [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/). Popup templates allow you to define custom titles and content templates based on the source of the\n[selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature). When a layer or a graphic has a defined\npopup template, the popup will display the content defined in the popup template when the feature is clicked.\nThe content may contain field values from the attributes of the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature).\n\nCustom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) on the\n[features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) property.","docsTags":[{"name":"since","text":"4.34"},{"name":"beta"},{"name":"see","text":"[PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"actions","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"PopupAction":{"location":"import","path":"@arcgis/core/popup/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [action button](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionButton/) or [action toggle](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionToggle/) objects. Each action may be executed by clicking the icon or image symbolizing them.\nThere is a default `Zoom To` action styled with a magnifying glass icon to zoom in four LODs and center the map on the selected feature. This default action can be removed by setting [includeDefaultActionsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#includeDefaultActionsDisabled) to `true`, or by setting the [`overwriteActions`](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\n\nThe order of each action is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/). The [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#event-arcgisTriggerAction) event fires each time an action is clicked.","docsTags":[{"name":"see","text":"[@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#event-arcgisTriggerAction)"},{"name":"see","text":"[Popup actions sample](https://developers.arcgis.com/javascript/latest/sample-code/popup-actions/)"}],"values":[],"optional":true,"required":false},{"name":"active","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates if the component is active when it is visible and is not [waiting](https://developers.arcgis.com/javascript/latest/references/core/popup/Features/#waitingForResult).","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"alignment","type":"Alignment","complexType":{"original":"Alignment","resolved":"Alignment","references":{"Alignment":{"location":"local","path":"components/arcgis-popup/types","id":"notImplemented"}}},"mutable":true,"attr":"alignment","reflectToAttr":false,"docs":"Position of the popup in relation to the selected feature. The default behavior\nis to display above the feature and adjust if not enough room. If needing\nto explicitly control where the popup displays in relation to the feature, choose\nan option besides `auto`.","docsTags":[{"name":"example","text":"```js\n// Popup will display on the bottom-right of the selected feature regardless of where that feature is located\npopupComponent.alignment = \"bottom-right\";\n```"}],"default":"\"auto\"","values":[{"type":"string","value":"top-center"},{"type":"string","value":"top-left"},{"type":"string","value":"top-right"},{"type":"string","value":"bottom-center"},{"type":"string","value":"bottom-left"},{"type":"string","value":"bottom-right"},{"type":"string","value":"top-start"},{"type":"string","value":"top-end"},{"type":"string","value":"bottom-start"},{"type":"string","value":"bottom-end"},{"type":"string","value":"auto"},{"type":"object"}],"optional":true,"required":false},{"name":"autoCloseEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-close-enabled","reflectToAttr":false,"docs":"This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/) changes.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapsed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"collapsed","reflectToAttr":false,"docs":"Indicates whether the popup displays its content. If `true`, only the header displays.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"content","type":"string | HTMLElement | null | undefined","complexType":{"original":"string | HTMLElement | null | undefined","resolved":"string | HTMLElement | null | undefined","references":{"HTMLElement":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"attr":"content","reflectToAttr":false,"docs":"The content of the component. When set directly on the component, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content).","docsTags":[{"name":"example","text":"```js\n// This sets generic instructions in the component that will always be displayed\n// unless it is overridden by a PopupTemplate.\ncomponent.content = \"Click a feature on the map to view its attributes\";\n```"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"currentDockPosition","type":"null | undefined | PopupPositionResult","complexType":{"original":"null | undefined | PopupPositionResult","resolved":"null | undefined | PopupPositionResult","references":{"PopupPositionResult":{"location":"local","path":"components/arcgis-popup/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Dock position in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"top-center"},{"type":"string","value":"top-left"},{"type":"string","value":"top-right"},{"type":"string","value":"bottom-center"},{"type":"string","value":"bottom-left"},{"type":"string","value":"bottom-right"},{"type":"string","value":"top-start"},{"type":"string","value":"top-end"},{"type":"string","value":"bottom-start"},{"type":"string","value":"bottom-end"}],"optional":true,"required":false},{"name":"defaultPopupTemplateEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"default-popup-template-enabled","reflectToAttr":false,"docs":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"dockEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"dock-enabled","reflectToAttr":false,"docs":"Indicates whether the placement of the popup is docked to the side of the view.\n\nDocking the popup allows for a better user experience, particularly when opening\npopups in apps on mobile devices. When a popup is \"dockEnabled\" it means the popup no\nlonger points to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature) or the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location)\nassigned to it. Rather it is attached to a side, the top, or the bottom of the view.\n\nSee [dockOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#dockOptions) to override default options related to docking the popup.","docsTags":[{"name":"example","text":"```html\n\n\n```"},{"name":"example","text":"```js\n// Setting this property using JS.\n// The popup will automatically be dockEnabled when made visible\npopupComponent.dockEnabled = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"dockOptions","type":"DockOptions","complexType":{"original":"DockOptions","resolved":"DockOptions","references":{"DockOptions":{"location":"local","path":"components/arcgis-popup/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Docking the popup allows for a better user experience, particularly when opening\npopups in apps on mobile devices. When a popup is \"dockEnabled\" it means the popup no\nlonger points to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature) or the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location)\nassigned to it. Rather it is placed in one of the corners of the view or to the top or bottom\nof it. This property allows the developer to set various options for docking the popup.\n\nSee the object specification table below to override default docking properties on the popup.","docsTags":[{"name":"example","text":"```js\npopupComponent.dockOptions = {\n // Disable the dock button so users cannot undock the popup\n buttonEnabled: false,\n // Dock the popup when the size of the view is less than or equal to 600x1000 pixels\n breakpoint: {\n width: 600,\n height: 1000\n }\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"effectiveHeading","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The heading currently displayed for the selected feature. This value resolves to the selected feature's [PopupTemplate title](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#title) when available, otherwise it falls back to the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading).","docsTags":[{"name":"since","text":"5.1"},{"name":"see","text":"[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading)"},{"name":"see","text":"[selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature)"},{"name":"readonly","text":""}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"featureCount","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) available in the component.","docsTags":[{"name":"readonly","text":""}],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"featureMenuOpen","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"feature-menu-open","reflectToAttr":false,"docs":"This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#initialDisplayMode) is set to \"feature\".","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"featureMenuTitle","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"feature-menu-title","reflectToAttr":false,"docs":"Sets the title to display on the component while viewing the feature menu.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"features","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of graphics associated with the component. Each graphic in this array must have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) set. They may share the same [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) or have unique [PopupTemplates](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) depending on their attributes. The [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content) and [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading) of the component is set based on the `content` and `title` properties of each graphic's respective [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\n \nWhen more than one graphic exists in this array, the current content of the component is set based on the value of the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature).\n\nThis value is `null` if no features are associated with the component.","docsTags":[{"name":"example","text":"```js\n// When setting the features property, the graphics pushed to this property\n// must have a PopupTemplate set.\nlet g1 = new Graphic();\ng1.popupTemplate = new PopupTemplate({\n title: \"Results title\",\n content: \"Results: {ATTRIBUTE_NAME}\"\n});\n// Set the graphics as an array to the popup instance. The content and title of\n// the component will be set depending on the PopupTemplate of the graphics.\n// Each graphic may share the same PopupTemplate or have a unique PopupTemplate\nlet graphics = [g1, g2, g3, g4, g5];\ncomponent.features = graphics;\n```"}],"values":[],"optional":true,"required":false},{"name":"focusTrapDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"focus-trap-disabled","reflectToAttr":false,"docs":"When `true`, this prevents the popup from trapping focus when opened.\nPreventing focus trapping can be used in scenarios where interactions are expected within the user interface, such as when the popup resides in a panel.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | null | undefined","complexType":{"original":"GoToOverride | null | undefined","resolved":"GoToOverride | null | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"heading","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"heading","reflectToAttr":false,"docs":"The title of the popup. This can be set generically on the popup no\nmatter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the\ncorresponding template is used here.","docsTags":[{"name":"see","text":"[headingLevel](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#headingLevel)"},{"name":"example","text":"```html\n\n\n```"},{"name":"example","text":"```js\n// This title will display in the popup unless a selected feature's\n// PopupTemplate overrides it\npopupComponent.heading = \"Population by zip codes in Southern California\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading) of the popup.\nBy default, the heading is rendered\nas a level 2 heading (e.g. `

Popup title

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"},{"name":"see","text":"[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading)"},{"name":"example","text":"```html\n\n\n```"}],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideActionBar","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-action-bar","reflectToAttr":false,"docs":"Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-close-button","reflectToAttr":false,"docs":"Indicates whether to hide the close button in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-collapse-button","reflectToAttr":false,"docs":"Indicates whether to hide the collapse button in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureListLayerTitle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-list-layer-title","reflectToAttr":false,"docs":"Indicates whether to hide the group heading for a list of multiple features.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureMenuHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-menu-heading","reflectToAttr":false,"docs":"Indicates whether to hide the feature menu heading and description in the component's feature menu list.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureNavigation","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-navigation","reflectToAttr":false,"docs":"Indicates whether to hide the feature navigation in the component. This allows the user to scroll through various [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) using pagination arrows.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-heading","reflectToAttr":false,"docs":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSpinner","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-spinner","reflectToAttr":false,"docs":"Indicates whether to hide the spinner in the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlightDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"highlight-disabled","reflectToAttr":false,"docs":"Indicates if the selected feature will be highlighted.\nThis is done using the [arcgis-map.highlights](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#highlights) or the [arcgis-scene.highlights](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#highlights).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"includeDefaultActionsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"include-default-actions-disabled","reflectToAttr":false,"docs":"Indicates whether to include the default actions in the component.\nIn order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"initialDisplayMode","type":"InitialDisplayOptions","complexType":{"original":"InitialDisplayOptions","resolved":"InitialDisplayOptions","references":{"InitialDisplayOptions":{"location":"import","path":"@arcgis/core/popup/types.js","id":"notImplemented"}}},"mutable":true,"attr":"initial-display-mode","reflectToAttr":false,"docs":"Indicates whether to initially display a list of features, or the content for one feature.","docsTags":[],"default":"\"feature\"","values":[{"type":"string","value":"list"},{"type":"string","value":"feature"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"location","type":"Point | null | undefined","complexType":{"original":"Point | null | undefined","resolved":"Point | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Point used to position the popup. This is automatically set when viewing the\npopup by selecting a feature. If using the Popup to display content not related\nto features in the map, such as the results from a task, then you must set this\nproperty before [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open) the popup.","docsTags":[{"name":"example","text":"```js\n// Sets the location of the popup to the center of the view\npopupComponent.location = viewElement.center;\n// Displays the popup\npopupComponent.open = true;\n```"},{"name":"example","text":"```js\n// Sets the location of the popup to a specific place (using autocast)\n// Note: using latitude/longitude only works if view is in Web Mercator or WGS84 spatial reference.\npopupComponent.location = {latitude: 34.0571, longitude: -117.1968};\n```"},{"name":"example","text":"```js\n// Sets the location of the popup to the location of a click on the view\nreactiveUtils.on(()=>viewElement, \"arcgisViewClick\", (event)=>{\n popupComponent.location = event.detail.mapPoint;\n // Displays the popup\n popupComponent.open = true;\n});\n```"},{"name":"see","text":"[Get started with popups](https://developers.arcgis.com/javascript/latest/sample-code/intro-popup/)"}],"values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Overwrite localized strings for this component","docsTags":[],"values":[],"optional":true,"required":false},{"name":"open","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"open","reflectToAttr":false,"docs":"Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.","docsTags":[{"name":"see","text":"[active](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#active)"},{"name":"see","text":"[clear()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#clear)"},{"name":"since","text":"5.0"},{"name":"example","text":"```js\n// Listen for clicks on the view and open the component at the clicked location with custom content.\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n const { mapPoint } = event.detail;\n component.location = mapPoint;\n component.heading = \"You clicked here\";\n component.content = \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3);\n component.open = true;\n});\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"promises","type":"Array>>","complexType":{"original":"Array>>","resolved":"Array>>","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of pending Promises that have not yet been fulfilled. If there are\nno pending promises, the value is `null`. When the pending promises are\nresolved they are removed from this array and the features they return\nare pushed into the [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) array.","docsTags":[],"deprecation":"since 5.1.","values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedDrillInFeature","type":"Graphic | null | undefined","complexType":{"original":"Graphic | null | undefined","resolved":"Graphic | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The feature that the component has drilled into.\nThis feature is either associated with the selected feature in a [relationship](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) or [utility network](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) element.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedFeature","type":"Graphic | null","complexType":{"original":"Graphic | null","resolved":"Graphic | null","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The selected feature accessed by the popup. The content of the Popup is\ndetermined based on the [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) assigned to\nthis feature.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedFeatureComponent","type":"ArcgisFeatureNext | null","complexType":{"original":"ArcgisFeatureNext | null","resolved":"ArcgisFeatureNext | null","references":{"ArcgisFeatureNext":{"location":"local","path":"components/arcgis-feature-next","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Returns a reference to the current [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) that the Popup is using.\nThis is useful if needing to get a reference to the component in order to make any changes to it.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"selectedFeatureIndex","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"selected-feature-index","reflectToAttr":false,"docs":"Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) are set,\nthe first index is automatically selected.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/popup/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"error"}],"optional":true,"required":false},{"name":"topLayerDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"top-layer-disabled","reflectToAttr":false,"docs":"When true, disables rendering in the top layer (above overlays and modals).\nThis can be useful for controlling stacking context in complex UI layouts.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"updateLocationEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"update-location-enabled","reflectToAttr":false,"docs":"Indicates whether to update the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeatureIndex) changes.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-popup component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Removes all [promises](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#promises), [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content),\n[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading) and [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) from the Popup.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisPopup = document.createElement(\"arcgis-popup\");\ndocument.body.append(arcgisPopup);\nawait arcgisPopup.componentOnReady();\nconsole.log(\"arcgis-popup is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"fetchFeatures","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(screenPoint?: ScreenPoint, options?: FetchFeaturesOptions): Promise","parameters":[{"name":"screenPoint","type":"ScreenPoint","docs":""},{"name":"options","type":"FetchFeaturesOptions","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"FetchFeaturesOptions":{"location":"local","path":"components/arcgis-popup/types","id":"notImplemented"}}},"signature":"fetchFeatures(screenPoint?: ScreenPoint, options?: FetchFeaturesOptions): Promise","parameters":[{"name":"screenPoint","type":"ScreenPoint","docs":""},{"name":"options","type":"FetchFeaturesOptions","docs":""}],"docs":"Use this method to return feature(s) at a given screen location. These features are fetched from all of the [LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) in the [view](https://developers.arcgis.com/javascript/latest/references/core/views/View/). In order to use this, a layer must already have an associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled). This method allows a developer to control how the input location is handled. For example, you may want to fetch features on a `click` event or on a `pointer-move` event. This method automatically sets the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) based on the input event's screen coordinates.","docsTags":[{"name":"deprecated"},{"name":"see","text":"[open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open)"}],"deprecation":"since 5.1. Use the `fetchPopupFeatures` method on the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#fetchPopupFeatures), [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#fetchPopupFeatures), or [Link Chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#fetchPopupFeatures) component to fetch features based on a screen location."},{"name":"handleViewClick","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(event: ClickEvent): Promise","parameters":[{"name":"event","type":"ClickEvent","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"PopupOpenOptions":{"location":"import","path":"@arcgis/core/widgets/Popup/types.js","id":"notImplemented"},"ClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"signature":"handleViewClick(event: ClickEvent): Promise","parameters":[{"name":"event","type":"ClickEvent","docs":""}],"docs":"","docsTags":[{"name":"internal"}]},{"name":"next","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"next(): Promise","parameters":[],"docs":"Selects the feature at the next index in relation to the selected feature.","docsTags":[{"name":"see","text":"[selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeatureIndex)"}]},{"name":"previous","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"previous(): Promise","parameters":[],"docs":"Selects the feature at the previous index in relation to the selected feature.","docsTags":[{"name":"see","text":"[selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeatureIndex)"}]},{"name":"setFocus","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setFocus(): Promise","parameters":[],"docs":"Use this method to give focus to the component if the component is able to be focused.","docsTags":[]}],"events":[{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"active\" | \"collapsed\" | \"currentAlignment\" | \"dockEnabled\" | \"effectiveHeading\" | \"featureCount\" | \"featureMenuOpen\" | \"features\" | \"promises\" | \"selectedDrillInFeature\" | \"selectedFeature\" | \"selectedFeatureComponent\" | \"selectedFeatureIndex\" | \"state\" | \"open\"; }","bubbles":true,"complexType":{"original":"{ name: \"active\" | \"collapsed\" | \"currentAlignment\" | \"dockEnabled\" | \"effectiveHeading\" | \"featureCount\" | \"featureMenuOpen\" | \"features\" | \"promises\" | \"selectedDrillInFeature\" | \"selectedFeature\" | \"selectedFeatureComponent\" | \"selectedFeatureIndex\" | \"state\" | \"open\"; }","resolved":"{ name: \"active\" | \"collapsed\" | \"currentAlignment\" | \"dockEnabled\" | \"effectiveHeading\" | \"featureCount\" | \"featureMenuOpen\" | \"features\" | \"promises\" | \"selectedDrillInFeature\" | \"selectedFeature\" | \"selectedFeatureComponent\" | \"selectedFeatureIndex\" | \"state\" | \"open\"; }","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTriggerAction","detail":"ActionEvent","bubbles":true,"complexType":{"original":"ActionEvent","resolved":"ActionEvent","references":{"ActionEvent":{"location":"import","path":"@arcgis/core/widgets/Popup/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after the user clicks on an action in the Popup component.\nThis event may be used to define a custom function to execute when particular actions are clicked.","docsTags":[{"name":"see","text":"[actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions)"},{"name":"see","text":"[PopupTemplate.actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions)"},{"name":"see","text":"[open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open)"},{"name":"example","text":"```js\n// Fires each time an action is clicked\nreactiveUtils.on(()=> component, \"arcgisTriggerAction\", (event)=>{\n // If the zoom-out action is clicked, execute the following code\n if(event.detail.action.id === \"zoom-out\"){\n // Zoom out two levels (LODs)\n viewElement.goTo({\n center: viewElement.center,\n zoom: viewElement.zoom - 2\n });\n }\n});\n```"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/presentation/presentation.tsx","tag":"arcgis-presentation","overview":"","readme":"","usage":{},"docs":"The Presentation component allows to present slides of a web scene in a presentation mode\nand supports navigating between the slides of a web scene.","docsTags":[{"name":"since","text":"5.0"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-presentation/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"keyboardNavigationEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"keyboard-navigation-enabled","reflectToAttr":false,"docs":"Enable navigation with the keyboard\nby using the arrow keys or page up/page down keys","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"scale","type":"\"l\" | \"m\" | \"s\"","complexType":{"original":"\"l\" | \"m\" | \"s\"","resolved":"\"l\" | \"m\" | \"s\"","references":{}},"mutable":true,"attr":"scale","reflectToAttr":false,"docs":"specifies the size of the component","docsTags":[],"default":"\"m\"","values":[{"type":"string","value":"l"},{"type":"string","value":"m"},{"type":"string","value":"s"}],"optional":true,"required":false},{"name":"sliceAnalysisInteractive","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"slice-analysis-interactive","reflectToAttr":false,"docs":"Show the slice analysis of a slide interactive so manipulators will be displayed, allowing users to click and drag to edit the analysis.\nPer default interactive is set to false.","docsTags":[{"name":"see","text":"[SliceAnalysisView3D.interactive](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/SliceAnalysisView3D/#interactive)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"slideCaptionsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"slide-captions-disabled","reflectToAttr":false,"docs":"Disable display of captions when slide is applied.\nPer default the display of captions is enabled.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"slideId","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"slide-id","reflectToAttr":false,"docs":"The id of the slide applied to the view","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"slideLegendDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"slide-legend-disabled","reflectToAttr":false,"docs":"Disable display of legend when slide is applied.\nPer default the display of legend is enabled.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"slidePopupDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"slide-popup-disabled","reflectToAttr":false,"docs":"Disable display of popup when slide with popup is applied.\nPer default the display of popup is enabled.\nThe events arcgisPopupFeaturesRetrieved and arcgisPopupFeatureNotFound will be emitted also when popups are disabled.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-presentation component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisPresentation = document.createElement(\"arcgis-presentation\");\ndocument.body.append(arcgisPresentation);\nawait arcgisPresentation.componentOnReady();\nconsole.log(\"arcgis-presentation is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component","docsTags":[]}],"events":[{"event":"arcgisPopupFeatureNotFound","detail":"{ slide: Slide; }","bubbles":true,"complexType":{"original":"{ slide: Slide; }","resolved":"{ slide: Slide; }","references":{"default":{"location":"import","path":"@arcgis/core/webscene/Slide.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a slide with a popup reference element has been applied, but the component was unable to retrieve the popup feature.\nThis event may be used to show a custom error message for such cases.","docsTags":[{"name":"see","text":"[SlideElements.popupInfo](https://developers.arcgis.com/javascript/latest/references/core/webscene/support/SlideElements/#popupInfo)"},{"name":"example","text":"```js\nreactiveUtils.on(()=> component, \"arcgisPopupFeatureNotFound\", (event)=>{\n // show error message if popup feature has not been found\n console.error(\"Unable to retrieve popup feature\");\n});\n```"}]},{"event":"arcgisPopupFeaturesRetrieved","detail":"{\n slide: Slide;\n features: Graphic[];\n location: Point | undefined;\n}","bubbles":true,"complexType":{"original":"{\n slide: Slide;\n features: Graphic[];\n location: Point | undefined;\n}","resolved":"{\n slide: Slide;\n features: Graphic[];\n location: Point | undefined;\n}","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after the popup feature(s) of a slide have been retrieved from the service or from the view.\nThis event may be used to show the popup graphic not in a popup, but in another component, e.g. ArcgisFeature.","docsTags":[{"name":"see","text":"[ArcgisFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/)"},{"name":"example","text":"```js\nreactiveUtils.on(()=> component, \"arcgisPopupFeaturesRetrieved\", (event)=>{\n const { features, slide } = (\n event as CustomEvent<{ slide: Slide; features: Graphic[]; location: Point | undefined }>\n ).detail;\n const arcgisFeature = document.querySelector(\"arcgis-feature\");\n arcgisFeature.graphic = features.length > 0 ? features[0] : null;\n});\n```"}]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/print/print.tsx","tag":"arcgis-print","overview":"","readme":"","usage":{},"docs":"The Print component connects your application with a [printing service](https://doc.esri.com/en/arcgis-enterprise/latest/administer/configure-the-portal-to-print-maps.html) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print component works with the [print](https://developers.arcgis.com/javascript/latest/references/core/rest/print/) module, which generates a printer-ready version of the map.\n\nThe Print component uses the ArcGIS Online print service by default, but it can be configured to use a custom print service with the [printServiceUrl](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#printServiceUrl) property.\nThe component can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use\n[TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/TemplateOptions/#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/references/core/rest/support/PrintTemplate/#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/references/core/rest/support/PrintTemplate/#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/references/core/rest/print/) for a detailed list of known limitations.\n\n```html\n\n \n\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"allowedFormats","type":"Formats2","complexType":{"original":"Formats2","resolved":"Formats2","references":{"Formats":{"location":"import","path":"@arcgis/core/widgets/Print/types.js","id":"notImplemented"}}},"mutable":true,"attr":"allowed-formats","reflectToAttr":false,"docs":"Specify the print output file format(s) that the user can select based on the options available from the print service.\nThis property can take a string value or an array of string values.\n\nWhen this value is \"all\" (default value), all the print service formats are available to be used.\nWhen an array of string values is used, only those values that match the options available from the print service will be used.\nIf none of the input string values match those available from the print service, `allowedFormats` will fallback to default behavior.","docsTags":[{"name":"since","text":"4.15"},{"name":"see","text":"[TemplateOptions#format](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/TemplateOptions/#format)"},{"name":"example","text":"const print = new Print({\n view: view,\n printServiceUrl: url\n});\n\nprint.viewModel.allowedFormats = [\"jpg\", \"png8\", \"png32\"];\n\nview.ui.add(print, {position: \"top-right\"});"}],"default":"\"all\"","values":[{"type":"string","value":"all"},{"type":"object"}],"optional":true,"required":false},{"name":"allowedFormatsForSaving","type":"Formats | undefined","complexType":{"original":"Formats | undefined","resolved":"Formats | undefined","references":{"Formats":{"location":"local","path":"components/arcgis-print/types","id":"notImplemented"}}},"mutable":true,"attr":"allowed-formats-for-saving","reflectToAttr":false,"docs":"Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.","docsTags":[],"values":[{"type":"string","value":"all"},{"type":"object"}],"optional":true,"required":false},{"name":"allowedLayouts","type":"Layouts","complexType":{"original":"Layouts","resolved":"Layouts","references":{"Layouts":{"location":"import","path":"@arcgis/core/widgets/Print/types.js","id":"notImplemented"}}},"mutable":true,"attr":"allowed-layouts","reflectToAttr":false,"docs":"Specify the print output layout(s) that the user can select based on the options available from the print service.\nThis property can take a string value or an array of string values.\n\nWhen this value is \"all\" (default value), all the print service layouts are available to be used.\nWhen an array of string values is used, only those values that match the options available from the print service will be used.\nIf none of the input string values match those available from the print service, `allowedLayouts` will fallback to default behavior.","docsTags":[{"name":"since","text":"4.15"},{"name":"see","text":"[TemplateOptions.layout](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/TemplateOptions/#format)"},{"name":"example","text":"const print = new Print({\n view: view,\n printServiceUrl: url\n});\n\nprint.viewModel.allowedLayouts = [\"a3-landscape\", \"a3-portrait\"];\n\nview.ui.add(print, {position: \"top-right\"});"}],"default":"\"all\"","values":[{"type":"string","value":"all"},{"type":"object"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"autoPopulateAuthor","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-populate-author","reflectToAttr":false,"docs":"Indicates whether to automatically populate the author field in the print layout advanced options\nwith the username of the current portal user.\n\nThis only takes effect if there is a portal with a signed-in user assigned to the [portal](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#portal) property.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"excludeDefaultTemplates","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"exclude-default-templates","reflectToAttr":false,"docs":"Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/PrintViewModel/#defaultTemplates).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"excludeOrganizationTemplates","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"exclude-organization-templates","reflectToAttr":false,"docs":"Indicates whether or not to include templates from an organization's portal.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"exportedLinks","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Print/FileLink.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The collection of links exported from the Print component.","docsTags":[{"name":"since","text":"4.33"}],"values":[],"optional":true,"required":false},{"name":"extraParameters","type":"Record | null | undefined","complexType":{"original":"Record | null | undefined","resolved":"Record | null | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This option allows passing extra parameters (in addition to [templateOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#templateOptions)) to the print (export webmap) requests.","docsTags":[{"name":"since","text":"4.20"}],"values":[],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `

Exported files

`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","docsTags":[],"default":"3","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideAdvancedOptions","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-advanced-options","reflectToAttr":false,"docs":"Indicates whether the advanced options section in the Print component UI is hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureAttributes","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-attributes","reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-header","reflectToAttr":false,"docs":"Indicates whether the component's header is hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideIncludeTables","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-include-tables","reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"print\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"outSpatialReference","type":"SpatialReference | null | undefined","complexType":{"original":"SpatialReference | null | undefined","resolved":"SpatialReference | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/SpatialReference.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [spatial reference](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/) used to render the printed map on the server.","docsTags":[{"name":"since","text":"4.33"}],"values":[],"optional":true,"required":false},{"name":"portal","type":"Portal","complexType":{"original":"Portal","resolved":"Portal","references":{"default":{"location":"import","path":"@arcgis/core/portal/Portal.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"It is possible to search a specified portal instance's [locator services](https://doc.esri.com/en/arcgis-enterprise/latest/administer/configure-portal-to-geocode-addresses.html).\nUse this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.\nThis is especially helpful when working with a [custom template](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/CustomTemplate/).\n\nIf this property is set, it is not necessary to set the [printServiceUrl](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#printServiceUrl) property.","docsTags":[{"name":"since","text":"4.18"},{"name":"see","text":"[CustomTemplate](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/CustomTemplate/)"}],"values":[],"optional":true,"required":false},{"name":"printServiceUrl","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"print-service-url","reflectToAttr":false,"docs":"The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#portal) property is set, this property will use the portal's print service URL.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"showPrintAreaEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-print-area-enabled","reflectToAttr":false,"docs":"The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.","docsTags":[{"name":"since","text":"4.30"},{"name":"see","text":"[Print component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showSaveAs","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"show-save-as","reflectToAttr":false,"docs":"Indicates whether to show the \"Save As\" option in the Print component UI.","docsTags":[{"name":"internal"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/Print/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The state of the Print component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"error"},{"type":"string","value":"initializing"}],"optional":true,"required":false},{"name":"templateCustomTextElements","type":"TemplateCustomTextElements | null | undefined","complexType":{"original":"TemplateCustomTextElements | null | undefined","resolved":"TemplateCustomTextElements | null | undefined","references":{"TemplateCustomTextElements":{"location":"import","path":"@arcgis/core/widgets/Print/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An object containing an array of `customTextElements` name-value pair objects\nfor each print template in a custom print service. Use this property to update\nthe text for custom text elements on the page layout.\n\nThe Print component calls the `Get Layout Templates Info` task on the GPServer\nto discover possible `customTextElements` values for each template. The name of\nthe task must match `Get Layout Templates Info`, templates must be published\nwith `customTextElements`, and values must be strings. Values found there will be\npopulated in the Print component under `Advanced options`. These values can be\noverwritten in the Print component UI, or programmatically using this property.\nTo list all print templates available on the print service to see\nsee which templates were published with `customTextElements`, use the\n[effectiveTemplateCustomTextElements](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/PrintViewModel/#effectiveTemplateCustomTextElements)\nproperty.","docsTags":[{"name":"since","text":"4.22"},{"name":"example","text":"const printViewModel = new PrintViewModel({\n view: view,\n // specify your custom print service\n printServiceUrl: \"\",\n // `customTextElements` are defined per print template\n // this example has one template with `customTextElements`\n templateCustomTextElements: {\n // if there were more applicable templates, then we would\n // create another object with the template name containing\n // an array of more name-value pairs\n \"Portrait_TextElements\": [\n // the possible values are defined in the print service\n { \"headquarters\": \"Tampa, Florida\" },\n { \"division\": \"NFC South\" },\n { \"founded\": \"1976\" }\n ]\n }\n });"}],"values":[],"optional":true,"required":false},{"name":"templateOptions","type":"Partial","complexType":{"original":"Partial","resolved":"Partial","references":{"Partial":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/Print/TemplateOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Defines the layout template options used by the Print component to generate the print page.","docsTags":[{"name":"since","text":"4.33"}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-print component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"addPortalTemplate","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(portalItem: PortalItem): Promise","parameters":[{"name":"portalItem","type":"PortalItem","docs":"The portal item to add."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/portal/PortalItem.js","id":"notImplemented"}}},"signature":"addPortalTemplate(portalItem: PortalItem): Promise","parameters":[{"name":"portalItem","type":"PortalItem","docs":"The portal item to add."}],"docs":"Adds a portal item to a collection of browse templates available in the Print component UI.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisPrint = document.createElement(\"arcgis-print\");\ndocument.body.append(arcgisPrint);\nawait arcgisPrint.componentOnReady();\nconsole.log(\"arcgis-print is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisBrowseTemplatesChange","detail":"CollectionChangeEvent","bubbles":true,"complexType":{"original":"CollectionChangeEvent","resolved":"CollectionChangeEvent","references":{"CollectionChangeEvent":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/Print/CustomTemplate.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when the collection of browse templates changes.","docsTags":[{"name":"since","text":"5.0"}]},{"event":"arcgisComplete","detail":"CompleteEvent","bubbles":true,"complexType":{"original":"CompleteEvent","resolved":"CompleteEvent","references":{"CompleteEvent":{"location":"import","path":"@arcgis/core/widgets/Print/PrintViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when the component is complete.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSaveAs","detail":"FileLink","bubbles":true,"complexType":{"original":"FileLink","resolved":"FileLink","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Print/FileLink.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when the user saves an exported map printout.","docsTags":[{"name":"since","text":"5.0"}]},{"event":"arcgisSubmit","detail":"SubmitEvent","bubbles":true,"complexType":{"original":"SubmitEvent","resolved":"SubmitEvent","references":{"SubmitEvent":{"location":"import","path":"@arcgis/core/widgets/Print/PrintViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when the component is submitted.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/reverse-geocode-list/reverse-geocode-list.tsx","tag":"arcgis-reverse-geocode-list","overview":"","readme":"","usage":{},"docs":"The Reverse Geocode List component displays a list of addresses obtained by reverse geocoding a given location.\nThis is the component behind the What's Here functionality in Map Viewer. This class was created for MV for 5.0,\nbut is internal for 5.0, and will be wider released at 5.1 or later.","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the component title.","docsTags":[],"default":"3","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideCoordinates","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-coordinates","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"location","type":"Point | undefined","complexType":{"original":"Point | undefined","resolved":"Point | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"portal","type":"Portal","complexType":{"original":"Portal","resolved":"Portal","references":{"default":{"location":"import","path":"@arcgis/core/portal/Portal.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"reverseGeocodeResults","type":"null | undefined | ReverseGeocodeResult[]","complexType":{"original":"null | undefined | ReverseGeocodeResult[]","resolved":"null | undefined | ReverseGeocodeResult[]","references":{"ReverseGeocodeResult":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisReverseGeocodeList = document.createElement(\"arcgis-reverse-geocode-list\");\ndocument.body.append(arcgisReverseGeocodeList);\nawait arcgisReverseGeocodeList.componentOnReady();\nconsole.log(\"arcgis-reverse-geocode-list is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisReverseGeocodeCopy","detail":"{ data: string; }","bubbles":true,"complexType":{"original":"{ data: string; }","resolved":"{ data: string; }","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisReverseGeocodeResultsChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/scale-bar/scale-bar.tsx","tag":"arcgis-scale-bar","overview":"","readme":"","usage":{},"docs":"The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scale-bar/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"barStyle","type":"ScaleBarStyle","complexType":{"original":"ScaleBarStyle","resolved":"ScaleBarStyle","references":{"ScaleBarStyle":{"location":"local","path":"components/arcgis-scale-bar/types","id":"notImplemented"}}},"mutable":true,"attr":"bar-style","reflectToAttr":false,"docs":"The style for the scale bar.\nWhen `unit` is set to `dual`, the style will always be `line`.","docsTags":[],"default":"\"line\"","values":[{"type":"string","value":"line"},{"type":"string","value":"ruler"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"actual-size\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"unit","type":"ScaleBarUnit | undefined","complexType":{"original":"ScaleBarUnit | undefined","resolved":"ScaleBarUnit | undefined","references":{"ScaleBarUnit":{"location":"local","path":"components/arcgis-scale-bar/types","id":"notImplemented"}}},"mutable":true,"attr":"unit","reflectToAttr":false,"docs":"Units to use for the scale bar.\nWhen using `dual`, the scale bar displays both metric and imperial units.\nWhen metric, distances will be shown in either kilometers, meters, centimeters, or millimeters depending on the scale. Similarly, imperial\nunits will be shown in either miles, feet, or inches.","docsTags":[],"values":[{"type":"string","value":"dual"},{"type":"string","value":"metric"},{"type":"string","value":"imperial"}],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-scale-bar component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisScaleBar = document.createElement(\"arcgis-scale-bar\");\ndocument.body.append(arcgisScaleBar);\nawait arcgisScaleBar.componentOnReady();\nconsole.log(\"arcgis-scale-bar is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/scale-range-slider/scale-range-slider.tsx","tag":"arcgis-scale-range-slider","overview":"","readme":"","usage":{},"docs":"The Scale Range Slider component allows the user to set a minimum and maximum scale based on named scale ranges.\n\n> [!WARNING]\n> This component is a wrapped version of the [ScaleRangeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html) widget.\n> We recommend using the [arcgis-slider-scale-range](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/) component instead, which provides a native implementation with improved features and accessibility.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"deprecation":"since 5.1. Use [arcgis-slider-scale-range](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/) instead.","props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scale-range-slider/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":true,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePreview","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-preview","reflectToAttr":false,"docs":"Indicates whether the preview thumbnail of the scale is visible.\nDefault value is `true`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideScaleMenusMaxScaleMenu","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-scale-menus-max-scale-menu","reflectToAttr":false,"docs":"Indicates whether the maximum scale dropdown menu is visible. Default value is `true`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideScaleMenusMinScaleMenu","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-scale-menus-min-scale-menu","reflectToAttr":false,"docs":"Indicates whether the minimum scale dropdown menu is visible. Default value is `true`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"actual-size\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layer","type":"Layer | Sublayer | null | undefined","complexType":{"original":"Layer | Sublayer | null | undefined","resolved":"Layer | Sublayer | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/support/Sublayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"When provided, the initial [minScale](https://developers.arcgis.com/javascript/latest/references/core/widgets/ScaleRangeSlider/#minScale) and [maxScale](https://developers.arcgis.com/javascript/latest/references/core/widgets/ScaleRangeSlider/#maxScale) values will match the layer's.\n\nWhen a tiled layer is used, the slider will be restricted from moving the slider thumbs past the `lods` of the layer's tiling scheme.\nSince version 4.28, when a [MapImageLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/) is used, the slider will be restricted from moving past the min/max scale defined on the map service.\nThe unavailable range will be designated with a dashed line.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"maxScale","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-scale","reflectToAttr":false,"docs":"The maximum scale of the active scale range. When the maxScale\nreaches the [maxScaleLimit](https://developers.arcgis.com/javascript/latest/references/core/widgets/ScaleRangeSlider/#maxScaleLimit), the maxScale\nvalue becomes 0 and there is no maximum scale set.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"maxScaleLimit","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-scale-limit","reflectToAttr":false,"docs":"The lowest possible maximum scale value on the slider.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"minScale","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-scale","reflectToAttr":false,"docs":"The minimum scale of the active scale range. When the minScale\nreaches the [minScaleLimit](https://developers.arcgis.com/javascript/latest/references/core/widgets/ScaleRangeSlider/#minScaleLimit), the minScale\nvalue becomes 0 and there is no minimum scale.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"minScaleLimit","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-scale-limit","reflectToAttr":false,"docs":"The highest possible minimum scale value on the slider.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"mode","type":"\"range\" | \"max-scale-only\" | \"min-scale-only\"","complexType":{"original":"\"range\" | \"max-scale-only\" | \"min-scale-only\"","resolved":"\"range\" | \"max-scale-only\" | \"min-scale-only\"","references":{}},"mutable":true,"attr":"mode","reflectToAttr":false,"docs":"The mode of the component, indicating which slider thumbs can be adjusted.","docsTags":[{"name":"since","text":"4.29"}],"default":"\"range\"","values":[{"type":"string","value":"range"},{"type":"string","value":"max-scale-only"},{"type":"string","value":"min-scale-only"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"region","type":"SupportedRegion","complexType":{"original":"SupportedRegion","resolved":"SupportedRegion","references":{"SupportedRegion":{"location":"import","path":"@arcgis/core/widgets/ScaleRangeSlider/types.js","id":"notImplemented"}}},"mutable":true,"attr":"region","reflectToAttr":false,"docs":"The region that the scale thumbnails will focus on.\nEach region comes from the [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).\nSee [SupportedRegion](https://developers.arcgis.com/javascript/latest/references/core/widgets/ScaleRangeSlider/types/#SupportedRegion) for the list of regions that are currently supported.","docsTags":[],"default":"\"US\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"showWorldValue","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-world-value","reflectToAttr":false,"docs":"Indicates whether the world scale value is shown in the scale menu.","docsTags":[{"name":"since","text":"4.34"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"ScaleRangeSliderViewModelState","complexType":{"original":"ScaleRangeSliderViewModelState","resolved":"ScaleRangeSliderViewModelState","references":{"ScaleRangeSliderViewModelState":{"location":"import","path":"@arcgis/core/widgets/ScaleRangeSlider/ScaleRangeSliderViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-scale-range-slider component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisScaleRangeSlider = document.createElement(\"arcgis-scale-range-slider\");\ndocument.body.append(arcgisScaleRangeSlider);\nawait arcgisScaleRangeSlider.componentOnReady();\nconsole.log(\"arcgis-scale-range-slider is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\" | \"minScale\" | \"maxScale\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\" | \"minScale\" | \"maxScale\"; }","resolved":"{ name: \"state\" | \"minScale\" | \"maxScale\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/scene/scene.tsx","tag":"arcgis-scene","overview":"","readme":"","usage":{},"docs":"The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/references/core/WebScene/) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html).\n\n```html\n\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n\n\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n\n \n\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/references/core/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nconst layer = new GraphicsLayer({ title: \"My layer\"});\nviewElement.map.add(layer);\n```\n\n**See also**\n\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"allLayerViews","type":"ReadonlyCollection","complexType":{"original":"ReadonlyCollection","resolved":"ReadonlyCollection","references":{"ReadonlyCollection":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Collection containing a flat list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\nrelated to the basemap, operational layers, and group layers in this view.","docsTags":[{"name":"see","text":"[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"alphaCompositingEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"alpha-compositing-enabled","reflectToAttr":false,"docs":"Allows the view to be partially or fully transparent when composited with the webpage elements behind it.\n\nThis property can only be set once at construction time. When alpha compositing is enabled, web scenes are less\nperformant. It is important to set this property to `true` only when you need to apply transparency on the view.","docsTags":[{"name":"since","text":"4.8"},{"name":"example","text":"// create a view with a fully transparent background\nlet view = new SceneView({\n map: map,\n alphaCompositingEnabled: true,\n environment: {\n background: {\n type: \"color\",\n color: [0, 0, 0, 0]\n },\n starsEnabled: false,\n atmosphereEnabled: false\n }\n})"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"analyses","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/analysis/Analysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of analyses associated with the view.","docsTags":[{"name":"example","text":"// Adds an analysis to the View\nview.analyses.add(lineOfSightAnalysis);"},{"name":"example","text":"// Removes an analysis from the View\nview.analyses.remove(lineOfSightAnalysis);"}],"values":[],"optional":true,"required":false},{"name":"animationsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"animations-disabled","reflectToAttr":false,"docs":"Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/FlowRenderer/)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#goTo)).\nSetting this property to `true` disables all animations in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"aria","type":"SceneView[\"aria\"]","complexType":{"original":"SceneView[\"aria\"]","resolved":"SceneView[\"aria\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The ARIA attributes for the view container. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements).","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"attributionItems","type":"SceneView[\"attributionItems\"]","complexType":{"original":"SceneView[\"attributionItems\"]","resolved":"SceneView[\"attributionItems\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The attribution items displayed in the view's attribution.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"attributionMode","type":"\"dark\" | \"light\" | null | undefined","complexType":{"original":"\"dark\" | \"light\" | null | undefined","resolved":"\"dark\" | \"light\" | null | undefined","references":{}},"mutable":true,"attr":"attribution-mode","reflectToAttr":false,"docs":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"dark"},{"type":"string","value":"light"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"basemap","type":"Basemap | string | undefined","complexType":{"original":"Basemap | string | undefined","resolved":"Basemap | string | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Basemap.js","id":"notImplemented"}}},"mutable":true,"attr":"basemap","reflectToAttr":false,"docs":"Specifies a basemap for the map. The basemap is a set of layers that give\ngeographic context to the view and the other operational layers\nin the map.\nIt can either be set using a basemap ID string ([see values](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap)),\n[Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)\nor [BasemapStyle](https://developers.arcgis.com/javascript/latest/references/core/support/BasemapStyle/).\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap)","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"basemapView","type":"BasemapView","complexType":{"original":"BasemapView","resolved":"BasemapView","references":{"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Represents the [view for a single basemap](https://developers.arcgis.com/javascript/latest/references/core/views/BasemapView/)\nafter it has been added to the map.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"camera","type":"Camera","complexType":{"original":"Camera","resolved":"Camera","references":{"default":{"location":"import","path":"@arcgis/core/Camera.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [camera](https://developers.arcgis.com/javascript/latest/references/core/Camera/) allows to set the observation point from which the visible portion (or perspective)\nof the view is determined. When set in the constructor, this property overrides the [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#center), [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#extent), [scale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#scale), [viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#viewpoint), and [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#zoom) properties.\n\nSetting the camera immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"cameraFov","type":"null | undefined | number","complexType":{"original":"null | undefined | number","resolved":"null | undefined | number","references":{}},"mutable":true,"attr":"camera-fov","reflectToAttr":false,"docs":"The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#fov)","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"cameraHeading","type":"null | undefined | number","complexType":{"original":"null | undefined | number","resolved":"null | undefined | number","references":{}},"mutable":true,"attr":"camera-heading","reflectToAttr":false,"docs":"The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#heading)","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"cameraPosition","type":"null | undefined | number[] | Point | string","complexType":{"original":"null | undefined | number[] | Point | string","resolved":"null | undefined | number[] | Point | string","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"mutable":true,"attr":"camera-position","reflectToAttr":false,"docs":"The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#position)","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"cameraTilt","type":"null | undefined | number","complexType":{"original":"null | undefined | number","resolved":"null | undefined | number","references":{}},"mutable":true,"attr":"camera-tilt","reflectToAttr":false,"docs":"The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#tilt)","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"canZoomIn","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates if the view component can zoom in.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canZoomOut","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates if the view component can zoom out.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"center","type":"null | undefined | number[] | SceneView[\"center\"] | string","complexType":{"original":"null | undefined | number[] | SceneView[\"center\"] | string","resolved":"null | undefined | number[] | SceneView[\"center\"] | string","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"attr":"center","reflectToAttr":false,"docs":"Represents the center point of the view. It can be a string with the format `\", \"`\nor a [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#center)","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"clippingArea","type":"Extent | null | undefined","complexType":{"original":"Extent | null | undefined","resolved":"Extent | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Extent.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/)\nof a Scene in `local` [viewingMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#viewingMode).\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#clippingArea)","docsTags":[{"name":"see","text":"[viewingMode](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#viewingMode)"},{"name":"see","text":"[Sample - Create a local scene](https://developers.arcgis.com/javascript/latest/sample-code/scene-local/)"},{"name":"example","text":"let extent = view.extent.clone();\n\n// Expand the extent in place, reducing it to 50% of its original size and set it as the clippingArea\nview.clippingArea = extent.expand(0.5);"}],"values":[],"optional":true,"required":false},{"name":"constraints","type":"Constraints","complexType":{"original":"Constraints","resolved":"Constraints","references":{"default":{"location":"import","path":"@arcgis/core/views/3d/constraints/Constraints.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies constraints for the camera's tilt, altitude, and view's clip distance.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#constraints)","docsTags":[{"name":"see","text":"[Sample - Custom background for SceneView (altitude)](https://developers.arcgis.com/javascript/latest/sample-code/sceneview-background/)"}],"values":[],"optional":true,"required":false},{"name":"displayFilterDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"display-filter-disabled","reflectToAttr":false,"docs":"Indicates whether a layer's `displayFilter` is honored when rendering layers in the view.\nIf `false`, the display filters are ignored and all features are rendered.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"environment","type":"Environment","complexType":{"original":"Environment","resolved":"Environment","references":{"default":{"location":"import","path":"@arcgis/core/views/3d/environment/Environment.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies various properties of the environment's visualization within the view, including lighting, background, weather, and more.\nThe Scene will redraw automatically when any property of environment changes.\n\nModifying the lighting:\n\n```js\nviewElement.environment.lighting = {\n type: \"sun\", // autocasts as new SunLighting()\n date: new Date(), // sets the lighting to reflect the current time of day\n directShadowsEnabled: true,\n};\n```\n\nSetting the background:\n\n```js\nviewElement.environment = {\n background: {\n type: \"color\",\n color: [255, 252, 244, 1]\n },\n starsEnabled: false,\n atmosphereEnabled: false\n};\n```\n\nChanging the weather in the scene:\n\n```js\nviewElement.environment.weather = {\n type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n cloudCover: 0.7,\n precipitation: 0.3\n};\n```\n\n**See also**\n\n- [SunLighting](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/)\n- [VirtualLighting](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/)\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunnyWeather/)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/CloudyWeather/)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/RainyWeather/)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SnowyWeather/)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/FoggyWeather/)\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#environment)","docsTags":[],"values":[],"optional":true,"required":false},{"name":"extent","type":"SceneView[\"extent\"]","complexType":{"original":"SceneView[\"extent\"]","resolved":"SceneView[\"extent\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The extent represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map) within the view as an instance of\n[Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/).\n\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#extent)","docsTags":[],"values":[],"optional":true,"required":false},{"name":"fatalError","type":"Error | null | undefined","complexType":{"original":"Error | null | undefined","resolved":"Error | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/core/Error.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A rejected view indicates a fatal [error](https://developers.arcgis.com/javascript/latest/references/core/core/Error/)\nmaking it unable to display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#fatalError)","docsTags":[{"name":"since","text":"4.12"},{"name":"see","text":"[tryFatalErrorRecovery()](https://developers.arcgis.com/javascript/latest/references/core/views/View/#tryFatalErrorRecovery)"},{"name":"example","text":"reactiveUtils.when(\n () => view.fatalError,\n () => {\n console.error(\"Fatal Error! View has lost its WebGL context. Attempting to recover...\");\n view.tryFatalErrorRecovery();\n }\n);"}],"values":[],"optional":true,"required":false},{"name":"floors","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Applies a display filter on the view for a specific set of floor levels.\nIt can filter the map display on floor-aware layers by zero or more level IDs.","docsTags":[{"name":"since","text":"4.19"}],"values":[],"optional":true,"required":false},{"name":"focusAreas","type":"FocusAreas","complexType":{"original":"FocusAreas","resolved":"FocusAreas","references":{"default":{"location":"import","path":"@arcgis/core/effects/FocusAreas.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A container of all focus areas present in the map.","docsTags":[{"name":"since","text":"4.33"}],"values":[],"optional":true,"required":false},{"name":"gamepad","type":"GamepadSettings","complexType":{"original":"GamepadSettings","resolved":"GamepadSettings","references":{"default":{"location":"import","path":"@arcgis/core/views/input/gamepad/GamepadSettings.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Gamepad input specific configuration settings.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"graphics","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Allows for adding graphics directly to the default graphics in the view.","docsTags":[{"name":"example","text":"```js\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```"},{"name":"see","text":"[Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/)"},{"name":"see","text":"[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/)"},{"name":"see","text":"[Intro to graphics](https://developers.arcgis.com/javascript/latest/sample-code/intro-graphics/)"}],"values":[],"optional":true,"required":false},{"name":"ground","type":"Ground | string","complexType":{"original":"Ground | string","resolved":"Ground | string","references":{"default":{"location":"import","path":"@arcgis/core/Ground.js","id":"notImplemented"}}},"mutable":true,"attr":"ground","reflectToAttr":false,"docs":"Specifies the surface properties for the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/references/core/Ground/)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Map/#ground)","docsTags":[{"name":"see","text":"[ElevationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/)"},{"name":"see","text":"[Ground](https://developers.arcgis.com/javascript/latest/references/core/Ground/)"},{"name":"example","text":"// Use the world elevation service\nconst map = new Map({\n basemap: \"topo-vector\",\n ground: \"world-elevation\"\n});"},{"name":"example","text":"// Create a map with the world elevation layer overlaid by a custom elevation layer\nconst worldElevation = new ElevationLayer({\n url: \"//elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer\"\n});\nconst customElevation = new ElevationLayer({\n url: \"https://my.server.com/arcgis/rest/service/MyElevationService/ImageServer\"\n});\nconst map = new Map({\n basemap: \"topo-vector\",\n ground: new Ground({\n layers: [ worldElevation, customElevation ]\n })\n});"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"groundView","type":"GroundView","complexType":{"original":"GroundView","resolved":"GroundView","references":{"default":{"location":"import","path":"@arcgis/core/views/GroundView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view for the ground of the map.","docsTags":[{"name":"since","text":"4.7"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"hideAttribution","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-attribution","reflectToAttr":false,"docs":"Indicates whether the attribution is hidden in the view.\n\nEsri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.\nFor detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.\nFor information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"highlights","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/views/support/HighlightOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Represents a collection of [HighlightOptions](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/) objects which can be used to\nhighlight features throughout an application. Highlighting works by applying highlight options to one or\nmore features. You can configure these options (such as color or opacity) to define how a feature will be visually\nemphasized.\n\nA maximum of six [HighlightOptions](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/) objects are supported in the collection, and\nthey can be added, removed, and reordered freely. Their order in the collection determines priority, with the last\nobject having the highest priority. If you apply more than one highlight to a feature, the one that is last within\nthe collection will be applied. The [HighlightOptions](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/) object must be part of this\ncollection in order to be applied to features.\n\nTo highlight a feature, use the [highlight](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#highlight) method on\nthe relevant [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) instance. To apply specific\n[HighlightOptions](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/), include the\n[name](https://developers.arcgis.com/javascript/latest/references/core/views/support/HighlightOptions/#name) in the `highlight()` method's `options` parameter. If\nno `name` is provided, the feature will use the `default` highlight options.\n\nThe table below shows the default highlight options in the View's highlights collection if the collection has not\nbeen modified:\n\n| Highlight options name | Description | Default settings |\n| ---------------------- | ----------- | ---------------- |\n| default | The default highlight options. Used when `layerView.highlight()` is called without specifying any particular highlight options. | ` { name: \"default\", color: \"cyan\", haloOpacity: 1, fillOpacity: 0.25, shadowColor: \"black\", shadowOpacity: 0.4, shadowDifference: 0.2}` |\n| temporary | The temporary highlight options, pre-configured for common use cases such as hovering over a feature in the view. | `{ name: \"temporary\", color: \"yellow\", haloOpacity: 1, fillOpacity: 0.25, shadowColor: \"black\", shadowOpacity: 0.4, shadowDifference: 0.2 }` |","docsTags":[{"name":"since","text":"4.32"},{"name":"see","text":"[Sample: Highlight features by geometry](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)"},{"name":"see","text":"[Sample: Highlight SceneLayer](https://developers.arcgis.com/javascript/latest/sample-code/highlight-scenelayer/)"},{"name":"example","text":"// Use the default highlights collection to apply a highlight to features when you hover over them\n\n// A handler can be used to remove any previous highlight when applying a new one\nlet hoverHighlight;\n\nview.on(\"pointer-move\", (event) => {\n // Search for the first feature in the featureLayer at the hovered location\n view.hitTest(event, { include: featureLayer }).then((response) => {\n if (response.results[0]) {\n const graphic = response.results[0].graphic;\n view.whenLayerView(graphic.layer).then((layerView) => {\n // Remove any previous highlight, if it exists\n hoverHighlight?.remove();\n // Highlight the hit features with the temporary highlight options, which are pre-configured for this use case\n hoverHighlight = layerView.highlight(graphic, { name: \"temporary\"});\n });\n }\n });\n});"},{"name":"example","text":"// Override the default highlights collection\n\nconst view = new MapView({\n map: map,\n container: \"viewDiv\",\n\n // Set the highlight options to be used in the view\n highlights: [\n { name: \"default\", color: \"orange\" },\n { name: \"temporary\", color: \"magenta\" },\n { name: \"table\", color: \"cyan\", fillOpacity: 0.5, haloOpacity: 0}\n ]\n});"},{"name":"example","text":"// Add highlight options to the collection after initialization\n\nconst selectionHighlightOptions = {\n name: \"selection\",\n color: \"#ff00ff\", // bright fuchsia\n haloOpacity: 0.8,\n fillOpacity: 0.2\n};\n\n// Add the options to the highlights collection at the first position\nview.highlights.add(selectionGroup, 0);"}],"values":[],"optional":true,"required":false},{"name":"interacting","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indication whether the view is being interacted with (for example when panning or by an interactive tool).","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"itemId","type":"null | undefined | string","complexType":{"original":"null | undefined | string","resolved":"null | undefined | string","references":{}},"mutable":true,"attr":"item-id","reflectToAttr":true,"docs":"The ID of a [WebScene](https://developers.arcgis.com/javascript/latest/references/core/WebScene/) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html).\n\nTo configure the portal url you must set the [config.portalUrl](https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl) property before the Scene component loads.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layerViews","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection containing a hierarchical list of all the created\n[LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/references/core/Map/#layers) in the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map).","docsTags":[{"name":"see","text":"[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"loadErrorSources","type":"LoadErrorSource[] | undefined","complexType":{"original":"LoadErrorSource[] | undefined","resolved":"LoadErrorSource[] | undefined","references":{"LoadErrorSource":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of objects that encountered an error while loading the component or any of its dependencies (e.g., basemap, ground, layers, tables). You may inspect the errors by accessing each object's `loadError` property.","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"magnifier","type":"Magnifier","complexType":{"original":"Magnifier","resolved":"Magnifier","references":{"default":{"location":"import","path":"@arcgis/core/views/Magnifier.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The magnifier allows for showing a portion of the view as a magnifier image on top of the view.","docsTags":[{"name":"since","text":"4.19"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"map","type":"Map | null | undefined","complexType":{"original":"Map | null | undefined","resolved":"Map | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Map.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An instance of a [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/) object to display in the view.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"navigating","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indication whether the view is being navigated (for example when panning).","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"navigation","type":"Navigation","complexType":{"original":"Navigation","resolved":"Navigation","references":{"default":{"location":"import","path":"@arcgis/core/views/navigation/Navigation.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Options to configure the navigation behavior of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#navigation)","docsTags":[{"name":"since","text":"4.9"},{"name":"example","text":"// Disable the gamepad usage, single touch panning, panning momentum and mouse wheel zooming.\nconst view = new MapView({\n container: \"viewDiv\",\n map: new Map({\n basemap: \"satellite\"\n }),\n center: [176.185, -37.643],\n zoom: 13,\n navigation: {\n gamepad: {\n enabled: false\n },\n actionMap: {\n dragSecondary: \"none\", // Disable rotating the view with the right mouse button\n mouseWheel: \"none\" // Disable zooming with the mouse wheel\n },\n browserTouchPanEnabled: false,\n momentumEnabled: false,\n }\n});"}],"values":[],"optional":true,"required":false},{"name":"padding","type":"ViewPadding","complexType":{"original":"ViewPadding","resolved":"ViewPadding","references":{"ViewPadding":{"location":"import","path":"@arcgis/core/views/ui/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#center),\nand [extent](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#extent),\netc. work off a subsection of the full view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#padding)","docsTags":[],"default":"{left: 0, top: 0, right: 0, bottom: 0}","values":[],"optional":true,"required":false},{"name":"performanceInfo","type":"SceneViewPerformanceInfo","complexType":{"original":"SceneViewPerformanceInfo","resolved":"SceneViewPerformanceInfo","references":{"default":{"location":"import","path":"@arcgis/core/views/3d/support/SceneViewPerformanceInfo.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property contains performance information of the view, e.g. global memory usage and additional\ndetails for layers about memory consumption and number of features.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"popup","type":"Popup | null | undefined","complexType":{"original":"Popup | null | undefined","resolved":"Popup | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Popup.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/) widget object that displays general content or attributes from [layers](https://developers.arcgis.com/javascript/latest/references/core/Map/#layers) in the [map](https://developers.arcgis.com/javascript/latest/references/core/views/View/#map). Consider using the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) (beta), which represents the Popup component, instead.\n\nBy default, the `popup` property is an empty object that allows you to set the popup options. A [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/) instance is automatically created and assigned to the view's [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup) when the user clicks on the view and [popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/PopupView/#popupEnabled) is `true`, when the [openPopup()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#openPopup) method is called, or when some widgets need the popup, such as [Search](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/). If [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup) is `null`, the popup instance will not be created.","docsTags":[{"name":"see","text":"[popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement)"},{"name":"see","text":"[popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupDisabled)"},{"name":"see","text":"[openPopup()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#openPopup)"}],"values":[],"optional":true,"required":false},{"name":"popupComponentEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"popup-component-enabled","reflectToAttr":false,"docs":"Indicates whether the [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) (beta) is enabled as the default popup. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) property (representing the component) will be used for popups instead of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup) property (representing the widget).\n\n**Note:** This is a beta feature and may change in future releases. At version 6.0, the Popup component will be used by default instead of the Popup widget and the `popup-component-enabled` attribute will no longer be necessary.","docsTags":[{"name":"beta"},{"name":"since","text":"5.0"},{"name":"see","text":"[popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement)"},{"name":"example","text":"```html\n\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"popupDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"popup-disabled","reflectToAttr":false,"docs":"Controls whether the default popup opens automatically when users click on the view. This controls both the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) and [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup) properties. When set to `true`, the popup will not open on click or when triggered programmatically.","docsTags":[{"name":"see","text":"[openPopup()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#openPopup)"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"popupElement","type":"ArcgisPopup | null","complexType":{"original":"ArcgisPopup | null","resolved":"ArcgisPopup | null","references":{"ArcgisPopup":{"location":"local","path":"components/arcgis-popup","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A reference to the current [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) (beta). The [popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupComponentEnabled) property must be set to `true` to use this property.\n\n**Note:** This is a beta feature and may change in future releases.","docsTags":[{"name":"beta"},{"name":"since","text":"5.0"},{"name":"see","text":"[popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupComponentEnabled)"},{"name":"example","text":"```html\n\n\n```"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"qualityProfile","type":"\"medium\" | \"low\" | \"high\"","complexType":{"original":"\"medium\" | \"low\" | \"high\"","resolved":"\"medium\" | \"low\" | \"high\"","references":{}},"mutable":true,"attr":"quality-profile","reflectToAttr":false,"docs":"Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#qualityProfile)","docsTags":[{"name":"example","text":"let view = new SceneView({\n qualityProfile: \"high\"\n});"}],"values":[{"type":"string","value":"medium"},{"type":"string","value":"low"},{"type":"string","value":"high"}],"optional":true,"required":false},{"name":"ready","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"When `true`, this property indicates whether the view successfully satisfied all dependencies,\nsignaling that the necessary conditions are met.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#ready)","docsTags":[{"name":"see","text":"[when()](https://developers.arcgis.com/javascript/latest/references/core/views/View/#when)"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"resolution","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Represents the current value of one pixel in the unit of the view's\n[spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#spatialReference).\nThe resolution is calculated by dividing the Scene component's [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#extent) [width](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/#width)\nby its width.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"scale","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"scale","reflectToAttr":false,"docs":"Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#scale)","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"selectionManager","type":"SelectionManager","complexType":{"original":"SelectionManager","resolved":"SelectionManager","references":{"default":{"location":"import","path":"@arcgis/core/views/SelectionManager.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The default [SelectionManager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) for this view. Used to manage selections of features across layers.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"slotGroupRefs","type":"SlotGroupRefs","complexType":{"original":"SlotGroupRefs","resolved":"SlotGroupRefs","references":{"SlotGroupRefs":{"location":"local","path":"support/slots","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"spatialReference","type":"SpatialReference","complexType":{"original":"SpatialReference","resolved":"SpatialReference","references":{"default":{"location":"import","path":"@arcgis/core/geometry/SpatialReference.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [spatial reference](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/) of the view.\nThis indicates the projected or geographic coordinate system used\nto locate geographic features in the map. In a Scene, the following [coordinate systems](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#supported-coordinate-systems) are available.\n\nThe spatial reference can either be set explicitly or automatically derived from the following:\n\n* If the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map) is a [WebScene](https://developers.arcgis.com/javascript/latest/references/core/WebScene/) instance,\nthe [WebScene.initialViewProperties.spatialReference](https://developers.arcgis.com/javascript/latest/references/core/webscene/InitialViewProperties/#spatialReference) is used.\n* Otherwise, the spatial reference is derived from the first layer that loads in this order:\n * [map.basemap.baseLayer](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap)\n * [Map.layers](https://developers.arcgis.com/javascript/latest/references/core/Map/#layers)\n * [map.ground.layers](https://developers.arcgis.com/javascript/latest/references/core/Ground/#layers)\n\n**Notes**\n\n* In case the spatial reference is determined from the map layers or the ground layers and they are in WGS84 or Web Mercator, the following rule also applies: the first layer that does not support server side reprojection (tiled layers) determines the spatial reference of the view and all the other layers are reprojected.\n* If no spatial reference can be derived, then the view does not resolve and the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#ready) property is false.\n* Prior to changing the spatial reference, check if the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/)\nis loaded by calling [projectOperator.isLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#isLoaded) method.\nIf it is not yet loaded, call [projectOperator.load()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) method.","docsTags":[{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\n// Check if the projectOperator is loaded\nif (!projectOperator.isLoaded()) {\n await projectOperator.load();\n}\n// Change the spatial reference of the scene component to GCS2000\nviewElement.spatialReference = new SpatialReference({\n wkid: 4490 //GCS2000\n});\n```"}],"values":[],"optional":true,"required":false},{"name":"stationary","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indication whether the view is animating, being navigated with or resizing.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"suspended","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"suspended","reflectToAttr":true,"docs":"Indicates if the view is visible on the page.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#suspended)","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"theme","type":"Theme | null | undefined","complexType":{"original":"Theme | null | undefined","resolved":"Theme | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/Theme.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property specifies the base colors used by some components to render graphics and labels.\nThis only affects those elements that would otherwise use the default orange pattern.","docsTags":[{"name":"since","text":"4.28"},{"name":"see","text":"[Theme](https://developers.arcgis.com/javascript/latest/references/core/views/Theme/)"},{"name":"see","text":"[Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)"},{"name":"example","text":"// Update the theme to use purple graphics\n// and slightly transparent green text\nview.theme = new Theme({\n accentColor: \"purple\",\n textColor: [125, 255, 13, 0.9]\n});"}],"values":[],"optional":true,"required":false},{"name":"timeExtent","type":"TimeExtent | null | undefined","complexType":{"original":"TimeExtent | null | undefined","resolved":"TimeExtent | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/time/TimeExtent.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view's time extent. Time-aware layers display their temporal data that falls within\nthe view's time extent. Setting the view's time extent is similar to setting the spatial\nextent because once the time extent is set, the\nview updates automatically to conform to the change.","docsTags":[{"name":"since","text":"4.12"},{"name":"example","text":"// Create a csv layer from an online spreadsheet.\nlet csvLayer = new CSVLayer({\n url: \"http://test.com/daily-magazines-sold-in-new-york.csv\",\n timeInfo: {\n startField: \"SaleDate\" // The csv field contains date information.\n }\n});\n\n// Create a mapview showing sales for the last week of March 2019 only.\nconst view = new MapView({\n map: map,\n container: \"viewDiv\",\n timeExtent: {\n start: new Date(\"2019, 2, 24\"),\n end: new Date(\"2019, 2, 31\")\n }\n});"}],"values":[],"optional":true,"required":false},{"name":"updating","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether the view is being updated by additional data requests to the network,\nor by processing received data.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"SceneView","complexType":{"original":"SceneView","resolved":"SceneView","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/) instance created and managed by the component. Accessible once the component is fully loaded.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"viewingMode","type":"\"global\" | \"local\"","complexType":{"original":"\"global\" | \"local\"","resolved":"\"global\" | \"local\"","references":{}},"mutable":true,"attr":"viewing-mode","reflectToAttr":false,"docs":"The viewing mode sets whether the view renders the earth as a sphere (global mode) or on a flat plane (local mode).\n\nNote that the viewing mode must be set before the Scene component loads.\nDepending on the viewing mode different [supported coordinate systems](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#supported-coordinate-systems) are available.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#viewingMode)","docsTags":[{"name":"see","text":"[clippingArea](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#clippingArea)"},{"name":"see","text":"[Sample - Create a local scene](https://developers.arcgis.com/javascript/latest/sample-code/scene-local/)"}],"default":"\"global\"","values":[{"type":"string","value":"global"},{"type":"string","value":"local"}],"optional":true,"required":false},{"name":"viewpoint","type":"Viewpoint","complexType":{"original":"Viewpoint","resolved":"Viewpoint","references":{"default":{"location":"import","path":"@arcgis/core/Viewpoint.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/)\nor point of observation on the view.\n\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#viewpoint)","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visibleArea","type":"Polygon | null | undefined","complexType":{"original":"Polygon | null | undefined","resolved":"Polygon | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Polygon.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The visibleArea represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map) within the view as an instance of a\n[Polygon](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon/).\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#visibleArea)","docsTags":[{"name":"since","text":"4.31"},{"name":"see","text":"[Sample: SceneView - visibleArea](https://developers.arcgis.com/javascript/latest/sample-code/sceneview-visible-area/)"},{"name":"see","text":"[extent](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#extent)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"zoom","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"zoom","reflectToAttr":false,"docs":"Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\nSetting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#zoom)","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false}],"methods":[{"name":"closePopup","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"closePopup(): Promise","parameters":[],"docs":"Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup).","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisScene = document.createElement(\"arcgis-scene\");\ndocument.body.append(arcgisScene);\nawait arcgisScene.componentOnReady();\nconsole.log(\"arcgis-scene is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Destroys the Scene component, and any associated resources, including its [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map), [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup),\nand removes components or other UI DOM elements added to it.","docsTags":[]},{"name":"fetchPopupFeatures","returns":{"type":"Promise>","docs":""},"complexType":{"signature":"(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise>","parameters":[{"name":"hitTarget","type":"ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"FetchPopupFeaturesOptions","docs":""}],"return":"Promise>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"AsyncGenerator":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"ScreenRect":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"FetchPopupFeaturesOptions":{"location":"import","path":"@arcgis/core/views/PopupView.js","id":"notImplemented"}}},"signature":"fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise>","parameters":[{"name":"hitTarget","type":"ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"FetchPopupFeaturesOptions","docs":""}],"docs":"Use this method to query for features at a given screen location. These features come from origins (layers and sublayers) configured with a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [FeatureLayer.popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled) set. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer to control how the input location is handled, and then subsequently, what to do with the results.\n> [!WARNING]\n> Using [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) as the hit target is considered **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** functionality.","docsTags":[{"name":"since","text":"5.1"},{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-map\");\n// Get viewElement's click event\nviewElement.addEventListener(\"arcgisViewClick\", async (event) => {\n const generator = await viewElement.fetchPopupFeatures(event.detail.screenPoint, {\n pointerType: event.detail.pointerType\n });\n // Access the features returned from the generator\n for await (const feature of generator) {\n console.log(feature);\n }\n});\n```"},{"name":"example","text":"```js\n// Wait for all the features to be available\nview.on(\"click\", async (event) => {\n const generator = view.fetchPopupFeatures(event.screenPoint, {\n pointerType: event.pointerType\n });\n\n const features = await Array.fromAsync(generator);\n});"}]},{"name":"goTo","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(target: GoToTarget3D, options?: GoToOptions3D): Promise","parameters":[{"name":"target","type":"GoToTarget3D","docs":""},{"name":"options","type":"GoToOptions3D","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"GoToTarget3D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"},"GoToOptions3D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"goTo(target: GoToTarget3D, options?: GoToOptions3D): Promise","parameters":[{"name":"target","type":"GoToTarget3D","docs":""},{"name":"options","type":"GoToOptions3D","docs":""}],"docs":"Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#goTo)","docsTags":[]},{"name":"hitTest","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(hitTarget: MouseEvent | ScreenPoint | ScreenRect, options?: HitTestOptions3D): Promise","parameters":[{"name":"hitTarget","type":"MouseEvent | ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"HitTestOptions3D","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"SceneViewHitTestResult":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"},"MouseEvent":{"location":"global","path":"global:","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"ScreenRect":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"HitTestOptions3D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"hitTest(hitTarget: MouseEvent | ScreenPoint | ScreenRect, options?: HitTestOptions3D): Promise","parameters":[{"name":"hitTarget","type":"MouseEvent | ScreenPoint | ScreenRect","docs":""},{"name":"options","type":"HitTestOptions3D","docs":""}],"docs":"Returns [hit test results](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#hitTest)","docsTags":[]},{"name":"openPopup","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(options?: ViewPopupOpenOptions): Promise","parameters":[{"name":"options","type":"ViewPopupOpenOptions","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ViewPopupOpenOptions":{"location":"import","path":"@arcgis/core/views/PopupView.js","id":"notImplemented"}}},"signature":"openPopup(options?: ViewPopupOpenOptions): Promise","parameters":[{"name":"options","type":"ViewPopupOpenOptions","docs":""}],"docs":"Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#openPopup)","docsTags":[]},{"name":"takeScreenshot","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(options?: UserSettings): Promise","parameters":[{"name":"options","type":"UserSettings","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"Screenshot":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"},"UserSettings":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"takeScreenshot(options?: UserSettings): Promise","parameters":[{"name":"options","type":"UserSettings","docs":""}],"docs":"Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#takeScreenshot)","docsTags":[]},{"name":"toMap","returns":{"type":"Point | null | undefined","docs":""},"complexType":{"signature":"(screenPoint: MouseEvent | ScreenPoint, options?: HitTestOptions3D): Point | null | undefined","parameters":[{"name":"screenPoint","type":"MouseEvent | ScreenPoint","docs":""},{"name":"options","type":"HitTestOptions3D","docs":""}],"return":"Point | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"},"MouseEvent":{"location":"global","path":"global:","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"HitTestOptions3D":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"signature":"toMap(screenPoint: MouseEvent | ScreenPoint, options?: HitTestOptions3D): Point | null | undefined","parameters":[{"name":"screenPoint","type":"MouseEvent | ScreenPoint","docs":""},{"name":"options","type":"HitTestOptions3D","docs":""}],"docs":"Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).","docsTags":[]},{"name":"toScreen","returns":{"type":"ScreenPoint","docs":""},"complexType":{"signature":"(point: Point): ScreenPoint","parameters":[{"name":"point","type":"Point","docs":""}],"return":"ScreenPoint","references":{"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"}}},"signature":"toScreen(point: Point): ScreenPoint","parameters":[{"name":"point","type":"Point","docs":""}],"docs":"Converts the given [map point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) to a screen point.","docsTags":[]},{"name":"tryFatalErrorRecovery","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"tryFatalErrorRecovery(): Promise","parameters":[],"docs":"Call this method to clear any fatal errors resulting from a lost WebGL context.","docsTags":[]},{"name":"viewOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(callback?: () => void, errback?: (error: Error) => void): Promise","parameters":[{"name":"callback","type":"() => void","docs":""},{"name":"errback","type":"(error: Error) => void","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/core/Error.js","id":"notImplemented"}}},"signature":"viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise","parameters":[{"name":"callback","type":"() => void","docs":""},{"name":"errback","type":"(error: Error) => void","docs":""}],"docs":"`viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.","docsTags":[{"name":"since","text":"4.33"},{"name":"see","text":"[Watch for changes - waiting for components or views to be ready](https://developers.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"},{"name":"example","text":"```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"}]},{"name":"whenAnalysisView","returns":{"type":"Promise>","docs":""},"complexType":{"signature":"(analysis: AnalysisType): Promise>","parameters":[{"name":"analysis","type":"AnalysisType","docs":""}],"return":"Promise>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"AnalysisView3DFor":{"location":"import","path":"@arcgis/core/views/3d/analysis/types.js","id":"notImplemented"},"AnalysisType":{"location":"local","id":"notImplemented"}}},"signature":"whenAnalysisView(analysis: AnalysisType): Promise>","parameters":[{"name":"analysis","type":"AnalysisType","docs":""}],"docs":"Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#whenAnalysisView)","docsTags":[]},{"name":"whenLayerView","returns":{"type":"Promise>","docs":""},"complexType":{"signature":"(layer: TLayer): Promise>","parameters":[{"name":"layer","type":"TLayer","docs":""}],"return":"Promise>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/views/layers/LayerView.js","id":"notImplemented"},"TLayer":{"location":"local","id":"notImplemented"},"LayerView3DFor":{"location":"import","path":"@arcgis/core/views/3d/types.js","id":"notImplemented"}}},"signature":"whenLayerView(layer: TLayer): Promise>","parameters":[{"name":"layer","type":"TLayer","docs":""}],"docs":"Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#whenLayerView)","docsTags":[]},{"name":"zoomIn","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomIn(): Promise","parameters":[],"docs":"Zooms in the view component by a factor of 2.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"zoomOut","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomOut(): Promise","parameters":[],"docs":"Zooms out the view component by a factor of 2.","docsTags":[{"name":"since","text":"5.0"}]}],"events":[{"event":"arcgisLoadError","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when an arcgis-scene fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).","docsTags":[{"name":"since","text":"4.34"},{"name":"see","text":"[loadErrorSources](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#loadErrorSources)"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisLoadError\", () => {\n console.log(viewElement.loadErrorSources);\n});\n```"}]},{"event":"arcgisViewAnalysisViewCreate","detail":"AnalysisViewCreateEvent","bubbles":true,"complexType":{"original":"AnalysisViewCreateEvent","resolved":"AnalysisViewCreateEvent","references":{"AnalysisViewCreateEvent":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-analysis-view-create)","docsTags":[]},{"event":"arcgisViewAnalysisViewCreateError","detail":"AnalysisViewCreateErrorEvent","bubbles":true,"complexType":{"original":"AnalysisViewCreateErrorEvent","resolved":"AnalysisViewCreateErrorEvent","references":{"AnalysisViewCreateErrorEvent":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-analysis-view-create-error)","docsTags":[]},{"event":"arcgisViewAnalysisViewDestroy","detail":"AnalysisViewDestroyEvent","bubbles":true,"complexType":{"original":"AnalysisViewDestroyEvent","resolved":"AnalysisViewDestroyEvent","references":{"AnalysisViewDestroyEvent":{"location":"import","path":"@arcgis/core/views/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-analysis-view-destroy)","docsTags":[]},{"event":"arcgisViewChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"This event is for view related property changes: [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#zoom), [scale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#scale), [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#center), [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#camera), [viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#viewpoint). This event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#stationary) toggles from `true` to `false`.\n\n> The `arcgisViewChange` event may be emitted before the view is fully ready.\n> This means the event can fire before the component's `stationary` property is `true` or before the view has completed its initial setup.\n> For actions that require the view to be ready and stationary, combine this event with checks on the component's `stationary` and `ready` properties.","docsTags":[]},{"event":"arcgisViewClick","detail":"ClickEvent","bubbles":true,"complexType":{"original":"ClickEvent","resolved":"ClickEvent","references":{"ClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-click)","docsTags":[]},{"event":"arcgisViewDoubleClick","detail":"DoubleClickEvent","bubbles":true,"complexType":{"original":"DoubleClickEvent","resolved":"DoubleClickEvent","references":{"DoubleClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-double-click)","docsTags":[]},{"event":"arcgisViewDoubleTapDrag","detail":"DoubleTapDragEvent","bubbles":true,"complexType":{"original":"DoubleTapDragEvent","resolved":"DoubleTapDragEvent","references":{"DoubleTapDragEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires while the pointer is dragged following a double-tap gesture on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-double-tap-drag)","docsTags":[{"name":"since","text":"5.0"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewDoubleTapDrag\", (event) => {\n // Display the distance moved from the drag origin.\n console.log(\"x distance:\", event.detail.x, \"y distance:\", event.detail.y);\n});\n```"}]},{"event":"arcgisViewDrag","detail":"DragEvent","bubbles":true,"complexType":{"original":"DragEvent","resolved":"DragEvent","references":{"DragEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-drag)","docsTags":[]},{"event":"arcgisViewHold","detail":"HoldEvent","bubbles":true,"complexType":{"original":"HoldEvent","resolved":"HoldEvent","references":{"HoldEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-hold)","docsTags":[]},{"event":"arcgisViewImmediateClick","detail":"ImmediateClickEvent","bubbles":true,"complexType":{"original":"ImmediateClickEvent","resolved":"ImmediateClickEvent","references":{"ImmediateClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-immediate-click)","docsTags":[]},{"event":"arcgisViewImmediateDoubleClick","detail":"ImmediateDoubleClickEvent","bubbles":true,"complexType":{"original":"ImmediateDoubleClickEvent","resolved":"ImmediateDoubleClickEvent","references":{"ImmediateDoubleClickEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-immediate-double-click)","docsTags":[]},{"event":"arcgisViewKeyDown","detail":"KeyDownEvent","bubbles":true,"complexType":{"original":"KeyDownEvent","resolved":"KeyDownEvent","references":{"KeyDownEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-key-down)","docsTags":[]},{"event":"arcgisViewKeyUp","detail":"KeyUpEvent","bubbles":true,"complexType":{"original":"KeyUpEvent","resolved":"KeyUpEvent","references":{"KeyUpEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-key-up)","docsTags":[]},{"event":"arcgisViewLayerviewCreate","detail":"LayerViewCreateEvent","bubbles":true,"complexType":{"original":"LayerViewCreateEvent","resolved":"LayerViewCreateEvent","references":{"LayerViewCreateEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-layerview-create)","docsTags":[]},{"event":"arcgisViewLayerviewCreateError","detail":"LayerViewCreateErrorEvent","bubbles":true,"complexType":{"original":"LayerViewCreateErrorEvent","resolved":"LayerViewCreateErrorEvent","references":{"LayerViewCreateErrorEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-layerview-create-error)","docsTags":[]},{"event":"arcgisViewLayerviewDestroy","detail":"LayerViewDestroyEvent","bubbles":true,"complexType":{"original":"LayerViewDestroyEvent","resolved":"LayerViewDestroyEvent","references":{"LayerViewDestroyEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-layerview-destroy)","docsTags":[]},{"event":"arcgisViewMouseWheel","detail":"ViewMouseWheelEvent","bubbles":true,"complexType":{"original":"ViewMouseWheelEvent","resolved":"ViewMouseWheelEvent","references":{"ViewMouseWheelEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-mouse-wheel)","docsTags":[]},{"event":"arcgisViewPointerDown","detail":"PointerDownEvent","bubbles":true,"complexType":{"original":"PointerDownEvent","resolved":"PointerDownEvent","references":{"PointerDownEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-down)","docsTags":[]},{"event":"arcgisViewPointerEnter","detail":"PointerEnterEvent","bubbles":true,"complexType":{"original":"PointerEnterEvent","resolved":"PointerEnterEvent","references":{"PointerEnterEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-enter)","docsTags":[]},{"event":"arcgisViewPointerLeave","detail":"PointerLeaveEvent","bubbles":true,"complexType":{"original":"PointerLeaveEvent","resolved":"PointerLeaveEvent","references":{"PointerLeaveEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-leave)","docsTags":[]},{"event":"arcgisViewPointerMove","detail":"PointerMoveEvent","bubbles":true,"complexType":{"original":"PointerMoveEvent","resolved":"PointerMoveEvent","references":{"PointerMoveEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-move)","docsTags":[]},{"event":"arcgisViewPointerUp","detail":"PointerUpEvent","bubbles":true,"complexType":{"original":"PointerUpEvent","resolved":"PointerUpEvent","references":{"PointerUpEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-up)","docsTags":[]},{"event":"arcgisViewReadyChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map) property is changed.","docsTags":[]},{"event":"arcgisViewReadyError","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires if the view encounters a content or rendering error.","docsTags":[{"name":"since","text":"4.34"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewReadyError\", () => {\n // handle error\n});\n```"}]},{"event":"arcgisViewVerticalTwoFingerDrag","detail":"VerticalTwoFingerDragEvent","bubbles":true,"complexType":{"original":"VerticalTwoFingerDragEvent","resolved":"VerticalTwoFingerDragEvent","references":{"VerticalTwoFingerDragEvent":{"location":"import","path":"@arcgis/core/views/input/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires while the two pointers are dragged vertically on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-vertical-two-finger-drag)","docsTags":[{"name":"since","text":"5.0"},{"name":"example","text":"```js\nviewElement.addEventListener(\"arcgisViewVerticalTwoFingerDrag\", (event) => {\n // Display the distance moved vertically from the drag origin.\n console.log(\"y distance:\", event.detail.y);\n});\n```"}]}],"styles":[{"name":"--arcgis-layout-overlay-space-top","annotation":"prop","docs":"_Since 4.34_ Specifies the top padding for the layout."},{"name":"--arcgis-layout-overlay-space-bottom","annotation":"prop","docs":"_Since 4.34_ Specifies the bottom padding for the layout."},{"name":"--arcgis-layout-overlay-space-left","annotation":"prop","docs":"_Since 4.34_ Specifies the left padding for the layout."},{"name":"--arcgis-layout-overlay-space-right","annotation":"prop","docs":"_Since 4.34_ Specifies the right padding for the layout."},{"name":"--arcgis-view-color-focus","annotation":"prop","docs":"_Since 5.0_ Specifies the focus outline color for the view."},{"name":"--arcgis-table-row-background-color","annotation":"prop","docs":"_Since 5.1_ Specifies the background color for table rows."},{"name":"--arcgis-table-row-alt-background-color","annotation":"prop","docs":"_Since 5.1_ Specifies the background color for alternate table rows."}],"slots":[{"name":"","docs":"Default slot for adding components to the scene. User is responsible for positioning the content via CSS."},{"name":"top-left","docs":"Slot for components positioned in the top-left corner."},{"name":"top-right","docs":"Slot for components positioned in the top-right corner."},{"name":"bottom-left","docs":"Slot for components positioned in the bottom-left corner."},{"name":"bottom-right","docs":"Slot for components positioned in the bottom-right corner."},{"name":"top-start","docs":"Slot for components positioned at the top-start (top-left in LTR, top-right in RTL)."},{"name":"top-end","docs":"Slot for components positioned at the top-end (top-right in LTR, top-left in RTL)."},{"name":"bottom-start","docs":"Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL)."},{"name":"bottom-end","docs":"Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."},{"name":"popup","docs":"Slot for the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot."}],"parts":[],"listeners":[]},{"filePath":"src/components/search/search.tsx","tag":"arcgis-search","overview":"","readme":"","usage":{},"docs":"The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\n`findAddressCandidates` operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.\n\nFor popups, we recommend using either [popup-component-enabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled),\nor adding the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) to your view components as a best practice.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n\nStarting with version `5.1`, on [@arcgisSelectResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#event-arcgisSelectResult) the selected search result is announced to assistive technologies. Visit the [Accessibility guide](https://developers.arcgis.com/javascript/latest/accessibility/#assistive-technologies) to learn more\nabout live announcements supporting more audiences.","docsTags":[{"name":"see","text":"[Sample - Search component with multiple sources](https://developers.arcgis.com/javascript/latest/sample-code/search-component-multisource/)"},{"name":"see","text":"[Sample - Search component with custom source](https://developers.arcgis.com/javascript/latest/sample-code/search-component-customsource/)"},{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"activeMenu","type":"ActiveMenu","complexType":{"original":"ActiveMenu","resolved":"ActiveMenu","references":{"ActiveMenu":{"location":"local","path":"components/arcgis-search/types","id":"notImplemented"}}},"mutable":true,"attr":"active-menu","reflectToAttr":false,"docs":"The current active menu of the Search component.","docsTags":[],"default":"\"none\"","values":[{"type":"string","value":"source"},{"type":"string","value":"none"},{"type":"string","value":"suggestion"}],"optional":true,"required":false},{"name":"activeSource","type":"null | undefined | (LayerSearchSource | LocatorSearchSource)","complexType":{"original":"null | undefined | (LayerSearchSource | LocatorSearchSource)","resolved":"null | undefined | (LayerSearchSource | LocatorSearchSource)","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Search/LocatorSearchSource.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [sources](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#sources) object currently selected. Can be either a\n[LayerSearchSource](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/LayerSearchSource/) or a [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/LocatorSearchSource/).","docsTags":[{"name":"readonly","text":""}],"default":"null","values":[],"optional":true,"required":false},{"name":"activeSourceIndex","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"active-source-index","reflectToAttr":false,"docs":"The selected source's index. This value is `-1` when all sources are selected.","docsTags":[],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"allPlaceholder","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"all-placeholder","reflectToAttr":false,"docs":"String value used as a hint for input text when searching on multiple sources. See\nthe image below to view the location and style of this text in the context of the component.\n\n![search-allPlaceholder](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-allplaceholder.avif)","docsTags":[],"default":"\"Find address or place\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"allSources","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"SupportedSearchSource":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The combined collection of [defaultSources](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/SearchViewModel/#defaultSources)\nand [sources](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/SearchViewModel/#sources).\nThe [defaultSources](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/SearchViewModel/#defaultSources)\ndisplays first in the Search UI.","docsTags":[{"name":"since","text":"4.8"},{"name":"readonly","text":""}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"autoNavigateDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-navigate-disabled","reflectToAttr":false,"docs":"Indicates whether to automatically navigate to the selected result. If `true`, will not automatically navigate to the selected result.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"autoSelectDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-select-disabled","reflectToAttr":false,"docs":"By default, the component will automatically select and zoom to the first geocoded result. When `true`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [@arcgisSearchComplete](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#event-arcgisSearchComplete) event handler and get the results\nthrough the event object.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"defaultSources","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"SupportedSearchSource":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A read-only property that is a [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/)\nof [LayerSearchSource](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/LayerSearchSource/)\nand/or [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/LocatorSearchSource/). This property\nmay contain [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/)\n[locators](https://doc.esri.com/en/arcgis-enterprise/latest/administer/geocode-services.html)\nand any web map or web scene [configurable search sources](http://doc.arcgis.com/en/arcgis-online/create-maps/configure-feature-search.htm).\nWeb maps or web scenes may contain\n[map](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/)/[feature](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) service feature\nlayer(s), and/or [table(s)](https://developers.arcgis.com/javascript/latest/references/core/webdoc/applicationProperties/SearchTable/) as sources.\n\nThis property is used to populate the Search UI if the [sources](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/SearchViewModel/#sources) property is not set.","docsTags":[{"name":"since","text":"4.8"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | null | undefined","complexType":{"original":"GoToOverride | null | undefined","resolved":"GoToOverride | null | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"search\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"includeDefaultSourcesDisabled","type":"boolean | SourcesHandler","complexType":{"original":"boolean | SourcesHandler","resolved":"boolean | SourcesHandler","references":{"SourcesHandler":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"mutable":true,"attr":"include-default-sources-disabled","reflectToAttr":false,"docs":"When `true`, will not include [defaultSources](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/SearchViewModel/#defaultSources) in the Search UI.","docsTags":[],"default":"false","values":[{"type":"boolean"},{"type":"object"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"locationDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"location-disabled","reflectToAttr":false,"docs":"When `true`, will disable location services within the component.\n\n![locationDisabled](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-locationEnabled.avif)\n\n**Note:**\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"maxResults","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-results","reflectToAttr":false,"docs":"The maximum number of results returned by the component if not specified by the source.","docsTags":[],"default":"6","values":[{"type":"number"}],"optional":true,"required":false},{"name":"maxSuggestions","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-suggestions","reflectToAttr":false,"docs":"The maximum number of suggestions returned by the component if not specified by the source.\n\nIf working with the default\n[ArcGIS Online Geocoding service](https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm),\nthe default remains at `5`.","docsTags":[],"default":"6","values":[{"type":"number"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"minSuggestCharacters","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-suggest-characters","reflectToAttr":false,"docs":"The minimum number of characters needed for the search if not specified by the source.","docsTags":[],"default":"3","values":[{"type":"number"}],"optional":true,"required":false},{"name":"popupDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"popup-disabled","reflectToAttr":false,"docs":"By default, the graphic can be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/).\nWhen `true`, disables displaying the [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/) on feature click.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"popupTemplate","type":"PopupTemplate | null | undefined","complexType":{"original":"PopupTemplate | null | undefined","resolved":"PopupTemplate | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/PopupTemplate.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A customized [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) for the selected feature.\nNote that any [templates](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)\ndefined on [allSources](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#allSources) take precedence over those defined directly on the template.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"portal","type":"Portal | null | undefined","complexType":{"original":"Portal | null | undefined","resolved":"Portal | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/portal/Portal.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"It is possible to search a specified portal instance's [locator services](https://doc.esri.com/en/arcgis-enterprise/latest/administer/configure-portal-to-geocode-addresses.html)\nUse this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.","docsTags":[{"name":"since","text":"4.8"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"resultGraphic","type":"Graphic | null | undefined","complexType":{"original":"Graphic | null | undefined","resolved":"Graphic | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The graphic used to highlight the resulting feature or location.\n\n**Note:**\nA graphic will be placed in the View's\n[graphics](https://developers.arcgis.com/javascript/latest/references/core/views/View/#graphics)\nfor [layer](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\nthat do not support the `highlight` method.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"resultGraphicDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"result-graphic-disabled","reflectToAttr":false,"docs":"If `true`, the [resultGraphic](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#resultGraphic) will not display at the\nlocation of the selected feature.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"results","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SearchResults":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of objects, each containing a [SearchResult](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/types/#SearchResult) from the search.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"searchAllDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"search-all-disabled","reflectToAttr":false,"docs":"By default, the \"All\" option is displayed by default to search all sources:\n\n![search-searchAllDisabled-true](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-enablesearchingall-true.avif)\n\nWhen `true`, no option to search all sources at once is available:\n\n![search-searchAllDisabled-false](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-enablesearchingall-false.avif)","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"searchTerm","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"search-term","reflectToAttr":false,"docs":"The value of the search box input text string.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"selectedResult","type":"SearchResult | null | undefined","complexType":{"original":"SearchResult | null | undefined","resolved":"SearchResult | null | undefined","references":{"SearchResult":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The result selected from a search.","docsTags":[{"name":"see","text":"[SearchResult](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/types/#SearchResult)"},{"name":"see","text":"[select()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/SearchViewModel/#select)"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"sources","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"SupportedSearchSource":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The Search component may be used to search features in a\n[map](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/)/[feature](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) service feature\nlayer(s), [SceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/) with an associated feature layer,\n[BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingComponentSublayer/) with an associated feature layer,\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/), [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/) or\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OGCFeatureLayer/), or [table](https://developers.arcgis.com/javascript/latest/references/core/webdoc/applicationProperties/SearchTable/),\nor geocode locations with a [locator](https://developers.arcgis.com/javascript/latest/references/core/rest/locator/). The `sources` property defines the sources from which\nto search for the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#view) specified by the Search component instance. There are two types of sources:\n\n* [LayerSearchSource](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/LayerSearchSource/)\n* [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/LocatorSearchSource/)\n\nAny combination of these sources may be used\ntogether in the same instance of the Search component.\n\n**Note:** Feature layers created from client-side graphics are not supported.","docsTags":[{"name":"example","text":"// Default sources[] when sources is not specified\n[\n {\n url: \"https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer\",\n singleLineFieldName: \"SingleLine\",\n outFields: [\"Addr_type\"],\n name: \"ArcGIS World Geocoding Service\",\n placeholder: \"Adresse\",\n resultSymbol: {\n type: \"picture-marker\", // autocasts as new PictureMarkerSymbol()\n url: this.basePath + \"/images/search/search-symbol-32.png\",\n size: 24,\n width: 24,\n height: 24,\n xoffset: 0,\n yoffset: 0\n }\n }\n]"},{"name":"example","text":"// Example of multiple sources[]\nlet sources = [\n{\n url: \"https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer\",\n singleLineFieldName: \"SingleLine\",\n name: \"Custom Geocoding Service\",\n placeholder: \"Search Geocoder\",\n maxResults: 3,\n maxSuggestions: 6,\n suggestionsEnabled: false,\n minSuggestCharacters: 0\n}, {\n layer: new FeatureLayer({\n url: \"https://services.arcgis.com/DO4gTjwJVIJ7O9Ca/arcgis/rest/services/GeoForm_Survey_v11_live/FeatureServer/0\",\n outFields: [\"*\"]\n }),\n searchFields: [\"Email\", \"URL\"],\n displayField: \"Email\",\n exactMatch: false,\n outFields: [\"*\"],\n name: \"Point FS\",\n placeholder: \"example: esri\",\n maxResults: 6,\n maxSuggestions: 6,\n suggestionsEnabled: true,\n minSuggestCharacters: 0\n},\n{\n layer: new FeatureLayer({\n outFields: [\"*\"]\n });\n placeholder: \"esri\",\n name: \"A FeatureLayer\",\n prefix: \"\",\n suffix: \"\",\n maxResults: 1,\n maxSuggestions: 6,\n exactMatch: false,\n searchFields: [], // defaults to FeatureLayer.displayField\n displayField: \"\", // defaults to FeatureLayer.displayField\n minSuggestCharacters: 0\n}\n];"},{"name":"example","text":"let sources = [{ ... }, { ... }, { ... }]; // array of sources\nsearchViewModel.sources = sources;\n\n// Add to source(s)\nsearchViewModel.sources.push({ ... }); // new source"}],"values":[],"optional":true,"required":false},{"name":"state","type":"SearchViewModelState","complexType":{"original":"SearchViewModelState","resolved":"SearchViewModelState","references":{"SearchViewModelState":{"location":"import","path":"@arcgis/core/widgets/Search/SearchViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"since","text":"4.8"},{"name":"readonly","text":""}],"default":"\"ready\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"searching"}],"optional":true,"required":false},{"name":"suggestions","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SuggestResults":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of results from the [suggest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#suggest).\n\nThis is available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a\n10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"suggestionsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"suggestions-disabled","reflectToAttr":false,"docs":"If `true`, disables suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"topLayerDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"top-layer-disabled","reflectToAttr":false,"docs":"When true, disables rendering in the top layer (above overlays and modals).\nThis can be useful for controlling stacking context in complex UI layouts.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-search component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"clear(): void","parameters":[],"docs":"Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSearch = document.createElement(\"arcgis-search\");\ndocument.body.append(arcgisSearch);\nawait arcgisSearch.componentOnReady();\nconsole.log(\"arcgis-search is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"search","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(searchItem?: Graphic | null | undefined | number[] | Point | SuggestResult | string): Promise","parameters":[{"name":"searchItem","type":"Graphic | null | undefined | number[] | Point | SuggestResult | string","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"SearchResponse":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/geometry/Point.js","id":"notImplemented"},"SuggestResult":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"signature":"search(searchItem?: Graphic | null | undefined | number[] | Point | SuggestResult | string): Promise","parameters":[{"name":"searchItem","type":"Graphic | null | undefined | number[] | Point | SuggestResult | string","docs":""}],"docs":"Depending on the sources specified, search() queries the feature layer(s) and/or performs\naddress matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/references/core/rest/locator/) and\nreturns any applicable results.","docsTags":[]},{"name":"setFocus","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setFocus(): Promise","parameters":[],"docs":"Brings focus to the component's text input.","docsTags":[]},{"name":"suggest","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(query?: string): Promise","parameters":[{"name":"query","type":"string","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"SuggestResponse":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"signature":"suggest(query?: string): Promise","parameters":[{"name":"query","type":"string","docs":""}],"docs":"Performs a suggest() request on the active Locator. It also uses the current value of\nthe component or one that is passed in.\n\nSuggestions are available if working with a 10.3 or greater geocoding service that has\n[suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.\n`supportsPagination = true`.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSearchClear","detail":"SearchViewModelEvents[\"search-clear\"]","bubbles":true,"complexType":{"original":"SearchViewModelEvents[\"search-clear\"]","resolved":"SearchViewModelEvents[\"search-clear\"]","references":{"SearchViewModelEvents":{"location":"import","path":"@arcgis/core/widgets/Search/SearchViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a result is cleared from the input box or a new result is selected.","docsTags":[]},{"event":"arcgisSearchComplete","detail":"SearchResponse","bubbles":true,"complexType":{"original":"SearchResponse","resolved":"SearchResponse","references":{"SearchResponse":{"location":"import","path":"@arcgis/core/widgets/Search/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the [search()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#search) method is called and returns its results.","docsTags":[]},{"event":"arcgisSearchStart","detail":"SearchViewModelEvents[\"search-start\"]","bubbles":true,"complexType":{"original":"SearchViewModelEvents[\"search-start\"]","resolved":"SearchViewModelEvents[\"search-start\"]","references":{"SearchViewModelEvents":{"location":"import","path":"@arcgis/core/widgets/Search/SearchViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the [search()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#search) method starts.","docsTags":[]},{"event":"arcgisSelectResult","detail":"SearchViewModelSelectResultEvent","bubbles":true,"complexType":{"original":"SearchViewModelSelectResultEvent","resolved":"SearchViewModelSelectResultEvent","references":{"SearchViewModelSelectResultEvent":{"location":"import","path":"@arcgis/core/widgets/Search/SearchViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a search result is selected.","docsTags":[]},{"event":"arcgisSuggestComplete","detail":"SearchViewModelEvents[\"suggest-complete\"]","bubbles":true,"complexType":{"original":"SearchViewModelEvents[\"suggest-complete\"]","resolved":"SearchViewModelEvents[\"suggest-complete\"]","references":{"SearchViewModelEvents":{"location":"import","path":"@arcgis/core/widgets/Search/SearchViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the [suggest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#suggest) method is called and returns its results.","docsTags":[]},{"event":"arcgisSuggestStart","detail":"SearchViewModelEvents[\"suggest-start\"]","bubbles":true,"complexType":{"original":"SearchViewModelEvents[\"suggest-start\"]","resolved":"SearchViewModelEvents[\"suggest-start\"]","references":{"SearchViewModelEvents":{"location":"import","path":"@arcgis/core/widgets/Search/SearchViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the [suggest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#suggest) method starts.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/search-result-renderer/search-result-renderer.tsx","tag":"arcgis-search-result-renderer","overview":"","readme":"","usage":{},"docs":"The Search Result Renderer renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search-result-renderer/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"messages","type":"ArcgisSearch[\"messages\"] | undefined","complexType":{"original":"ArcgisSearch[\"messages\"] | undefined","resolved":"ArcgisSearch[\"messages\"] | undefined","references":{"ArcgisSearch":{"location":"local","path":"components/arcgis-search","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"viewModel","type":"SearchViewModel | undefined","complexType":{"original":"SearchViewModel | undefined","resolved":"SearchViewModel | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Search/SearchViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSearchResultRenderer = document.createElement(\"arcgis-search-result-renderer\");\ndocument.body.append(arcgisSearchResultRenderer);\nawait arcgisSearchResultRenderer.componentOnReady();\nconsole.log(\"arcgis-search-result-renderer is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/shadow-cast/shadow-cast.tsx","tag":"arcgis-shadow-cast","overview":"","readme":"","usage":{},"docs":"The Shadow Cast component visualizes shadows cast by 3D features or sunlight exposure in an\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). This is helpful in urban development, where projects may need to satisfy shadow or\nsunlight exposure requirements for a selected day and time range.\n\n[![shadow cast component](https://developers.arcgis.com/javascript/latest/assets/references/core/analysis/shadow-cast-analysis-duration.avif)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nBy default, the component visualizes shadows. When [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`,\nit visualizes sunlight exposure instead.\n\nThe component provides controls for the date, time range, timezone, visualization mode, colors, intervals, and whether\nto visualize shadows or sunlight.\n\nThe [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date), [startTimeOfDay](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#startTimeOfDay),\n[endTimeOfDay](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#endTimeOfDay), and [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#utcOffset) properties\ndefine the date, time range, and UTC offset used to compute the analysis overlay. They do not change the lighting in\nthe scene. To control scene lighting, use the [arcgis-daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/) component.\n\nThe [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#utcOffset) property determines which timezone the selected date and time range\nare interpreted in for the analysis. This differs from the Daylight component, where selecting a timezone updates the\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) date and time according to the camera position.\n\nThe [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) property controls how shadow or sunlight exposure is visualized:\n\n| Mode | Use for | Details |\n| --- | --- | --- |\n| `min-duration` | Highlighting areas that meet or exceed a minimum shadow or sunlight duration. | The threshold is defined by [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration). |\n| `total-duration` | Showing cumulative shadow or sunlight duration across the analysis area. | Supports continuous visualization or 1-hour intervals. Areas with no duration remain transparent, intermediate values are interpolated, and the highest duration uses the opacity from [totalDurationColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#totalDurationColor). |\n| `discrete` | Displaying individual shadow or sunlight samples at regular intervals. | The interval is defined by [discreteInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#discreteInterval). For example, a one-hour range with a 30-minute interval displays samples at the start, middle, and end of the range. |\n\nHovering over the scene displays a tooltip showing the shadow or sunlight duration at that location, rounded to\n15-minute intervals. To disable this tooltip, set\n[hideShadowDurationTooltip](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#hideShadowDurationTooltip) to `true`.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n* Terrain does not cast shadows in this analysis.\n* As a result, shadow duration may be underestimated and sunlight duration may be overestimated in areas where terrain\nwould normally block sunlight. To avoid incorrect visualization, `startTimeOfDay` should be set after local sunrise\nand `endTimeOfDay` before local sunset.\n* The analysis does not take daylight savings into account. Use the timezone picker to adjust the offset from the\nCoordinated Universal Time (UTC) and account for daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might\nnot be accurate. In case of an inaccurate timezone, users can set it manually using the timezone picker.\n\n**See also**\n\n- [Sample - Shadow Cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n- [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/)","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"analysis","type":"ShadowCastAnalysis","complexType":{"original":"ShadowCastAnalysis","resolved":"ShadowCastAnalysis","references":{"default":{"location":"import","path":"@arcgis/core/analysis/ShadowCastAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Shadow Cast component to the [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the [arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses)\ncollection.\nYou can then wait for the [ShadowCastAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/)\nto be created before accessing the analysis results.\n\n```js\n// Get the Scene component and the Shadow Cast component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst shadowCastElement = document.querySelector(\"arcgis-shadow-cast\");\nawait shadowCastElement.componentOnReady();\n\n// Get the ShadowCastAnalysis created by the Shadow Cast component.\nconst analysis = shadowCastElement.analysis;\n\n// Get the ShadowCastAnalysisView3D.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\n\n// Click in the Scene and get the shadow or sunlight duration at that specific point.\nviewElement.addEventListener(\"arcgisViewClick\", async (event) => {\n const screenPoint = { x: event.detail.x, y: event.detail.y };\n const duration = await analysisView.getDurationAtScreen(screenPoint);\n console.log(\"Duration (milliseconds):\", duration);\n});\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\nUse this property to configure analysis options that are not exposed by the component UI. For example, the component\ndoes not provide UI controls for setting a polygonal analysis area or custom color stops; configure those directly\non the analysis.\n\nAlternatively, a programmatically created [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.\n\n```js\n// Create the ShadowCastAnalysis.\nconst analysis = new ShadowCastAnalysis();\n\n// Get the Scene component and the Shadow Cast component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst shadowCastElement = document.querySelector(\"arcgis-shadow-cast\");\nawait shadowCastElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Scene component.\nviewElement.analyses.add(analysis);\n\n// Connect the analysis to the shadow cast component.\nshadowCastElement.analysis = analysis;\n```","docsTags":[{"name":"since","text":"5.0"}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"date","type":"Date | number | string","complexType":{"original":"Date | number | string","resolved":"Date | number | string","references":{"Date":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"attr":"date","reflectToAttr":false,"docs":"The calendar date used to calculate the shadow or sunlight visualization. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)","docsTags":[],"values":[{"type":"string"},{"type":"number"},{"type":"object"}],"optional":true,"required":false},{"name":"discreteColor","type":"Color","complexType":{"original":"Color","resolved":"Color","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Color of the visualization in `\"discrete\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). The opacity of the\nvisualization is mapped to the number of overlapping shadow or sunlight samples. No duration corresponds to opacity\n0 and the maximum sample count corresponds to the opacity set in this color value. The component UI exposes a single\ncolor for this mode.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"discreteInterval","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"discrete-interval","reflectToAttr":false,"docs":"Individual shadow or sunlight samples are displayed at this time interval in `\"discrete\"`\n[mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode), starting with the start time of day. The interval is expressed in\nmilliseconds. If set to 0, the analysis uses the smallest possible interval, up to a maximum of 255 samples.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"endTimeOfDay","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"end-time-of-day","reflectToAttr":false,"docs":"Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date)) when the shadow or sunlight computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#endTimeOfDay)","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the component title.","docsTags":[],"default":"4","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideDatePicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-date-picker","reflectToAttr":false,"docs":"If true, the date picker will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDiscreteColorPicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-discrete-color-picker","reflectToAttr":false,"docs":"If true, the color picker will be hidden in the discrete mode options.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDiscreteInterval","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-discrete-interval","reflectToAttr":false,"docs":"If true, the interval selector will be hidden in the discrete mode options.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDiscreteOptions","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-discrete-options","reflectToAttr":false,"docs":"If true, the visualization options will be hidden in discrete mode.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMinDurationColorPicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-min-duration-color-picker","reflectToAttr":false,"docs":"If true, the color picker will be hidden in the minimum duration mode options.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMinDurationContextColorPicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-min-duration-context-color-picker","reflectToAttr":false,"docs":"If true, the color picker will be hidden in the context options in minimum duration mode.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMinDurationContextInterval","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-min-duration-context-interval","reflectToAttr":false,"docs":"If true, the interval selector will be hidden in the context options in minimum duration mode.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMinDurationContextOptions","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-min-duration-context-options","reflectToAttr":false,"docs":"If true, the context options will be hidden in the minimum duration mode options.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMinDurationContextToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-min-duration-context-toggle","reflectToAttr":false,"docs":"If true, the toggle used to show or hide the context options will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMinDurationOptions","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-min-duration-options","reflectToAttr":false,"docs":"If true, the visualization options will be hidden in minimum duration mode.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMinDurationSlider","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-min-duration-slider","reflectToAttr":false,"docs":"If true, the minimum duration slider will be hidden in the minimum duration mode options.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideShadowDurationTooltip","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-shadow-duration-tooltip","reflectToAttr":false,"docs":"If true, the tooltip which displays the shadow or sunlight duration at a certain location will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTimeRangeSlider","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-time-range-slider","reflectToAttr":false,"docs":"If true, the time range slider will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTimezone","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-timezone","reflectToAttr":false,"docs":"If true, the timezone picker will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTotalDurationColorPicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-total-duration-color-picker","reflectToAttr":false,"docs":"If true, the color picker will be hidden in the total duration mode options.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTotalDurationModeSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-total-duration-mode-select","reflectToAttr":false,"docs":"If true, the mode selector will be hidden in the total duration mode options.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTotalDurationOptions","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-total-duration-options","reflectToAttr":false,"docs":"If true, the visualization options will be hidden in the total duration mode.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualization","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization","reflectToAttr":false,"docs":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualizationOptions","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization-options","reflectToAttr":false,"docs":"If true, the visualization options will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"measure-building-height-shadow\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"maxMinDuration","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-min-duration","reflectToAttr":false,"docs":"Maximum allowed value for the [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration) property, in milliseconds.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"minDuration","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-duration","reflectToAttr":false,"docs":"The minimum duration (in milliseconds) used in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) to\ndetermine which shadowed or sunlit areas are displayed.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"minDurationColor","type":"Color","complexType":{"original":"Color","resolved":"Color","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Color of the visualization in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). Areas with cumulative\nshadow or sunlight time longer than the minimum duration value are displayed with this color.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"minDurationContextColor","type":"Color","complexType":{"original":"Color","resolved":"Color","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The color used when showing additional context in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) when\n[minDurationContextEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextEnabled) is true. This context applies to shadow\nvisualization and is not used when [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"minDurationContextEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"min-duration-context-enabled","reflectToAttr":false,"docs":"Whether to enable additional context showing discrete shadows at the same time as displaying shadows above a\nminimum duration when in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). The [minDurationContextColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextColor)\nand [minDurationContextInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextInterval) properties are used to configure the visualization of the\ndiscrete shadows when context is enabled. This context is hidden when\n[visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true` because the equivalent sunlight context would show\nbroad areas not in shadow at each sample and can obscure the threshold result.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"minDurationContextInterval","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-duration-context-interval","reflectToAttr":false,"docs":"The interval in milliseconds used when showing additional context in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) when\n[minDurationContextEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextEnabled) is true. This context applies to shadow\nvisualization and is not used when [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"minMinDuration","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-min-duration","reflectToAttr":false,"docs":"Minimum allowed value for the [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration) property, in milliseconds.","docsTags":[{"name":"since","text":"5.0"}],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"mode","type":"ShadowCastMode","complexType":{"original":"ShadowCastMode","resolved":"ShadowCastMode","references":{"ShadowCastMode":{"location":"import","path":"@arcgis/core/analysis/ShadowCast/types.js","id":"notImplemented"}}},"mutable":true,"attr":"mode","reflectToAttr":false,"docs":"Mode of analysis to use when computing and displaying shadows or sunlight.\n\n- `\"discrete\"`: Displays individual shadow or sunlight snapshots at regular time intervals within the selected time range.\n- `\"min-duration\"`: Displays areas where accumulated shadow or sunlight exceeds a user-defined minimum duration within the selected time range. When visualizing shadows, optional discrete shadow overlays can provide additional context.\n- `\"total-duration\"`: Displays total shadow or sunlight accumulation within the selected time range. Supports continuous or 1-hour aggregated modes.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"discrete"},{"type":"string","value":"min-duration"},{"type":"string","value":"total-duration"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"startTimeOfDay","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"start-time-of-day","reflectToAttr":false,"docs":"Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date)) when the shadow or sunlight computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#startTimeOfDay)","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"state","type":"\"disabled\" | \"ready\"","complexType":{"original":"\"disabled\" | \"ready\"","resolved":"\"disabled\" | \"ready\"","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"totalDurationColor","type":"Color","complexType":{"original":"Color","resolved":"Color","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Color of the visualization in `\"total-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). The opacity is mapped\nto the time spent in shadow or sunlight. Areas with no duration are displayed with zero opacity and areas with the\nmaximum duration use the opacity specified in this property. The component UI exposes a single color for this mode.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"totalDurationMode","type":"ShadowCastTotalDurationMode","complexType":{"original":"ShadowCastTotalDurationMode","resolved":"ShadowCastTotalDurationMode","references":{"ShadowCastTotalDurationMode":{"location":"import","path":"@arcgis/core/analysis/ShadowCast/types.js","id":"notImplemented"}}},"mutable":true,"attr":"total-duration-mode","reflectToAttr":false,"docs":"Mode in which the cumulative shadow or sunlight duration should be displayed in `\"total-duration\"`\n[mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode): as a continuous surface or as an hourly aggregation of values.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"continuous"},{"type":"string","value":"hourly"}],"optional":true,"required":false},{"name":"utcOffset","type":"number | null | undefined","complexType":{"original":"number | null | undefined","resolved":"number | null | undefined","references":{}},"mutable":true,"attr":"utc-offset","reflectToAttr":false,"docs":"The UTC offset in hours used to interpret the selected date and time range for the analysis. If not specified, the\ncomponent automatically determines an approximate UTC offset based on the camera location.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-shadow-cast component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualizeSunlight","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"visualize-sunlight","reflectToAttr":false,"docs":"When `true`, the component visualizes sunlight duration instead of shadow duration. This applies to all modes,\ntheir respective options, and the duration returned by\n[getDurationAtScreen()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#getDurationAtScreen). In sunlight mode, the discrete context controls in the\n`\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) are hidden because the equivalent sunlight context\nwould show broad areas not in shadow at each sample and can obscure the threshold result.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#visualizeSunlight)","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"visualScale","type":"\"l\" | \"m\" | \"s\"","complexType":{"original":"\"l\" | \"m\" | \"s\"","resolved":"\"l\" | \"m\" | \"s\"","references":{}},"mutable":true,"attr":"visual-scale","reflectToAttr":true,"docs":"Specifies the size of the component.","docsTags":[{"name":"experimental"},{"name":"since","text":"5.0"}],"default":"\"m\"","values":[{"type":"string","value":"l"},{"type":"string","value":"m"},{"type":"string","value":"s"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisShadowCast = document.createElement(\"arcgis-shadow-cast\");\ndocument.body.append(arcgisShadowCast);\nawait arcgisShadowCast.componentOnReady();\nconsole.log(\"arcgis-shadow-cast is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"getDurationAtScreen","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(point: ScreenPoint): Promise","parameters":[{"name":"point","type":"ScreenPoint","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ScreenPoint":{"location":"import","path":"@arcgis/core/core/types.js","id":"notImplemented"}}},"signature":"getDurationAtScreen(point: ScreenPoint): Promise","parameters":[{"name":"point","type":"ScreenPoint","docs":""}],"docs":"Returns the duration (in milliseconds) for a certain point on the screen based on the current analysis settings.\nBy default, this method returns the time spent in shadow. When\n[visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`, this method returns the time spent in sunlight.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/#getDurationAtScreen)","docsTags":[{"name":"since","text":"5.0"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/sketch/sketch.tsx","tag":"arcgis-sketch","overview":"","readme":"","usage":{},"docs":"The Sketch component provides a simple UI for creating and updating graphics on a [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) or a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"activeTool","type":"SketchTool | SelectionTool | null","complexType":{"original":"SketchTool | SelectionTool | null","resolved":"SketchTool | SelectionTool | null","references":{"SketchTool":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"},"SelectionTool":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"attr":"active-tool","reflectToAttr":true,"docs":"When creating new graphics (for example after [create()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#create) has been called),\nthis property reflects the create tool being used. When updating graphics\n(for example after [update()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#update) has been called), this property reflects the\nupdate tool being used. If no create or update operation is in progress, this is `null`.\n\nPrior to 4.32, creation tools were modeled as a combination of a geometry type (point, line, polygon)\nand an interaction mode (click, freehand, hybrid).\nAt 4.32, the available create tools were expanded to include \"freehandPolyline\" and \"freehandPolygon\".\nThese tools are made available to enable interoperability with other components of the ArcGIS system,\nwhere freehand polyline is a distinct create tool from polyline.\n\nTo minimize compatibility issues, if \"freehandPolyline\" and \"freehandPolygon\" are not in the list\nof available create tools, they will not be returned by this property, even if the user is drawing a\npolygon in freehand mode.\n\nTo opt in to freehandPolyline and freehandPolygon tools, include them when setting availableCreateTools,\nand hideCreateTools* properties","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"circle"},{"type":"string","value":"move"},{"type":"string","value":"point"},{"type":"string","value":"polygon"},{"type":"string","value":"rectangle"},{"type":"string","value":"text"},{"type":"string","value":"reshape"},{"type":"string","value":"polyline"},{"type":"string","value":"multipoint"},{"type":"string","value":"mesh"},{"type":"string","value":"transform"},{"type":"string","value":"freehandPolyline"},{"type":"string","value":"freehandPolygon"},{"type":"string","value":"lasso-selection"},{"type":"string","value":"rectangle-selection"},{"type":"string","value":"custom-selection"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"availableCreateTools","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"CreateTool":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Property controlling the visibility and order of create tool buttons.\nCreate tool buttons will only be rendered if they are in this collections and the\nmatching hide/show property or attribute is configured to show the tool.","docsTags":[],"default":"[\"point\", \"polyline\", \"freehandPolyline\", \"polygon\", \"freehandPolygon\", \"rectangle\", \"circle\"]","values":[],"optional":true,"required":false},{"name":"createGraphic","type":"Graphic | null | undefined","complexType":{"original":"Graphic | null | undefined","resolved":"Graphic | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The graphic that is being created.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"creationMode","type":"CreationMode","complexType":{"original":"CreationMode","resolved":"CreationMode","references":{"CreationMode":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"attr":"creation-mode","reflectToAttr":false,"docs":"Defines the default behavior once the [create()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#create) operation is completed. By default, the user will be\nable to continuously create graphics with same geometry types.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\ncontinuous | This is the default. Users can continue creating graphics with same geometry types.\nsingle | User can create a single graphic with the specified geometry type. User must choose an operation once the graphic is created.\nupdate | The graphic will be selected for an [update()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#update) operation once the `create` operation is completed.","docsTags":[{"name":"since","text":"4.14"}],"default":"\"continuous\"","values":[{"type":"string","value":"update"},{"type":"string","value":"single"},{"type":"string","value":"continuous"}],"optional":true,"required":false},{"name":"defaultCreateOptions","type":"CreateOptions","complexType":{"original":"CreateOptions","resolved":"CreateOptions","references":{"CreateOptions":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Default create options set for the Sketch component.","docsTags":[{"name":"since","text":"4.14"}],"values":[],"optional":true,"required":false},{"name":"defaultGraphicsLayerDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"default-graphics-layer-disabled","reflectToAttr":false,"docs":"By default, sketch will auto-create a new graphics layer if none was\nprovided. Set this prop to true to disable this behavior.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"defaultUpdateOptions","type":"UpdateOptions","complexType":{"original":"UpdateOptions","resolved":"UpdateOptions","references":{"UpdateOptions":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Default update options set for the Sketch component. Update options set on this property will be overwritten if the update options are changed\nwhen [update()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#update) method is called.","docsTags":[{"name":"since","text":"4.11"},{"name":"example","text":"// Turn off highlights for update operations\nconst sketch = new Sketch({\n view,\n defaultUpdateOptions: {\n highlightOptions: {\n enabled: false\n }\n }\n});\n// Turn off highlights from the update() method\nconst updateOptions = { tool: \"reshape\", highlightOptions: { enabled: false }};\nsketch.update(graphic, updateOptions);"}],"values":[],"optional":true,"required":false},{"name":"hideCreateToolsCircle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-create-tools-circle","reflectToAttr":false,"docs":"Indicates whether to hide the circle sketch tool.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCreateToolsMultipoint","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-create-tools-multipoint","reflectToAttr":false,"docs":"Indicates whether to hide the multipoint tool. Regardless of setting, multipoint is not available when working with a scene view.\n\nThe multipoint tool is excluded from `availableCreateTools` by default. Even if this property is false,\nmultipoint will not be available until it is added to `availableCreateTools`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCreateToolsPoint","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-create-tools-point","reflectToAttr":false,"docs":"Indicates whether to hide the point sketch tool.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCreateToolsPolygon","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-create-tools-polygon","reflectToAttr":false,"docs":"Indicates whether to hide the polygon sketch tool.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCreateToolsPolyline","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-create-tools-polyline","reflectToAttr":false,"docs":"Indicates whether to hide the polyline sketch tool.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideCreateToolsRectangle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-create-tools-rectangle","reflectToAttr":false,"docs":"Indicates whether to hide the rectangle sketch tool.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDeleteButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-delete-button","reflectToAttr":false,"docs":"Indicates whether to hide the 'delete' button while a graphic is selected. Do not hide this button without giving users on touch devices another way to delete selected geometries.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideDuplicateButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-duplicate-button","reflectToAttr":false,"docs":"Indicates whether to hide the 'duplicate' button while a graphic is selected.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLabelsToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-labels-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the sketch labels toggle`.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSelectionCountLabel","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-selection-count-label","reflectToAttr":false,"docs":"Indicates whether to hide a label indicating the length of the currently selected feature set.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSelectionToolsLassoSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-selection-tools-lasso-selection","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSelectionToolsRectangleSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-selection-tools-rectangle-selection","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSettingsMenu","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-settings-menu","reflectToAttr":false,"docs":"Indicates whether to hide the settings menu. Currently this menu contains snapping options`.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControls","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls","reflectToAttr":false,"docs":"Indicates whether to hide the `SnappingControls` component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-enabled-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `enabledToggle` (Enable snapping). This toggles\nthe [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#enabled) property.\n> [!WARNING]\n>\n> **Note**\n>\n> It is recommended to set `SnappingControls.snappingOptions.enabled = true` if `enabledToggle` is set to `false`.\n> This is because `selfEnabledToggle` and `featureEnabledToggle` require snapping globally to be enabled in order to be interactive. Otherwise, these toggles will not be responsive.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsFeatureEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-feature-enabled-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `featureEnabledToggle` (Feature to feature). This toggles\nthe [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#featureEnabled) property.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControls","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls","reflectToAttr":false,"docs":"Indicates whether to hide the `gridControls` (configuration of the snapping grid).","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsColorSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-color-selection","reflectToAttr":false,"docs":"Indicates whether to hide the `colorSelection` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsDynamicScaleToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-dynamic-scale-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `dynamicScaleToggle` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsLineIntervalInput","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-line-interval-input","reflectToAttr":false,"docs":"Indicates whether to hide the `lineIntervalInput` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsNumericInputs","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-numeric-inputs","reflectToAttr":false,"docs":"Indicates whether to hide the `numericInputs` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsOutOfScaleWarning","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-out-of-scale-warning","reflectToAttr":false,"docs":"Indicates whether to hide the `outOfScaleWarning` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsPlacementButtons","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-placement-buttons","reflectToAttr":false,"docs":"Indicates whether to hide the `placementButtons` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridControlsElementsRotateWithMapToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-controls-elements-rotate-with-map-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `rotateWithMapToggle` within the snapping grid controls.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsGridEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-grid-enabled-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `gridEnabledToggle` (snap-to-grid).","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsLayerList","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-layer-list","reflectToAttr":false,"docs":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/) layerList. The layerlist provides the available layer sources supported for snapping.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSnappingControlsElementsSelfEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-snapping-controls-elements-self-enabled-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the `selfEnabledToggle` (Geometry guides). This toggles\nthe [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#selfEnabled) property.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTooltipsToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-tooltips-toggle","reflectToAttr":false,"docs":"Indicates whether to hide the tooltips toggle`.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideUndoRedoMenu","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-undo-redo-menu","reflectToAttr":false,"docs":"Indicates whether to hide the undo/redo menu within the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"pencil\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"labelOptions","type":"SketchLabelOptions","complexType":{"original":"SketchLabelOptions","resolved":"SketchLabelOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/sketch/SketchLabelOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Options to configure the sketch labels shown next to each segment of the geometry being created or updated.\n\n> [!WARNING]\n>\n> **Known Limitation**\n>\n> Sketch labels are currently only supported when working with a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).","docsTags":[{"name":"since","text":"4.24"}],"values":[],"optional":true,"required":false},{"name":"layer","type":"GraphicsLayer | MapNotesLayer | null | undefined","complexType":{"original":"GraphicsLayer | MapNotesLayer | null | undefined","resolved":"GraphicsLayer | MapNotesLayer | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/MapNotesLayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) associated with the Sketch component. The Sketch component adds new [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) to this layer or can only update graphics\nstored in this layer.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"layout","type":"Layout","complexType":{"original":"Layout","resolved":"Layout","references":{"Layout":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"attr":"layout","reflectToAttr":false,"docs":"Determines the layout/orientation of the Sketch component.","docsTags":[{"name":"since","text":"4.10"}],"default":"\"horizontal\"","values":[{"type":"string","value":"horizontal"},{"type":"string","value":"vertical"}],"optional":true,"required":false},{"name":"pointSymbol","type":"SketchPointSymbol","complexType":{"original":"SketchPointSymbol","resolved":"SketchPointSymbol","references":{"SketchPointSymbol":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleMarkerSymbol/), [PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/), [PointSymbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/PointSymbol3D/), [TextSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/TextSymbol/), [CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/), or [WebStyleSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/WebStyleSymbol/) used for representing the point geometry that is being drawn. [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleMarkerSymbol/) may also be used to symbolize point features in a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/). However, it is recommended you use [PointSymbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/PointSymbol3D/) instead.\n\n> [!WARNING]\n>\n> **Known Limitation**\n> To avoid unintended side effects, instantiate a new symbol rather than modifying the current instance.\n\nThe default value is the following:\n```js\n{\n type: \"simple-marker\",\n style: \"circle\",\n size: 6,\n color: [255, 255, 255],\n outline: {\n color: [50, 50, 50],\n width: 1\n }\n}\n```","docsTags":[],"values":[],"optional":true,"required":false},{"name":"polygonSymbol","type":"SketchPolygonSymbol","complexType":{"original":"SketchPolygonSymbol","resolved":"SketchPolygonSymbol","references":{"SketchPolygonSymbol":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol/), [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/PolygonSymbol3D/), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/) used for representing the polygon geometry that is being drawn. [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol/) may also be used to symbolize polygon features in a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/). However, it is recommended you use [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/PolygonSymbol3D/) instead.\n\n> [!WARNING]\n>\n> **Known Limitation**\n> To avoid unintended side effects, instantiate a new symbol rather than modifying the current instance.\n\nThe default value is the following:\n```js\n{\n type: \"simple-fill\",\n color: [150, 150, 150, 0.2],\n outline: {\n color: [50, 50, 50],\n width: 2\n }\n}\n```","docsTags":[],"values":[],"optional":true,"required":false},{"name":"polylineSymbol","type":"SketchPolylineSymbol","complexType":{"original":"SketchPolylineSymbol","resolved":"SketchPolylineSymbol","references":{"SketchPolylineSymbol":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleLineSymbol/), [LineSymbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/LineSymbol3D/), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/) used for representing the polyline geometry that is being drawn. [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleLineSymbol/) may also be used to symbolize polyline features in a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/). However, it is recommended you use [LineSymbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/LineSymbol3D/) instead.\n\n> [!WARNING]\n>\n> **Known Limitation**\n> To avoid unintended side effects, instantiate a new symbol rather than modifying the current instance.\n\nThe default value is the following:\n```js\n{\n type: \"simple-line\",\n color: [130, 130, 130],\n width: 2\n}\n```","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"scale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"scale","reflectToAttr":false,"docs":"Determines the size of component elements.","docsTags":[{"name":"since","text":"4.32"}],"default":"\"m\"","deprecation":"since 5.0, use `element.visualScale` instead.","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false},{"name":"showCreateToolsFreehandPolygon","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-create-tools-freehand-polygon","reflectToAttr":false,"docs":"Indicates whether to display the freehandPolygon tool.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCreateToolsFreehandPolyline","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-create-tools-freehand-polyline","reflectToAttr":false,"docs":"Indicates whether to display the freehandPolyline tool.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCreateToolsText","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-create-tools-text","reflectToAttr":false,"docs":"Indicates whether to display the text tool.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showSnappingControlsElementsHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-snapping-controls-elements-header","reflectToAttr":false,"docs":"Indicates whether to display the header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"snappingOptions","type":"SnappingOptions","complexType":{"original":"SnappingOptions","resolved":"SnappingOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/snapping/SnappingOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/) for sketching. It supports [self](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#selfEnabled) and [feature](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/#featureEnabled) snapping.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"active"}],"optional":true,"required":false},{"name":"textSymbol","type":"TextSymbol","complexType":{"original":"TextSymbol","resolved":"TextSymbol","references":{"default":{"location":"import","path":"@arcgis/core/symbols/TextSymbol.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [TextSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/TextSymbol/) used for representing the geometry that is being drawn.\n\n> [!WARNING]\n>\n> **Known Limitation**\n> To avoid unintended side effects, instantiate a new symbol rather than modifying the current instance.\n\nThe default value is the following:\n```js\n{\n type: \"text\",\n text: \"hello world\"\n}\n```","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"toolbarKind","type":"ToolbarKind","complexType":{"original":"ToolbarKind","resolved":"ToolbarKind","references":{"ToolbarKind":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"mutable":true,"attr":"toolbar-kind","reflectToAttr":false,"docs":"Controls the appearance of the sketch component, allowing the toolbar to adapt its appearance appropriately based on context.\n\nSet this to `docked` for use within the Expand component, or any other situation\nwhere Sketch is not floating within a large canvas.","docsTags":[{"name":"since","text":"4.32"}],"default":"\"floating\"","values":[{"type":"string","value":"floating"},{"type":"string","value":"docked"}],"optional":true,"required":false},{"name":"tooltipOptions","type":"SketchTooltipOptions","complexType":{"original":"SketchTooltipOptions","resolved":"SketchTooltipOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/sketch/SketchTooltipOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Options to configure the tooltip shown next to the cursor when creating or updating graphics.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"updateGraphics","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) that are being updated by the Sketch component.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"updateOnGraphicClickDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"update-on-graphic-click-disabled","reflectToAttr":false,"docs":"Controls whether the user can click a graphic in the layer to start updating it.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"useLegacyCreateTools","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"use-legacy-create-tools","reflectToAttr":false,"docs":"Starting at version 5.0, `arcgis-sketch` is transitioning to a next generation geometry\ncreation experience. This new experience provides advanced curve creation tools\nand allows multiple tools to be used in combination to define a single geometry.\n\nAs of 5.0, this experience is only available in 2D (e.g. [`arcgis-map`](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map)).\n\nThis property is available to allow 2D applications to temporarily\nopt out of this experience.\n\n> [!CAUTION]\n>\n> This option will be removed in an upcoming release.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","deprecation":"","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-sketch component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Specifies the size of the component.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"cancel","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"cancel(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"complete","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"complete(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSketch = document.createElement(\"arcgis-sketch\");\ndocument.body.append(arcgisSketch);\nawait arcgisSketch.componentOnReady();\nconsole.log(\"arcgis-sketch is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"create","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(tool: CreateTool, createOptions?: CreateOptions): Promise","parameters":[{"name":"tool","type":"CreateTool","docs":""},{"name":"createOptions","type":"CreateOptions","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"CreateTool":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"},"CreateOptions":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"signature":"create(tool: CreateTool, createOptions?: CreateOptions): Promise","parameters":[{"name":"tool","type":"CreateTool","docs":""},{"name":"createOptions","type":"CreateOptions","docs":""}],"docs":"","docsTags":[]},{"name":"delete","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"delete(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"dismissFloatingElements","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"dismissFloatingElements(): Promise","parameters":[],"docs":"","docsTags":[{"name":"internal"},{"name":"since","text":"5.1"}]},{"name":"duplicate","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"duplicate(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"redo","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"redo(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"setContextualToolLocation","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(location: \"inline-end\" | \"inline\" | \"separate\"): Promise","parameters":[{"name":"location","type":"\"inline-end\" | \"inline\" | \"separate\"","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setContextualToolLocation(location: \"inline-end\" | \"inline\" | \"separate\"): Promise","parameters":[{"name":"location","type":"\"inline-end\" | \"inline\" | \"separate\"","docs":""}],"docs":"","docsTags":[{"name":"internal"},{"name":"since","text":"5.1"}]},{"name":"setCustomTools","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(createToolOptions?: CustomToolOptions[] | null, customActionOptions?: CustomActionProperties[] | null): Promise","parameters":[{"name":"createToolOptions","type":"CustomToolOptions[] | null","docs":""},{"name":"customActionOptions","type":"CustomActionProperties[] | null","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"CustomToolOptions":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"},"CustomActionProperties":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"signature":"setCustomTools(createToolOptions?: CustomToolOptions[] | null, customActionOptions?: CustomActionProperties[] | null): Promise","parameters":[{"name":"createToolOptions","type":"CustomToolOptions[] | null","docs":""},{"name":"customActionOptions","type":"CustomActionProperties[] | null","docs":""}],"docs":"","docsTags":[{"name":"internal"},{"name":"since","text":"5.1"}]},{"name":"setGroupAllowCollapseOptions","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(options: Map): Promise","parameters":[{"name":"options","type":"Map","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"Map":{"location":"global","path":"global:","id":"notImplemented"},"SketchGroupName":{"location":"import","path":"@arcgis/core/applications/ExperienceBuilder/sketchUtils.js","id":"notImplemented"}}},"signature":"setGroupAllowCollapseOptions(options: Map): Promise","parameters":[{"name":"options","type":"Map","docs":""}],"docs":"","docsTags":[{"name":"internal"},{"name":"since","text":"5.1"}]},{"name":"setGroupCollapsePriorities","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(priorities: Map | null): Promise","parameters":[{"name":"priorities","type":"Map | null","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"Map":{"location":"global","path":"global:","id":"notImplemented"},"SketchGroupName":{"location":"import","path":"@arcgis/core/applications/ExperienceBuilder/sketchUtils.js","id":"notImplemented"}}},"signature":"setGroupCollapsePriorities(priorities: Map | null): Promise","parameters":[{"name":"priorities","type":"Map | null","docs":""}],"docs":"","docsTags":[{"name":"internal"},{"name":"since","text":"5.1"}]},{"name":"triggerUpdate","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(graphic: Parameters[0], updateOptions?: Parameters[1]): Promise","parameters":[{"name":"graphic","type":"Parameters[0]","docs":""},{"name":"updateOptions","type":"Parameters[1]","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"Parameters":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/widgets/Sketch.js","id":"notImplemented"}}},"signature":"triggerUpdate(graphic: Parameters[0], updateOptions?: Parameters[1]): Promise","parameters":[{"name":"graphic","type":"Parameters[0]","docs":""},{"name":"updateOptions","type":"Parameters[1]","docs":""}],"docs":"","docsTags":[]},{"name":"undo","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"undo(): Promise","parameters":[],"docs":"","docsTags":[]}],"events":[{"event":"arcgisCreate","detail":"CreateEvent","bubbles":true,"complexType":{"original":"CreateEvent","resolved":"CreateEvent","references":{"CreateEvent":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user starts sketching a graphic, is actively sketching a graphic and completes sketching a graphic.","docsTags":[]},{"event":"arcgisDelete","detail":"DeleteEvent","bubbles":true,"complexType":{"original":"DeleteEvent","resolved":"DeleteEvent","references":{"DeleteEvent":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user deletes selected graphics by clicking the Delete feature button on the Sketch widget or when the `delete()` method is called.","docsTags":[]},{"event":"arcgisDuplicate","detail":"DuplicateEvent","bubbles":true,"complexType":{"original":"DuplicateEvent","resolved":"DuplicateEvent","references":{"DuplicateEvent":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the user duplicates selected graphics.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisRedo","detail":"RedoEvent","bubbles":true,"complexType":{"original":"RedoEvent","resolved":"RedoEvent","references":{"RedoEvent":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires in response to redo action during creation of a new graphic or updating existing graphics. The undo/redo stack is for an individual sketch operation, meaning you can undo/redo actions while creating or updating a graphic.","docsTags":[]},{"event":"arcgisUndo","detail":"UndoEvent","bubbles":true,"complexType":{"original":"UndoEvent","resolved":"UndoEvent","references":{"UndoEvent":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires in response to undo action during creation of a new graphic or updating existing graphics. The undo/redo stack is for an individual sketch operation, meaning you can undo/redo actions while creating or updating a graphic.","docsTags":[]},{"event":"arcgisUpdate","detail":"UpdateEvent","bubbles":true,"complexType":{"original":"UpdateEvent","resolved":"UpdateEvent","references":{"UpdateEvent":{"location":"import","path":"@arcgis/core/widgets/Sketch/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the user starts updating graphics, is actively updating graphics, and completes updating graphics.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/sketch-tooltip-controls/sketch-tooltip-controls.tsx","tag":"arcgis-sketch-tooltip-controls","overview":"","readme":"","usage":{},"docs":"The sketch-tooltip-controls component provides a user interface to set specific options within Sketch's [SketchTooltipOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchTooltipOptions/), [SkechLabelOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchLabelOptions/), and [SketchValueOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchValueOptions/) classes.","docsTags":[{"name":"since","text":"5.1"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"_hasContent","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"private","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"directionMode","type":"TooltipDirectionMode","complexType":{"original":"TooltipDirectionMode","resolved":"TooltipDirectionMode","references":{"TooltipDirectionMode":{"location":"import","path":"@arcgis/core/views/interactive/tooltip/types.js","id":"notImplemented"}}},"mutable":true,"attr":"direction-mode","reflectToAttr":false,"docs":"Indicates whether the direction (deflection) of the segment being drawn\nis measured relative to the previous segment or from the main axis of the map\n(usually north). See [SketchTooltipOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchTooltipOptions/) and [SketchValueOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchValueOptions/#directionMode).","docsTags":[],"values":[{"type":"string","value":"absolute"},{"type":"string","value":"relative"}],"optional":true,"required":false},{"name":"hideLabelsToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-labels-toggle","reflectToAttr":false,"docs":"Controls whether the labels toggle is shown for this component.\n\n> **Note:** If this component is contained in another component, the parent\ncomponent is responsible for setting this property based on any\nknown limitations, including properties on the view. Specifically,\nas of 5.1, if the view is a 2d video or linkchart instead of a map,\nthe parent component should set this property to `true`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideTooltipsToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-tooltips-toggle","reflectToAttr":false,"docs":"Controls whether the tooltips toggle is shown for this component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"labelsEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"labels-enabled","reflectToAttr":false,"docs":"Indicates whether labels are shown next to each segment of the graphic being sketched.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showDirectionModePicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-direction-mode-picker","reflectToAttr":false,"docs":"Controls whether the direction mode picker is shown for this component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-header","reflectToAttr":false,"docs":"Controls whether a header is shown for this component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"sketchOptions","type":"SketchOptions","complexType":{"original":"SketchOptions","resolved":"SketchOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/sketch/SketchOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Controls the sketch labels, tooltips, and values options.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"tooltipsEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"tooltips-enabled","reflectToAttr":false,"docs":"Indicates whether tooltips are shown while sketching and editing.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSketchTooltipControls = document.createElement(\"arcgis-sketch-tooltip-controls\");\ndocument.body.append(arcgisSketchTooltipControls);\nawait arcgisSketchTooltipControls.componentOnReady();\nconsole.log(\"arcgis-sketch-tooltip-controls is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"tooltipsEnabled\" | \"labelsEnabled\" | \"directionMode\"; }","bubbles":true,"complexType":{"original":"{ name: \"tooltipsEnabled\" | \"labelsEnabled\" | \"directionMode\"; }","resolved":"{ name: \"tooltipsEnabled\" | \"labelsEnabled\" | \"directionMode\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slice/slice.tsx","tag":"arcgis-slice","overview":"","readme":"","usage":{},"docs":"The Slice component is a 3D analysis tool that can be used to reveal occluded content in a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\n\n\nThe slicing [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/references/core/analysis/SlicePlane/).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/references/core/analysis/SlicePlane/)\ncan be set or retrieved using the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n\n[![slice-exclude](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/slice-exclude.avif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nHolding the `Shift` key while placing a new slice applies it vertically.\n\n**Known limitation**\n\nSlice is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [SliceAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)","docsTags":[{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"analysis","type":"SliceAnalysis","complexType":{"original":"SliceAnalysis","resolved":"SliceAnalysis","references":{"default":{"location":"import","path":"@arcgis/core/analysis/SliceAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [SliceAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Slice component to the [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses) collection.\nYou can then wait for the [SliceAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/SliceAnalysisView3D/)\nto be created before interacting with the slice or reading the current slice parameters.\n\n```js\n// Get the Scene component and the Slice component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst sliceElement = document.querySelector(\"arcgis-slice\");\nawait sliceElement.componentOnReady();\n\n// Get the SliceAnalysis created by the Slice component.\nconst analysis = sliceElement.analysis;\n\n// Get the SliceAnalysisView3D and watch for changes.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysis.shape,\n () => {\n console.log(\"Slice active:\", analysisView.active);\n console.log(\"Slice interactive:\", analysisView.interactive);\n console.log(\"Slice shape:\", analysis.shape);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [SliceAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.\n\n```js\n// Create the SliceAnalysis.\nconst sliceAnalysis = new SliceAnalysis({\n shape: new SlicePlane({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624925.727820931,\n y: 4550341.695170021,\n z: 56\n }),\n tilt: 270,\n width: 310,\n height: 190,\n heading: 45\n })\n});\n// Get the Scene component and the Slice component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst sliceElement = document.querySelector(\"arcgis-slice\");\nawait sliceElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Scene component.\nviewElement.analyses.add(sliceAnalysis);\n\n// Connect the analysis to the slice component:\nsliceElement.analysis = sliceAnalysis;\n```","docsTags":[],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"excludedLayers","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"SliceableLayer":{"location":"local","path":"components/arcgis-slice/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Add layers to this collection to exclude them from the slice. Layers that\nare draped on the ground surface are not affected by this property","docsTags":[],"values":[],"optional":true,"required":false},{"name":"excludeGroundSurface","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"exclude-ground-surface","reflectToAttr":false,"docs":"Indicates whether the [Ground](https://developers.arcgis.com/javascript/latest/references/core/Ground/) and layers that\nare draped on the ground surface are excluded from the slice.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the \"Excluded layers\" heading.","docsTags":[],"default":"3","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideStartButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-start-button","reflectToAttr":false,"docs":"If true, the button that starts a new slice will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualization","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization","reflectToAttr":false,"docs":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"slice\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"shape","type":"SlicePlane | null | undefined","complexType":{"original":"SlicePlane | null | undefined","resolved":"SlicePlane | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/analysis/SlicePlane.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The shape used to slice elements in a 3D scene. Currently the only supported shape is a\n[plane](https://developers.arcgis.com/javascript/latest/references/core/analysis/SlicePlane/).","docsTags":[{"name":"since","text":"4.28"},{"name":"example","text":"```js\n// Create a slice plane programmatically.\nconst shape = new SlicePlane({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624925.727820931,\n y: 4550341.695170021,\n z: 56\n }),\n tilt: 270,\n width: 310,\n height: 190,\n heading: 45\n});\n// Apply the new shape to the slice component's shape.\nslice.shape = shape;\n```"},{"name":"example","text":"```js\n// Clone the shape to modify its properties.\nconst shape = slice.shape.clone();\n// Set new values for heading and tilt.\nshape.heading = 180;\nshape.tilt = 45;\n// Apply the new shape to the slice component's shape.\nslice.shape = shape;\n```"}],"values":[],"optional":true,"required":false},{"name":"state","type":"\"disabled\" | \"ready\" | \"excludingLayer\" | \"sliced\" | \"slicing\"","complexType":{"original":"\"disabled\" | \"ready\" | \"excludingLayer\" | \"sliced\" | \"slicing\"","resolved":"\"disabled\" | \"ready\" | \"excludingLayer\" | \"sliced\" | \"slicing\"","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `excludingLayer` - currently excluding a layer from the slice\n* `ready` - ready for slicing\n* `slicing` - currently slicing\n* `sliced` - finished slicing and a valid shape is available","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"excludingLayer"},{"type":"string","value":"sliced"},{"type":"string","value":"slicing"}],"optional":true,"required":false},{"name":"tiltEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"tilt-enabled","reflectToAttr":false,"docs":"Enable tilting the slice shape. If set to true, the slice shape will orient itself as best as\npossible to the surface under the cursor when first placing the shape. If set to false, the slice shape is\nrestricted to be either horizontal or vertical.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-slice component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Clear the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#excludedLayers)\nand [excludeGroundSurface](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#excludeGroundSurface) are not modified.\nCalling this method changes the [state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#state) to `ready`.","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSlice = document.createElement(\"arcgis-slice\");\ndocument.body.append(arcgisSlice);\nawait arcgisSlice.componentOnReady();\nconsole.log(\"arcgis-slice is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"start","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"start(): Promise","parameters":[],"docs":"Start the interactive placement of a new slice, clearing the previous [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape).\nCalling this method changes the [state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#state) to `slicing`.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"analysis\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"analysis\" | \"state\"; }","resolved":"{ name: \"analysis\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slider-binary-color-size-legacy/slider-binary-color-size-legacy.tsx","tag":"arcgis-slider-binary-color-size-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained.\nAt that point, development should use the native component.\n\nThe Binary Color Size Slider component is intended for authoring and exploring diverging data-driven visualizations in any\nlayer that can be rendered with an above and below theme for a [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/).\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/BinaryColorSizeSlider/#fromRendererResult)\nmethod can be used to intelligently populate slider properties including [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nconfiguration, and the slider's histogram after the renderer has been created from the result of the\n[createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer) method.\n\n```js\nconst univariateColorSizeRendererCreator = await import(\n \"@arcgis/core/smartMapping/renderers/univariateColorSize.js\"\n);\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst binaryColorSizeSlider = document.querySelector(\"arcgis-slider-binary-color-size-legacy\");\n\nconst featureLayer = new FeatureLayer({\n url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n layer: featureLayer,\n field: \"B17020_calc_pctPovE\",\n view: viewElement.view,\n theme: \"above-and-below\",\n};\n\nconst rendererResult = await univariateColorSizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait binaryColorSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update an above and below (diverging) visualization in a layer's renderer.\nIt is the responsibility of the app developer to set up event listeners on that update the size variable of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = async () => {\n const result = await binaryColorSizeSlider.updateRenderer(featureLayer.renderer);\n featureLayer.renderer = result;\n};\n\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nbinaryColorSizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[univariateColorSizeRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"handlesSyncedToPrimary","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"handles-synced-to-primary","reflectToAttr":false,"docs":"This property indicates whether the position of the outside handles are synced with the middle, or primary,\nhandle. When enabled, if the primary handle is moved then the outside handle positions are updated\nwhile maintaining a fixed distance from the primary handle.","docsTags":[{"name":"example","text":"```js\n// enables the primary handles and syncs it with the others\nbinaryColorSizeSlider.handlesSyncedToPrimary = true;\n```"}],"default":"true","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"histogramConfig","type":"HistogramConfig | null | undefined","complexType":{"original":"HistogramConfig | null | undefined","resolved":"HistogramConfig | null | undefined","references":{"HistogramConfig":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The histogram associated with the data represented on the slider. The bins are typically\ngenerated using the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) statistics function.","docsTags":[{"name":"example","text":"```js\nconst histogramResult = await histogram({\n layer: featureLayer,\n field: \"fieldName\",\n numBins: 30,\n});\n\nslider.histogramConfig = {\n bins: histogramResult.bins\n};\n```"},{"name":"see","text":"[histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#labelFormatFunction), which formats\nthumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins\nto edit them.\n\nThe image below demonstrates how slider input values resemble corresponding slider values by default\nand won't match the formatting set in `labelFormatFunction`.\n\n![Slider without input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-no-input-formatter.avif \"Slider without input formatter\")\n\nIf you want to format slider input values so they match thumb labels, you can pass the same function set in `labelFormatFunction` to\n`inputFormatFunction` for consistent formatting.\n\n![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-input-formatter.avif \"Slider with input formatter\")\n\nHowever, if an `inputFormatFunction` is specified, you must also write a corresponding\n[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if\nyou specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#labelFormatFunction) to the same value\nfor consistency between labels and inputs.\n\nThis property overrides the default input formatter, which formats by calling `toString()` on the input value.\n ","docsTags":[{"name":"see","text":"[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#inputParseFunction)"},{"name":"example","text":"```js\n// Formats the slider input to abbreviated numbers with units\n// e.g. a thumb at position 1500 will render with an input label of 1.5k\nslider.inputFormatFunction = (value: number): string => {\n if (value >= 1000000) {\n return (value / 1000000).toPrecision(3) + \"m\";\n }\n if (value >= 100000) {\n return (value / 1000).toPrecision(3) + \"k\";\n }\n if (value >= 1000) {\n return (value / 1000).toPrecision(2) + \"k\";\n }\n return value.toFixed(0);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"inputParseFunction","type":"InputParseFunction | null | undefined","complexType":{"original":"InputParseFunction | null | undefined","resolved":"InputParseFunction | null | undefined","references":{"InputParseFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#inputFormatFunction).\nThis property must be set if an `inputFormatFunction` is set. Otherwise the slider values will\nlikely not update to their expected positions.\n\nOverrides the default input parses, which is a parsed floating point number.","docsTags":[{"name":"see","text":"[inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#inputFormatFunction)"},{"name":"example","text":"```js\n// Parses the slider input (a string value) to a number value understandable to the slider\n// This assumes the slider was already configured with an inputFormatFunction\n// For example, if the input is 1.5k this function will parse\n// it to a value of 1500\ncolorSlider.inputParseFunction = (value: string): number => {\n const charLength = value.length;\n const valuePrefix = parseFloat(value.substring(0, charLength - 1));\n const finalChar = value.substring(charLength - 1);\n\n if (parseFloat(finalChar) >= 0) {\n return parseFloat(value);\n }\n if (finalChar === \"k\") {\n return valuePrefix * 1000;\n }\n if (finalChar === \"m\") {\n return valuePrefix * 1000000;\n }\n return parseFloat(value);\n};\n ```"}],"values":[],"optional":true,"required":false},{"name":"labelFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.","docsTags":[{"name":"example","text":"```js\n// For thumb values, rounds each label to whole numbers\nslider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {\n return (type === \"value\") ? value.toFixed(0) : value.toString();\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"max","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max","reflectToAttr":false,"docs":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nbinaryColorSizeSlider.max = 150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min","reflectToAttr":false,"docs":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nbinaryColorSizeSlider.min = -150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"persistSizeRangeEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"persist-size-range-enabled","reflectToAttr":false,"docs":"When `true`, ensures symbol sizes in the `above` range\nare consistent with symbol sizes in the `below` range for all slider thumb positions.\nIn other words, the size values in the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#stops) will adjust\nproportionally according to the positions of the data values within the\nconstraints of the size range (maxSize - minSize) as the slider thumbs update.\nWhen `false`, size values in the stops will remain the same even when slider thumb values\nchange.\n\nIn most cases, this should be set to `true` to keep sizes in the `above` range consistent with\nsizes in the `below` range to avoid map misinterpretation.","docsTags":[{"name":"example","text":"```js\nbinaryColorSizeSlider.persistSizeRangeEnabled = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"precision","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"precision","reflectToAttr":false,"docs":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","docsTags":[{"name":"example","text":"```js\n// Rounds slider thumb values to 7 decimal places\nslider.precision = 7;\n```"}],"default":"4","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"sliderStyle","type":"BinaryColorSizeSliderStyle","complexType":{"original":"BinaryColorSizeSliderStyle","resolved":"BinaryColorSizeSliderStyle","references":{"BinaryColorSizeSliderStyle":{"location":"import","path":"@arcgis/core/widgets/smartMapping/BinaryColorSizeSlider.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Exposes various properties of the widget that can be styled. The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod can be used to match the `trackBelowFillColor` and `trackAboveFillColor` to the current layer symbology.","docsTags":[{"name":"example","text":"```js\nbinaryColorSizeSlider.sliderStyle = {\n trackAboveFillColor: rendererResult.renderer.classBreakInfos[1].symbol.color ?? new Color([149, 149, 149]),\n trackBackgroundColor: new Color([224, 224, 224]),\n trackBelowFillColor: rendererResult.renderer.classBreakInfos[0].symbol.color ?? new Color([149, 149, 149]),\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"state","type":"SmartMappingSliderBaseState","complexType":{"original":"SmartMappingSliderBaseState","resolved":"SmartMappingSliderBaseState","references":{"SmartMappingSliderBaseState":{"location":"import","path":"@arcgis/core/widgets/smartMapping/SmartMappingSliderBase.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"stops","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/renderers/visualVariables/support/SizeStop.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The size stops from the [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nto link to the slider. You must provide either three or five stops. The minimum size\nshould be represented in the size property of the middle stop. The maximum size should be represented in either first or last stops.","docsTags":[{"name":"example","text":"```js\nbinaryColorSizeSlider.stops = [\n { value: 8, size: 7 },\n { value: 15, size: 3 },\n { value: 40, size: 17 },\n { value: 64, size: 30 }\n];\n```"}],"values":[],"optional":true,"required":false},{"name":"zoomOptions","type":"ZoomOptions | null | undefined","complexType":{"original":"ZoomOptions | null | undefined","resolved":"ZoomOptions | null | undefined","references":{"ZoomOptions":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Zooms the slider track to the bounds provided in this property. When min and/or max zoom values are provided, the absolute [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#min) and\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#max) slider values are preserved and rendered at their typical positions on the slider. However, the\n slider track itself is zoomed so that thumbs cannot be moved above or below the provided min and max zoomed values.\n\n When a slider is in a zoomed state, the zoomed ends of the track will appear jagged. In the image below, notice how the\n top thumb cannot be moved past the zoom max of `31` even though the slider max is `200`.\n\n ![slider-zoom](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-zoomed.avif \"Zoomed slider\")\n\n To exit a zoomed state, the user can click the jagged line or the developer can set the `zoomOptions` to `null`. It\n is up to the developer to provide a UI option for end users to enable zooming on the slider.\n\n Setting the `zoomOptions` is useful when the slider is tied to heavily skewed datasets where the histogram renders only one or two bars because of outliers.\n\n ![slider-not-zoomed](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-skewed-not-zoomed.avif \"Unzoomed slider\")\n\n You can remove the influence of outliers by zooming the slider and regenerating a histogram based on the zoomed min and max. This will provide a better view of the data\n and make the slider more useful to the end user.","docsTags":[{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions between\n// values of 10 and 25 while maintaining the slider's absolute min and max values\nslider.zoomOptions = {\n min: 10,\n max: 25\n};\n```"},{"name":"example","text":"```js\n// disables zooming on the slider\nslider.zoomOptions = null;\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions above\n// value of 10 while maintaining the slider's absolute min value\nslider.zoomOptions = {\n min: 10\n};\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions below\n// value of 25 while maintaining the slider's absolute max value\nslider.zoomOptions = {\n max: 25\n};\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSliderBinaryColorSizeLegacy = document.createElement(\"arcgis-slider-binary-color-size-legacy\");\ndocument.body.append(arcgisSliderBinaryColorSizeLegacy);\nawait arcgisSliderBinaryColorSizeLegacy.componentOnReady();\nconsole.log(\"arcgis-slider-binary-color-size-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"updateFromRendererResult","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(rendererResult: RendererResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"rendererResult","type":"RendererResult","docs":"The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"RendererResult":{"location":"import","path":"@arcgis/core/smartMapping/renderers/univariateColorSize.js","id":"notImplemented"},"HistogramResult":{"location":"import","path":"@arcgis/core/smartMapping/statistics/types.js","id":"notImplemented"}}},"signature":"updateFromRendererResult(rendererResult: RendererResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"rendererResult","type":"RendererResult","docs":"The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"docs":"A convenience function used to update the properties of a Binary Color Size Slider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod. This method is useful for cases when the app allows the end user to switch data variables used to render the data.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","docsTags":[{"name":"example","text":"```js\nconst rendererResult = await univariateColorSizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait binaryColorSizeSlider?.updateFromRendererResult(rendererResult, histogramResult)\n```"}]},{"name":"updateRenderer","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(renderer: ClassBreaksRenderer): Promise","parameters":[{"name":"renderer","type":"ClassBreaksRenderer","docs":"The renderer to update from the slider values."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/renderers/ClassBreaksRenderer.js","id":"notImplemented"}}},"signature":"updateRenderer(renderer: ClassBreaksRenderer): Promise","parameters":[{"name":"renderer","type":"ClassBreaksRenderer","docs":"The renderer to update from the slider values."}],"docs":"A convenience function used to update the input renderer based on\nthe values of the slider [stops](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/BinaryColorSizeSlider/#stops).","docsTags":[{"name":"example","text":"```js\nconst updatedRenderer = await binaryColorSizeSlider.updateRenderer(featureLayer.renderer as ClassBreaksRenderer);\nfeatureLayer.renderer = updatedRenderer;\n```"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\" | \"zoomOptions\"; }","bubbles":true,"complexType":{"original":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\" | \"zoomOptions\"; }","resolved":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\" | \"zoomOptions\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisThumbChange","detail":"ThumbChangeEvent","bubbles":true,"complexType":{"original":"ThumbChangeEvent","resolved":"ThumbChangeEvent","references":{"ThumbChangeEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.","docsTags":[]},{"event":"arcgisThumbDrag","detail":"ThumbDragEvent","bubbles":true,"complexType":{"original":"ThumbDragEvent","resolved":"ThumbDragEvent","references":{"ThumbDragEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user drags a thumb on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slider-classed-color-legacy/slider-classed-color-legacy.tsx","tag":"arcgis-slider-classed-color-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Classed Color Slider component is designed for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with color in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/).\n\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Classed Color Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/classedcolorslider-labels.avif \"Classed Color Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ClassedColorSlider/#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos) configuration,\nand the slider's histogram after the renderer has been created from the result of the\n[createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createClassBreaksRenderer) method.\n\n```js\nconst colorRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/color.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst classedColorSlider = document.querySelector(\"arcgis-slider-classed-color-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n layer: featureLayer,\n field: \"B17020_calc_pctPovE\",\n view: viewElement.view,\n numClasses: 4\n};\n\nconst rendererResult = await colorRendererCreator.createClassBreaksRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait classedColorSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nin a ClassBreaksRenderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update the breaks of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = async () => {\n const renderer = featureLayer?.renderer?.clone();\n if (!renderer || !(\"classBreakInfos\" in renderer) || !renderer.classBreakInfos?.[0]) {\n return;\n }\n\n const updatedClassBreakInfos = await classedColorSlider.updateClassBreakInfos(renderer.classBreakInfos);\n if (!updatedClassBreakInfos) {\n return;\n }\n\n renderer.classBreakInfos = updatedClassBreakInfos;\n featureLayer.renderer = renderer;\n};\n\nclassedColorSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nclassedColorSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nclassedColorSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[colorRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/)"},{"name":"see","text":"[ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"breaks","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"ColorBreak":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of class breaks with associated colors. The colors mapped to each break can\nbe used to update the renderer of a layer. A minimum of two breaks must be provided to the slider.","docsTags":[{"name":"see","text":"[Color](https://developers.arcgis.com/javascript/latest/references/core/Color/)"},{"name":"example","text":"```js\nclassedColorSlider.breaks = [\n { min: 0, max: 15, color: new Color([255, 200, 210]) },\n { min: 15, max: 30, color: new Color([255, 160, 170]) },\n { min: 30, max: 45, color: new Color([255, 110, 120]) },\n { min: 45, max: 60, color: new Color([240, 70, 70]) },\n];\n```"}],"values":[],"optional":true,"required":false},{"name":"histogramConfig","type":"HistogramConfig | null | undefined","complexType":{"original":"HistogramConfig | null | undefined","resolved":"HistogramConfig | null | undefined","references":{"HistogramConfig":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The histogram associated with the data represented on the slider. The bins are typically\ngenerated using the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) statistics function.","docsTags":[{"name":"example","text":"```js\nconst histogramResult = await histogram({\n layer: featureLayer,\n field: \"fieldName\",\n numBins: 30,\n});\n\nslider.histogramConfig = {\n bins: histogramResult.bins\n};\n```"},{"name":"see","text":"[histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#labelFormatFunction), which formats\nthumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins\nto edit them.\n\nThe image below demonstrates how slider input values resemble corresponding slider values by default\nand won't match the formatting set in `labelFormatFunction`.\n\n![Slider without input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-no-input-formatter.avif \"Slider without input formatter\")\n\nIf you want to format slider input values so they match thumb labels, you can pass the same function set in `labelFormatFunction` to\n`inputFormatFunction` for consistent formatting.\n\n![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-input-formatter.avif \"Slider with input formatter\")\n\nHowever, if an `inputFormatFunction` is specified, you must also write a corresponding\n[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if\nyou specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#labelFormatFunction) to the same value\nfor consistency between labels and inputs.\n\nThis property overrides the default input formatter, which formats by calling `toString()` on the input value.\n ","docsTags":[{"name":"see","text":"[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#inputParseFunction)"},{"name":"example","text":"```js\n// Formats the slider input to abbreviated numbers with units\n// e.g. a thumb at position 1500 will render with an input label of 1.5k\nslider.inputFormatFunction = (value: number): string => {\n if (value >= 1000000) {\n return (value / 1000000).toPrecision(3) + \"m\";\n }\n if (value >= 100000) {\n return (value / 1000).toPrecision(3) + \"k\";\n }\n if (value >= 1000) {\n return (value / 1000).toPrecision(2) + \"k\";\n }\n return value.toFixed(0);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"inputParseFunction","type":"InputParseFunction | null | undefined","complexType":{"original":"InputParseFunction | null | undefined","resolved":"InputParseFunction | null | undefined","references":{"InputParseFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#inputFormatFunction).\nThis property must be set if an `inputFormatFunction` is set. Otherwise the slider values will\nlikely not update to their expected positions.\n\nOverrides the default input parses, which is a parsed floating point number.","docsTags":[{"name":"see","text":"[inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#inputFormatFunction)"},{"name":"example","text":"```js\n// Parses the slider input (a string value) to a number value understandable to the slider\n// This assumes the slider was already configured with an inputFormatFunction\n// For example, if the input is 1.5k this function will parse\n// it to a value of 1500\ncolorSlider.inputParseFunction = (value: string): number => {\n const charLength = value.length;\n const valuePrefix = parseFloat(value.substring(0, charLength - 1));\n const finalChar = value.substring(charLength - 1);\n\n if (parseFloat(finalChar) >= 0) {\n return parseFloat(value);\n }\n if (finalChar === \"k\") {\n return valuePrefix * 1000;\n }\n if (finalChar === \"m\") {\n return valuePrefix * 1000000;\n }\n return parseFloat(value);\n};\n ```"}],"values":[],"optional":true,"required":false},{"name":"labelFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.","docsTags":[{"name":"example","text":"```js\n// For thumb values, rounds each label to whole numbers\nslider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {\n return (type === \"value\") ? value.toFixed(0) : value.toString();\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"max","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max","reflectToAttr":false,"docs":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nclassedColorSlider.max = 150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min","reflectToAttr":false,"docs":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nclassedColorSlider.min = -150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"precision","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"precision","reflectToAttr":false,"docs":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","docsTags":[{"name":"example","text":"```js\n// Rounds slider thumb values to 7 decimal places\nslider.precision = 7;\n```"}],"default":"4","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"SmartMappingSliderBaseState","complexType":{"original":"SmartMappingSliderBaseState","resolved":"SmartMappingSliderBaseState","references":{"SmartMappingSliderBaseState":{"location":"import","path":"@arcgis/core/widgets/smartMapping/SmartMappingSliderBase.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSliderClassedColorLegacy = document.createElement(\"arcgis-slider-classed-color-legacy\");\ndocument.body.append(arcgisSliderClassedColorLegacy);\nawait arcgisSliderClassedColorLegacy.componentOnReady();\nconsole.log(\"arcgis-slider-classed-color-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"updateClassBreakInfos","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(breakInfos: ClassBreakInfo[]): Promise","parameters":[{"name":"breakInfos","type":"ClassBreakInfo[]","docs":"The classBreakInfos\n from a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) instance to update based on\n the properties of the slider."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/renderers/support/ClassBreakInfo.js","id":"notImplemented"}}},"signature":"updateClassBreakInfos(breakInfos: ClassBreakInfo[]): Promise","parameters":[{"name":"breakInfos","type":"ClassBreakInfo[]","docs":"The classBreakInfos\n from a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) instance to update based on\n the properties of the slider."}],"docs":"A convenience function used to update the\n[classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) associated with this slider.\n\nThe number of breaks from the renderer must match the number of breaks in the slider.\nGenerally, the input breaks for this method should come from the same renderer as one\nused to create the slider with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#updateFromRendererResult) method.","docsTags":[{"name":"example","text":"```js\nconst renderer = featureLayer?.renderer?.clone();\nconst updatedClassBreakInfos = await classedColorSlider.updateClassBreakInfos(renderer.classBreakInfos);\nrenderer.classBreakInfos = updatedClassBreakInfos;\nfeatureLayer.renderer = renderer;\n```"}]},{"name":"updateFromRendererResult","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"rendererResult","type":"ClassBreaksRendererResult","docs":"The result object from the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createClassBreaksRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ClassBreaksRendererResult":{"location":"import","path":"@arcgis/core/smartMapping/renderers/color.js","id":"notImplemented"},"HistogramResult":{"location":"import","path":"@arcgis/core/smartMapping/statistics/types.js","id":"notImplemented"}}},"signature":"updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"rendererResult","type":"ClassBreaksRendererResult","docs":"The result object from the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createClassBreaksRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"docs":"A convenience function used to update the properties a ClassedColorSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createClassBreaksRenderer) method.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","docsTags":[{"name":"example","text":"```js\nconst rendererResult = await colorRendererCreator.createClassBreaksRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait classedColorSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"breaks\" | \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"breaks\" | \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"state\"; }","resolved":"{ name: \"breaks\" | \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisThumbChange","detail":"ThumbChangeEvent","bubbles":true,"complexType":{"original":"ThumbChangeEvent","resolved":"ThumbChangeEvent","references":{"ThumbChangeEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.","docsTags":[]},{"event":"arcgisThumbDrag","detail":"ThumbDragEvent","bubbles":true,"complexType":{"original":"ThumbDragEvent","resolved":"ThumbDragEvent","references":{"ThumbDragEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user drags a thumb on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slider-classed-size-legacy/slider-classed-size-legacy.tsx","tag":"arcgis-slider-classed-size-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Classed Size Slider component is designed for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with size in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/).\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Classed Size Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/classedsizeslider-labels.avif \"Classed Size Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos) configuration,\nand the slider's histogram after the renderer has been created from the result of the [createClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer)\nmethod.\n\n```js\nconst sizeRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/size.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst classedSizeSlider = document.querySelector(\"arcgis-slider-classed-size-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Median_Income_by_Race_and_Age_Selp_Emp_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n layer: featureLayer,\n field: \"B19049_001E\",\n view: viewElement.view,\n numClasses: 4,\n};\n\nconst rendererResult = await sizeRendererCreator.createClassBreaksRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait classedSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nin a ClassBreaksRenderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update the breaks of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = async () => {\n const renderer = featureLayer?.renderer?.clone();\n if (!renderer || !(\"classBreakInfos\" in renderer) || !renderer.classBreakInfos?.[0]) {\n return;\n }\n renderer.classBreakInfos = (await classedSizeSlider.updateClassBreakInfos(renderer.classBreakInfos);\n featureLayer.renderer = renderer;\n};\n\nclassedSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nclassedSizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nclassedSizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[sizeRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/)"},{"name":"see","text":"[ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"breaks","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SizeBreak":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of class breaks with associated sizes. The size mapped to each break should\nbe used to update the renderer of a layer. A minimum of two breaks must be provided to the slider.","docsTags":[{"name":"example","text":"```js\nclassedSizeSlider.breaks = [\n { min: 0, max: 20, size: 6 },\n { min: 20, max: 40, size: 12 },\n { min: 40, max: 60, size: 24 },\n { min: 60, max: 80, size: 48 },\n];\n```"}],"values":[],"optional":true,"required":false},{"name":"histogramConfig","type":"HistogramConfig | null | undefined","complexType":{"original":"HistogramConfig | null | undefined","resolved":"HistogramConfig | null | undefined","references":{"HistogramConfig":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The histogram associated with the data represented on the slider. The bins are typically\ngenerated using the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) statistics function.","docsTags":[{"name":"example","text":"```js\nconst histogramResult = await histogram({\n layer: featureLayer,\n field: \"fieldName\",\n numBins: 30,\n});\n\nslider.histogramConfig = {\n bins: histogramResult.bins\n};\n```"},{"name":"see","text":"[histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#labelFormatFunction), which formats\nthumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins\nto edit them.\n\nThe image below demonstrates how slider input values resemble corresponding slider values by default\nand won't match the formatting set in `labelFormatFunction`.\n\n![Slider without input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-no-input-formatter.avif \"Slider without input formatter\")\n\nIf you want to format slider input values so they match thumb labels, you can pass the same function set in `labelFormatFunction` to\n`inputFormatFunction` for consistent formatting.\n\n![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-input-formatter.avif \"Slider with input formatter\")\n\nHowever, if an `inputFormatFunction` is specified, you must also write a corresponding\n[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if\nyou specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#labelFormatFunction) to the same value\nfor consistency between labels and inputs.\n\nThis property overrides the default input formatter, which formats by calling `toString()` on the input value.\n ","docsTags":[{"name":"see","text":"[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#inputParseFunction)"},{"name":"example","text":"```js\n// Formats the slider input to abbreviated numbers with units\n// e.g. a thumb at position 1500 will render with an input label of 1.5k\nslider.inputFormatFunction = (value: number): string => {\n if (value >= 1000000) {\n return (value / 1000000).toPrecision(3) + \"m\";\n }\n if (value >= 100000) {\n return (value / 1000).toPrecision(3) + \"k\";\n }\n if (value >= 1000) {\n return (value / 1000).toPrecision(2) + \"k\";\n }\n return value.toFixed(0);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"inputParseFunction","type":"InputParseFunction | null | undefined","complexType":{"original":"InputParseFunction | null | undefined","resolved":"InputParseFunction | null | undefined","references":{"InputParseFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#inputFormatFunction).\nThis property must be set if an `inputFormatFunction` is set. Otherwise the slider values will\nlikely not update to their expected positions.\n\nOverrides the default input parses, which is a parsed floating point number.","docsTags":[{"name":"see","text":"[inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#inputFormatFunction)"},{"name":"example","text":"```js\n// Parses the slider input (a string value) to a number value understandable to the slider\n// This assumes the slider was already configured with an inputFormatFunction\n// For example, if the input is 1.5k this function will parse\n// it to a value of 1500\ncolorSlider.inputParseFunction = (value: string): number => {\n const charLength = value.length;\n const valuePrefix = parseFloat(value.substring(0, charLength - 1));\n const finalChar = value.substring(charLength - 1);\n\n if (parseFloat(finalChar) >= 0) {\n return parseFloat(value);\n }\n if (finalChar === \"k\") {\n return valuePrefix * 1000;\n }\n if (finalChar === \"m\") {\n return valuePrefix * 1000000;\n }\n return parseFloat(value);\n};\n ```"}],"values":[],"optional":true,"required":false},{"name":"labelFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.","docsTags":[{"name":"example","text":"```js\n// For thumb values, rounds each label to whole numbers\nslider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {\n return (type === \"value\") ? value.toFixed(0) : value.toString();\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"max","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max","reflectToAttr":false,"docs":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nclassedSizeSlider.max = 150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min","reflectToAttr":false,"docs":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nclassedSizeSlider.min = -150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"precision","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"precision","reflectToAttr":false,"docs":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","docsTags":[{"name":"example","text":"```js\n// Rounds slider thumb values to 7 decimal places\nslider.precision = 7;\n```"}],"default":"4","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"sliderStyle","type":"ClassedSizeSliderStyle","complexType":{"original":"ClassedSizeSliderStyle","resolved":"ClassedSizeSliderStyle","references":{"ClassedSizeSliderStyle":{"location":"import","path":"@arcgis/core/widgets/smartMapping/ClassedSizeSlider.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Exposes various properties of the component that can be styled. The result object from the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer)\nmethod can be used to match the `trackFillColor` to the current layer symbology.","docsTags":[{"name":"see","text":"[Color](https://developers.arcgis.com/javascript/latest/references/core/Color/)"},{"name":"example","text":"```js\nclassedSizeSlider.sliderStyle = {\n trackFillColor: rendererResult.renderer.classBreakInfos[0].symbol.color ?? new Color([149, 149, 149]),\n trackBackgroundColor: new Color([224, 224, 224]),\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"state","type":"SmartMappingSliderBaseState","complexType":{"original":"SmartMappingSliderBaseState","resolved":"SmartMappingSliderBaseState","references":{"SmartMappingSliderBaseState":{"location":"import","path":"@arcgis/core/widgets/smartMapping/SmartMappingSliderBase.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSliderClassedSizeLegacy = document.createElement(\"arcgis-slider-classed-size-legacy\");\ndocument.body.append(arcgisSliderClassedSizeLegacy);\nawait arcgisSliderClassedSizeLegacy.componentOnReady();\nconsole.log(\"arcgis-slider-classed-size-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"updateClassBreakInfos","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(breakInfos: ClassBreakInfo[]): Promise","parameters":[{"name":"breakInfos","type":"ClassBreakInfo[]","docs":"The classBreakInfos\n from a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) instance to update based on\n the properties of the slider."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/renderers/support/ClassBreakInfo.js","id":"notImplemented"}}},"signature":"updateClassBreakInfos(breakInfos: ClassBreakInfo[]): Promise","parameters":[{"name":"breakInfos","type":"ClassBreakInfo[]","docs":"The classBreakInfos\n from a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) instance to update based on\n the properties of the slider."}],"docs":"A convenience function used to update the\n[classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) associated with this slider.\n\nThe number of breaks from the renderer must match the number of breaks in the slider.\nGenerally, the input breaks for this method should come from the same renderer as one\nused to create the slider with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method.","docsTags":[{"name":"example","text":"```js\nconst renderer = featureLayer?.renderer?.clone();\nrenderer.classBreakInfos = (await classedSizeSlider.updateClassBreakInfos(renderer.classBreakInfos));\nfeatureLayer.renderer = renderer;\n```"}]},{"name":"updateFromRendererResult","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"rendererResult","type":"ClassBreaksRendererResult","docs":"The result object from the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ClassBreaksRendererResult":{"location":"import","path":"@arcgis/core/smartMapping/renderers/size.js","id":"notImplemented"},"HistogramResult":{"location":"import","path":"@arcgis/core/smartMapping/statistics/types.js","id":"notImplemented"}}},"signature":"updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"rendererResult","type":"ClassBreaksRendererResult","docs":"The result object from the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"docs":"A convenience function used to update the properties a ClassedSizeSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer) method.\nThis method is used to configure an empty ClassedSizeSlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","docsTags":[{"name":"example","text":"```js\nconst rendererResult = await sizeRendererCreator.createClassBreaksRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait classedSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"breaks\" | \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"breaks\" | \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\"; }","resolved":"{ name: \"breaks\" | \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisThumbChange","detail":"ThumbChangeEvent","bubbles":true,"complexType":{"original":"ThumbChangeEvent","resolved":"ThumbChangeEvent","references":{"ThumbChangeEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.","docsTags":[]},{"event":"arcgisThumbDrag","detail":"ThumbDragEvent","bubbles":true,"complexType":{"original":"ThumbDragEvent","resolved":"ThumbDragEvent","references":{"ThumbDragEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user drags a thumb on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slider-color-legacy/slider-color-legacy.tsx","tag":"arcgis-slider-color-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Color Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/).\n\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Color Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/colorslider-2-labels.avif \"Color Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#min), the [color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) configuration,\nand the slider's histogram after the renderer has been created from the result of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createContinuousRenderer) method.\n\n```js\nconst colorRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/color.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst colorSlider = document.querySelector(\"arcgis-slider-color-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params: ContinuousRendererParameters = {\n layer: featureLayer,\n field: \"B17020_calc_pctPovE\",\n view: viewElement.view,\n theme: \"above-and-below\",\n};\n\nconst rendererResult = await colorRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\ncolorSlider.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update a [color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/)\nin a layer's renderer. It is the responsibility of the app developer to set up event listeners on this slider that update the color variable of the appropriate renderer.\n\n```js\n// when the user slides the handle(s), update the renderer\n// with the updated color stops\ncolorSlider.updateFromRendererResult(rendererResult, histogramResult);\n\nconst updateRendererFromSlider = () => {\n const renderer = featureLayer.renderer?.clone();\n if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n return;\n }\n\n const colorVariable = renderer.visualVariables[0].clone();\n colorVariable.stops = colorSlider.stops;\n\n renderer.visualVariables = [colorVariable];\n featureLayer.renderer = renderer;\n};\n\ncolorSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\ncolorSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\ncolorSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[colorRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"handlesSyncedToPrimary","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"handles-synced-to-primary","reflectToAttr":false,"docs":"Only applicable when three thumbs (i.e. handles) are set on the\nslider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#primaryHandleEnabled) is `true`). This property\nindicates whether the position of the outside handles are synced with the middle, or primary,\nhandle. When enabled, if the primary handle is moved then the outside handle positions are updated\nwhile maintaining a fixed distance from the primary handle.","docsTags":[{"name":"see","text":"[primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ColorSlider/#primaryHandleEnabled)"},{"name":"example","text":"```js\n// enables the primary handles and syncs it with the others\ncolorSlider.primaryHandleEnabled = true;\ncolorSlider.handlesSyncedToPrimary = true;\n```"}],"default":"true","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"histogramConfig","type":"HistogramConfig | null | undefined","complexType":{"original":"HistogramConfig | null | undefined","resolved":"HistogramConfig | null | undefined","references":{"HistogramConfig":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The histogram associated with the data represented on the slider. The bins are typically\ngenerated using the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) statistics function.","docsTags":[{"name":"example","text":"```js\nconst histogramResult = await histogram({\n layer: featureLayer,\n field: \"fieldName\",\n numBins: 30,\n});\n\nslider.histogramConfig = {\n bins: histogramResult.bins\n};\n```"},{"name":"see","text":"[histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#labelFormatFunction), which formats\nthumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins\nto edit them.\n\nThe image below demonstrates how slider input values resemble corresponding slider values by default\nand won't match the formatting set in `labelFormatFunction`.\n\n![Slider without input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-no-input-formatter.avif \"Slider without input formatter\")\n\nIf you want to format slider input values so they match thumb labels, you can pass the same function set in `labelFormatFunction` to\n`inputFormatFunction` for consistent formatting.\n\n![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-input-formatter.avif \"Slider with input formatter\")\n\nHowever, if an `inputFormatFunction` is specified, you must also write a corresponding\n[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if\nyou specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#labelFormatFunction) to the same value\nfor consistency between labels and inputs.\n\nThis property overrides the default input formatter, which formats by calling `toString()` on the input value.\n ","docsTags":[{"name":"see","text":"[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#inputParseFunction)"},{"name":"example","text":"```js\n// Formats the slider input to abbreviated numbers with units\n// e.g. a thumb at position 1500 will render with an input label of 1.5k\nslider.inputFormatFunction = (value: number): string => {\n if (value >= 1000000) {\n return (value / 1000000).toPrecision(3) + \"m\";\n }\n if (value >= 100000) {\n return (value / 1000).toPrecision(3) + \"k\";\n }\n if (value >= 1000) {\n return (value / 1000).toPrecision(2) + \"k\";\n }\n return value.toFixed(0);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"inputParseFunction","type":"InputParseFunction | null | undefined","complexType":{"original":"InputParseFunction | null | undefined","resolved":"InputParseFunction | null | undefined","references":{"InputParseFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#inputFormatFunction).\nThis property must be set if an `inputFormatFunction` is set. Otherwise the slider values will\nlikely not update to their expected positions.\n\nOverrides the default input parses, which is a parsed floating point number.","docsTags":[{"name":"see","text":"[inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#inputFormatFunction)"},{"name":"example","text":"```js\n// Parses the slider input (a string value) to a number value understandable to the slider\n// This assumes the slider was already configured with an inputFormatFunction\n// For example, if the input is 1.5k this function will parse\n// it to a value of 1500\ncolorSlider.inputParseFunction = (value: string): number => {\n const charLength = value.length;\n const valuePrefix = parseFloat(value.substring(0, charLength - 1));\n const finalChar = value.substring(charLength - 1);\n\n if (parseFloat(finalChar) >= 0) {\n return parseFloat(value);\n }\n if (finalChar === \"k\") {\n return valuePrefix * 1000;\n }\n if (finalChar === \"m\") {\n return valuePrefix * 1000000;\n }\n return parseFloat(value);\n};\n ```"}],"values":[],"optional":true,"required":false},{"name":"labelFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.","docsTags":[{"name":"example","text":"```js\n// For thumb values, rounds each label to whole numbers\nslider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {\n return (type === \"value\") ? value.toFixed(0) : value.toString();\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"max","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max","reflectToAttr":false,"docs":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color variable of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\ncolorSlider.max = 150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min","reflectToAttr":false,"docs":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color variable of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\ncolorSlider.min = -150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"precision","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"precision","reflectToAttr":false,"docs":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","docsTags":[{"name":"example","text":"```js\n// Rounds slider thumb values to 7 decimal places\nslider.precision = 7;\n```"}],"default":"4","values":[{"type":"number"}],"optional":true,"required":false},{"name":"primaryHandleEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"primary-handle-enabled","reflectToAttr":false,"docs":"When `true`, the slider will render a third handle between the two handles already provided by default. This is the primary handle.\nThree or five [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#stops) must be defined for the primary handle to render.\nThe primary handle represents the middle stop.\n\nWhen [handlesSyncedToPrimary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#handlesSyncedToPrimary) is `true`, then this handle will control the position of the others when moved.\n\nThis is typically used in diverging, or `above-and-below` renderer configurations.","docsTags":[{"name":"example","text":"```js\n// enables the primary handles and syncs it with the others\ncolorSlider.primaryHandleEnabled = true;\ncolorSlider.handlesSyncedToPrimary = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"stops","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/renderers/visualVariables/support/ColorStop.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The color stops from the [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/)\nto link to the slider. The colors in these stops will be used to render the color gradient on the slider's track. They should match the colors\nrendered in the associated layer's renderer.","docsTags":[{"name":"example","text":"```js\ncolorSlider.stops = [\n { value: colorSlider.min, color: new Color([0, 255, 0, 1]) },\n { value: (colorSlider.max + colorSlider.min) / 2, color: new Color([255, 255, 255, 1]) },\n { value: colorSlider.max, color: new Color([255, 0, 0, 1]) },\n]\n```"}],"values":[],"optional":true,"required":false},{"name":"zoomOptions","type":"ZoomOptions | null | undefined","complexType":{"original":"ZoomOptions | null | undefined","resolved":"ZoomOptions | null | undefined","references":{"ZoomOptions":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Zooms the slider track to the bounds provided in this property. When min and/or max zoom values are provided, the absolute [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#min) and\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#max) slider values are preserved and rendered at their typical positions on the slider. However, the\n slider track itself is zoomed so that thumbs cannot be moved above or below the provided min and max zoomed values.\n\n When a slider is in a zoomed state, the zoomed ends of the track will appear jagged. In the image below, notice how the\n top thumb cannot be moved past the zoom max of `31` even though the slider max is `200`.\n\n ![slider-zoom](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-zoomed.avif \"Zoomed slider\")\n\n To exit a zoomed state, the user can click the jagged line or the developer can set the `zoomOptions` to `null`. It\n is up to the developer to provide a UI option for end users to enable zooming on the slider.\n\n Setting the `zoomOptions` is useful when the slider is tied to heavily skewed datasets where the histogram renders only one or two bars because of outliers.\n\n ![slider-not-zoomed](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-skewed-not-zoomed.avif \"Unzoomed slider\")\n\n You can remove the influence of outliers by zooming the slider and regenerating a histogram based on the zoomed min and max. This will provide a better view of the data\n and make the slider more useful to the end user.","docsTags":[{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions between\n// values of 10 and 25 while maintaining the slider's absolute min and max values\nslider.zoomOptions = {\n min: 10,\n max: 25\n};\n```"},{"name":"example","text":"```js\n// disables zooming on the slider\nslider.zoomOptions = null;\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions above\n// value of 10 while maintaining the slider's absolute min value\nslider.zoomOptions = {\n min: 10\n};\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions below\n// value of 25 while maintaining the slider's absolute max value\nslider.zoomOptions = {\n max: 25\n};\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSliderColorLegacy = document.createElement(\"arcgis-slider-color-legacy\");\ndocument.body.append(arcgisSliderColorLegacy);\nawait arcgisSliderColorLegacy.componentOnReady();\nconsole.log(\"arcgis-slider-color-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"updateFromRendererResult","returns":{"type":"void","docs":""},"complexType":{"signature":"(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void","parameters":[{"name":"rendererResult","type":"ContinuousRendererResult","docs":"The result object from the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createContinuousRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)\n method."}],"return":"void","references":{"ContinuousRendererResult":{"location":"import","path":"@arcgis/core/smartMapping/renderers/color.js","id":"notImplemented"},"HistogramResult":{"location":"import","path":"@arcgis/core/smartMapping/statistics/types.js","id":"notImplemented"}}},"signature":"updateFromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void","parameters":[{"name":"rendererResult","type":"ContinuousRendererResult","docs":"The result object from the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createContinuousRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)\n method."}],"docs":"A convenience function used to update the properties of a Color Slider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createContinuousRenderer)\nmethod. This method is used to configure an empty Color Slider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","docsTags":[{"name":"example","text":"```js\nconst rendererResult = await colorRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\ncolorSlider.updateFromRendererResult(rendererResult, histogramResult);\n```"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"handlesSyncedToPrimary\" | \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"primaryHandleEnabled\" | \"stops\" | \"zoomOptions\"; }","bubbles":true,"complexType":{"original":"{ name: \"handlesSyncedToPrimary\" | \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"primaryHandleEnabled\" | \"stops\" | \"zoomOptions\"; }","resolved":"{ name: \"handlesSyncedToPrimary\" | \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"primaryHandleEnabled\" | \"stops\" | \"zoomOptions\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisThumbChange","detail":"ThumbChangeEvent","bubbles":true,"complexType":{"original":"ThumbChangeEvent","resolved":"ThumbChangeEvent","references":{"ThumbChangeEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.","docsTags":[{"name":"example","text":"```js\n// when the user slides the handle(s), update the layer's renderer\n// with the updated color stops\ncolorSlider.addEventListener(\"arcgisThumbChange\", updateLayerRenderer);\ncolorSlider.addEventListener(\"arcgisThumbDrag\", updateLayerRenderer);\n\nfunction updateLayerRenderer (event) {\n const renderer = layer.renderer.clone();\n const colorVariable = renderer.visualVariables[0].clone();\n colorVariable.stops = colorSlider.stops;\n renderer.visualVariables = [colorVariable];\n layer.renderer = renderer;\n}\n```"}]},{"event":"arcgisThumbDrag","detail":"ThumbDragEvent","bubbles":true,"complexType":{"original":"ThumbDragEvent","resolved":"ThumbDragEvent","references":{"ThumbDragEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user drags a thumb on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slider-color-size-legacy/slider-color-size-legacy.tsx","tag":"arcgis-slider-color-size-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Color Size Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) and\na [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/). Both visual variables should be used\nto visualize the same data variable.\n\nThis slider and visualization style is designed specifically for\n3D thematic visualizations where both size and color are used to visualize the same data variable in order\nto minimize confusion because of distortion in perception. For example, a visualization of extruded points\nmay be difficult to understand if two features of similar sizes (and therefore data values) are located\nfar apart from one another; the feature furthest from the [Camera](https://developers.arcgis.com/javascript/latest/references/core/Camera/) will appear smaller than\nthe feature closer to the camera. The color variable can help the user understand that both features have similar values.\n\n![Slider Color Size with perspective](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/colorsizeslider-perspective.avif \"Slider Color Size with perspective\")\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Slider Color Size with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/colorsizeslider-labels.avif \"Slider Color Size with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) configuration,\n[color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) configuration, and the slider's histogram after the\nrenderer has been created from the result of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer) method.\n\n```js\nconst colorAndSizeRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/univariateColorSize.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst colorSizeSlider = document.querySelector(\"arcgis-slider-color-size-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n layer: featureLayer,\n field: \"B17020_calc_pctPovE\",\n view: viewElement.view,\n};\n\nconst rendererResult = await colorAndSizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait colorSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update the corresponding [color](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/)\nand [size](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) visual variables in a layer's renderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update these variables in the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = () => {\n const renderer = featureLayer?.renderer?.clone();\n if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n return;\n }\n renderer.visualVariables = colorSizeSlider.updateVisualVariables(\n renderer.visualVariables as VisualVariable[],\n );\n featureLayer.renderer = renderer;\n};\n\ncolorSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\ncolorSizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\ncolorSizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[univariateColorSizeRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"handlesSyncedToPrimary","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"handles-synced-to-primary","reflectToAttr":false,"docs":"Only applicable when three thumbs (i.e. handles) are set on the\nslider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#primaryHandleEnabled) is `true`). This property\nindicates whether the position of the outside handles are synced with the middle, or primary,\nhandle. When enabled, if the primary handle is moved then the outside handle positions are updated\nwhile maintaining a fixed distance from the primary handle.","docsTags":[{"name":"see","text":"[primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ColorSizeSlider/#primaryHandleEnabled)"},{"name":"example","text":"```js\n// enables the primary handles and syncs it with the others\ncolorSizeSlider.primaryHandleEnabled = true;\ncolorSizeSlider.handlesSyncedToPrimary = true;\ncolorSizeSlider.persistSizeRangeEnabled = true;\n```"}],"default":"true","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"histogramConfig","type":"HistogramConfig | null | undefined","complexType":{"original":"HistogramConfig | null | undefined","resolved":"HistogramConfig | null | undefined","references":{"HistogramConfig":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The histogram associated with the data represented on the slider. The bins are typically\ngenerated using the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) statistics function.","docsTags":[{"name":"example","text":"```js\nconst histogramResult = await histogram({\n layer: featureLayer,\n field: \"fieldName\",\n numBins: 30,\n});\n\nslider.histogramConfig = {\n bins: histogramResult.bins\n};\n```"},{"name":"see","text":"[histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#labelFormatFunction), which formats\nthumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins\nto edit them.\n\nThe image below demonstrates how slider input values resemble corresponding slider values by default\nand won't match the formatting set in `labelFormatFunction`.\n\n![Slider without input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-no-input-formatter.avif \"Slider without input formatter\")\n\nIf you want to format slider input values so they match thumb labels, you can pass the same function set in `labelFormatFunction` to\n`inputFormatFunction` for consistent formatting.\n\n![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-input-formatter.avif \"Slider with input formatter\")\n\nHowever, if an `inputFormatFunction` is specified, you must also write a corresponding\n[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if\nyou specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#labelFormatFunction) to the same value\nfor consistency between labels and inputs.\n\nThis property overrides the default input formatter, which formats by calling `toString()` on the input value.\n ","docsTags":[{"name":"see","text":"[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#inputParseFunction)"},{"name":"example","text":"```js\n// Formats the slider input to abbreviated numbers with units\n// e.g. a thumb at position 1500 will render with an input label of 1.5k\nslider.inputFormatFunction = (value: number): string => {\n if (value >= 1000000) {\n return (value / 1000000).toPrecision(3) + \"m\";\n }\n if (value >= 100000) {\n return (value / 1000).toPrecision(3) + \"k\";\n }\n if (value >= 1000) {\n return (value / 1000).toPrecision(2) + \"k\";\n }\n return value.toFixed(0);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"inputParseFunction","type":"InputParseFunction | null | undefined","complexType":{"original":"InputParseFunction | null | undefined","resolved":"InputParseFunction | null | undefined","references":{"InputParseFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#inputFormatFunction).\nThis property must be set if an `inputFormatFunction` is set. Otherwise the slider values will\nlikely not update to their expected positions.\n\nOverrides the default input parses, which is a parsed floating point number.","docsTags":[{"name":"see","text":"[inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#inputFormatFunction)"},{"name":"example","text":"```js\n// Parses the slider input (a string value) to a number value understandable to the slider\n// This assumes the slider was already configured with an inputFormatFunction\n// For example, if the input is 1.5k this function will parse\n// it to a value of 1500\ncolorSlider.inputParseFunction = (value: string): number => {\n const charLength = value.length;\n const valuePrefix = parseFloat(value.substring(0, charLength - 1));\n const finalChar = value.substring(charLength - 1);\n\n if (parseFloat(finalChar) >= 0) {\n return parseFloat(value);\n }\n if (finalChar === \"k\") {\n return valuePrefix * 1000;\n }\n if (finalChar === \"m\") {\n return valuePrefix * 1000000;\n }\n return parseFloat(value);\n};\n ```"}],"values":[],"optional":true,"required":false},{"name":"labelFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.","docsTags":[{"name":"example","text":"```js\n// For thumb values, rounds each label to whole numbers\nslider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {\n return (type === \"value\") ? value.toFixed(0) : value.toString();\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"max","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max","reflectToAttr":false,"docs":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color and size variables of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\ncolorSizeSlider.max = 150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min","reflectToAttr":false,"docs":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color and size variables of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\ncolorSizeSlider.min = -150;"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"persistSizeRangeEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"persist-size-range-enabled","reflectToAttr":false,"docs":"Only applicable when three thumbs (i.e. handles) are set on the\nslider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#primaryHandleEnabled) is `true`).\nThis property is typically used in diverging, or `above-and-below` renderer configurations.\n\nWhen `true`, ensures symbol sizes in the `above` range\nare consistent with symbol sizes in the `below` range for all slider thumb positions.\nIn other words, the size values in the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#stops) will adjust\nproportionally according to the positions of the data values within the\nconstraints of the size range (maxSize - minSize) as the slider thumbs update.\nWhen `false`, size values in the stops will remain the same even when slider thumb values\nchange.\n\nIn most cases, this should be set to `true` to keep sizes in the `above` range consistent with\nsizes in the `below` range to avoid map misinterpretation.","docsTags":[{"name":"see","text":"[primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ColorSizeSlider/#primaryHandleEnabled)"},{"name":"example","text":"```js\ncolorSizeSlider.primaryHandleEnabled = true;\ncolorSizeSlider.persistSizeRangeEnabled = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"precision","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"precision","reflectToAttr":false,"docs":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","docsTags":[{"name":"example","text":"```js\n// Rounds slider thumb values to 7 decimal places\nslider.precision = 7;\n```"}],"default":"4","values":[{"type":"number"}],"optional":true,"required":false},{"name":"primaryHandleEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"primary-handle-enabled","reflectToAttr":false,"docs":"When `true`, the slider will render a third handle between the\ntwo handles already provided by default. This is the primary handle.\nThree or five [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#stops) must be defined for the primary handle to render.\nThe primary handle represents the middle stop.\n\nWhen [handlesSyncedToPrimary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#handlesSyncedToPrimary) is `true`, then\nthis handle will control the position of the others when moved.\n\nThis is typically used in diverging, or `above-and-below` renderer configurations.","docsTags":[{"name":"see","text":"[handlesSyncedToPrimary](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ColorSizeSlider/#handlesSyncedToPrimary)"},{"name":"see","text":"[persistSizeRangeEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ColorSizeSlider/#persistSizeRangeEnabled)"},{"name":"example","text":"```js\n// enables the primary handles and syncs it with the others\ncolorSizeSlider.primaryHandleEnabled = true;\ncolorSizeSlider.handlesSyncedToPrimary = true;\ncolorSizeSlider.persistSizeRangeEnabled = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"SmartMappingSliderBaseState","complexType":{"original":"SmartMappingSliderBaseState","resolved":"SmartMappingSliderBaseState","references":{"SmartMappingSliderBaseState":{"location":"import","path":"@arcgis/core/widgets/smartMapping/SmartMappingSliderBase.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"stops","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/renderers/visualVariables/support/ColorSizeStop.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The colors and sizes corresponding with data values in the [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/)\nand [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) of the renderer associated with the slider.\n\nUse the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method to conveniently construct these stops from a renderer generated from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer) smart mapping module.\n\nUse [updateVisualVariables()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateVisualVariables) to update the renderer's visual variables with the values matching the slider thumb positions.","docsTags":[{"name":"see","text":"[updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult)"},{"name":"see","text":"[updateVisualVariables()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateVisualVariables)"},{"name":"example","text":"```js\ncolorSizeSlider.stops = [\n { size: 2, value: colorSizeSlider.min, color: new Color([240, 240, 240, 1]) },\n { size: 24, value: colorSizeSlider.max, color: new Color([0, 0, 255, 1]) },\n]\n```"}],"values":[],"optional":true,"required":false},{"name":"zoomOptions","type":"ZoomOptions | null | undefined","complexType":{"original":"ZoomOptions | null | undefined","resolved":"ZoomOptions | null | undefined","references":{"ZoomOptions":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Zooms the slider track to the bounds provided in this property. When min and/or max zoom values are provided, the absolute [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#min) and\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#max) slider values are preserved and rendered at their typical positions on the slider. However, the\n slider track itself is zoomed so that thumbs cannot be moved above or below the provided min and max zoomed values.\n\n When a slider is in a zoomed state, the zoomed ends of the track will appear jagged. In the image below, notice how the\n top thumb cannot be moved past the zoom max of `31` even though the slider max is `200`.\n\n ![slider-zoom](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-zoomed.avif \"Zoomed slider\")\n\n To exit a zoomed state, the user can click the jagged line or the developer can set the `zoomOptions` to `null`. It\n is up to the developer to provide a UI option for end users to enable zooming on the slider.\n\n Setting the `zoomOptions` is useful when the slider is tied to heavily skewed datasets where the histogram renders only one or two bars because of outliers.\n\n ![slider-not-zoomed](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-skewed-not-zoomed.avif \"Unzoomed slider\")\n\n You can remove the influence of outliers by zooming the slider and regenerating a histogram based on the zoomed min and max. This will provide a better view of the data\n and make the slider more useful to the end user.","docsTags":[{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions between\n// values of 10 and 25 while maintaining the slider's absolute min and max values\nslider.zoomOptions = {\n min: 10,\n max: 25\n};\n```"},{"name":"example","text":"```js\n// disables zooming on the slider\nslider.zoomOptions = null;\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions above\n// value of 10 while maintaining the slider's absolute min value\nslider.zoomOptions = {\n min: 10\n};\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions below\n// value of 25 while maintaining the slider's absolute max value\nslider.zoomOptions = {\n max: 25\n};\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSliderColorSizeLegacy = document.createElement(\"arcgis-slider-color-size-legacy\");\ndocument.body.append(arcgisSliderColorSizeLegacy);\nawait arcgisSliderColorSizeLegacy.componentOnReady();\nconsole.log(\"arcgis-slider-color-size-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"updateFromRendererResult","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(rendererResult: RendererResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"rendererResult","type":"RendererResult","docs":"The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"RendererResult":{"location":"import","path":"@arcgis/core/smartMapping/renderers/univariateColorSize.js","id":"notImplemented"},"HistogramResult":{"location":"import","path":"@arcgis/core/smartMapping/statistics/types.js","id":"notImplemented"}}},"signature":"updateFromRendererResult(rendererResult: RendererResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"rendererResult","type":"RendererResult","docs":"The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"docs":"A convenience function used to update the properties of a Slider Color Size component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod. Note that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","docsTags":[{"name":"example","text":"```js\nconst rendererResult = await colorAndSizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait colorSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```"}]},{"name":"updateVisualVariables","returns":{"type":"VisualVariable[]","docs":""},"complexType":{"signature":"(variables: VisualVariable[]): VisualVariable[]","parameters":[{"name":"variables","type":"VisualVariable[]","docs":"The visual variables to update from the renderer associated with the slider. The properties of the\n color and size variables will update based on the slider thumb values."}],"return":"VisualVariable[]","references":{"VisualVariable":{"location":"import","path":"@arcgis/core/widgets/smartMapping/ColorSizeSlider.js","id":"notImplemented"}}},"signature":"updateVisualVariables(variables: VisualVariable[]): VisualVariable[]","parameters":[{"name":"variables","type":"VisualVariable[]","docs":"The visual variables to update from the renderer associated with the slider. The properties of the\n color and size variables will update based on the slider thumb values."}],"docs":"A convenience function used to update the visual variables of a renderer generated with the\n[createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod with the values obtained from the slider. This method is useful for cases when the app allows the end user to switch data variables\nused to render the data.","docsTags":[{"name":"example","text":"```js\nconst renderer = featureLayer?.renderer?.clone();\nrenderer.visualVariables = colorSizeSlider.updateVisualVariables(renderer.visualVariables as VisualVariable[]);\nfeatureLayer.renderer = renderer;\n```"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"state\" | \"stops\" | \"zoomOptions\"; }","bubbles":true,"complexType":{"original":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"state\" | \"stops\" | \"zoomOptions\"; }","resolved":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"state\" | \"stops\" | \"zoomOptions\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisThumbChange","detail":"ThumbChangeEvent","bubbles":true,"complexType":{"original":"ThumbChangeEvent","resolved":"ThumbChangeEvent","references":{"ThumbChangeEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.","docsTags":[]},{"event":"arcgisThumbDrag","detail":"ThumbDragEvent","bubbles":true,"complexType":{"original":"ThumbDragEvent","resolved":"ThumbDragEvent","references":{"ThumbDragEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user drags a thumb on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slider-heatmap-legacy/slider-heatmap-legacy.tsx","tag":"arcgis-slider-heatmap-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Heatmap Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/HeatmapRenderer/).\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Heatmap Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/heatmapslider-labels.avif \"Heatmap Slider with annotations\")\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst heatmapSlider = document.querySelector(\"arcgis-slider-heatmap-legacy\")!;\n\nconst layer = new CSVLayer({\n url: \"https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.csv\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(layer);\n\nconst params = {\n layer,\n valueExpression: \"($feature.mag)\",\n view: viewElement.view,\n};\n\nconst rendererResult = await heatmapRendererCreator.createRenderer(params);\n\nlayer.renderer = rendererResult.renderer;\n\nheatmapSlider.stops = rendererResult.renderer.colorStops;\n```\n\nThis slider should be used to update the [colorStops](https://developers.arcgis.com/javascript/latest/references/core/renderers/HeatmapRenderer/#colorStops)\nproperty in a HeatmapRenderer. It is the responsibility of the app developer\nto set up event listeners on this slider to update the renderer's colorStops based on how the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-heatmap-legacy/#stops) property was recalculated.\n\n```js\nconst updateRendererFromSlider = () => {\n const renderer = layer.renderer?.clone();\n if (!renderer || !(\"colorStops\" in renderer)) {\n return;\n }\n renderer.colorStops = heatmapSlider.stops;\n layer.renderer = renderer;\n};\n\nheatmapSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nheatmapSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nheatmapSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[heatmapRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/heatmap/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-heatmap-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"max","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The maximum value or upper bound of the slider.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The minimum value or lower bound of the slider.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"precision","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"precision","reflectToAttr":false,"docs":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","docsTags":[{"name":"example","text":"```js\n// Rounds slider thumb values to 7 decimal places\nslider.precision = 7;\n```"}],"default":"4","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"SmartMappingSliderBaseState","complexType":{"original":"SmartMappingSliderBaseState","resolved":"SmartMappingSliderBaseState","references":{"SmartMappingSliderBaseState":{"location":"import","path":"@arcgis/core/widgets/smartMapping/SmartMappingSliderBase.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"stops","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/renderers/support/HeatmapColorStop.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The color stops of the [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/HeatmapRenderer/) to associate with the slider.","docsTags":[{"name":"example","text":"```js\nheatmapSlider.stops = rendererResult.renderer.colorStops;\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSliderHeatmapLegacy = document.createElement(\"arcgis-slider-heatmap-legacy\");\ndocument.body.append(arcgisSliderHeatmapLegacy);\nawait arcgisSliderHeatmapLegacy.componentOnReady();\nconsole.log(\"arcgis-slider-heatmap-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"precision\" | \"state\" | \"stops\"; }","bubbles":true,"complexType":{"original":"{ name: \"precision\" | \"state\" | \"stops\"; }","resolved":"{ name: \"precision\" | \"state\" | \"stops\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisThumbChange","detail":"ThumbChangeEvent","bubbles":true,"complexType":{"original":"ThumbChangeEvent","resolved":"ThumbChangeEvent","references":{"ThumbChangeEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.","docsTags":[]},{"event":"arcgisThumbDrag","detail":"ThumbDragEvent","bubbles":true,"complexType":{"original":"ThumbDragEvent","resolved":"ThumbDragEvent","references":{"ThumbDragEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user drags a thumb on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slider-opacity-legacy/slider-opacity-legacy.tsx","tag":"arcgis-slider-opacity-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Opacity Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with an [OpacityVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/).\n\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Opacity Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/opacityslider-labels.avif \"Opacity Slider with annotations\")\n\nThe [updateFromVisualVariableResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#updateFromVisualVariableResult) method can be used to intelligently populate slider properties including [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#min),\nthe [opacity visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/) configuration,\nand the slider's histogram after the renderer has been created from the result of the\n[createVisualVariable()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#createVisualVariable) method.\n\n```js\nconst opacityVariableCreator = await import(\"@arcgis/core/smartMapping/renderers/opacity.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst opacitySlider = document.querySelector(\"arcgis-slider-opacity-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/ArcGIS/rest/services/USA_Census_2020_DHC_Total_Population/FeatureServer/2\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n layer: featureLayer,\n view: viewElement.view,\n field: \"P002_calc_pct0002\",\n};\n\nconst variableResult = await opacityVariableCreator.createVisualVariable(params);\n\nif (featureLayer.renderer && \"visualVariables\" in featureLayer.renderer) {\n featureLayer.renderer.visualVariables = [variableResult.visualVariable];\n}\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait opacitySlider.updateFromVisualVariableResult(variableResult, histogramResult);\n```\n\nThis slider should be used to update an [opacity visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/)\nin a layer's renderer. It is the responsibility of the app developer\nto set up event listeners on this slider to update the opacity variable of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = () => {\n const renderer = featureLayer.renderer?.clone();\n if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n return;\n }\n\n const visualVariable = renderer.visualVariables[0];\n if (visualVariable.type !== \"opacity\") {\n return;\n }\n\n const opacityVariable = visualVariable.clone();\n opacityVariable.stops = opacitySlider.stops;\n renderer.visualVariables = [opacityVariable];\n featureLayer.renderer = renderer;\n};\n\nopacitySlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nopacitySlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nopacitySlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[opacityVariableCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"histogramConfig","type":"HistogramConfig | null | undefined","complexType":{"original":"HistogramConfig | null | undefined","resolved":"HistogramConfig | null | undefined","references":{"HistogramConfig":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The histogram associated with the data represented on the slider. The bins are typically\ngenerated using the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) statistics function.","docsTags":[{"name":"example","text":"```js\nconst histogramResult = await histogram({\n layer: featureLayer,\n field: \"fieldName\",\n numBins: 30,\n});\n\nslider.histogramConfig = {\n bins: histogramResult.bins\n};\n```"},{"name":"see","text":"[histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#labelFormatFunction), which formats\nthumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins\nto edit them.\n\nThe image below demonstrates how slider input values resemble corresponding slider values by default\nand won't match the formatting set in `labelFormatFunction`.\n\n![Slider without input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-no-input-formatter.avif \"Slider without input formatter\")\n\nIf you want to format slider input values so they match thumb labels, you can pass the same function set in `labelFormatFunction` to\n`inputFormatFunction` for consistent formatting.\n\n![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-input-formatter.avif \"Slider with input formatter\")\n\nHowever, if an `inputFormatFunction` is specified, you must also write a corresponding\n[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if\nyou specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#labelFormatFunction) to the same value\nfor consistency between labels and inputs.\n\nThis property overrides the default input formatter, which formats by calling `toString()` on the input value.\n ","docsTags":[{"name":"see","text":"[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#inputParseFunction)"},{"name":"example","text":"```js\n// Formats the slider input to abbreviated numbers with units\n// e.g. a thumb at position 1500 will render with an input label of 1.5k\nslider.inputFormatFunction = (value: number): string => {\n if (value >= 1000000) {\n return (value / 1000000).toPrecision(3) + \"m\";\n }\n if (value >= 100000) {\n return (value / 1000).toPrecision(3) + \"k\";\n }\n if (value >= 1000) {\n return (value / 1000).toPrecision(2) + \"k\";\n }\n return value.toFixed(0);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"inputParseFunction","type":"InputParseFunction | null | undefined","complexType":{"original":"InputParseFunction | null | undefined","resolved":"InputParseFunction | null | undefined","references":{"InputParseFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#inputFormatFunction).\nThis property must be set if an `inputFormatFunction` is set. Otherwise the slider values will\nlikely not update to their expected positions.\n\nOverrides the default input parses, which is a parsed floating point number.","docsTags":[{"name":"see","text":"[inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#inputFormatFunction)"},{"name":"example","text":"```js\n// Parses the slider input (a string value) to a number value understandable to the slider\n// This assumes the slider was already configured with an inputFormatFunction\n// For example, if the input is 1.5k this function will parse\n// it to a value of 1500\ncolorSlider.inputParseFunction = (value: string): number => {\n const charLength = value.length;\n const valuePrefix = parseFloat(value.substring(0, charLength - 1));\n const finalChar = value.substring(charLength - 1);\n\n if (parseFloat(finalChar) >= 0) {\n return parseFloat(value);\n }\n if (finalChar === \"k\") {\n return valuePrefix * 1000;\n }\n if (finalChar === \"m\") {\n return valuePrefix * 1000000;\n }\n return parseFloat(value);\n};\n ```"}],"values":[],"optional":true,"required":false},{"name":"labelFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.","docsTags":[{"name":"example","text":"```js\n// For thumb values, rounds each label to whole numbers\nslider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {\n return (type === \"value\") ? value.toFixed(0) : value.toString();\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"max","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max","reflectToAttr":false,"docs":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromVisualVariableResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#updateFromVisualVariableResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the opacity variable of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nopacitySlider.max = 75;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min","reflectToAttr":false,"docs":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromVisualVariableResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#updateFromVisualVariableResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the opacity variable of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nopacitySlider.min = 25;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"precision","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"precision","reflectToAttr":false,"docs":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","docsTags":[{"name":"example","text":"```js\n// Rounds slider thumb values to 7 decimal places\nslider.precision = 7;\n```"}],"default":"4","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"sliderStyle","type":"OpacitySliderStyle","complexType":{"original":"OpacitySliderStyle","resolved":"OpacitySliderStyle","references":{"OpacitySliderStyle":{"location":"import","path":"@arcgis/core/widgets/smartMapping/OpacitySlider.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Defines the color to be used within the slider's track. The renderer assigned to the layer can be used to\nmatch the `trackFillColor` to the current layer symbology.","docsTags":[{"name":"see","text":"[Color](https://developers.arcgis.com/javascript/latest/references/core/Color/)"},{"name":"example","text":"```js\nopacitySlider.sliderStyle = {\n trackFillColor: featureLayer.renderer.symbol.color ?? new Color([0, 121, 193]),\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"state","type":"SmartMappingSliderBaseState","complexType":{"original":"SmartMappingSliderBaseState","resolved":"SmartMappingSliderBaseState","references":{"SmartMappingSliderBaseState":{"location":"import","path":"@arcgis/core/widgets/smartMapping/SmartMappingSliderBase.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"stops","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/renderers/visualVariables/support/OpacityStop.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The opacity stops from the [OpacityVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/)\nto link to the slider. The opacity values in these stops will be used\nto render the gradient on the slider. They should match the opacity\nrendered in the associated layer's opacity visual variable.","docsTags":[{"name":"example","text":"```js\nconst updateRendererFromSlider = () => {\n const renderer = featureLayer.renderer?.clone();\n const visualVariable = renderer.visualVariables[0];\n\n const opacityVariable = visualVariable.clone();\n opacityVariable.stops = opacitySlider.stops;\n renderer.visualVariables = [opacityVariable];\n featureLayer.renderer = renderer;\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"zoomOptions","type":"ZoomOptions | null | undefined","complexType":{"original":"ZoomOptions | null | undefined","resolved":"ZoomOptions | null | undefined","references":{"ZoomOptions":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Zooms the slider track to the bounds provided in this property. When min and/or max zoom values are provided, the absolute [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#min) and\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#max) slider values are preserved and rendered at their typical positions on the slider. However, the\n slider track itself is zoomed so that thumbs cannot be moved above or below the provided min and max zoomed values.\n\n When a slider is in a zoomed state, the zoomed ends of the track will appear jagged. In the image below, notice how the\n top thumb cannot be moved past the zoom max of `31` even though the slider max is `200`.\n\n ![slider-zoom](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-zoomed.avif \"Zoomed slider\")\n\n To exit a zoomed state, the user can click the jagged line or the developer can set the `zoomOptions` to `null`. It\n is up to the developer to provide a UI option for end users to enable zooming on the slider.\n\n Setting the `zoomOptions` is useful when the slider is tied to heavily skewed datasets where the histogram renders only one or two bars because of outliers.\n\n ![slider-not-zoomed](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-skewed-not-zoomed.avif \"Unzoomed slider\")\n\n You can remove the influence of outliers by zooming the slider and regenerating a histogram based on the zoomed min and max. This will provide a better view of the data\n and make the slider more useful to the end user.","docsTags":[{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions between\n// values of 10 and 25 while maintaining the slider's absolute min and max values\nslider.zoomOptions = {\n min: 10,\n max: 25\n};\n```"},{"name":"example","text":"```js\n// disables zooming on the slider\nslider.zoomOptions = null;\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions above\n// value of 10 while maintaining the slider's absolute min value\nslider.zoomOptions = {\n min: 10\n};\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions below\n// value of 25 while maintaining the slider's absolute max value\nslider.zoomOptions = {\n max: 25\n};\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSliderOpacityLegacy = document.createElement(\"arcgis-slider-opacity-legacy\");\ndocument.body.append(arcgisSliderOpacityLegacy);\nawait arcgisSliderOpacityLegacy.componentOnReady();\nconsole.log(\"arcgis-slider-opacity-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"updateFromVisualVariableResult","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(visualVariable: VisualVariableResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"visualVariable","type":"VisualVariableResult","docs":"The result object from the [createVisualVariable()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#createVisualVariable)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"VisualVariableResult":{"location":"import","path":"@arcgis/core/smartMapping/renderers/opacity.js","id":"notImplemented"},"HistogramResult":{"location":"import","path":"@arcgis/core/smartMapping/statistics/types.js","id":"notImplemented"}}},"signature":"updateFromVisualVariableResult(visualVariable: VisualVariableResult, histogramResult?: HistogramResult): Promise","parameters":[{"name":"visualVariable","type":"VisualVariableResult","docs":"The result object from the [createVisualVariable()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#createVisualVariable)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"docs":"A convenience function used to update the properties of an OpacitySlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#VisualVariableResult) of\nthe [createVisualVariable()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#createVisualVariable)\nmethod. This method is used to configure an empty OpacitySlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","docsTags":[{"name":"example","text":"```js\nconst opacityVariableCreator = await import(\"@arcgis/core/smartMapping/renderers/opacity.js\");\nconst variableResult = await opacityVariableCreator.createVisualVariable(params);\n\nif (featureLayer.renderer && \"visualVariables\" in featureLayer.renderer) {\n featureLayer.renderer.visualVariables = [variableResult.visualVariable];\n}\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nawait opacitySlider.updateFromVisualVariableResult(variableResult, histogramResult);\n```"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\" | \"stops\" | \"zoomOptions\"; }","bubbles":true,"complexType":{"original":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\" | \"stops\" | \"zoomOptions\"; }","resolved":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\" | \"stops\" | \"zoomOptions\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisThumbChange","detail":"ThumbChangeEvent","bubbles":true,"complexType":{"original":"ThumbChangeEvent","resolved":"ThumbChangeEvent","references":{"ThumbChangeEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.","docsTags":[]},{"event":"arcgisThumbDrag","detail":"ThumbDragEvent","bubbles":true,"complexType":{"original":"ThumbDragEvent","resolved":"ThumbDragEvent","references":{"ThumbDragEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user drags a thumb on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slider-scale-range/slider-scale-range.tsx","tag":"arcgis-slider-scale-range","overview":"","readme":"","usage":{},"docs":"The Scale Range Slider component allows the user to set a minimum and maximum scale based on named scale ranges. When a layer is provided, the component's minScale and maxScale properties will be set to the scale range of the layer.","docsTags":[{"name":"since","text":"5.1"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":true,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMaxScaleMenu","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-max-scale-menu","reflectToAttr":false,"docs":"Indicates whether the maximum scale dropdown menu is visible. Default value is `false`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideMinScaleMenu","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-min-scale-menu","reflectToAttr":false,"docs":"Indicates whether the minimum scale dropdown menu is visible. Default value is `false`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePreview","type":"boolean | undefined","complexType":{"original":"boolean | undefined","resolved":"boolean | undefined","references":{}},"mutable":true,"attr":"hide-preview","reflectToAttr":false,"docs":"Indicates whether the preview thumbnail of the scale is visible.\nDefault value is `false`.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"actual-size\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layer","type":"Layer | Sublayer | SubtypeSublayer | undefined","complexType":{"original":"Layer | Sublayer | SubtypeSublayer | undefined","resolved":"Layer | Sublayer | SubtypeSublayer | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/support/SubtypeSublayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"When provided, the initial [minScale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#minScale)\nand [maxScale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#maxScale) values will match the scale range\nwithin which the layer will render.\n\nIf a [TileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/TileLayer/) with resampling disabled is provided,\nthe slider thumbs will not be allowed to move past the `lods` of the layer's tiling scheme.\nIf a [MapImageLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/) is provided, the same restrictions to the thumbs\nwill be applied via the min/max scale defined by the map service. The unavailable range will be designated with a dashed line.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"maxScale","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-scale","reflectToAttr":false,"docs":"The maximum scale of the active scale range.","docsTags":[],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"maxScaleLimit","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-scale-limit","reflectToAttr":false,"docs":"The lowest possible maximum scale value on the slider, at which [maxScale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#maxScale) may not be set below.","docsTags":[],"default":"100000000","values":[{"type":"number"}],"optional":true,"required":false},{"name":"minScale","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-scale","reflectToAttr":false,"docs":"The minimum scale of the active scale range.","docsTags":[],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"minScaleLimit","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-scale-limit","reflectToAttr":false,"docs":"The highest possible minimum scale value on the slider, at which [minScale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#minScale) may not be set above.","docsTags":[],"default":"147914382","values":[{"type":"number"}],"optional":true,"required":false},{"name":"mode","type":"\"max-scale-only\" | \"min-scale-only\" | \"range\"","complexType":{"original":"\"max-scale-only\" | \"min-scale-only\" | \"range\"","resolved":"\"max-scale-only\" | \"min-scale-only\" | \"range\"","references":{}},"mutable":true,"attr":"mode","reflectToAttr":false,"docs":"The mode of the component, indicating which slider thumbs can be adjusted.","docsTags":[],"default":"\"range\"","values":[{"type":"string","value":"max-scale-only"},{"type":"string","value":"min-scale-only"},{"type":"string","value":"range"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"region","type":"SupportedRegion | undefined","complexType":{"original":"SupportedRegion | undefined","resolved":"SupportedRegion | undefined","references":{"SupportedRegion":{"location":"local","path":"components/arcgis-slider-scale-range/spriteSheetsUtils","id":"notImplemented"}}},"mutable":true,"attr":"region","reflectToAttr":false,"docs":"The region that the scale thumbnails will focus on.\nEach region comes from the [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).\nSee [SupportedRegion](https://developers.arcgis.com/javascript/latest/references/core/widgets/ScaleRangeSlider/types/#SupportedRegion) for the list of regions that are currently supported.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"showWorldValue","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-world-value","reflectToAttr":false,"docs":"Indicates whether the world scale value is shown in the scale menu.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"\"disabled\" | \"ready\"","complexType":{"original":"\"disabled\" | \"ready\"","resolved":"\"disabled\" | \"ready\"","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"LinkChartView | MapView | SceneView | undefined","complexType":{"original":"LinkChartView | MapView | SceneView | undefined","resolved":"LinkChartView | MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-slider-scale-range component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSliderScaleRange = document.createElement(\"arcgis-slider-scale-range\");\ndocument.body.append(arcgisSliderScaleRange);\nawait arcgisSliderScaleRange.componentOnReady();\nconsole.log(\"arcgis-slider-scale-range is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the thumb or range is released on the component. Use [@arcgisInput](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#event-arcgisInput) for continuous updates during a drag.","docsTags":[]},{"event":"arcgisInput","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires continuously while the thumb or range is being dragged. This event can fire frequently; consider debouncing or throttling expensive work.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\" | \"minScale\" | \"maxScale\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\" | \"minScale\" | \"maxScale\"; }","resolved":"{ name: \"state\" | \"minScale\" | \"maxScale\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/slider-size-legacy/slider-size-legacy.tsx","tag":"arcgis-slider-size-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Size Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/).\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Size Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/sizeslider-labels.avif \"Size Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nintervals, and the slider's histogram after the renderer has been created from the result of the\n[createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer) method.\n\n```js\nconst sizeRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/size.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst sizeSlider = document.querySelector(\"arcgis-slider-size-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/USA_Major_Cities_/FeatureServer/0\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n layer: featureLayer,\n view: viewElement.view,\n field: \"POPULATION\",\n};\n\nconst rendererResult = await sizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nsizeSlider.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update a [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nin a layer's renderer. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = () => {\n const renderer = featureLayer.renderer?.clone();\n if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n return;\n }\n\n const sizeVariable = renderer.visualVariables[0];\n const updatedSizeVariable = sizeSlider.updateVisualVariable(sizeVariable);\n if (!updatedSizeVariable) {\n return;\n }\n\n renderer.visualVariables = [updatedSizeVariable];\n featureLayer.renderer = renderer;\n};\n\nsizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nsizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nsizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[sizeRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"histogramConfig","type":"HistogramConfig | null | undefined","complexType":{"original":"HistogramConfig | null | undefined","resolved":"HistogramConfig | null | undefined","references":{"HistogramConfig":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The histogram associated with the data represented on the slider. The bins are typically\ngenerated using the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) statistics function.","docsTags":[{"name":"example","text":"```js\nconst histogramResult = await histogram({\n layer: featureLayer,\n field: \"fieldName\",\n numBins: 30,\n});\n\nslider.histogramConfig = {\n bins: histogramResult.bins\n};\n```"},{"name":"see","text":"[histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#labelFormatFunction), which formats\nthumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins\nto edit them.\n\nThe image below demonstrates how slider input values resemble corresponding slider values by default\nand won't match the formatting set in `labelFormatFunction`.\n\n![Slider without input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-no-input-formatter.avif \"Slider without input formatter\")\n\nIf you want to format slider input values so they match thumb labels, you can pass the same function set in `labelFormatFunction` to\n`inputFormatFunction` for consistent formatting.\n\n![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-input-formatter.avif \"Slider with input formatter\")\n\nHowever, if an `inputFormatFunction` is specified, you must also write a corresponding\n[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if\nyou specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#labelFormatFunction) to the same value\nfor consistency between labels and inputs.\n\nThis property overrides the default input formatter, which formats by calling `toString()` on the input value.\n ","docsTags":[{"name":"see","text":"[inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#inputParseFunction)"},{"name":"example","text":"```js\n// Formats the slider input to abbreviated numbers with units\n// e.g. a thumb at position 1500 will render with an input label of 1.5k\nslider.inputFormatFunction = (value: number): string => {\n if (value >= 1000000) {\n return (value / 1000000).toPrecision(3) + \"m\";\n }\n if (value >= 100000) {\n return (value / 1000).toPrecision(3) + \"k\";\n }\n if (value >= 1000) {\n return (value / 1000).toPrecision(2) + \"k\";\n }\n return value.toFixed(0);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"inputParseFunction","type":"InputParseFunction | null | undefined","complexType":{"original":"InputParseFunction | null | undefined","resolved":"InputParseFunction | null | undefined","references":{"InputParseFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#inputFormatFunction).\nThis property must be set if an `inputFormatFunction` is set. Otherwise the slider values will\nlikely not update to their expected positions.\n\nOverrides the default input parses, which is a parsed floating point number.","docsTags":[{"name":"see","text":"[inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#inputFormatFunction)"},{"name":"example","text":"```js\n// Parses the slider input (a string value) to a number value understandable to the slider\n// This assumes the slider was already configured with an inputFormatFunction\n// For example, if the input is 1.5k this function will parse\n// it to a value of 1500\ncolorSlider.inputParseFunction = (value: string): number => {\n const charLength = value.length;\n const valuePrefix = parseFloat(value.substring(0, charLength - 1));\n const finalChar = value.substring(charLength - 1);\n\n if (parseFloat(finalChar) >= 0) {\n return parseFloat(value);\n }\n if (finalChar === \"k\") {\n return valuePrefix * 1000;\n }\n if (finalChar === \"m\") {\n return valuePrefix * 1000000;\n }\n return parseFloat(value);\n};\n ```"}],"values":[],"optional":true,"required":false},{"name":"labelFormatFunction","type":"LabelFormatFunction | null | undefined","complexType":{"original":"LabelFormatFunction | null | undefined","resolved":"LabelFormatFunction | null | undefined","references":{"LabelFormatFunction":{"location":"import","path":"@arcgis/core/widgets/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.","docsTags":[{"name":"example","text":"```js\n// For thumb values, rounds each label to whole numbers\nslider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {\n return (type === \"value\") ? value.toFixed(0) : value.toString();\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"max","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max","reflectToAttr":false,"docs":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nsizeSlider.max = 150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min","reflectToAttr":false,"docs":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","docsTags":[{"name":"example","text":"```js\nsizeSlider.min = -150;\n```"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"precision","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"precision","reflectToAttr":false,"docs":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","docsTags":[{"name":"example","text":"```js\n// Rounds slider thumb values to 7 decimal places\nslider.precision = 7;\n```"}],"default":"4","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"sliderStyle","type":"SizeSliderStyle","complexType":{"original":"SizeSliderStyle","resolved":"SizeSliderStyle","references":{"SizeSliderStyle":{"location":"import","path":"@arcgis/core/widgets/smartMapping/SizeSlider.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Exposes various properties of the slider that can be styled. The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer)\nmethod can be used to match the `trackFillColor` to the current layer symbology.","docsTags":[{"name":"see","text":"[Color](https://developers.arcgis.com/javascript/latest/references/core/Color/)"},{"name":"example","text":"```js\nsizeSlider.sliderStyle = {\n trackFillColor: rendererResult.renderer.classBreakInfos[0].symbol.color ?? new Color([149, 149, 149]),\n trackBackgroundColor: new Color([224, 224, 224]),\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"state","type":"SmartMappingSliderBaseState","complexType":{"original":"SmartMappingSliderBaseState","resolved":"SmartMappingSliderBaseState","references":{"SmartMappingSliderBaseState":{"location":"import","path":"@arcgis/core/widgets/smartMapping/SmartMappingSliderBase.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"stops","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/renderers/visualVariables/support/SizeStop.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The size stops from the [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) to link to the slider.","docsTags":[{"name":"see","text":"[updateVisualVariable()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateVisualVariable)"},{"name":"example","text":"```js\nsizeSlider.stops = [\n { value: 0, size: 4 },\n { value: 100, size: 8 },\n { value: 1000, size: 16 },\n { value: 10000, size: 32 },\n];\n```"}],"values":[],"optional":true,"required":false},{"name":"zoomOptions","type":"ZoomOptions | null | undefined","complexType":{"original":"ZoomOptions | null | undefined","resolved":"ZoomOptions | null | undefined","references":{"ZoomOptions":{"location":"import","path":"@arcgis/core/widgets/smartMapping/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Zooms the slider track to the bounds provided in this property. When min and/or max zoom values are provided, the absolute [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#min) and\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#max) slider values are preserved and rendered at their typical positions on the slider. However, the\n slider track itself is zoomed so that thumbs cannot be moved above or below the provided min and max zoomed values.\n\n When a slider is in a zoomed state, the zoomed ends of the track will appear jagged. In the image below, notice how the\n top thumb cannot be moved past the zoom max of `31` even though the slider max is `200`.\n\n ![slider-zoom](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-zoomed.avif \"Zoomed slider\")\n\n To exit a zoomed state, the user can click the jagged line or the developer can set the `zoomOptions` to `null`. It\n is up to the developer to provide a UI option for end users to enable zooming on the slider.\n\n Setting the `zoomOptions` is useful when the slider is tied to heavily skewed datasets where the histogram renders only one or two bars because of outliers.\n\n ![slider-not-zoomed](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-skewed-not-zoomed.avif \"Unzoomed slider\")\n\n You can remove the influence of outliers by zooming the slider and regenerating a histogram based on the zoomed min and max. This will provide a better view of the data\n and make the slider more useful to the end user.","docsTags":[{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions between\n// values of 10 and 25 while maintaining the slider's absolute min and max values\nslider.zoomOptions = {\n min: 10,\n max: 25\n};\n```"},{"name":"example","text":"```js\n// disables zooming on the slider\nslider.zoomOptions = null;\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions above\n// value of 10 while maintaining the slider's absolute min value\nslider.zoomOptions = {\n min: 10\n};\n```"},{"name":"example","text":"```js\n// zooms the slider so thumbs can only be moved to positions below\n// value of 25 while maintaining the slider's absolute max value\nslider.zoomOptions = {\n max: 25\n};\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSliderSizeLegacy = document.createElement(\"arcgis-slider-size-legacy\");\ndocument.body.append(arcgisSliderSizeLegacy);\nawait arcgisSliderSizeLegacy.componentOnReady();\nconsole.log(\"arcgis-slider-size-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"updateFromRendererResult","returns":{"type":"void","docs":""},"complexType":{"signature":"(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void","parameters":[{"name":"rendererResult","type":"ContinuousRendererResult","docs":"The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"return":"void","references":{"ContinuousRendererResult":{"location":"import","path":"@arcgis/core/smartMapping/renderers/size.js","id":"notImplemented"},"HistogramResult":{"location":"import","path":"@arcgis/core/smartMapping/statistics/types.js","id":"notImplemented"}}},"signature":"updateFromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void","parameters":[{"name":"rendererResult","type":"ContinuousRendererResult","docs":"The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer)\n method."},{"name":"histogramResult","type":"HistogramResult","docs":"The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)\n method."}],"docs":"A convenience function used to update the properties of a SizeSlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer)\nmethod. This method is used to configure an empty SizeSlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","docsTags":[{"name":"example","text":"```js\nconst rendererResult = await sizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n ...params,\n numBins: 30,\n});\n\nsizeSlider.updateFromRendererResult(rendererResult, histogramResult);\n```"}]},{"name":"updateVisualVariable","returns":{"type":"null | undefined | SizeVariable","docs":""},"complexType":{"signature":"(sizeVariable: SizeVariable): null | undefined | SizeVariable","parameters":[{"name":"sizeVariable","type":"SizeVariable","docs":"The size visual variable\n from the renderer to update to the set [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#stops) on the slider."}],"return":"null | undefined | SizeVariable","references":{"default":{"location":"import","path":"@arcgis/core/renderers/visualVariables/SizeVariable.js","id":"notImplemented"}}},"signature":"updateVisualVariable(sizeVariable: SizeVariable): null | undefined | SizeVariable","parameters":[{"name":"sizeVariable","type":"SizeVariable","docs":"The size visual variable\n from the renderer to update to the set [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#stops) on the slider."}],"docs":"A convenience function used to update the [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nto match the values of the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#stops) on the slider.\nThe slider stops are automatically updated internally when the user drags a thumb slider.\n\nThis is particularly useful for Size visual variables that have a set\n[minDataValue](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#minDataValue) and\n[maxDataValue](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#minDataValue).\nThis method will properly reconstruct the variable to set on the renderer so it matches the stops on the slider.","docsTags":[{"name":"example","text":"```js\nconst renderer = featureLayer.renderer?.clone();\nconst sizeVariable = renderer.visualVariables[0];\nconst updatedSizeVariable = sizeSlider.updateVisualVariable(sizeVariable);\n```"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\" | \"stops\" | \"zoomOptions\"; }","bubbles":true,"complexType":{"original":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\" | \"stops\" | \"zoomOptions\"; }","resolved":"{ name: \"histogramConfig\" | \"max\" | \"min\" | \"precision\" | \"sliderStyle\" | \"state\" | \"stops\" | \"zoomOptions\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisThumbChange","detail":"ThumbChangeEvent","bubbles":true,"complexType":{"original":"ThumbChangeEvent","resolved":"ThumbChangeEvent","references":{"ThumbChangeEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.","docsTags":[]},{"event":"arcgisThumbDrag","detail":"ThumbDragEvent","bubbles":true,"complexType":{"original":"ThumbDragEvent","resolved":"ThumbDragEvent","references":{"ThumbDragEvent":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when a user drags a thumb on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/snapping-controls/snapping-controls.tsx","tag":"arcgis-snapping-controls","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-snapping-controls/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-enabled-toggle","reflectToAttr":false,"docs":"Controls display of the \"Enable snapping\" toggle.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-enabled-toggle","reflectToAttr":false,"docs":"Controls display of the \"Feature to feature\" toggle. This controls feature snapping.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridControls","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-controls","reflectToAttr":false,"docs":"Controls display of the [arcgis-grid-controls](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridControlsElementsColorSelection","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-controls-elements-color-selection","reflectToAttr":false,"docs":"Controls display of the buttons to change the color of the grid.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridControlsElementsDynamicScaleToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-controls-elements-dynamic-scale-toggle","reflectToAttr":false,"docs":"Controls display of the toggle that modifies [dynamicScaling](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#dynamicScaling).","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridControlsElementsLineIntervalInput","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-controls-elements-line-interval-input","reflectToAttr":false,"docs":"Controls display of the line interval input. The input sets the interval between major grid lines.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridControlsElementsNumericInputs","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-controls-elements-numeric-inputs","reflectToAttr":false,"docs":"Controls display of the numeric inputs that allow for setting grid spacing and rotation","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridControlsElementsOutOfScaleWarning","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-controls-elements-out-of-scale-warning","reflectToAttr":false,"docs":"Controls display of the out of scale warning. This warning is displayed when the grid is not shown because it would be too small at the current scale and dynamic scaling is disabled.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridControlsElementsPlacementButtons","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-controls-elements-placement-buttons","reflectToAttr":false,"docs":"Controls display of the grid placement buttons. These buttons allow the user to start interactive configuration of the grid.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideGridControlsElementsRotateWithMapToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-grid-controls-elements-rotate-with-map-toggle","reflectToAttr":false,"docs":"Controls display of the \"Rotate grid with map\" toggle. This toggle controls whether the grid rotates with the map.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideLayerList","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-layer-list","reflectToAttr":false,"docs":"Controls display of the \"Snapping layers\" dropdown. The list displays the available layers to configure snapping.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSelfEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-self-enabled-toggle","reflectToAttr":false,"docs":"Controls display of the “Geometry guides” toggle. This toggle controls the self-snapping configuration which handles showing right-angle and parallel line indicators while constructing or modifying geometries.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"snap-to-point\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"showGridControlsElementsGridEnabledToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-grid-controls-elements-grid-enabled-toggle","reflectToAttr":false,"docs":"Controls display of the \"Enable grid\" toggle. This toggle controls whether the grid is displayed.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-header","reflectToAttr":false,"docs":"Controls display of the header","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"snappingOptions","type":"SnappingOptions","complexType":{"original":"SnappingOptions","resolved":"SnappingOptions","references":{"default":{"location":"import","path":"@arcgis/core/views/interactive/snapping/SnappingOptions.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/)\nthat will be controlled by this component if the snapping toggle is enabled for display.\nIf SnappingOptions are provided, grid display will be automatically enabled or disabled to match snapping state.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"state","type":"SnappingControlsViewModelState","complexType":{"original":"SnappingControlsViewModelState","resolved":"SnappingControlsViewModelState","references":{"SnappingControlsViewModelState":{"location":"import","path":"@arcgis/core/widgets/support/SnappingControls/SnappingControlsViewModel.js","id":"notImplemented"}}},"mutable":true,"attr":"state","reflectToAttr":true,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-snapping-controls component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSnappingControls = document.createElement(\"arcgis-snapping-controls\");\ndocument.body.append(arcgisSnappingControls);\nawait arcgisSnappingControls.componentOnReady();\nconsole.log(\"arcgis-snapping-controls is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"snappingOptions\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"snappingOptions\" | \"state\"; }","resolved":"{ name: \"snappingOptions\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/support/color-select/color-select.tsx","tag":"arcgis-color-select","overview":"","readme":"","usage":{},"docs":"Labeled swatch which opens a color picker popover to select a color.","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"color","type":"number[] | RGBA | string","complexType":{"original":"number[] | RGBA | string","resolved":"number[] | RGBA | string","references":{"RGBA":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"attr":"color","reflectToAttr":false,"docs":"The current color value.","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The label for the component.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisColorSelect = document.createElement(\"arcgis-color-select\");\ndocument.body.append(arcgisColorSelect);\nawait arcgisColorSelect.componentOnReady();\nconsole.log(\"arcgis-color-select is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[{"event":"arcgisColorChanged","detail":"Color","bubbles":true,"complexType":{"original":"Color","resolved":"Color","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when the color value changes.","docsTags":[{"name":"internal"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/support/time-of-day-slider/time-of-day-slider.tsx","tag":"arcgis-time-of-day-slider","overview":"","readme":"","usage":{},"docs":"Component which displays a slider to select a specific time of day or a range of times within a day.","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":true,"docs":"Whether the slider is disabled.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"endTime","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"end-time","reflectToAttr":false,"docs":"The end time of the time range in minutes since midnight.","docsTags":[],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The label for the component.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"mode","type":"Mode","complexType":{"original":"Mode","resolved":"Mode","references":{"Mode":{"location":"local","id":"notImplemented"}}},"mutable":true,"attr":"mode","reflectToAttr":true,"docs":"The mode of the slider - single time or time range.","docsTags":[],"default":"\"range\"","values":[{"type":"string","value":"range"},{"type":"string","value":"single"}],"optional":true,"required":false},{"name":"startTime","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"start-time","reflectToAttr":false,"docs":"The start time of the time range in minutes since midnight.","docsTags":[],"default":"0","values":[{"type":"number"}],"optional":true,"required":false},{"name":"steps","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"steps","reflectToAttr":false,"docs":"If specified, sets an incremental step for the slider.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"visualScale","type":"\"l\" | \"m\" | \"s\" | undefined","complexType":{"original":"\"l\" | \"m\" | \"s\" | undefined","resolved":"\"l\" | \"m\" | \"s\" | undefined","references":{}},"mutable":true,"attr":"visual-scale","reflectToAttr":true,"docs":"The scale of the component.","docsTags":[],"default":"\"m\"","values":[{"type":"string","value":"l"},{"type":"string","value":"m"},{"type":"string","value":"s"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisTimeOfDaySlider = document.createElement(\"arcgis-time-of-day-slider\");\ndocument.body.append(arcgisTimeOfDaySlider);\nawait arcgisTimeOfDaySlider.componentOnReady();\nconsole.log(\"arcgis-time-of-day-slider is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[{"event":"arcgisTimeChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the time is changed.","docsTags":[{"name":"internal"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/support/webgl-error/webgl-error.tsx","tag":"arcgis-webgl-error","overview":"","readme":"","usage":{},"docs":"Warning for WebGL errors.","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"errorName","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"error-name","reflectToAttr":false,"docs":"The WebGL Error name.","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisWebGlError = document.createElement(\"arcgis-webgl-error\");\ndocument.body.append(arcgisWebGlError);\nawait arcgisWebGlError.componentOnReady();\nconsole.log(\"arcgis-webgl-error is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/swipe/swipe.tsx","tag":"arcgis-swipe","overview":"","readme":"","usage":{},"docs":"The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `startLayers` and `endLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.","docsTags":[{"name":"since","text":"4.31"},{"name":"see","text":"[Sample - Swipe component](https://developers.arcgis.com/javascript/latest/sample-code/swipe/)"},{"name":"see","text":"[Sample - Swipe component with scroll](https://developers.arcgis.com/javascript/latest/sample-code/swipe-scroll/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"direction","type":"Direction","complexType":{"original":"Direction","resolved":"Direction","references":{"Direction":{"location":"import","path":"@arcgis/core/widgets/Swipe/types.js","id":"notImplemented"}}},"mutable":true,"attr":"direction","reflectToAttr":true,"docs":"The direction the Swipe component moves across the view.\nIf `\"horizontal\"`, the component will move left and right and\nif `\"vertical\"`, the component will move up and down.","docsTags":[],"default":"\"horizontal\"","values":[{"type":"string","value":"horizontal"},{"type":"string","value":"vertical"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":true,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"endLayers","type":"SwipeViewModel[\"trailingLayers\"]","complexType":{"original":"SwipeViewModel[\"trailingLayers\"]","resolved":"SwipeViewModel[\"trailingLayers\"]","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Swipe/SwipeViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of layers that will show on the right or bottom side of the Swipe component.","docsTags":[{"name":"see","text":"[trailingLayers](https://developers.arcgis.com/javascript/latest/references/core/widgets/Swipe/SwipeViewModel/#trailingLayers)"},{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"hideDivider","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-divider","reflectToAttr":true,"docs":"When `true`, the divider between the leading and trailing layers will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHandle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-handle","reflectToAttr":true,"docs":"When `true`, the handle from which you drag the component will be hidden.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"compare\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"default":"\"Swipe\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"leadingLayers","type":"SwipeViewModel[\"leadingLayers\"]","complexType":{"original":"SwipeViewModel[\"leadingLayers\"]","resolved":"SwipeViewModel[\"leadingLayers\"]","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Swipe/SwipeViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of layers that will show on the left or top side of the Swipe component.","docsTags":[{"name":"see","text":"[leadingLayers](https://developers.arcgis.com/javascript/latest/references/core/widgets/Swipe/SwipeViewModel/#leadingLayers)"}],"deprecation":"since 5.0, use [startLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/#startLayers) instead.","values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"position","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"position","reflectToAttr":false,"docs":"The position of the Swipe component. This determines what percentage\nof the view will be taken up by the [startLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/#startLayers).","docsTags":[{"name":"since","text":"5.0"}],"default":"25","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"startLayers","type":"SwipeViewModel[\"leadingLayers\"]","complexType":{"original":"SwipeViewModel[\"leadingLayers\"]","resolved":"SwipeViewModel[\"leadingLayers\"]","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Swipe/SwipeViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of layers that will show on the left or top side of the Swipe component.","docsTags":[{"name":"see","text":"[leadingLayers](https://developers.arcgis.com/javascript/latest/references/core/widgets/Swipe/SwipeViewModel/#leadingLayers)"},{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/Swipe/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"swipePosition","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"swipe-position","reflectToAttr":false,"docs":"The position of the Swipe component. This determines what percentage\nof the view will be taken up by the [startLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/#startLayers).","docsTags":[],"default":"25","deprecation":"since 5.0, use [position](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/#position) instead.","values":[{"type":"number"}],"optional":true,"required":false},{"name":"trailingLayers","type":"SwipeViewModel[\"trailingLayers\"]","complexType":{"original":"SwipeViewModel[\"trailingLayers\"]","resolved":"SwipeViewModel[\"trailingLayers\"]","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Swipe/SwipeViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of layers that will show on the right or bottom side of the Swipe component.","docsTags":[{"name":"see","text":"[trailingLayers](https://developers.arcgis.com/javascript/latest/references/core/widgets/Swipe/SwipeViewModel/#trailingLayers)"}],"deprecation":"since 5.0, use [endLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/#endLayers) instead.","values":[],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-swipe component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSwipe = document.createElement(\"arcgis-swipe\");\ndocument.body.append(arcgisSwipe);\nawait arcgisSwipe.componentOnReady();\nconsole.log(\"arcgis-swipe is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisSwipeChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the swipe position changes and the drag handle is released on the component.\n\n**Note:** To constantly listen to changes while dragging, use the `arcgisSwipeInput` event instead.","docsTags":[{"name":"since","text":"4.34"}]},{"event":"arcgisSwipeInput","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle.","docsTags":[{"name":"since","text":"4.34"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/table-list/table-list.tsx","tag":"arcgis-table-list","overview":"","readme":"","usage":{},"docs":"The Table List component provides a way to display a list of tables associated with a [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/).\nIt is meant to be used with [feature layer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) tables.\n\nIf a map contains feature layer tables, they will display within the component. Tables can also be added to the Map's\n[tables](https://developers.arcgis.com/javascript/latest/references/core/Map/#tables) collection. Any tables referenced in the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#map)\nproperty will display in the component. If unsure of whether the layer is a table, check the feature layer's\n[isTable](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#isTable) property.\n\nThe [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/) API provides access to each table, allows\nthe developer to configure actions related to the table, and allows the developer to add content to the item related to the table.\n\n\n**Known Limitations**\n* The TableList component is not supported with [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).","docsTags":[{"name":"since","text":"4.28"},{"name":"example","text":"```js\n\nconst tableListElement = document.createElement(\"arcgis-table-list\");\ntableListElement.referenceElement = viewElement;\ntableListElement.slot = \"top-left\";\nviewElement.appendChild(tableListElement);\n\nconst layer = Layer.fromPortalItem({\n // Loads a layer (table) from a portal item\n portalItem: {\n id: \"add portal item id\"\n }\n});\n\n// Wait for the layer to load\nawait layer.load()\n\n// Check if the layer is a table\nif (layer.isTable) {\n // Add the table to the map's tables collection\n viewElement.map.tables.add(layer);\n}\n```"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"closed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closed","reflectToAttr":false,"docs":"Indicates whether a component is closed. When `true`, the component will be hidden.","docsTags":[{"name":"since","text":"4.33"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"collapsed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"collapsed","reflectToAttr":true,"docs":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showCollapseButton)"},{"name":"example","text":"```js\ntableListElement.collapsed = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"dragEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"drag-enabled","reflectToAttr":false,"docs":"Indicates whether [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/) may be reordered within the list by dragging and dropping.\nDrag won't be enabled until the number of list items is equal to or greater than than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#minDragEnabledItems).","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#minDragEnabledItems)"},{"name":"example","text":"```js\ntableListElement.dragEnabled = true;\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"filterPlaceholder","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-placeholder","reflectToAttr":false,"docs":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter) is true.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter)"},{"name":"example","text":"```js\ntableListElement.filterPlaceholder = \"Filter layers\";\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"filterPredicate","type":"FilterPredicate | null | undefined","complexType":{"original":"FilterPredicate | null | undefined","resolved":"FilterPredicate | null | undefined","references":{"FilterPredicate":{"location":"import","path":"@arcgis/core/widgets/TableList.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/).","docsTags":[{"name":"since","text":"4.32"},{"name":"example","text":"```js\ntableListElement.filterPredicate = (item) => item.title.toLowerCase().includes(\"streets\");\n```"}],"values":[],"optional":true,"required":false},{"name":"filterText","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"filter-text","reflectToAttr":false,"docs":"The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter) is true.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter)"},{"name":"example","text":"```js\nreactiveUtils.watch(\n () => tableListElement.filterText,\n (filterText) => console.log(filterText)\n);\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideStatusIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-status-indicators","reflectToAttr":false,"docs":"Indicates whether the status indicators will be displayed.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"table\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"listItemCreatedFunction","type":"ListItemModifier | null | undefined","complexType":{"original":"ListItemModifier | null | undefined","resolved":"ListItemModifier | null | undefined","references":{"ListItemModifier":{"location":"import","path":"@arcgis/core/widgets/TableList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/).\nEach list item can be modified according to its modifiable properties. Actions can be added\nto list items using the [ListItem#actionsSections](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/#actionsSections)\nproperty of the ListItem.","docsTags":[{"name":"example","text":"```js\ntableListElement.listItemCreatedFunction = (event) => {\n const { item } = event;\n item.actionsSections = [\n [\n {\n title: \"Open in feature table\",\n icon: \"table\",\n id: \"open-table\"\n }\n ]\n ];\n }\n```"}],"values":[],"optional":true,"required":false},{"name":"map","type":"WebMap | WebScene | null | undefined","complexType":{"original":"WebMap | WebScene | null | undefined","resolved":"WebMap | WebScene | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/WebScene.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A reference to a [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/) containing the tables. Set this property\nto access the underlying tables within the map.","docsTags":[{"name":"since","text":"4.34"},{"name":"see","text":"[Map#tables](https://developers.arcgis.com/javascript/latest/references/core/Map/#tables)"},{"name":"see","text":"[WebMap#tables](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#tables)"}],"values":[],"optional":true,"required":false},{"name":"minDragEnabledItems","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-drag-enabled-items","reflectToAttr":false,"docs":"The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#dragEnabled).","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[dragEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#dragEnabled)"},{"name":"example","text":"```js\ntableListElement.dragEnabled = true;\ntableListElement.minDragEnabledItems = 5;\n```"}],"default":"2","values":[{"type":"number"}],"optional":true,"required":false},{"name":"minFilterItems","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-filter-items","reflectToAttr":false,"docs":"The minimum number of list items required to display the [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter) input box.","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter)"},{"name":"example","text":"```js\ntableListElement.showFilter = true;\ntableListElement.minFilterItems = 5;\n```"}],"default":"10","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/TableList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/)s representing table list items\nselected by the user.","docsTags":[{"name":"see","text":"[selectionMode](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#selectionMode)"}],"values":[],"optional":true,"required":false},{"name":"selectionMode","type":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","complexType":{"original":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","resolved":"\"multiple\" | \"single\" | \"none\" | \"single-persist\"","references":{}},"mutable":true,"attr":"selection-mode","reflectToAttr":false,"docs":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#selectedItems) property.\n\n| Value | Description |\n| ----- | ----------- |\n| multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |\n| none | Disables selection. Use this when you want to prevent selecting items. |\n| single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |\n| single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |","docsTags":[{"name":"since","text":"4.29"},{"name":"see","text":"[selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#selectedItems)"},{"name":"example","text":"```js\ntableListElement.selectionMode = \"multiple\";\n```"}],"default":"\"none\"","values":[{"type":"string","value":"multiple"},{"type":"string","value":"single"},{"type":"string","value":"none"},{"type":"string","value":"single-persist"}],"optional":true,"required":false},{"name":"showCloseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-close-button","reflectToAttr":false,"docs":"Indicates whether to display a close button in the header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showCollapseButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-collapse-button","reflectToAttr":false,"docs":"Indicates whether to display a collapse button in the header.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showErrors","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-errors","reflectToAttr":false,"docs":"Indicates whether to display layers with load errors.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showFilter","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-filter","reflectToAttr":false,"docs":"Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [TableList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#minFilterItems), allowing users to filter tables by their title.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showHeading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-heading","reflectToAttr":false,"docs":"Indicates whether to display the table list heading. The heading text is \"Table List\". The heading level can be set with the [TableList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#headingLevel).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showTemporaryTableIndicators","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-temporary-table-indicators","reflectToAttr":false,"docs":"Indicates whether temporary table indicators will be displayed for tables with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the table title.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"import","path":"@arcgis/core/widgets/TableList/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"tableItems","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/widgets/TableList/ListItem.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The collection of table ListItems displayed within the component.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"tables","type":"ReadonlyCollection | null | undefined","complexType":{"original":"ReadonlyCollection | null | undefined","resolved":"ReadonlyCollection | null | undefined","references":{"ReadonlyCollection":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/layers/support/Sublayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"view","type":"LinkChartView | MapView | SceneView | undefined","complexType":{"original":"LinkChartView | MapView | SceneView | undefined","resolved":"LinkChartView | MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-table-list component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisTableList = document.createElement(\"arcgis-table-list\");\ndocument.body.append(arcgisTableList);\nawait arcgisTableList.componentOnReady();\nconsole.log(\"arcgis-table-list is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisClose","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component's close button is clicked.","docsTags":[{"name":"since","text":"4.33"}]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTriggerAction","detail":"TableListViewModelTriggerActionEvent","bubbles":true,"complexType":{"original":"TableListViewModelTriggerActionEvent","resolved":"TableListViewModelTriggerActionEvent","references":{"TableListViewModelTriggerActionEvent":{"location":"import","path":"@arcgis/core/widgets/TableList/TableListViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when an action is triggered on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/time-slider/time-slider.tsx","tag":"arcgis-time-slider","overview":"","readme":"","usage":{},"docs":"The Time Slider component simplifies visualization of temporal data in your application.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"actions","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"Action":{"location":"import","path":"@arcgis/core/widgets/TimeSlider/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Defines actions that will appear in a menu when the user clicks the ellipsis button\n![timeSlider-actions-menu](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/ellipsis.avif) in the component. The\nellipsis button will not display if this property is `null` or if the collection is empty.\nEach [Action](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/types/#Action) is defined with a unique id, a title,\nand an icon.\n\nThe [@trigger-action](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#event-trigger-action) event fires each time an action in the menu is clicked. This event\ncan be used to execute custom code such as setting the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) to a specific date or copying the\ntimeExtent to the browser's clipboard.\n\n[![widgets-timeSlider-actions](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/widgets-timeslider-actions.avif)](https://developers.arcgis.com/javascript/latest/sample-code/sandbox/?sample=widgets-timeslider-offset)","docsTags":[{"name":"since","text":"4.21"},{"name":"see","text":"[Sample - TimeSlider with offset](https://developers.arcgis.com/javascript/latest/sample-code/widgets-timeslider-offset/)"},{"name":"example","text":"// Create a TimeSlider with two actions to snap the thumb to\n// two specific time extents.\nconst timeSlider = new TimeSlider({\n container: \"timeSliderDiv\",\n fullTimeExtent: {\n start: new Date(2011, 0, 1),\n end: new Date(2012, 0, 1)\n },\n mode: \"instant\",\n actions: [\n {\n id: \"quake\",\n icon: \"exclamation-mark-triangle\",\n title: \"Jump to Earthquake\"\n },\n {\n id: \"quake-plus-one-month\",\n icon: \"organization\",\n title: \"One month later\"\n }\n ]\n});\n\n// listen to timeSlider's trigger-action event\n// check what action user clicked on and respond accordingly.\ntimeSlider.on(\"trigger-action\", (event) => {\n const quake = new Date(Date.UTC(2011, 3, 11, 8, 16, 12));\n const oneMonthLater = new Date(quake.getTime()).setMonth(quake.getMonth() + 1);\n switch(event.action.id) {\n case \"quake\":\n timeSlider.timeExtent = {\n start: quake,\n end: quake\n };\n break;\n case \"quake-plus-one-month\":\n timeSlider.timeExtent = {\n start: oneMonthLater,\n end: oneMonthLater\n };\n break;\n }\n});"}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-slider/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":true,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[{"name":"example","text":"// Create a timeslider widget that is initially disabled.\nconst timeSlider = new TimeSlider({\n container: \"timeSliderDiv\",\n fullTimeExtent: {\n start: new Date(2000, 5, 1),\n end: new Date(2010, 0, 1)\n },\n disabled: true\n});"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"effectiveStops","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"Date":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Lists the specific locations on the timeline where handle(s) will snap to when manipulated.","docsTags":[{"name":"example","text":"timeSlider.effectiveStops.forEach((stop) => {\n console.log(stop);\n});"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"fullTimeExtent","type":"TimeExtent | null | undefined","complexType":{"original":"TimeExtent | null | undefined","resolved":"TimeExtent | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/time/TimeExtent.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The temporal extent of the entire slider.\nIt defines the entire time period within which you can visualize\nyour time aware data using the time slider component.","docsTags":[{"name":"example","text":"// Create a new TimeSlider with set dates\nconst timeSlider = new TimeSlider({\n container: \"timeSliderDiv\",\n view: view\n});\n\n// wait for the time-aware layer to load\nlayer.when(() => {\n // set up time slider properties based on layer timeInfo\n timeSlider.fullTimeExtent = layer.timeInfo.fullTimeExtent;\n timeSlider.stops = {\n interval: layer.timeInfo.interval\n };\n});"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"clock\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"labelFormatFunction","type":"DateLabelFormatter | null | undefined","complexType":{"original":"DateLabelFormatter | null | undefined","resolved":"DateLabelFormatter | null | undefined","references":{"DateLabelFormatter":{"location":"import","path":"@arcgis/core/widgets/TimeSlider.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"layout","type":"TimeSliderLayout","complexType":{"original":"TimeSliderLayout","resolved":"TimeSliderLayout","references":{"TimeSliderLayout":{"location":"import","path":"@arcgis/core/widgets/TimeSlider.js","id":"notImplemented"}}},"mutable":true,"attr":"layout","reflectToAttr":false,"docs":"Determines the layout used by the TimeSlider component.\n\nPossible values are listed below:\n| Value | Description |\n| --- | --- |\n| auto | Automatically uses the \"compact\" layout when the component width is less than 858 pixels. Otherwise the \"wide\" layout it used. |\n| compact | Component elements are oriented vertically. This layout is better suited to narrower widths. |\n| wide | Component elements are oriented laterally. This thinner design is better suited to wide applications. |","docsTags":[{"name":"since","text":"4.16"},{"name":"example","text":"timeSlider.layout = \"compact\";"}],"default":"\"auto\"","values":[{"type":"string","value":"auto"},{"type":"string","value":"compact"},{"type":"string","value":"wide"}],"optional":true,"required":false},{"name":"loop","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loop","reflectToAttr":false,"docs":"When `true`, the time slider will play its animation in a loop.","docsTags":[{"name":"example","text":"// Start a time slider animation that advances every second\n// and restarts when it reaches the end.\ntimeSlider.set({\n loop: true,\n playRate: 1000\n});\ntimeSlider.play();"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"mode","type":"TimeSliderMode","complexType":{"original":"TimeSliderMode","resolved":"TimeSliderMode","references":{"TimeSliderMode":{"location":"import","path":"@arcgis/core/widgets/TimeSlider/types.js","id":"notImplemented"}}},"mutable":true,"attr":"mode","reflectToAttr":false,"docs":"The time slider mode. This property is used for defining if the temporal data will be displayed\ncumulatively up to a point in time, a single instant in time, or within a time range. See\nthe following table for possible values.\n\nPossible Values | Description | Example |\n----------------------|-------------- | ------- |\ninstant | The slider will show temporal data that falls on a single instance in time. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` and `end` dates to same date: `{start: sameDate, end: sameDate}` | \"mode-instance\" |\ntime-window | The slider will show temporal data that falls within a given time range. This is the default. Set [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` and `date` properties to desired dates. | \"mode-instance\" |\ncumulative-from-start | Similar to `time-window` with the start time is always pinned to the start of the slider. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` date to `null` and set `end` date to a desired date: `{start: null, end: date}` | \"mode-instance\" |\ncumulative-from-end | Also, similar to the `time-window` with the end time pinned to the end of the slider. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` date to a desired date and set `end` date to `null`: `{start: date, end: null}` | \"mode-instance\" |","docsTags":[{"name":"see","text":"[timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent)"},{"name":"example","text":"// Create a single thumbed time slider that includes all historic content.\nconst timeSlider = new TimeSlider({\n container: \"timeSliderDiv\",\n view: view,\n mode: \"cumulative-from-start\",\n fullTimeExtent: {\n start: new Date(2000, 0, 1),\n end: new Date(2010, 0, 1)\n },\n timeExtent: {\n start: null,\n end: new Date(2001, 0, 1) //end date\n }\n});"}],"default":"\"time-window\"","values":[{"type":"string","value":"instant"},{"type":"string","value":"time-window"},{"type":"string","value":"cumulative-from-start"},{"type":"string","value":"cumulative-from-end"}],"optional":true,"required":false},{"name":"playRate","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"play-rate","reflectToAttr":false,"docs":"The time (in milliseconds) between animation steps.\n\n> [!WARNING]\n>\n> When a [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) is associated with a TimeSlider and the TimeSlider is playing, the playback will pause before advancing if the View is still updating.\n> For example, if the `playRate` is set to 1,000 (one second) and the `View` takes 1.5 seconds to render then the TimeSlider thumb(s) will advance every\n> 1.5 seconds rather than every second.","docsTags":[{"name":"example","text":"// Start a time slider animation that advances\n// ten times a second and stops when it reaches the end.\ntimeSlider.set({\n loop: false,\n playRate: 100\n});\ntimeSlider.play();"}],"default":"1000","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"TimeSliderState","complexType":{"original":"TimeSliderState","resolved":"TimeSliderState","references":{"TimeSliderState":{"location":"import","path":"@arcgis/core/widgets/TimeSlider/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"example","text":"// Display the current state of the view model.\nswitch (timeSlider.viewModel.state) {\n case \"disabled\":\n console.log(\"The view is not ready or some property are not set.\");\n break;\n case \"ready\":\n console.log(\"The time slider is ready for use.\");\n break;\n case \"playing\":\n console.log(\"The time slider is currently animating.\");\n break;\n}"},{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"playing"}],"optional":true,"required":false},{"name":"stops","type":"Stops | null | undefined","complexType":{"original":"Stops | null | undefined","resolved":"Stops | null | undefined","references":{"Stops":{"location":"import","path":"@arcgis/core/widgets/TimeSlider/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Defines specific locations on the time slider where thumbs will snap to when manipulated.\nIf unspecified, ten evenly spaced stops will be added.\n\nFor continuous sliding, set `stops` to `null`:\n```js\ntimeSlider.stops = null;\n```\n\nTo define regularly spaced stops, parse an object with `interval` and `timeExtent` properties\nwith types [TimeInterval](https://developers.arcgis.com/javascript/latest/references/core/time/TimeInterval/) and [TimeExtent](https://developers.arcgis.com/javascript/latest/references/core/time/TimeExtent/) respectively.\nThe [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property is optional and used to confine stops to a certain date range.\nThis property is useful to commence stops on a specific day of the week or month.\nIf a stop definition by interval results in excess of 10,000 stops, then the view model\nwill default to ten evenly spaced stops.\n\n```js\n// Add yearly intervals starting from the beginning of the TimeSlider.\ntimeSlider.stops = {\n interval: {\n value: 1,\n unit: \"years\"\n }\n};\n```\nRather than setting the stops as time intervals, the TimeSlider can be divided into evenly spaced\nstops using the `count` property. Similar to the previous method, divisions can be confined to a specific date range\nusing the optional timeExtent property.\n```js\n// Add stops at 15 evenly spaced intervals.\ntimeSlider.stops = {\n count: 15\n};\n```\nFor irregularly spaced stops, simply assign an array of dates as demonstrated below.\n```js\n// Add nine irregular stops.\ntimeSlider.stops = {\n dates: [\n new Date(2000, 0, 1), new Date(2001, 3, 8), new Date(2002, 0, 10),\n new Date(2003, 12, 8), new Date(2004, 2, 19), new Date(2005, 7, 5),\n new Date(2006, 9, 11), new Date(2007, 11, 21), new Date(2008, 1, 10)\n ]\n};\n```\nLastly, to constrain or offset division by count or interval use the optional timeExtent property.\n```js\n// Add yearly stops from Christmas 2019 to Christmas 2029 only\ntimeSlider.stops = {\n interval: {\n value: 1,\n unit: \"years\"\n },\n timeExtent: {\n start: new Date(2019, 11, 25),\n end: new Date(2029, 11, 25)\n }\n};\n\n// Likewise, add stops that represent quarters of 2019 only.\ntimeSlider.stops = {\n count: 4,\n timeExtent: {\n start: new Date(2019, 0, 1),\n end: new Date(2020, 0, 1)\n }\n};\n```","docsTags":[],"default":"{ count : 10 }","values":[],"optional":true,"required":false},{"name":"tickConfigs","type":"Array | null | undefined","complexType":{"original":"Array | null | undefined","resolved":"Array | null | undefined","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"TickConfig":{"location":"import","path":"@arcgis/core/widgets/Slider/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"When set, overrides the default TimeSlider ticks labelling system.\nPlease refer to [TickConfig](https://developers.arcgis.com/javascript/latest/references/core/widgets/Slider/types/#TickConfig) for detailed documentation\non how to configure tick placement, style, and behavior.","docsTags":[{"name":"since","text":"4.16"},{"name":"example","text":"// By default in \"en-US\" the TimeSlider will display ticks with \"2010, 2011, 2012, etc\".\n// Overwrite TimeSlider tick configuration so that labels display \"'10, '12, '14, etc\" in red.\nconst timeSlider = new TimeSlider({\n container: \"timeSliderDiv\",\n fullTimeExtent: {\n start: new Date(2010, 0, 1),\n end: new Date(2020, 0, 1)\n },\n tickConfigs: [{\n mode: \"position\",\n values: [\n new Date(2010, 0, 1), new Date(2012, 0, 1), new Date(2014, 0, 1),\n new Date(2016, 0, 1), new Date(2018, 0, 1), new Date(2020, 0, 1)\n ].map((date) => date.getTime()),\n labelsVisible: true,\n labelFormatFunction: (value) => {\n const date = new Date(value);\n return `'${date.getUTCFullYear() - 2000}`;\n },\n tickCreatedFunction: (value, tickElement, labelElement) => {\n tickElement.classList.add(\"custom-ticks\");\n labelElement.classList.add(\"custom-labels\");\n }\n }]\n};"},{"name":"example","text":"// this CSS goes with the snippet above.\n#timeSlider .custom-ticks {\n background-color: red;\n width: 1px;\n height: 8px;\n}\n#timeSlider .custom-labels {\n font-family: Georgia, 'Times New Roman', Times, serif;\n font-size: 15px;\n color: red;\n}"}],"values":[],"optional":true,"required":false},{"name":"timeExtent","type":"TimeExtent | null | undefined","complexType":{"original":"TimeExtent | null | undefined","resolved":"TimeExtent | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/time/TimeExtent.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current time extent of the time slider. This property can be watched for\nupdates and used to update the time extent property in queries and/or the layer filters and effects.\nThe following table shows the `timeExtent` values returned for each [mode](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#mode).\n\n| Mode | The timeExtent value |\n| ------- | -------------------- |\n| `time-window` | `{start: startDate, end: endDate}` |\n| `instant` | `{start: sameDate, end: sameDate}` |\n| `cumulative-from-start` | `{start: null, end: endDate}` |\n| `cumulative-from-end` | `{start: startDate, end: null}` |","docsTags":[{"name":"example","text":"// Display the time extent to the console whenever it changes.\nconst timeSlider = new TimeSlider({\n container: \"timeSliderDiv\",\n mode: \"time-window\",\n fullTimeExtent: {\n start: new Date(2019, 2, 3),\n end: new Date(2019, 2, 5)\n },\n timeExtent: {\n start: new Date(2019, 2, 1),\n end: new Date(2019, 2, 28)\n }\n});\n\nreactiveUtils.watch(\n () => timeSlider.timeExtent,\n (timeExtent) => {\n console.log(\"Time extent now starts at\", timeExtent.start, \"and finishes at:\", timeExtent.end);\n }\n);"}],"values":[],"optional":true,"required":false},{"name":"timeVisible","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"time-visible","reflectToAttr":false,"docs":"Shows/hides time in the display.","docsTags":[{"name":"example","text":"// For time sliders with a small time extent it may be useful to display times as shown below.\nconst timeSlider = new TimeSlider({\n container: \"timeSliderDiv\",\n mode: \"time-window\",\n timeVisible: true,\n fullTimeExtent: {\n start: new Date(2019, 2, 3),\n end: new Date(2019, 2, 5)\n },\n timeExtent: {\n start: new Date(2019, 2, 1),\n end: new Date(2019, 2, 28)\n }\n});"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"timeZone","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"time-zone","reflectToAttr":false,"docs":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from [MapView#timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#timeZone). When a MapView is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nsystem | Dates and times will be displayed in the timezone of the device or browser.\nunknown | Dates and time are not adjusted for any timezone. [TimeSlider](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/) will be disabled.\nSpecified IANA timezone | Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","docsTags":[{"name":"since","text":"4.28"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"view","type":"MapViewOrSceneView | null | undefined","complexType":{"original":"MapViewOrSceneView | null | undefined","resolved":"MapViewOrSceneView | null | undefined","references":{"MapViewOrSceneView":{"location":"import","path":"@arcgis/core/views/MapViewOrSceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-time-slider component will be associated with a map or scene component rather than using the `view` property.","docsTags":[{"name":"example","text":"```js\n// Create and then add a TimeSlider component and then listen to changes in the View's time extent.\nconst timeSlider = new TimeSlider({\n container: \"timeSliderDiv\",\n view: view,\n mode: \"instant\",\n fullTimeExtent: {\n start: new Date(2000, 0, 1),\n end: new Date(2010, 0, 1)\n },\n timeExtent: {\n start: new Date(2000, 0, 1),\n end: new Date(2000, 0, 1)\n }\n});\nview.ui.add(timeSlider, \"top-left\");\n\nreactiveUtils.watch(\n () => view.timeExtent,\n (timeExtent) => {\n console.log(\"New view time is: \", timeExtent.start);\n }\n);\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"applyTimeSliderSettings","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(settings: TimeSliderSettings): Promise","parameters":[{"name":"settings","type":"TimeSliderSettings","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"TimeSliderSettings":{"location":"import","path":"@arcgis/core/widgets/TimeSlider/types.js","id":"notImplemented"}}},"signature":"applyTimeSliderSettings(settings: TimeSliderSettings): Promise","parameters":[{"name":"settings","type":"TimeSliderSettings","docs":""}],"docs":"","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisTimeSlider = document.createElement(\"arcgis-time-slider\");\ndocument.body.append(arcgisTimeSlider);\nawait arcgisTimeSlider.componentOnReady();\nconsole.log(\"arcgis-time-slider is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"next","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"next(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"play","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"play(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"previous","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"previous(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"stop","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"stop(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"updateWebDocument","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(webmap: WebMap): Promise","parameters":[{"name":"webmap","type":"WebMap","docs":""}],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"default":{"location":"import","path":"@arcgis/core/WebMap.js","id":"notImplemented"}}},"signature":"updateWebDocument(webmap: WebMap): Promise","parameters":[{"name":"webmap","type":"WebMap","docs":""}],"docs":"","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"effectiveStops\" | \"fullTimeExtent\" | \"timeExtent\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"effectiveStops\" | \"fullTimeExtent\" | \"timeExtent\" | \"state\"; }","resolved":"{ name: \"effectiveStops\" | \"fullTimeExtent\" | \"timeExtent\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTriggerAction","detail":"TimeSliderViewModelTriggerActionEvent","bubbles":true,"complexType":{"original":"TimeSliderViewModelTriggerActionEvent","resolved":"TimeSliderViewModelTriggerActionEvent","references":{"TimeSliderViewModelTriggerActionEvent":{"location":"import","path":"@arcgis/core/widgets/TimeSlider/TimeSliderViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when an action is triggered on the component.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/time-zone-label/time-zone-label.tsx","tag":"arcgis-time-zone-label","overview":"","readme":"","usage":{},"docs":"Time Zone Label is a component for displaying the current [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) of an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/).","docsTags":[{"name":"since","text":"4.33"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"actionIcon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"action-icon","reflectToAttr":true,"docs":"An optional leading icon that is displayed within the component.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":true,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.34"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"time-zone\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"local","path":"components/arcgis-time-zone-label/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-time-zone-label component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisTimeZoneLabel = document.createElement(\"arcgis-time-zone-label\");\ndocument.body.append(arcgisTimeZoneLabel);\nawait arcgisTimeZoneLabel.componentOnReady();\nconsole.log(\"arcgis-time-zone-label is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/track/track.tsx","tag":"arcgis-track","overview":"","readme":"","usage":{},"docs":"The Track component is a button that when activated continuously animates the Map or Scene\nto the user's location as the user moves.\nThe view rotates based on device heading, and the default heading symbol will display\nwhen speed is greater than zero and the browser provides heading information.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/docs/Web/Security/Defenses/Secure_Contexts), such as HTTPS.\n`localhost` is considered \"potentially secure\" and can be used for testing.\n\n> [!WARNING]\n>\n> **Note**\n>\n> To avoid unexpected navigation, especially when using custom spatial references, configure the view [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#constraints)\n> such as `extent`, `minZoom`, and `maxZoom`.\n> This helps when the geolocated position is inaccurate or causes the map to navigate to a location that is no longer visible because it is outside of\n> a layer's `fullExtent`.\n\n**Known limitations**\n\n- The heading symbol is not currently supported within an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-track/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"currentPosition","type":"GeolocationPosition | undefined","complexType":{"original":"GeolocationPosition | undefined","resolved":"GeolocationPosition | undefined","references":{"GeolocationPosition":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Indicates the current position of the geolocation result returned by the browser's Geolocation API.\nThis property is updated when a new position is returned by the API, and is used to update the graphic and navigate to that location.","docsTags":[{"name":"since","text":"5.1"}],"values":[],"optional":true,"required":false},{"name":"error","type":"Error | GeolocationPositionError | undefined","complexType":{"original":"Error | GeolocationPositionError | undefined","resolved":"Error | GeolocationPositionError | undefined","references":{"Error":{"location":"global","path":"global:","id":"notImplemented"},"GeolocationPositionError":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Error that caused the last [track-error](https://developers.arcgis.com/javascript/latest/references/core/widgets/Track/TrackViewModel/#event:track-error) event to fire.","docsTags":[{"name":"since","text":"4.29"},{"name":"example","text":"if(track.viewModel.state === 'error')\n console.error(track.viewModel.error);"}],"values":[],"optional":true,"required":false},{"name":"geolocationOptions","type":"PositionOptions | undefined","complexType":{"original":"PositionOptions | undefined","resolved":"PositionOptions | undefined","references":{"PositionOptions":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An object used for setting optional position parameters. Refer to the\n[Geolocation API Specification](https://www.w3.org/TR/geolocation/#position_options_interface)\nfor details on using these parameters.","docsTags":[{"name":"example","text":"const track = new Track({\n view: view,\n // Set optional position parameters\n geolocationOptions: {\n maximumAge: 0,\n timeout: 15000,\n enableHighAccuracy: true\n }\n});"}],"values":[],"optional":true,"required":false},{"name":"goToLocationDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"go-to-location-disabled","reflectToAttr":true,"docs":"Indicates whether to navigate the view to the position and scale of the geolocated result.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"goToOverride","type":"GoToOverride | undefined","complexType":{"original":"GoToOverride | undefined","resolved":"GoToOverride | undefined","references":{"GoToOverride":{"location":"import","path":"@arcgis/core/widgets/support/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This function provides the ability to override either the [arcgis-map.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) or [arcgis-scene.goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) methods.","docsTags":[{"name":"since","text":"4.33"},{"name":"example","text":"```js\ncomponent.goToOverride = function(view, goToParams) {\n goToParams.options = {\n duration: updatedDuration\n };\n return view.goTo(goToParams.target, goToParams.options);\n};\n```"}],"values":[],"optional":true,"required":false},{"name":"graphic","type":"Graphic","complexType":{"original":"Graphic","resolved":"Graphic","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The graphic used to show the user's location on the map.","docsTags":[{"name":"example","text":"const trackComponent = document.createElement(\"arcgis-track\");\n// Overwrite the default symbol used for the\n// graphic placed at the location of the user\ntrackComponent.graphic = new Graphic ({\n symbol: {\n // autocasts as new SimpleMarkerSymbol()\n type: \"simple-marker\",\n size: \"12px\",\n color: \"blue\",\n // autocasts as new SimpleLineSymbol()\n outline: {\n color: \"#efefef\",\n width: \"1.5px\"\n }\n }\n});"}],"values":[],"optional":true,"required":false},{"name":"icon","type":"IconName | undefined","complexType":{"original":"IconName | undefined","resolved":"IconName | undefined","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon displayed in the component's button.","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"compass-north-circle\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"positionFilterFunction","type":"PositionFilterFunction | undefined","complexType":{"original":"PositionFilterFunction | undefined","resolved":"PositionFilterFunction | undefined","references":{"PositionFilterFunction":{"location":"local","path":"components/arcgis-track/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function that is used as an expression to evaluate geolocation points, and returns a boolean\nvalue. If the function returns `true`, the component will draw a graphic and navigate to the position.\nThe component will ignore `false` values and not draw a graphic and not navigate to the position.\n\nExample use cases include smoothing out geolocation anomalies and geofencing.","docsTags":[{"name":"since","text":"4.27"},{"name":"example","text":"// Exclude locations that full outside an extent.\ntrackComponent.positionFilterFunction = (value) => {\n const { longitude, latitude } = value.position.coords;\n const myLocation = new Point({ longitude, latitude });\n const geofenceExtent = new Extent({\n // whatever\n });\n return geometryEngine.within(myLocation, geofenceExtent);\n};"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"rotationDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"rotation-disabled","reflectToAttr":false,"docs":"Indicates whether the component will automatically rotate to the device heading based on\nthe Geolocation APIs [`GeolocationCoordinates.heading`](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/heading)\nproperty. The map will not rotate if the speed is `0`,\nor if the device is unable to provide heading information.","docsTags":[{"name":"since","text":"4.33"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"scale","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"scale","reflectToAttr":false,"docs":"Indicates the scale to set on the view when navigating to the position of the geolocated\nresult, after a location is returned.\n\nBy default, the view will navigate to a scale of `2500` for 3D and `4514` for 2D.\nTo override the default in 2D, set the `scale` property and also set [snapToZoom](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#constraints) to `false`.\nFor 2D views the value should be within the [effectiveMinScale](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#constraints)\nand [effectiveMaxScale](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#constraints).","docsTags":[{"name":"since","text":"4.7"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"state","type":"TrackViewModelState","complexType":{"original":"TrackViewModelState","resolved":"TrackViewModelState","references":{"TrackViewModelState":{"location":"local","path":"components/arcgis-track/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"disabled\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"error"},{"type":"string","value":"waiting"},{"type":"string","value":"tracking"},{"type":"string","value":"feature-unsupported"}],"optional":true,"required":false},{"name":"tracking","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Indicates whether new positions are being watched.","docsTags":[{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-track component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Specifies the size of the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisTrack = document.createElement(\"arcgis-track\");\ndocument.body.append(arcgisTrack);\nawait arcgisTrack.componentOnReady();\nconsole.log(\"arcgis-track is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"start","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"start(): Promise","parameters":[],"docs":"Start tracking the user's location. Only start the component on a user gesture such as a click event.","docsTags":[]},{"name":"stop","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"stop(): Promise","parameters":[],"docs":"Stop tracking the user's location.","docsTags":[]}],"events":[{"event":"arcgisComplete","detail":"{ position: GeolocationPosition; }","bubbles":true,"complexType":{"original":"{ position: GeolocationPosition; }","resolved":"{ position: GeolocationPosition; }","references":{"GeolocationPosition":{"location":"global","path":"global:","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisError","detail":"{ error: GeolocationPositionError; }","bubbles":true,"complexType":{"original":"{ error: GeolocationPositionError; }","resolved":"{ error: GeolocationPositionError; }","references":{"GeolocationPositionError":{"location":"global","path":"global:","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-associations/utility-network-associations.tsx","tag":"arcgis-utility-network-associations","overview":"","readme":"","usage":{},"docs":"The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-associations/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"autoRefreshAssociationsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-refresh-associations-disabled","reflectToAttr":false,"docs":"Indicates whether to show a toggle to automatically show associations every time the map\nextent changes, or an action button to show associations within the current map extent on demand.","docsTags":[{"name":"since","text":"4.26"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"connectivityAssociationsLineSymbol","type":"SimpleLineSymbol","complexType":{"original":"SimpleLineSymbol","resolved":"SimpleLineSymbol","references":{"default":{"location":"import","path":"@arcgis/core/symbols/SimpleLineSymbol.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleLineSymbol/) used for representing the polyline geometry that is being\ndrawn for connectivity associations.","docsTags":[{"name":"since","text":"4.26"}],"values":[],"optional":true,"required":false},{"name":"hideConnectivityAssociationsSettingsColorPicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-connectivity-associations-settings-color-picker","reflectToAttr":false,"docs":"If true, hides the connectivity association color picker.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideConnectivityAssociationsSettingsStylePicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-connectivity-associations-settings-style-picker","reflectToAttr":false,"docs":"If true, hides the connectivity association style picker.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideConnectivityAssociationsSettingsWidthInput","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-connectivity-associations-settings-width-input","reflectToAttr":false,"docs":"If true, hides the connectivity association width input.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStructuralAttachmentAssociationsSettingsColorPicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-structural-attachment-associations-settings-color-picker","reflectToAttr":false,"docs":"If true, hides the structural attachment associations color picker.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStructuralAttachmentAssociationsSettingsStylePicker","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-structural-attachment-associations-settings-style-picker","reflectToAttr":false,"docs":"If true, hides the structural attachment associations style picker.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStructuralAttachmentAssociationsSettingsWidthInput","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-structural-attachment-associations-settings-width-input","reflectToAttr":false,"docs":"If true, hides the structural attachment associations width input.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"view-associations\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"includeConnectivityAssociationsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"include-connectivity-associations-disabled","reflectToAttr":false,"docs":"Indicates whether to query and display connectivity associations.","docsTags":[{"name":"since","text":"4.26"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"includeStructuralAttachmentAssociationsDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"include-structural-attachment-associations-disabled","reflectToAttr":false,"docs":"Indicates whether to query and display structural attachment associations.","docsTags":[{"name":"since","text":"4.26"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.26"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"maxAllowableAssociations","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-allowable-associations","reflectToAttr":false,"docs":"The maximum number of associations that can be returned from the server.","docsTags":[{"name":"since","text":"4.26"}],"default":"250","values":[{"type":"number"}],"optional":true,"required":false},{"name":"maxAllowableAssociationsSliderMax","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-allowable-associations-slider-max","reflectToAttr":false,"docs":"The maximum value or upper bound of the Maximum allowable associations slider.\n\nIf the value in the constructor is less than or equal to the value set for\n[maxAllowableAssociationsSliderMin](https://developers.arcgis.com/javascript/latest/references/core/widgets/UtilityNetworkAssociations/#maxAllowableAssociationsSliderMin), the property will be set to a default value (1000).","docsTags":[{"name":"since","text":"4.26"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"maxAllowableAssociationsSliderMin","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-allowable-associations-slider-min","reflectToAttr":false,"docs":"The minimum value or lower bound of the Maximum allowable associations slider.\n\nIf the value in the constructor is less than 0, the property will be set to a default value (250).\nIf the value in the constructor is greater than or equal to [maxAllowableAssociationsSliderMax](https://developers.arcgis.com/javascript/latest/references/core/widgets/UtilityNetworkAssociations/#maxAllowableAssociationsSliderMax),\nthe property will be set to a default value (250).","docsTags":[{"name":"since","text":"4.26"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"maxAllowableAssociationsSliderStep","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-allowable-associations-slider-step","reflectToAttr":false,"docs":"Specifies the interval to move the maximum allowable associations slider with the up, or down keys.","docsTags":[{"name":"since","text":"4.26"}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"showArrowsConnectivity","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-arrows-connectivity","reflectToAttr":false,"docs":"Indicates whether to show arrows for connectivity associations.","docsTags":[{"name":"since","text":"4.26"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showArrowsStructuralAttachment","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-arrows-structural-attachment","reflectToAttr":false,"docs":"Indicates whether to show arrows for structural attachment associations.","docsTags":[{"name":"since","text":"4.26"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showAssociationsEnabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-associations-enabled","reflectToAttr":false,"docs":"When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations\nevery time the current map extent changes.","docsTags":[{"name":"since","text":"4.26"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showConnectivityAssociationsSettingsArrowsToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-connectivity-associations-settings-arrows-toggle","reflectToAttr":false,"docs":"If true, shows the connectivity association arrows toggle.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showConnectivityAssociationsSettingsCapSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-connectivity-associations-settings-cap-select","reflectToAttr":false,"docs":"If true, shows the connectivity association cap select.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showMaxAllowableAssociationsSlider","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-max-allowable-associations-slider","reflectToAttr":false,"docs":"If true, hides the max allowable associations slider.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showStructuralAttachmentAssociationsSettingsArrowsToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-structural-attachment-associations-settings-arrows-toggle","reflectToAttr":false,"docs":"If true, shows the structural attachment associations arrow toggle.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showStructuralAttachmentAssociationsSettingsCapSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-structural-attachment-associations-settings-cap-select","reflectToAttr":false,"docs":"If true, shows the structural attachment associations cap select.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"structuralAttachmentAssociationsLineSymbol","type":"SimpleLineSymbol","complexType":{"original":"SimpleLineSymbol","resolved":"SimpleLineSymbol","references":{"default":{"location":"import","path":"@arcgis/core/symbols/SimpleLineSymbol.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleLineSymbol/) used for representing the polyline geometry that is being drawn for structural attachment associations.","docsTags":[{"name":"since","text":"4.26"}],"values":[],"optional":true,"required":false},{"name":"utilityNetwork","type":"UtilityNetwork | null | undefined","complexType":{"original":"UtilityNetwork | null | undefined","resolved":"UtilityNetwork | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/networks/UtilityNetwork.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Determines the utility network to use.","docsTags":[{"name":"since","text":"4.26"}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-utility-network-associations component will be associated with a map or scene component rather than using the `view` property.","docsTags":[{"name":"since","text":"4.26"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkAssociations = document.createElement(\"arcgis-utility-network-associations\");\ndocument.body.append(arcgisUtilityNetworkAssociations);\nawait arcgisUtilityNetworkAssociations.componentOnReady();\nconsole.log(\"arcgis-utility-network-associations is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-trace/utility-network-trace.tsx","tag":"arcgis-utility-network-trace","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This component is **deprecated**. [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/) is the preferred component for utility network tracing and should be used for all new development.\n\nUtility Network Trace component provides a way to run traces in a Utility Network based on connectivity or traversability from set trace locations. Trace locations (starting points and barriers) can be set by clicking the view.\n\n> The Utility Network Trace component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"deprecation":"since 5.0, use [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/) instead.","props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"defaultGraphicColor","type":"GraphicColor","complexType":{"original":"GraphicColor","resolved":"GraphicColor","references":{"GraphicColor":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The default color to assign the aggregated geometry of a trace result.","docsTags":[{"name":"since","text":"4.23"}],"default":"{\ncolor: [255, 255, 0, 0.6],\nhaloOpacity: 0.9,\nfillOpacity: 0.2,\nhex: \"#FFFF00\"\n}","values":[],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":true,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[{"name":"since","text":"4.22"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"enableResultArea","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"enable-result-area","reflectToAttr":false,"docs":"When `true`, provides the ability to show the convex hull or buffer.","docsTags":[{"name":"since","text":"4.27"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"flags","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"FlagProperty":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of map points to load into the component to lookup flags.","docsTags":[{"name":"since","text":"4.22"},{"name":"example","text":"const unt = new UtilityNetworkTrace({\n view: view,\n showSelectionAttributes: true,\n selectOnComplete: true,\n showGraphicsOnComplete: true,\n selectedTraces: [\"{E8D545B8-596D-4656-BF5E-16C1D7CBEC9B}\"],\n flags: [\n {\n type: \"starting-point\",\n mapPoint: {\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -9814829.166046409,\n y: 5127094.1017433\n }\n },\n {\n type: \"barrier\",\n mapPoint: {\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -9814828.449441982,\n y: 5127089.085566963\n }\n }\n ]\n});"}],"default":"[]","values":[],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"utility-network-trace\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputSettings","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"InputSetting":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Custom labels, descriptions, and symbol for the input [flags](https://developers.arcgis.com/javascript/latest/references/core/widgets/UtilityNetworkTrace/#flags).","docsTags":[{"name":"since","text":"4.23"}],"default":"[]","values":[],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"resultAreaProperties","type":"ResultAreaPropertiesExtend","complexType":{"original":"ResultAreaPropertiesExtend","resolved":"ResultAreaPropertiesExtend","references":{"ResultAreaPropertiesExtend":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The properties to determine the size and color of the result area convex hull or buffer, and determines if it displays on the map when the trace completes.","docsTags":[{"name":"since","text":"4.27"},{"name":"example","text":"const unt = new UtilityNetworkTrace({\n un: un,\n view: view,\n enableResultArea: true,\n resultAreaProperties: {\n type: \"buffer\",\n distance: 10,\n unit: \"feet\",\n areaUnit: \"square-feet\",\n color: {\n color: [255, 165, 0, 0.5],\n haloOpacity: 0.9,\n fillOpacity: 0.2,\n hex: \"#ffa500\"\n },\n show: true\n }\n});"}],"default":"{\n type: \"convexhull\",\n distance: 10,\n unit: \"meters\",\n areaUnit: \"square-meters\",\n color: {\n color: [255, 165, 0, 0.5],\n haloOpacity: 0.9,\n fillOpacity: 0.2,\n hex: \"#ffa500\"\n },\n show: false\n}","values":[],"optional":true,"required":false},{"name":"selectedTraces","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A list of global Ids of traces to select on load","docsTags":[{"name":"since","text":"4.22"},{"name":"example","text":"const unt = new UtilityNetworkTrace({\n view: view,\n selectedTraces: [\"{E8D545B8-596D-4656-BF5E-16C1D7CBEC9B}\"]\n});"}],"default":"[]","values":[],"optional":true,"required":false},{"name":"selectOnCompleteDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"select-on-complete-disabled","reflectToAttr":false,"docs":"When true, the utility network elements are selected in the view when traces are completed.","docsTags":[{"name":"since","text":"4.22"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showGraphicsOnCompleteDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-graphics-on-complete-disabled","reflectToAttr":false,"docs":"When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed.","docsTags":[{"name":"since","text":"4.22"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"showSelectionAttributesDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-selection-attributes-disabled","reflectToAttr":false,"docs":"Determines whether to show list of selection attributes","docsTags":[{"name":"since","text":"4.22"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"UtilityNetworkTraceViewModelState","complexType":{"original":"UtilityNetworkTraceViewModelState","resolved":"UtilityNetworkTraceViewModelState","references":{"UtilityNetworkTraceViewModelState":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"default":"\"ready\"","values":[{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"traceResults","type":"TraceResultExtend[]","complexType":{"original":"TraceResultExtend[]","resolved":"TraceResultExtend[]","references":{"TraceResultExtend":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Stores the result of completed traces.","docsTags":[{"name":"since","text":"4.34"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-utility-network-trace component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"checkCanTrace","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"checkCanTrace(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkTrace = document.createElement(\"arcgis-utility-network-trace\");\ndocument.body.append(arcgisUtilityNetworkTrace);\nawait arcgisUtilityNetworkTrace.componentOnReady();\nconsole.log(\"arcgis-utility-network-trace is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"confirmReset","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"confirmReset(): Promise","parameters":[],"docs":"","docsTags":[]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisAddFlag","detail":"UtilityNetworkTraceViewModelAddFlagEvent","bubbles":true,"complexType":{"original":"UtilityNetworkTraceViewModelAddFlagEvent","resolved":"UtilityNetworkTraceViewModelAddFlagEvent","references":{"UtilityNetworkTraceViewModelAddFlagEvent":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisAddFlagComplete","detail":"UtilityNetworkTraceViewModelAddFlagCompleteEvent","bubbles":true,"complexType":{"original":"UtilityNetworkTraceViewModelAddFlagCompleteEvent","resolved":"UtilityNetworkTraceViewModelAddFlagCompleteEvent","references":{"UtilityNetworkTraceViewModelAddFlagCompleteEvent":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisAddFlagError","detail":"UtilityNetworkTraceViewModelAddFlagErrorEvent","bubbles":true,"complexType":{"original":"UtilityNetworkTraceViewModelAddFlagErrorEvent","resolved":"UtilityNetworkTraceViewModelAddFlagErrorEvent","references":{"UtilityNetworkTraceViewModelAddFlagErrorEvent":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisAddResultArea","detail":"UtilityNetworkTraceViewModelAddResultAreaEvent","bubbles":true,"complexType":{"original":"UtilityNetworkTraceViewModelAddResultAreaEvent","resolved":"UtilityNetworkTraceViewModelAddResultAreaEvent","references":{"UtilityNetworkTraceViewModelAddResultAreaEvent":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\" | \"traceResults\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\" | \"traceResults\"; }","resolved":"{ name: \"state\" | \"traceResults\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisRemoveResultArea","detail":"UtilityNetworkTraceViewModelRemoveResultAreaEvent","bubbles":true,"complexType":{"original":"UtilityNetworkTraceViewModelRemoveResultAreaEvent","resolved":"UtilityNetworkTraceViewModelRemoveResultAreaEvent","references":{"UtilityNetworkTraceViewModelRemoveResultAreaEvent":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkTrace/UtilityNetworkTraceViewModel.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-trace-analysis/utility-network-trace-analysis.tsx","tag":"arcgis-utility-network-trace-analysis","overview":"","readme":"","usage":{},"docs":"## Overview\n\nThe Utility Network Trace Analysis component allows users to run traces and view trace results in a utility network.\n\n- The component supports selecting a utility network and a named trace configuration in that utility network. Both the utility network and trace configuration must be [stored in the map](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#utilityNetworks).\n- Trace locations (starting points, stopping points, and barriers) are set by selecting features on the view.\n- When a subnetwork-based trace is selected, the component displays the domain, tier, and target tier specified by the selected named trace configuration.\n- If the user selects a subnetwork trace with a specified subnetwork name, the component provides an option to choose a subnetwork name instead of starting location(s) to run the trace with.\n\nSupported trace types are: `connected`, `upstream`, `downstream`, `shortest-path` (deprecated), `path`, `subnetwork`, `subnetwork-controller`, `loops`, and `isolation`.\n\n> [!WARNING]\n>\n> The [shortest path trace type](https://pro.arcgis.com/en/pro-app/latest/help/data/trace-network/discover-the-shortest-path.htm) is deprecated with ArcGIS Pro 3.7 and ArcGIS Enterprise 12.1.\n>\n> While the shortest path trace will continue to function and be an option until the next major release, it is recommended to use the path trace to return the shortest path.\n> The path trace provides the same functionality to return a shortest path result while offering additional capabilities to find paths in your network.\n\nThe component can display the following from a trace result: elements (as [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures)), aggregated geometries, and function results.\nIf the trace result includes elements that originate from a [feature layer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/)\nthat is not included in the map, the Results tab displays an `Unknown` layer with a count of those elements.\nThe component's [traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures) property also does not include these elements.\n\n> [!WARNING]\n>\n> The Utility Network Trace Analysis component does not support the following:\n>\n> 1. Proxied feature services or feature services that utilize stored credentials.\n> 2. The `circuit` trace type or the `paths` and `circuits` result types.\n> 3. Setting grouping properties `firstUnit` and `lastUnit` for trace locations in a [telecom domain network](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/telecom-domain-networks.htm).\n> If a [grouped object](https://doc.esri.com/en/arcgis-pro/latest/help/data/utility-network/grouping.html) is used as a trace location, its `firstUnit` and `lastUnit` attributes are not used in the trace.\n\n## Working with nonspatial objects\n\nThe Utility Network Trace Analysis component supports selecting nonspatial objects as trace locations by traversing associations.\n\nWhen selecting a trace location or viewing a trace result feature, information about the feature is displayed according to the\n[PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) of the layer that the feature belongs to.\nIf the feature's layer has no PopupTemplate, a default template is used to display the feature's attributes.\n\nTo select a nonspatial object as a trace location, first select a spatial feature on the map that is associated with the target nonspatial object.\nThe spatial feature's layer must have a PopupTemplate that includes a [UtilityNetworkAssociationsContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/).\nNavigate through the spatial feature's associations to the target nonspatial object, then add the object as a trace location.\n\n## Examples\n\nThis component can be used slotted into an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/):\n\n```html\n\n \n\n```\n\nAlternatively, this component can be used outside of a map by providing a [referenceElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#referenceElement):\n\n```html\n\n \n \n \n \n\n```\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`","docsTags":[{"name":"since","text":"5.0"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"aggregatedGeometryGraphicsColor","type":"Color","complexType":{"original":"Color","resolved":"Color","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The color used to render graphics for aggregated geometries in trace results, specified as a\n[Color](https://developers.arcgis.com/javascript/latest/references/core/Color/) object.\n\nAggregated geometry is only rendered if the trace configuration specifies aggregated geometry as a result type.\n\nDefault color is #FFFF00.","docsTags":[{"name":"see","text":"[Color constructor](https://developers.arcgis.com/javascript/latest/references/core/Color/#constructors-summary)"}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"beforeTraceLocationSelectStart","type":"(() => Promise) | undefined","complexType":{"original":"(() => Promise) | undefined","resolved":"(() => Promise) | undefined","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function to run before trace location selection starts.","docsTags":[{"name":"internal"},{"name":"example","text":"```js\nconst traceElement = document.querySelector(\"arcgis-utility-network-trace-analysis\");\ntraceElement.beforeTraceLocationSelectStart = async () => await doAsyncWork();\n```"}],"values":[],"optional":true,"required":false},{"name":"disableHighlightFeatureResults","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disable-highlight-feature-results","reflectToAttr":false,"docs":"Whether to disable highlighting trace result features on the map.\n\nIf true, the features returned by a trace will not be highlighted on the map.","docsTags":[{"name":"example","text":"Disable highlighting trace result features.\n```html\n\n \n \n\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideActionBar","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-action-bar","reflectToAttr":false,"docs":"Indicates whether to hide the action bar that holds the feature's\n[actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#actions)\nwhen selecting trace locations and viewing trace result features.","docsTags":[{"name":"internal"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureResults","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-results","reflectToAttr":false,"docs":"Whether to hide feature results in the results tab.\n\nIf true, when features are returned by a trace, they will not be visible in the results tab.\nA message will be displayed in its place indicating that features were returned by the trace, but are not visible in the results pane.\nThis string can be overridden with the `messageOverrides` property.","docsTags":[{"name":"example","text":"Do not show features in the results tab.\n```html\n\n \n \n\n```"},{"name":"example","text":"Override the message displayed in the results tab when features are hidden.\n```js\nconst traceElement = document.querySelector(\"arcgis-utility-network-trace-analysis\");\ntraceElement.messageOverrides = { resultFeaturesAreHidden: \"Feature results were sent to the results window.\" };\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":true,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"UtilityNetworkTraceAnalysisState","complexType":{"original":"UtilityNetworkTraceAnalysisState","resolved":"UtilityNetworkTraceAnalysisState","references":{"UtilityNetworkTraceAnalysisState":{"location":"import","path":"@arcgis/core/networks/UtilityNetworkTraceAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"executing"}],"optional":true,"required":false},{"name":"traceResultFeatures","type":"Graphic[]","complexType":{"original":"Graphic[]","resolved":"Graphic[]","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An array of features returned by the trace result.\n\nThis array is populated if the trace returned [element](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#elements) results.\n\nWhen [@arcgisTraceResultFeaturesReady](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#event-arcgisTraceResultFeaturesReady) is raised, trace result features are available.\nWhen a new trace has been run, or the trace results are cleared, this array is cleared.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-utility-network-trace-analysis component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkTraceAnalysis = document.createElement(\"arcgis-utility-network-trace-analysis\");\ndocument.body.append(arcgisUtilityNetworkTraceAnalysis);\nawait arcgisUtilityNetworkTraceAnalysis.componentOnReady();\nconsole.log(\"arcgis-utility-network-trace-analysis is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisHideGraphicsChange","detail":"boolean","bubbles":true,"complexType":{"original":"boolean","resolved":"boolean","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the user toggles displaying aggregated geometry results in the result pane.\nEvent payload contains a boolean representing whether the aggregated geometry graphics are hidden.\nIf true, the aggregated geometry graphics are hidden on the view.","docsTags":[{"name":"example","text":"```js\nconst traceElement = document.querySelector(\"arcgis-utility-network-trace-analysis\");\ntraceElement.addEventListener(\"arcgisHideGraphicsChange\", (event) => {\n const hideGraphics = event.detail;\n console.log(hideGraphics);\n});\n```"}]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisTraceLocationSelectEnd","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the user completes the selection of a trace location.","docsTags":[{"name":"internal"},{"name":"example","text":"```js\nconst traceElement = document.querySelector(\"arcgis-utility-network-trace-analysis\");\ntraceElement.addEventListener(\"arcgisTraceLocationSelectEnd\", () => {\n console.log(\"Selection finished!\");\n});\n```"}]},{"event":"arcgisTraceLocationSelectStart","detail":"SelectStartPayload","bubbles":true,"complexType":{"original":"SelectStartPayload","resolved":"SelectStartPayload","references":{"SelectStartPayload":{"location":"local","path":"components/arcgis-utility-network-trace-location","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the user begins selection of a trace location.\nEvent payload contains a callback method `cancelSelect` to cancel a selection in progress.\nThe event can also be prevented with `event.preventDefault()` to stop the selection.","docsTags":[{"name":"internal"},{"name":"example","text":"```js\nconst traceElement = document.querySelector(\"arcgis-utility-network-trace-analysis\");\ntraceElement.addEventListener(\"arcgisTraceLocationSelectStart\", (event) => {\n event.preventDefault();\n});\n```"},{"name":"example","text":"```js\nlet cancelSelect;\nconst traceElement = document.querySelector(\"arcgis-utility-network-trace-analysis\");\ntraceElement.addEventListener(\"arcgisTraceLocationSelectStart\", (event) => {\n cancelSelect = event.detail.cancelSelect;\n});\n\nsetTimeout(() => {\n cancelSelect();\n}, 3000);\n```"}]},{"event":"arcgisTraceResultClear","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the trace result is cleared from the results tab.","docsTags":[{"name":"example","text":"```js\nconst traceElement = document.querySelector(\"arcgis-utility-network-trace-analysis\");\ntraceElement.addEventListener(\"arcgisTraceResultClear\", (event) => {\n console.log(\"Trace result was cleared.\");\n});\n```"}]},{"event":"arcgisTraceResultFeaturesReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the trace result features are ready.\nCheck property [traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures) for the trace result features.","docsTags":[{"name":"example","text":"```js\nconst traceElement = document.querySelector(\"arcgis-utility-network-trace-analysis\");\ntraceElement.addEventListener(\"arcgisTraceResultFeaturesReady\", (event) => {\n const resultFeatures = traceElement.traceResultFeatures;\n console.log(resultFeatures);\n});\n```"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-trace-analysis/components/utility-network-aggregated-geometry/utility-network-aggregated-geometry.tsx","tag":"arcgis-utility-network-aggregated-geometry","overview":"","readme":"","usage":{},"docs":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component renders the aggregated geometry from a `TraceResult` on a view.\nThe component does not project the geometry on the client.\nThis sub-component also renders a \"Show graphics\" toggle which shows or hides the aggregated geometry graphics.\n\nThe user can specify a color to render the aggregated geometry graphics in.\n\nThe map layer with the aggregated geometry graphics is removed on component disconnect.\nThe graphics layer is added to the map again when reconnected.","docsTags":[{"name":"since","text":"5.0"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-aggregated-geometry/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"geometry","type":"AggregatedGeometry | undefined","complexType":{"original":"AggregatedGeometry | undefined","resolved":"AggregatedGeometry | undefined","references":{"default":{"location":"import","path":"@arcgis/core/rest/networks/support/AggregatedGeometry.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"required"}],"values":[],"optional":false,"required":true},{"name":"graphicsColor","type":"Color","complexType":{"original":"Color","resolved":"Color","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The color used for the aggregated geometry graphics.\nDefault value is #FFFF00.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"hideGraphics","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-graphics","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"required"}],"values":[],"optional":false,"required":true}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkAggregatedGeometry = document.createElement(\"arcgis-utility-network-aggregated-geometry\");\ndocument.body.append(arcgisUtilityNetworkAggregatedGeometry);\nawait arcgisUtilityNetworkAggregatedGeometry.componentOnReady();\nconsole.log(\"arcgis-utility-network-aggregated-geometry is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisHideGraphicsChange","detail":"boolean","bubbles":true,"complexType":{"original":"boolean","resolved":"boolean","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-trace-analysis/components/utility-network-subnetwork-info/utility-network-subnetwork-info.tsx","tag":"arcgis-utility-network-subnetwork-info","overview":"","readme":"","usage":{},"docs":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a utility network and named trace configuration as input.\nThe sub-component displays information from the trace configuration relevant to subnetworks:\nDomain network name, tier name, and target tier name.","docsTags":[{"name":"since","text":"4.34"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"namedTraceConfig","type":"NamedTraceConfiguration | undefined","complexType":{"original":"NamedTraceConfiguration | undefined","resolved":"NamedTraceConfiguration | undefined","references":{"default":{"location":"import","path":"@arcgis/core/networks/support/NamedTraceConfiguration.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"required"}],"values":[],"optional":false,"required":true}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkSubnetworkInfo = document.createElement(\"arcgis-utility-network-subnetwork-info\");\ndocument.body.append(arcgisUtilityNetworkSubnetworkInfo);\nawait arcgisUtilityNetworkSubnetworkInfo.componentOnReady();\nconsole.log(\"arcgis-utility-network-subnetwork-info is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-trace-analysis/components/utility-network-trace-inputs/utility-network-trace-inputs.tsx","tag":"arcgis-utility-network-trace-inputs","overview":"","readme":"","usage":{},"docs":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select utility networks, trace configurations, and input features for tracing.","docsTags":[{"name":"since","text":"4.34"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-inputs/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"beforeTraceLocationSelectStart","type":"(() => Promise) | undefined","complexType":{"original":"(() => Promise) | undefined","resolved":"(() => Promise) | undefined","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function to run before trace location selection starts.","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"hideActionBar","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-action-bar","reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"isSubnetworkNameTraceSelected","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"mode","type":"UtilityNetworkTraceAnalysisDisplayMode","complexType":{"original":"UtilityNetworkTraceAnalysisDisplayMode","resolved":"UtilityNetworkTraceAnalysisDisplayMode","references":{"UtilityNetworkTraceAnalysisDisplayMode":{"location":"local","path":"components/arcgis-utility-network-trace-analysis/types","id":"notImplemented"}}},"mutable":true,"attr":"mode","reflectToAttr":true,"docs":"","docsTags":[],"default":"\"default\"","values":[{"type":"string","value":"default"},{"type":"string","value":"add-spatial-feature"},{"type":"string","value":"add-spatial-instructions"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedNamedTraceConfiguration","type":"NamedTraceConfiguration | undefined","complexType":{"original":"NamedTraceConfiguration | undefined","resolved":"NamedTraceConfiguration | undefined","references":{"default":{"location":"import","path":"@arcgis/core/networks/support/NamedTraceConfiguration.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"selectedUtilityNetwork","type":"UtilityNetwork | undefined","complexType":{"original":"UtilityNetwork | undefined","resolved":"UtilityNetwork | undefined","references":{"default":{"location":"import","path":"@arcgis/core/networks/UtilityNetwork.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"traceLocationFlagInfos","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"FlagInfo":{"location":"local","path":"components/arcgis-utility-network-trace-location","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Supplementary information about the points selected on the map to run the trace.\nI.e., feature title, terminal configuration, selected terminals, and spatial properties.","docsTags":[{"name":"internal"},{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"traceLocations","type":"TraceLocation[]","complexType":{"original":"TraceLocation[]","resolved":"TraceLocation[]","references":{"default":{"location":"import","path":"@arcgis/core/rest/networks/support/TraceLocation.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"unTraceConfiguration","type":"UNTraceConfiguration | undefined","complexType":{"original":"UNTraceConfiguration | undefined","resolved":"UNTraceConfiguration | undefined","references":{"default":{"location":"import","path":"@arcgis/core/networks/support/UNTraceConfiguration.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A clone of the utility network trace configuration associated with\nthe selected named trace configuration. Updates on this object are\nused to reflect the user's changes to the named trace configuration.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"required"}],"values":[],"optional":false,"required":true}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkTraceInputs = document.createElement(\"arcgis-utility-network-trace-inputs\");\ndocument.body.append(arcgisUtilityNetworkTraceInputs);\nawait arcgisUtilityNetworkTraceInputs.componentOnReady();\nconsole.log(\"arcgis-utility-network-trace-inputs is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"mode\"; }","bubbles":true,"complexType":{"original":"{ name: \"mode\"; }","resolved":"{ name: \"mode\"; }","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisSelectedNamedTraceConfigurationChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the user changes the selected named trace configuration.","docsTags":[]},{"event":"arcgisTraceInputsChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"There will be more added to this event as we increase the functionality of this component","docsTags":[]},{"event":"arcgisTraceLocationSelectEnd","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the user completes the selection of a trace location.","docsTags":[{"name":"internal"}]},{"event":"arcgisTraceLocationSelectStart","detail":"SelectStartPayload","bubbles":true,"complexType":{"original":"SelectStartPayload","resolved":"SelectStartPayload","references":{"SelectStartPayload":{"location":"local","path":"components/arcgis-utility-network-trace-location","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.","docsTags":[{"name":"internal"}]},{"event":"arcgisUtilityNetworkChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"This will be fired less often than above, only when the utility network changes","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-trace-analysis/components/utility-network-trace-location/utility-network-trace-location.tsx","tag":"arcgis-utility-network-trace-location","overview":"","readme":"","usage":{},"docs":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select locations on the map to use as trace inputs.","docsTags":[{"name":"since","text":"4.34"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"afterHitTest","type":"((graphics: Graphic[]) => Promise) | undefined","complexType":{"original":"((graphics: Graphic[]) => Promise) | undefined","resolved":"((graphics: Graphic[]) => Promise) | undefined","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"},"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function to run after a hit test is performed to select a trace location. If left empty, the first graphic from the hit test results will be used as the trace location.\nThis function allows for modification of the selected graphic before it is added as a trace location, such as changing its attributes or geometry.\nIf the promise is rejected, the selection process will be cancelled.","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"beforeTraceLocationSelectStart","type":"(() => Promise) | undefined","complexType":{"original":"(() => Promise) | undefined","resolved":"(() => Promise) | undefined","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function to run before trace location selection starts.","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"filterLayers","type":"Collection | undefined","complexType":{"original":"Collection | undefined","resolved":"Collection | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/Layer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"sketchViewModel","type":"SketchViewModel | undefined","complexType":{"original":"SketchViewModel | undefined","resolved":"SketchViewModel | undefined","references":{"default":{"location":"import","path":"@arcgis/core/widgets/Sketch/SketchViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"spatialTolerance","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"spatial-tolerance","reflectToAttr":false,"docs":"","docsTags":[],"default":"0.05","values":[{"type":"number"}],"optional":true,"required":false},{"name":"traceLocations","type":"Collection | undefined","complexType":{"original":"Collection | undefined","resolved":"Collection | undefined","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"FlagInfo":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"traceLocationType","type":"TraceLocationType","complexType":{"original":"TraceLocationType","resolved":"TraceLocationType","references":{"TraceLocationType":{"location":"local","id":"notImplemented"}}},"mutable":true,"attr":"trace-location-type","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"starting-point\"","values":[{"type":"string","value":"barrier"},{"type":"string","value":"starting-point"},{"type":"string","value":"stopping-point"}],"optional":true,"required":false},{"name":"utilityNetwork","type":"UtilityNetwork | undefined","complexType":{"original":"UtilityNetwork | undefined","resolved":"UtilityNetwork | undefined","references":{"default":{"location":"import","path":"@arcgis/core/networks/UtilityNetwork.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"required"}],"values":[],"optional":false,"required":true},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"required"}],"values":[],"optional":false,"required":true}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkTraceLocation = document.createElement(\"arcgis-utility-network-trace-location\");\ndocument.body.append(arcgisUtilityNetworkTraceLocation);\nawait arcgisUtilityNetworkTraceLocation.componentOnReady();\nconsole.log(\"arcgis-utility-network-trace-location is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisTraceLocationChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisTraceLocationSelectEnd","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the user completes the selection of a trace location.","docsTags":[{"name":"internal"}]},{"event":"arcgisTraceLocationSelectStart","detail":"SelectStartPayload","bubbles":true,"complexType":{"original":"SelectStartPayload","resolved":"SelectStartPayload","references":{"SelectStartPayload":{"location":"local","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.","docsTags":[{"name":"internal"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-trace-analysis/components/utility-network-trace-location-list/utility-network-trace-location-list.tsx","tag":"arcgis-utility-network-trace-location-list","overview":"","readme":"","usage":{},"docs":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component renders a collection of trace locations as a list.","docsTags":[{"name":"since","text":"4.34"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"traceLocations","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"},"FlagInfo":{"location":"local","path":"components/arcgis-utility-network-trace-location","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"required"}],"values":[],"optional":false,"required":true},{"name":"traceLocationType","type":"TraceLocationType","complexType":{"original":"TraceLocationType","resolved":"TraceLocationType","references":{"TraceLocationType":{"location":"local","path":"components/arcgis-utility-network-trace-location","id":"notImplemented"}}},"mutable":true,"attr":"trace-location-type","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"starting-point\"","values":[{"type":"string","value":"barrier"},{"type":"string","value":"starting-point"},{"type":"string","value":"stopping-point"}],"optional":true,"required":false},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"required"}],"values":[],"optional":false,"required":true}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkTraceLocationList = document.createElement(\"arcgis-utility-network-trace-location-list\");\ndocument.body.append(arcgisUtilityNetworkTraceLocationList);\nawait arcgisUtilityNetworkTraceLocationList.componentOnReady();\nconsole.log(\"arcgis-utility-network-trace-location-list is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-trace-analysis/components/utility-network-trace-results/utility-network-trace-results.tsx","tag":"arcgis-utility-network-trace-results","overview":"","readme":"","usage":{},"docs":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a `TraceResult` instance as input.\nOptionally, the title of a trace configuration can be provided as a heading to display.","docsTags":[{"name":"since","text":"4.34"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"aggregatedGeometryGraphicsColor","type":"Color","complexType":{"original":"Color","resolved":"Color","references":{"default":{"location":"import","path":"@arcgis/core/Color.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"featuresFromSelectedLayer","type":"Graphic[]","complexType":{"original":"Graphic[]","resolved":"Graphic[]","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"hideActionBar","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-action-bar","reflectToAttr":false,"docs":"","docsTags":[{"name":"internal"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideFeatureResults","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-feature-results","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"isElementsSelected","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"is-elements-selected","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"layers","type":"Layer[]","complexType":{"original":"Layer[]","resolved":"Layer[]","references":{"default":{"location":"import","path":"@arcgis/core/layers/Layer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"numResults","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"selectedLayer","type":"FeatureLayer | Layer | SubtypeSublayer | undefined","complexType":{"original":"FeatureLayer | Layer | SubtypeSublayer | undefined","resolved":"FeatureLayer | Layer | SubtypeSublayer | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/support/SubtypeSublayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"local","id":"notImplemented"}}},"mutable":true,"attr":"state","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"ready\"","values":[{"type":"string","value":"ready"},{"type":"string","value":"loading"}],"optional":true,"required":false},{"name":"traceConfigTitle","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"trace-config-title","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"traceError","type":"EsriError | undefined","complexType":{"original":"EsriError | undefined","resolved":"EsriError | undefined","references":{"default":{"location":"import","path":"@arcgis/core/core/Error.js","id":"notImplemented"},"TraceErrorDetails":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"traceResult","type":"TraceResult | undefined","complexType":{"original":"TraceResult | undefined","resolved":"TraceResult | undefined","references":{"default":{"location":"import","path":"@arcgis/core/rest/networks/support/TraceResult.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"traceResultFeatures","type":"Graphic[]","complexType":{"original":"Graphic[]","resolved":"Graphic[]","references":{"default":{"location":"import","path":"@arcgis/core/Graphic.js","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":{"default":{"location":"import","path":"@arcgis/core/networks/UtilityNetwork.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"clearAggregatedGeometryGraphics","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"clearAggregatedGeometryGraphics(): void","parameters":[],"docs":"","docsTags":[]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkTraceResults = document.createElement(\"arcgis-utility-network-trace-results\");\ndocument.body.append(arcgisUtilityNetworkTraceResults);\nawait arcgisUtilityNetworkTraceResults.componentOnReady();\nconsole.log(\"arcgis-utility-network-trace-results is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisAggregatedGeometryGraphicsColorChange","detail":"string","bubbles":true,"complexType":{"original":"string","resolved":"string","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisHideGraphicsChange","detail":"boolean","bubbles":true,"complexType":{"original":"boolean","resolved":"boolean","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisSelectedLayerChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisSelectedResultTypeChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisTraceResultFeaturesReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-validate-network-topology/utility-network-validate-network-topology.tsx","tag":"arcgis-utility-network-validate-network-topology","overview":"","readme":"","usage":{},"docs":"## Overview\n\nThe Utility Network Validate Network Topology component validates dirty areas in a utility network after edits have been made.\nIt provides an interface to choose a utility network (if applicable), choose the [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#extentToValidate) to validate, and perform validation.\nIf successful, the result of the validation is available as [result](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#result).\n\n## Validation requirements\n\n- The component only supports a 2D [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/).\n- The utility network must be [stored in the map](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#utilityNetworks) and the network topology must be enabled.\n- The active portal user must have the required user type extension to validate a network topology.\n- Validation fails in cases such as: no dirty areas in the target extent, inability to acquire a version lock, or insufficient permissions on the version.\n\n> [!WARNING]\n>\n> The Utility Network Validate Network Topology component does not support proxied feature services or feature services that utilize stored credentials.\n\n## Examples\n\nThis component can be used slotted into an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/):\n\n```html\n\n \n\n```\n\nAlternatively, this component can be used outside of a map by providing a [referenceElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#referenceElement):\n\n```html\n\n \n \n \n \n\n```\n\n","docsTags":[{"name":"since","text":"5.1"},{"name":"see","text":"[Network topology](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/about-network-topology.htm)"},{"name":"see","text":"[Validate a network topology](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/validate-a-network-topology.htm)"},{"name":"see","text":"[Dirty areas](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/dirty-areas-in-a-utility-network.htm)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"beforeValidateNetworkTopologyStart","type":"(() => Promise) | undefined","complexType":{"original":"(() => Promise) | undefined","resolved":"(() => Promise) | undefined","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A function to run before utility network topology validation starts.\n\nThe function is awaited before the [@arcgisValidateNetworkTopologyStart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#event-arcgisValidateNetworkTopologyStart)\nevent is emitted and before the validation request is sent.\nIf the function rejects its Promise, validation does not start and the component displays an error. If the Promise was rejected with an [Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error), the component displays the error.","docsTags":[{"name":"internal"},{"name":"example","text":"```js\nconst validateNetworkTopologyElement = document.querySelector(\"arcgis-utility-network-validate-network-topology\");\nvalidateNetworkTopologyElement.beforeValidateNetworkTopologyStart = async () => await doAsyncWork();\n```"}],"values":[],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"extentToValidate","type":"ExtentOption","complexType":{"original":"ExtentOption","resolved":"ExtentOption","references":{"ExtentOption":{"location":"local","id":"notImplemented"}}},"mutable":true,"attr":"extent-to-validate","reflectToAttr":false,"docs":"Specifies the area to validate.\n\nUse `\"current\"` to validate the current view extent. Use `\"entire\"` to validate the utility network's full extent.","docsTags":[],"default":"\"current\"","values":[{"type":"string","value":"current"},{"type":"string","value":"entire"}],"optional":true,"required":false},{"name":"hideUtilityNetworkSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-utility-network-select","reflectToAttr":false,"docs":"When true, hides the utility network selector.\n\nThe selector is also hidden when the map has one utility network.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"result","type":"ValidateNetworkTopologyResult | undefined","complexType":{"original":"ValidateNetworkTopologyResult | undefined","resolved":"ValidateNetworkTopologyResult | undefined","references":{"default":{"location":"import","path":"@arcgis/core/rest/networks/support/ValidateNetworkTopologyResult.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The result returned from the most recent successful utility network topology validation.\nThis value is cleared when clicking the \"Validate\" action.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current component state.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"utilityNetwork","type":"UtilityNetwork | undefined","complexType":{"original":"UtilityNetwork | undefined","resolved":"UtilityNetwork | undefined","references":{"default":{"location":"import","path":"@arcgis/core/networks/UtilityNetwork.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The utility network to validate.\n\nIf not provided, the component uses the first utility network stored in the map. When the map contains multiple\nutility networks and the selector is visible, the user can change this value from the component UI.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The target [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/).\n\nThe component only supports 2D map views.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkValidateNetworkTopology = document.createElement(\"arcgis-utility-network-validate-network-topology\");\ndocument.body.append(arcgisUtilityNetworkValidateNetworkTopology);\nawait arcgisUtilityNetworkValidateNetworkTopology.componentOnReady();\nconsole.log(\"arcgis-utility-network-validate-network-topology is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisValidateNetworkTopologyEnd","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires after a validation workflow ends.\n\nThis event fires after validation succeeds, fails, or is canceled by preventing the\n[@arcgisValidateNetworkTopologyStart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#event-arcgisValidateNetworkTopologyStart) event.","docsTags":[]},{"event":"arcgisValidateNetworkTopologyStart","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires before the validation request is sent.\n\nThis event can be prevented with `event.preventDefault()` to cancel validation.","docsTags":[{"name":"example","text":"```js\nconst validateNetworkTopologyElement = document.querySelector(\"arcgis-utility-network-validate-network-topology\");\nvalidateNetworkTopologyElement.addEventListener(\"arcgisValidateNetworkTopologyStart\", (event) => {\n event.preventDefault();\n});\n```"}]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/utility-network-validate-topology/utility-network-validate-topology.tsx","tag":"arcgis-utility-network-validate-topology","overview":"","readme":"","usage":{},"docs":"> This component is **deprecated**. [arcgis-utility-network-validate-network-topology](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/) is the preferred component for validating utility network topology and should be used for all new development.\n\nThe UtilityNetworkValidateTopology component simplifies the process of validating a DirtyArea within a utility network. It offers an intuitive user interface.\n\n> The UtilityNetworkValidateTopology Component does not support proxied feature services or feature services that utilize stored credentials.","docsTags":[{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"deprecation":"since 5.1, use [arcgis-utility-network-validate-network-topology](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/) instead.","props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-topology/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"extentToValidate","type":"UtilityNetworkValidateTopologyExtentOption","complexType":{"original":"UtilityNetworkValidateTopologyExtentOption","resolved":"UtilityNetworkValidateTopologyExtentOption","references":{"UtilityNetworkValidateTopologyExtentOption":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkValidateTopology.js","id":"notImplemented"}}},"mutable":true,"attr":"extent-to-validate","reflectToAttr":false,"docs":"Specifies the extent of the validation.","docsTags":[],"default":"\"current\"","values":[{"type":"string","value":"current"},{"type":"string","value":"entire"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"4.27"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"check-circle\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"4.11"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"UtilityNetworkValidateTopologyViewModelState","complexType":{"original":"UtilityNetworkValidateTopologyViewModelState","resolved":"UtilityNetworkValidateTopologyViewModelState","references":{"UtilityNetworkValidateTopologyViewModelState":{"location":"import","path":"@arcgis/core/widgets/UtilityNetworkValidateTopology/UtilityNetworkValidateTopologyViewModel.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"since","text":"4.27"},{"name":"readonly","text":""}],"default":"\"ready\"","values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"success"},{"type":"string","value":"failed"},{"type":"string","value":"executing"}],"optional":true,"required":false},{"name":"utilityNetwork","type":"UtilityNetwork | null | undefined","complexType":{"original":"UtilityNetwork | null | undefined","resolved":"UtilityNetwork | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/networks/UtilityNetwork.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Determines the utility network to use.","docsTags":[{"name":"since","text":"4.27"}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-utility-network-validate-topology component will be associated with a map or scene component rather than using the `view` property.","docsTags":[{"name":"since","text":"4.27"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisUtilityNetworkValidateTopology = document.createElement(\"arcgis-utility-network-validate-topology\");\ndocument.body.append(arcgisUtilityNetworkValidateTopology);\nawait arcgisUtilityNetworkValidateTopology.componentOnReady();\nconsole.log(\"arcgis-utility-network-validate-topology is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/value-picker/value-picker.tsx","tag":"arcgis-value-picker","overview":"","readme":"","usage":{},"docs":"The Value Picker component allows users to step or play through an iterable set of data. The component alone acts as a shell, consisting\nof a play/pause button, a next button, a previous button, and a slot for adding a component to Value Picker. Value Picker is not associated with a\n[View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) nor does it require that the dataset adheres to a specific structure\nfor it to function. The [arcgis-value-picker-label](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-label/), [arcgis-value-picker-slider](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/),\n[arcgis-value-picker-combobox](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-combobox/), and [arcgis-value-picker-collection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-collection/) components provide the user with a few different options\nfor placing their data into a Value Picker with minimal configuration. Value Picker handles the different shapes of these components automatically by asserting\nthat all slotted components will extend the\n[ArcgisValuePickerSubcomponent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/types/#ArcgisValuePickerSubcomponent)\ninterface, which allows Value picker to send and receive generic sets of instructions that are interpreted by the slotted component.\n\n### Configuring Value Picker\n\n#### Configuring Value Picker without slotted components\n\n![value-picker-nodata](https://developers.arcgis.com/javascript/latest/assets/references/components/value-picker/value-picker-nodata.avif)\n\n```html\n\n \n\n```\n\nIf a user wishes to use Value Picker with a component or dataset that can't be accurately represented by the slottable components, the component may be placed\nadjacent to the empty Value Picker, and events fired by Value Picker can be used to orchestrate the behavior of the adjacent component.\nFor example, when the user clicks the play button, Value Picker will emit [@arcgisAnimate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#event-arcgisAnimate) each time\n[playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#playRate) ms have elapsed since the button was clicked, which the user could listen to and iterate the index of\ntheir dataset on an interval as a result.\n\n```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst basemapGallery = document.querySelector(\"arcgis-basemap-gallery\");\n\nconst basemaps = new Collection([\n Basemap.fromId(\"topo-vector\"),\n Basemap.fromId(\"hybrid\"),\n Basemap.fromId(\"streets\"),\n Basemap.fromId(\"satellite\"),\n Basemap.fromId(\"oceans\"),\n]);\n\nbasemapGallery.source = new LocalBasemapsSource({ basemaps });\nbasemapGallery.activeBasemap = basemaps.getItemAt(0);\n\nvaluePicker.addEventListener(\"arcgisAnimate\", () => {\n const currentIndex = basemaps.indexOf(basemapGallery.activeBasemap);\n basemapGallery.activeBasemap = basemaps.getItemAt(currentIndex + 1);\n});\n```\n\n#### Configuring Value Picker with slotted components\n\nA single component may be placed into the Value Picker slot by placing one element inside of the other:\n\n```html\n\n \n\n```\n\n#### 1. Using a label component to step through a list of items\n\nConsider using the [arcgis-value-picker-label](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-label/) component to step through a small, fixed list of predefined values. This component provides a strict\ninterface that steps back and forth, so it's a good option for temporal data, or data that shows progression dependent on the element's position in the list.\n\n![value-picker-label](https://developers.arcgis.com/javascript/latest/assets/references/components/value-picker/value-picker-label.avif)\n\n```js\nconst mapElement = document.querySelector(\"arcgis-map\");\nconst valuePickerLabel = document.querySelector(\"arcgis-value-picker-label\");\n\nconst labelItems = [\n { value: \"2017\", label: \"Tree cover in 2017\" },\n { value: \"2018\", label: \"Tree cover in 2018\" },\n { value: \"2019\", label: \"Tree cover in 2019\" },\n { value: \"2020\", label: \"Tree cover in 2020\" },\n { value: \"2021\", label: \"Tree cover in 2021\" }\n];\n\nvaluePickerLabel.items = labelItems;\n\nvaluePickerLabel.currentValue = labelItems[0];\n```\n\nThe user's interaction can be handled by monitoring the [arcgis-value-picker-label.currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-label/#currentValue) property.\n\n```js\nvaluePickerLabel.addEventListener(\"arcgisPropertyChange\", () => {\n const year = Number(valuePickerLabel.currentValue.value);\n mapElement.view.timeExtent = {\n start: new Date(year, 0, 1),\n end: new Date(year + 1, 0, 1),\n };\n console.log(\"The current year is: \", valuePickerLabel.currentValue.value);\n});\n```\n\n#### 2. Using a slider component to traverse a list of items\n\nConsider using the [arcgis-value-picker-slider](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/) component to quickly traverse through a set of data\nthat can be represented along a fixed numeric range. This is a good option for sets of elements spaced along an interval, or mutating\na continuous parameter such as layer opacity.\n\n![value-picker-slider](https://developers.arcgis.com/javascript/latest/assets/references/components/value-picker/value-picker-slider.avif)\n\n```js\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\n\nvaluePickerSlider.steps = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100];\nvaluePickerSlider.labels = [0, 20, 40, 60, 80, 100];\nvaluePickerSlider.majorTicks = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100];\nvaluePickerSlider.minorTicks = [5, 15, 25, 35, 45, 55, 65, 75, 85, 95];\nvaluePickerSlider.currentValue = 100;\nvaluePickerSlider.labelFormatter = (value) => `${value}%`;\n```\n\nThe user's interaction can be handled by monitoring the [arcgis-value-picker-slider.currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#currentValue) property.\n\n```js\nvaluePickerSlider.addEventListener(\"arcgisPropertyChange\", () => {\n layer.opacity = valuePickerSlider.currentValue / 100;\n console.log(\"The current layer opacity is: \", valuePickerSlider.currentValue / 100);\n});\n```\n\nNote that [arcgis-value-picker-slider.labels](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#labels), [arcgis-value-picker-slider.majorTicks](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#majorTicks), and [arcgis-value-picker-slider.minorTicks](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#minorTicks)\nare all independent of each other and optional.\n\n#### 3. Using a combobox component to select from a list of items\n\nConsider using the [arcgis-value-picker-combobox](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-combobox/) component to step through a longer list of items that cannot be clicked through\none by one. The combobox component allows the user to open the list as a dropdown and make a selection, or narrow the size of the list by searching for an element or keyword.\n\n![value-picker-combobox](https://developers.arcgis.com/javascript/latest/assets/references/components/value-picker/value-picker-combobox.avif)\n\n```js\nconst valuePickerCombobox = document.querySelector(\"arcgis-value-picker-combobox\");\n\nconst comboboxItems = [\n { value: \"Bare\", label: \"Isolate Bare Ground Areas\" },\n { value: \"Built\", label: \"Isolate Built Areas\" },\n { value: \"Trees\", label: \"Isolate Trees\" },\n { value: \"Water\", label: \"Isolate Water Areas\" },\n { value: \"Crops\", label: \"Isolate Crop Areas\" },\n];\n\nvaluePickerCombobox.items = comboboxItems;\n\nvaluePickerCombobox.currentValue = comboboxItems[0];\n```\n\nThe user's interaction can be handled by monitoring the [arcgis-value-picker-combobox.currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-combobox/#currentValue) property.\n\n```js\nvaluePickerCombobox.addEventListener(\"arcgisPropertyChange\", () => {\n layer.rasterFunction = {\n functionName: valuePickerCombobox.currentValue.value,\n };\n console.log(\"The current land cover category is: \", valuePickerCombobox.currentValue.value);\n});\n```\n\n#### 4. Using a collection component to step through an arbitrary set of data\n\nConsider using the [arcgis-value-picker-collection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-collection/) component when a visual representation for the dataset is not necessary.\nThis is also a good option for datasets already in the form of a [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/).\n\n![value-picker-collection](https://developers.arcgis.com/javascript/latest/assets/references/components/value-picker/value-picker-collection.avif)\n\n```js\nconst Collection = (await import(\"@arcgis/core/core/Collection.js\")).default;\n\nconst mapElement = document.querySelector(\"arcgis-map\");\nconst valuePickerCollection = document.querySelector(\"arcgis-value-picker-collection\");\n\nconst basemapCollection = new Collection([\"topo-vector\", \"streets\", \"osm\"]);\n\nvaluePickerCollection.items = basemapCollection;\n\nvaluePickerCollection.currentValue = \"topo-vector\";\n```\n\nThe user's interaction can be handled by monitoring the [arcgis-value-picker-collection.currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-collection/#currentValue) property.\n\n```js\nvaluePickerCollection.addEventListener(\"arcgisPropertyChange\", () => {\n mapElement.basemap = valuePickerCollection.currentValue;\n console.log(\"The current basemap is: \", valuePickerCollection.currentValue);\n});\n```","docsTags":[{"name":"internal"},{"name":"since","text":"5.1"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"caption","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"caption","reflectToAttr":false,"docs":"An optional caption that renders under the Value Picker component to give context for the user. This is particularly\nuseful when an application is using more than one Value Picker instance.","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When true, the component is visually withdrawn and cannot be interacted with. If the slotted component also has a `disabled` property,\nit will be kept in sync with this property.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideNextButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-next-button","reflectToAttr":false,"docs":"When set to `true`, the next button is not displayed.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePlayButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-play-button","reflectToAttr":false,"docs":"When set to `true`, the play/pause button is not displayed.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePreviousButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-previous-button","reflectToAttr":false,"docs":"When set to `true`, the previous button is not displayed.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"list-rectangle\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"layout","type":"Layout","complexType":{"original":"Layout","resolved":"Layout","references":{"Layout":{"location":"local","path":"components/arcgis-value-picker/types","id":"notImplemented"}}},"mutable":true,"attr":"layout","reflectToAttr":true,"docs":"Indicates the axis that the Value Picker buttons should be oriented along.\n\nHorizontal layouts are best for wider components that don't require a lot of vertical space,\nor components that iterate from left to right over a dataset. Some examples of these are\nhorizontal sliders, collapsable dropdowns, or label components.\n\nVertical layouts are best for taller components or components that should iterate vertically.\nSome examples include vertical sliders or list components that require a larger space to allow the user to scroll through the list.","docsTags":[],"default":"\"horizontal\"","values":[{"type":"string","value":"horizontal"},{"type":"string","value":"vertical"}],"optional":true,"required":false},{"name":"loop","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loop","reflectToAttr":false,"docs":"When set to `true`, playback will restart from the first element of the slotted component's dataset\nonce it reaches the end. Note that this will not allow the Value Picker buttons to be used to manually loop back to the first element.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"playRate","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"play-rate","reflectToAttr":false,"docs":"Specifies the interval, in milliseconds, on which the component will call `step(\"next\")` on the slotted component.","docsTags":[],"default":"1000","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"\"playing\" | \"ready\"","complexType":{"original":"\"playing\" | \"ready\"","resolved":"\"playing\" | \"ready\"","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"playing"},{"type":"string","value":"ready"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisValuePicker = document.createElement(\"arcgis-value-picker\");\ndocument.body.append(arcgisValuePicker);\nawait arcgisValuePicker.componentOnReady();\nconsole.log(\"arcgis-value-picker is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"next","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"next(): void","parameters":[],"docs":"Selects the next index from the slotted component's dataset.","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\n\nvaluePickerSlider.steps = [1, 2, 3, 4, 5];\nvaluePickerSlider.currentValue = 1;\n\nconsole.log(`Current value: ${valuePickerSlider.currentValue}`); // \"Current value: 1\"\nvaluePicker.next();\nconsole.log(`Current value: ${valuePickerSlider.currentValue}`); // \"Current value: 2\"\n```"}]},{"name":"pause","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"pause(): void","parameters":[],"docs":"Stops the component from playing.","docsTags":[]},{"name":"play","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"play(): void","parameters":[],"docs":"Start playing. Value Picker will call `step(\"next\")` on the slotted component at an interval defined by [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#playRate).","docsTags":[{"name":"example","text":"```js\n// Start a continuously looping ValuePicker.\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\n\nvaluePickerSlider.steps = [1, 2, 3];\nvaluePickerSlider.currentValue = 1;\nvaluePicker.loop = true;\n\nvaluePickerSlider.addEventListener(\"arcgisPropertyChange\", () => {\n console.log(valuePickerSlider.currentValue);\n});\n\nvaluePicker.play();\n// output: 1, 2, 3, 1, 2, 3, 1...\n```"}]},{"name":"previous","returns":{"type":"void","docs":""},"complexType":{"signature":"(): void","parameters":[],"return":"void","references":{}},"signature":"previous(): void","parameters":[],"docs":"Selects the previous index from the slotted component's dataset.","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\n\nvaluePickerSlider.steps = [1, 2, 3, 4, 5];\nvaluePickerSlider.currentValue = 3;\n\nconsole.log(`Current value: ${valuePickerSlider.currentValue}`); // \"Current value: 3\"\nvaluePicker.previous();\nconsole.log(`Current value: ${valuePickerSlider.currentValue}`); // \"Current value: 2\"\n```"}]}],"events":[{"event":"arcgisAnimate","detail":"AnimateEvent","bubbles":true,"complexType":{"original":"AnimateEvent","resolved":"AnimateEvent","references":{"AnimateEvent":{"location":"local","path":"components/arcgis-value-picker/types","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires on each playback tick after the user presses the play button. The event payload contains `{ first: boolean }` and fires for\nthe first time after [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#playRate) ms have elapsed since the user pressed the play button. Users should\nlisten to this event to manually iterate an external dataset on an interval.","docsTags":[]},{"event":"arcgisNext","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the Value Picker's next button is pressed or when the [next()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#next) method is invoked.","docsTags":[]},{"event":"arcgisPause","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the Value Picker's pause button is pressed or when the [pause()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#pause) method is invoked.","docsTags":[]},{"event":"arcgisPlay","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the Value Picker's play button is pressed or when the [play()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#play) method is invoked.","docsTags":[]},{"event":"arcgisPrevious","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Fires when the Value Picker's previous button is pressed or when the [previous()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#previous) method is invoked.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"layout\" | \"loop\" | \"playRate\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"layout\" | \"loop\" | \"playRate\" | \"state\"; }","resolved":"{ name: \"layout\" | \"loop\" | \"playRate\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisSlottedElementChange","detail":"{ slottedElement: ArcgisValuePickerSubcomponent | undefined; }","bubbles":true,"complexType":{"original":"{ slottedElement: ArcgisValuePickerSubcomponent | undefined; }","resolved":"{ slottedElement: ArcgisValuePickerSubcomponent | undefined; }","references":{"ArcgisValuePickerSubcomponent":{"location":"local","path":"components/arcgis-value-picker/types","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the contents of Value Picker's slot changes.","docsTags":[]}],"styles":[],"slots":[{"name":"","docs":"Default slot for adding a component to value-picker. User is responsible for positioning the content via CSS."}],"parts":[],"listeners":[]},{"filePath":"src/components/value-picker/value-picker-collection/value-picker-collection.tsx","tag":"arcgis-value-picker-collection","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-collection/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canNext","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-next","reflectToAttr":false,"docs":"Determines whether the user can interact with the next button.\nThis property is automatically set to `false` when [currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-collection/#currentValue) matches the last index of\n[items](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-collection/#items).","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerCollection = document.querySelector(\"arcgis-value-picker-collection\");\n\nconst collection = new Collection([\n { name: \"Isaac Newton\", dob: new Date(1643, 0, 4)},\n { name: \"Albert Einstein\", dob: new Date(1879, 2, 14)},\n { name: \"Ernest Rutherford\", dob: new Date(1871, 7, 20)}\n]);\nvaluePickerCollection.items = collection;\nvaluePickerCollection.currentValue = valuePickerCollection.items.at(0);\nif (valuePickerCollection.canNext === true) {\n valuePicker.next();\n console.log(valuePickerCollection.currentValue.name); // \"Albert Einstein\"\n}\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPlay","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-play","reflectToAttr":false,"docs":"Determines whether the user can interact with the play/pause button.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPrevious","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-previous","reflectToAttr":false,"docs":"Determines whether the user can interact with the previous button.\nThis property is automatically set to `false` when [currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-collection/#currentValue) matches the first index of\n[items](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-collection/#items).","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerCollection = document.querySelector(\"arcgis-value-picker-collection\");\n\nconst collection = new Collection([\n { name: \"Isaac Newton\", dob: new Date(1643, 0, 4)},\n { name: \"Albert Einstein\", dob: new Date(1879, 2, 14)},\n { name: \"Ernest Rutherford\", dob: new Date(1871, 7, 20)}\n]);\nvaluePickerCollection.items = collection;\nvaluePickerCollection.currentValue = valuePickerCollection.items.at(1);\nif (valuePickerCollection.canPrevious === true) {\n valuePicker.previous();\n console.log(valuePickerCollection.currentValue.name); // \"Isaac Newton\"\n}\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"currentValue","type":"unknown | undefined","complexType":{"original":"unknown | undefined","resolved":"unknown | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The currently selected collection item. Note that because the type of [items](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-collection/#items) is a\n[Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of any shape, this component\nidentifies `currentValue` by reference rather than matching a field that may not always be present. Ensure that `currentValue` is always\nassigned from an existing element within `items`.","docsTags":[{"name":"example","text":"```js\nconst valuePickerCollection = document.querySelector(\"arcgis-value-picker-collection\");\n\nconst collection = new Collection([\n { name: \"Isaac Newton\", dob: new Date(1643, 0, 4)},\n { name: \"Albert Einstein\", dob: new Date(1879, 2, 14)},\n { name: \"Ernest Rutherford\", dob: new Date(1871, 7, 20)}\n]);\nvaluePickerCollection.items = collection;\n\n// 3 different approaches to setting currentValue\n\n// Acceptable. currentValue is a reference to items\nvaluePickerCollection.currentValue = valuePickerCollection.items.at(0);\n\n// Acceptable. currentValue is assigned to the element at the index of items returned by find()\nvaluePickerCollection.currentValue = valuePickerCollection.items.find(\n ({ name }) => name === \"Albert Einstein\"\n);\n\n// Invalid. The component has no mechanism to predict which field should be used to match this property to an index.\nvaluePickerCollection.currentValue = { name: \"Isaac Newton\", dob: new Date(1643, 0, 4) };\n```"}],"values":[],"optional":true,"required":false},{"name":"items","type":"Collection | undefined","complexType":{"original":"Collection | undefined","resolved":"Collection | undefined","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The collection of arbitrary items that [arcgis-value-picker](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/) can iterate over.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisValuePickerCollection = document.createElement(\"arcgis-value-picker-collection\");\ndocument.body.append(arcgisValuePickerCollection);\nawait arcgisValuePickerCollection.componentOnReady();\nconsole.log(\"arcgis-value-picker-collection is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","bubbles":true,"complexType":{"original":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","resolved":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/value-picker/value-picker-combobox/value-picker-combobox.tsx","tag":"arcgis-value-picker-combobox","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-combobox/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canNext","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-next","reflectToAttr":false,"docs":"Determines whether the user can interact with the next button.\nThis property is automatically set to `false` when [currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-combobox/#currentValue) matches the last index of\n[items](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-combobox/#items).","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerCombobox = document.querySelector(\"arcgis-value-picker-combobox\");\n\nvaluePickerCombobox.items = [\n { value: \"ind\", label: \"Industrial\" },\n { value: \"res\", label: \"Residential\" },\n { value: \"com\", label: \"Commercial\" }\n];\nvaluePickerCombobox.currentValue = valuePickerCombobox.items[0];\nif (valuePickerCombobox.canNext === true) {\n valuePicker.next();\n console.log(valuePickerCombobox.currentValue.label); // \"Residential\"\n}\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPlay","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-play","reflectToAttr":false,"docs":"Determines whether the user can interact with the play/pause button.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPrevious","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-previous","reflectToAttr":false,"docs":"Determines whether the user can interact with the previous button.\nThis property is automatically set to `false` when [currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-combobox/#currentValue) matches the first index of\n[items](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-combobox/#items).","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerCombobox = document.querySelector(\"arcgis-value-picker-combobox\");\n\nvaluePickerCombobox.items = [\n { value: \"ind\", label: \"Industrial\" },\n { value: \"res\", label: \"Residential\" },\n { value: \"com\", label: \"Commercial\" }\n];\nvaluePickerCombobox.currentValue = valuePickerCombobox.items[1];\nif (valuePickerCombobox.canPrevious === true) {\n valuePicker.previous();\n console.log(valuePickerCombobox.currentValue.label); // \"Industrial\"\n}\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"currentValue","type":"ComboboxItem | undefined","complexType":{"original":"ComboboxItem | undefined","resolved":"ComboboxItem | undefined","references":{"ComboboxItem":{"location":"local","path":"components/arcgis-value-picker/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The currently selected combobox item rendered by the component.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When true, the component is visually withdrawn and cannot receive user interaction.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"items","type":"ComboboxItem[] | undefined","complexType":{"original":"ComboboxItem[] | undefined","resolved":"ComboboxItem[] | undefined","references":{"ComboboxItem":{"location":"local","path":"components/arcgis-value-picker/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The array of combobox items that [arcgis-value-picker](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/) can iterate over.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisValuePickerCombobox = document.createElement(\"arcgis-value-picker-combobox\");\ndocument.body.append(arcgisValuePickerCombobox);\nawait arcgisValuePickerCombobox.componentOnReady();\nconsole.log(\"arcgis-value-picker-combobox is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","bubbles":true,"complexType":{"original":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","resolved":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/value-picker/value-picker-label/value-picker-label.tsx","tag":"arcgis-value-picker-label","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-label/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canNext","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-next","reflectToAttr":false,"docs":"Determines whether the user can interact with the next button.\nThis property is automatically set to `false` when [currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-label/#currentValue) matches the last index of\n[items](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-label/#items).","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerLabel = document.querySelector(\"arcgis-value-picker-label\");\n\nvaluePickerLabel.items = [\n { value: \"90606\", label: \"Whittier, CA (90606)\" },\n { value: \"76001\", label: \"Arlington, TX (76001)\" },\n { value: \"92335\", label: \"Fontana, CA (92335)\" }\n];\nvaluePickerLabel.currentValue = valuePickerLabel.items[0];\nif (valuePickerLabel.canNext === true) {\n valuePicker.next();\n console.log(valuePickerLabel.currentValue.label); // \"Arlington, TX (76001)\"\n}\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPlay","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-play","reflectToAttr":false,"docs":"Determines whether the user can interact with the play/pause button.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPrevious","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-previous","reflectToAttr":false,"docs":"Determines whether the user can interact with the previous button.\nThis property is automatically set to `false` when [currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-label/#currentValue) matches the first index of\n[items](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-label/#items).","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerLabel = document.querySelector(\"arcgis-value-picker-label\");\n\nvaluePickerLabel.items = [\n { value: \"90606\", label: \"Whittier, CA (90606)\" },\n { value: \"76001\", label: \"Arlington, TX (76001)\" },\n { value: \"92335\", label: \"Fontana, CA (92335)\" }\n];\nvaluePickerLabel.currentValue = valuePickerLabel.items[1];\nif (valuePickerLabel.canPrevious === true) {\n valuePicker.previous();\n console.log(valuePickerLabel.currentValue.label); // \"Whittier, CA (90606)\"\n}\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"currentValue","type":"LabelItem | undefined","complexType":{"original":"LabelItem | undefined","resolved":"LabelItem | undefined","references":{"LabelItem":{"location":"local","path":"components/arcgis-value-picker/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The currently selected label item rendered by the component.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"items","type":"LabelItem[] | undefined","complexType":{"original":"LabelItem[] | undefined","resolved":"LabelItem[] | undefined","references":{"LabelItem":{"location":"local","path":"components/arcgis-value-picker/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The array of label items that [arcgis-value-picker](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/) can iterate over.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisValuePickerLabel = document.createElement(\"arcgis-value-picker-label\");\ndocument.body.append(arcgisValuePickerLabel);\nawait arcgisValuePickerLabel.componentOnReady();\nconsole.log(\"arcgis-value-picker-label is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","bubbles":true,"complexType":{"original":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","resolved":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/value-picker/value-picker-slider/value-picker-slider.tsx","tag":"arcgis-value-picker-slider","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canNext","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-next","reflectToAttr":false,"docs":"Determines whether the user can interact with the next button.\nThis property is automatically set to `false` when the index of [currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#currentValue) matches the last index of\n[steps](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#steps). Regardless of the [layout](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#layout) property's value, the slider thumb will\nmove in the direction that the next button is pointing. This means that when the slider is visually flipped\n(`layout` is `\"horizontal\"` and `mirrored` is `true`, or `layout` is `\"vertical\"` and `mirrored` is `false`), this property becomes `false`\nwhen `currentValue` is equal to the first index of `steps` rather than the last.","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\n\nvaluePickerSlider.steps = [1, 2, 3];\nvaluePickerSlider.currentValue = 3;\n\nif (valuePickerSlider.canNext) {\n valuePicker.next();\n} else {\n console.log(\"Cannot step forward.\"); // this line will execute\n}\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPlay","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-play","reflectToAttr":false,"docs":"Determines whether the user can interact with the play/pause button.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPrevious","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"can-previous","reflectToAttr":false,"docs":"Determines whether the user can interact with the previous button.\nThis property is automatically set to `false` when the index of [currentValue](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#currentValue) matches the first index of\n[steps](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#steps). Regardless of the [layout](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#layout) property's value, the slider thumb will\nmove in the direction that the previous button is pointing. This means that when the slider is visually flipped\n(`layout` is `\"horizontal\"` and `mirrored` is `true`, or `layout` is `\"vertical\"` and `mirrored` is `false`), this property becomes `false`\nwhen `currentValue` is equal to the last index of `steps` rather than the first.","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker\");\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\n\n// `steps` will be rendered on a vertical track where \"3\" is the topmost value.\n// The previous button (pointing upwards) will fail to increment the index of `steps` by 1.\n\nvaluePickerSlider.steps = [1, 2, 3];\nvaluePickerSlider.currentValue = 1;\nvaluePickerSlider.mirrored = false;\nvaluePicker.layout = \"vertical\";\n\nif (valuePickerSlider.canPrevious) {\n valuePicker.previous(); // this line will execute\n} else {\n console.log(\"Cannot step upward.\");\n}\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"currentValue","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"current-value","reflectToAttr":false,"docs":"The value of the currently selected index in the slider's [steps](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#steps). If this property is not assigned by the\nuser, it will default to the last index of `steps`.","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"disabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"disabled","reflectToAttr":false,"docs":"When set to `true`, the user may not interact with the slider.\nNote that if the ValuePicker's [arcgis-value-picker.disabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#disabled) property is mutated, this property will update to match it.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"labelFormatter","type":"(value: number, defaultFormatter: (value: number) => string) => string | null | undefined","complexType":{"original":"(value: number, defaultFormatter: (value: number) => string) => string | null | undefined","resolved":"(value: number, defaultFormatter: (value: number) => string) => string | null | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"A function used to format labels. Overrides the default label formatter.","docsTags":[{"name":"example","text":"```js\n// Display a label at every step formatted as a percentage.\n\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\nvaluePickerSlider.steps = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100];\nvaluePickerSlider.labels = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100];\nvaluePickerSlider.labelFormatter = (value) => `${value}%`;\n```"}],"values":[],"optional":true,"required":false},{"name":"labels","type":"number[] | undefined","complexType":{"original":"number[] | undefined","resolved":"number[] | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Determines where along the slider track labels should be placed. Labels will be formatted by the [labelFormatter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#labelFormatter) property.","docsTags":[{"name":"example","text":"```js\n// Display a label at every other step\n\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\nvaluePickerSlider.steps = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100];\nvaluePickerSlider.labels = [0, 20, 40, 60, 80, 100];\n```"}],"values":[],"optional":true,"required":false},{"name":"layout","type":"Layout | undefined","complexType":{"original":"Layout | undefined","resolved":"Layout | undefined","references":{"Layout":{"location":"local","path":"components/arcgis-value-picker/types","id":"notImplemented"}}},"mutable":true,"attr":"layout","reflectToAttr":true,"docs":"Determines whether the slider should be oriented horizontally or vertically. Note that if [arcgis-value-picker.layout](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#layout) on the Value Picker component\nis mutated, this property will update to match it. The UI will behave as if the indices of [steps](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#steps) will ascend left to right, or bottom\nto top on a horizontal or vertical layout, respectively. If you wish for the slider to be visually mirrored, set the [mirrored](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#mirrored)\nproperty to true. This will also make the 'next' button responsible for stepping backwards to the previous index of `steps`, and\n'previous' responsible for advancing to the next index of `steps`.","docsTags":[{"name":"example","text":"```js\n// Display a vertical slider with `steps` ascending bottom to top. In this instance, the 'next'\n// button (pointing downwards) will bring `currentValue` closer to 0 to match the slider's appearance.\n\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\nvaluePickerSlider.steps = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100];\nvaluePickerSlider.currentValue = 100;\nvaluePickerSlider.layout = \"vertical\";\n\n// Display a horizontal slider with `steps` ascending right to left. Since `mirrored` is true,\n// the slider will show `currentValue` decreasing from 100 to 0 as the 'next' button (pointing to the right) is pressed.\n\nconst valuePickerSlider = document.querySelector(\"arcgis-value-picker-slider\");\nvaluePickerSlider.steps = [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100];\nvaluePickerSlider.currentValue = 100;\nvaluePickerSlider.layout = \"horizontal\";\nvaluePickerSlider.mirrored = true;\n```"},{"name":"see","text":"[arcgis-value-picker.layout](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker/#layout)"}],"default":"\"horizontal\"","values":[{"type":"string","value":"horizontal"},{"type":"string","value":"vertical"}],"optional":true,"required":false},{"name":"majorTicks","type":"number[] | undefined","complexType":{"original":"number[] | undefined","resolved":"number[] | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Positions along the slider track rendered as long tick marks under the track.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"max","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"max","reflectToAttr":false,"docs":"The greatest possible value on the slider track. If this property is not set, it will be inferred from the last index of [steps](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#steps).","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"min","type":"number | undefined","complexType":{"original":"number | undefined","resolved":"number | undefined","references":{}},"mutable":true,"attr":"min","reflectToAttr":false,"docs":"The smallest possible value on the slider track. If this property is not set, it will be inferred from the first index of [steps](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#steps).","docsTags":[],"values":[{"type":"number"}],"optional":true,"required":false},{"name":"minorTicks","type":"number[] | undefined","complexType":{"original":"number[] | undefined","resolved":"number[] | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Positions along the slider track rendered as short tick marks under the track.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"mirrored","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"mirrored","reflectToAttr":false,"docs":"When `true`, the slider will display its [steps](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#steps) from right to left, or top to bottom,\ndepending on the value of [layout](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#layout). This inverts the direction of the slider.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"steps","type":"number[] | undefined","complexType":{"original":"number[] | undefined","resolved":"number[] | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Positions along the slider track between [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#min) and [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-slider/#max) that\nthe slider thumb will snap to when interacted with.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisValuePickerSlider = document.createElement(\"arcgis-value-picker-slider\");\ndocument.body.append(arcgisValuePickerSlider);\nawait arcgisValuePickerSlider.componentOnReady();\nconsole.log(\"arcgis-value-picker-slider is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","bubbles":true,"complexType":{"original":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","resolved":"{ name: \"canNext\" | \"canPlay\" | \"canPrevious\" | \"currentValue\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/value-picker-legacy/value-picker-legacy.tsx","tag":"arcgis-value-picker-legacy","overview":"","readme":"","usage":{},"docs":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nValue Picker is a component that allows users to step or play through a list of values. Value Picker component can be configured\nwith an optional [collection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#from-collection),\n[label](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#from-labels),\n[combobox](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#selectable-items) or\n[slider](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#numeric-values)\ncontrol to help users navigate values.\n\nSimilar to a media player, values can be interactively stepped through using the `next` and `previous` buttons.\nValue Picker can also be set to automatically progress (play) through an ordered\nlist of items at a [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#playRate).\n\n### Configuring Value Picker\n\nValue Picker can be configured in variety of ways, depending on your use case.\nThe following are the five possible configurations of the Value Picker component.\n\n\n#### 1. Configuring Value Picker without data\n\nIt is important to note that the Value Picker component is not associated with a [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) nor does it\nnecessarily require data.\n\n![option-nodata](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/valuepicker/option-nodata.avif)\n\n```html\n\n \n\n```\n\nSince the component is not associated with any data, it is necessary to listen and respond to component events generated by\nthe component. This could be useful when data is not static like positional changes for bus features currently in service, for example.\n\n```js\nvaluePicker.addEventListener(\"arcgisPlay\", () => { console.log(\"user clicks play\"); });\nvaluePicker.addEventListener(\"arcgisPause\", () => { console.log(\"user clicks pause\"); });\nvaluePicker.addEventListener(\"arcgisPrevious\", () => { console.log(\"user clicks previous\"); });\nvaluePicker.addEventListener(\"arcgisNext\", () => { console.log(\"user clicks next\"); });\n```\n\n\n#### 2. Using the label component to present items\n\nConsider using the [label component](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerLabel/) to step through a fixed list of predefined values like land use zones.\nIn the following snippet a Value Picker component is created containing three coded land use zones.\n\n![option-labels](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/valuepicker/option-labels.avif)\n\n```js\nconst ValuePickerLabel = (await import(\"@arcgis/core/widgets/ValuePicker/ValuePickerLabel.js\")).default;\n\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nconst labelItems = [\n { value: \"ind\", label: \"Industrial\" },\n { value: \"res\", label: \"Residential\" },\n { value: \"com\", label: \"Commercial\" }\n];\n\nvaluePicker.component = new ValuePickerLabel({\n items: labelItems,\n});\n\nvaluePicker.values = [\"ind\"];\n```\n\nThe user's interaction can be handled by monitoring the [values](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#values) property.\n\n```js\nvaluePicker.addEventListener(\"arcgisPropertyChange\", () => {\n console.log(\"The current land use zone is: \", valuePicker.values[0]);\n layer.rasterFunction = {\n functionName: valuePicker.values[0],\n };\n});\n```\n\n\n#### 3. Using an arbitrary collection component to present predefined list\n\nIt may be required to step through a fixed collection of items like [extents](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/),\n[bookmarks](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/), or\n[basemaps](https://developers.arcgis.com/javascript/latest/references/core/Basemap/). If only the `play`,\n`next` and `previous` buttons are required then the collection component may be used. The [collection component](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerCollection/)\nconsists of the same user interface as option 1 above with the distinction that the current item is accessible and\ntracked.\n\nIn the following example, a Value Picker component is created with a [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of three items. Value Picker is\ninitialized with starting value of \"topo-vector\". Since \"topo-vector\" is the first item in the collection, only the _next_\nbutton will be enabled.\n\n![option-collection](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/valuepicker/option-collection.avif)\n\n```js\nconst Collection = (await import(\"@arcgis/core/core/Collection.js\")).default;\nconst ValuePickerCollection = (await import(\"@arcgis/core/widgets/ValuePicker/ValuePickerCollection.js\")).default;\n\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nconst basemapCollection = new Collection([\"topo-vector\", \"streets\", \"osm\"]);\n\nvaluePicker.component = new ValuePickerCollection({\n collection: basemapCollection,\n});\n\nvaluePicker.values = [\"topo-vector\"];\n```\n\nAs the user clicks the _next_, _previous_, and _play_ buttons, the [values](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#values) property updates.\nHandle this by listening for the [@arcgisPropertyChange](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#event-arcgisPropertyChange)\nevent when the component’s [values](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#values)\nproperty changes, as shown below.\n\n```js\nvaluePicker.addEventListener(\"arcgisPropertyChange\", () => {\n console.log(\"The current basemap is: \", valuePicker.values[0]);\n mapElement.basemap = valuePicker.values[0];\n});\n```\n\n\n#### 4. Using the combobox component to present selectable items\n\nConsider using the [combobox component](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerCombobox/) when a searchable\ndropdown list is required. In the following snippet the Value Picker component is created containing three coded land use zones.\n\n![option-combobox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/valuepicker/option-combobox.avif)\n\n```js\nconst ValuePickerCombobox = (await import(\"@arcgis/core/widgets/ValuePicker/ValuePickerCombobox.js\")).default;\n\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nconst comboboxItems = [\n { value: \"ind\", label: \"Industrial\" },\n { value: \"res\", label: \"Residential\" },\n { value: \"com\", label: \"Commercial\" }\n];\n\nvaluePicker.component = new ValuePickerCombobox({\n placeholder: \"Pick Zoning Type\",\n items: comboboxItems,\n});\n\nvaluePicker.values = [\"res\"];\n```\n\nThe user's interaction can be handled by monitoring the [values](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#values) property.\n\n```js\nvaluePicker.addEventListener(\"arcgisPropertyChange\", () => {\n console.log(\"The current land use zone is: \", valuePicker.values[0]);\n layer.rasterFunction = {\n functionName: valuePicker.values[0],\n };\n});\n```\n\n\n#### 5. Using the slider component to navigate numeric values\n\nThe [slider component](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerSlider/),\nas the name suggests, appends a slider to end of the Value Picker component. The slider is ideal\nfor users that need to select a value within a fixed numeric range. For example, the snippet below presents a\nValue Picker with a slider for picking a layer's opacity. The starting value is 50%.\n\n![option-slider](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/valuepicker/option-slider.avif)\n\n```js\nconst ValuePickerSlider = (await import(\"@arcgis/core/widgets/ValuePicker/ValuePickerSlider.js\")).default;\n\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nvaluePicker.component = new ValuePickerSlider({\n min: 0,\n max: 10,\n steps: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10],\n minorTicks: [.5, 1.5, 2.5, 3.5, 4.5, 5.5, 6.5, 7.5, 8.5, 9.5],\n majorTicks: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10],\n labels: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10],\n});\n\nvaluePicker.values = [5];\n```\n\nNote that [steps](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerSlider/#steps) (positions the slider thumb snaps\nto), [minorTicks](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerSlider/#minorTicks),\n[majorTicks](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerSlider/#majorTicks) and\n[labels](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerSlider/#labels) are independent of each other and optional.\n\nThe following code will watch for changes and apply the user's modification to a feature layer.\n```js\nvaluePicker.addEventListener(\"arcgisPropertyChange\", () => {\n console.log(\"The current opacity is: \", valuePicker.values[0]);\n layer.opacity = valuePicker.values[0] / 100;\n});\n```\n\n\n### Value Picker Orientation\n\nBy default Value Picker is oriented horizontally. Value Picker (with the exception of combobox and label components) can be oriented\nvertically. The following snippet demonstrates how to orient a collection based Value Picker vertically.\n\n```js\nconst Collection = (await import(\"@arcgis/core/core/Collection.js\")).default;\nconst ValuePickerCollection = (await import(\"@arcgis/core/widgets/ValuePicker/ValuePickerCollection.js\")).default;\n\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nconst basemapCollection = new Collection([\"topo-vector\", \"streets\", \"osm\"]);\n\nvaluePicker.component = new ValuePickerCollection({\n layout: \"vertical\", // default is \"horizontal\"\n collection: basemapCollection,\n});\n\nvaluePickerBasemap.values = [\"topo-vector\"];\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[ValuePickerCollection](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerCollection/)"},{"name":"see","text":"[ValuePickerCombobox](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerCombobox/)"},{"name":"see","text":"[ValuePickerLabel](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerLabel/)"},{"name":"see","text":"[ValuePickerSlider](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerSlider/)"},{"name":"see","text":"[Slider](https://developers.arcgis.com/javascript/latest/references/core/widgets/Slider/)"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canNext","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Returns `true` if the Value Picker can be advanced to the next position.","docsTags":[{"name":"example","text":"```js\n// check if canNext is true before advancing.\nconst basemapCollection = new Collection([\"topo-vector\", \"streets\", \"osm\"]);\n\nvaluePicker.component = new ValuePickerCollection({\n collection: basemapCollection,\n});\n\nvaluePicker.values = [\"topo-vector\"];\n\nif (valuePicker.canNext) {\n valuePicker.next();\n} else {\n console.log(\"Already at the end of the collection. Please press the 'previous' button instead.\");\n}\n```"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPlay","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Returns `true` if the Value Picker can be played.","docsTags":[{"name":"example","text":"```js\n// Create a new Value Picker and then check canPlay before playing.\nconst basemapCollection = new Collection([\"topo-vector\", \"streets\", \"osm\"]);\n\nvaluePicker.component = new ValuePickerCollection({\n collection: basemapCollection,\n});\n\nvaluePicker.values = [\"topo-vector\"];\n\nif (valuePicker.canPlay) {\n valuePicker.play();\n} else {\n console.log(\"Cannot play this collection.\");\n}\n```"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"canPrevious","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Returns `true` if the Value Picker can moved to the previous item.","docsTags":[{"name":"example","text":"```js\n// Create a new Value Picker and then test if canPrevious is true before selecting the preceding item.\nconst basemapCollection = new Collection([\"topo-vector\", \"streets\", \"osm\"]);\n\nvaluePicker.component = new ValuePickerCollection({\n collection: basemapCollection,\n});\n\nvaluePicker.values = [\"topo-vector\"];\n\nif (valuePicker.canPrevious) {\n valuePicker.previous();\n} else {\n console.log(\"Already at the beginning of the collection. Please press the 'next' button instead.\");\n}\n```"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"caption","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"caption","reflectToAttr":false,"docs":"An optional caption that appears on the Value Picker component to give context for the user. This is particularly\nuseful when an application is using more than one Value Picker component.","docsTags":[{"name":"example","text":"```js\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nvaluePicker.component = new ValuePickerCombobox({\n items: [\n { value: \"Newton\", label: \"Newton\" },\n { value: \"Einstein\", label: \"Einstein\" }\n ],\n});\n\nvaluePicker.caption = \"Scientist\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"component","type":"ValuePickerComponent | null | undefined","complexType":{"original":"ValuePickerComponent | null | undefined","resolved":"ValuePickerComponent | null | undefined","references":{"ValuePickerComponent":{"location":"import","path":"@arcgis/core/widgets/ValuePicker.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"An optional component for presenting and managing data. This property can be assigned one of the following:\n[ValuePickerCollection](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerCollection/)\n[ValuePickerCombobox](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerCombobox/),\n[ValuePickerLabel](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerLabel/), or\n[ValuePickerSlider](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerSlider/).\n\nIf this property is not set then the play, next and previous buttons will always be enabled. In this case, listen to the\ncomponent events, for example, [@arcgisPrevious](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#event-arcgisPrevious) and\n[@arcgisNext](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#event-arcgisNext), when the user interacts with the\ncomponent.","docsTags":[{"name":"example","text":"```js\n// Add a Value Picker with a slider ranging from 0 to 10.\nconst steps = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];\n\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nvaluePicker.component = new ValuePickerSlider({\n min: 0,\n max: 10,\n steps,\n labels: steps,\n labelFormatFunction: (value) => value + \" km\",\n});\n\nvaluePicker.values = [0];\n```"}],"values":[],"optional":true,"required":false},{"name":"hideNextButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-next-button","reflectToAttr":false,"docs":"When set to `false`, the next button (or up button when vertical) is not displayed.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePlayButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-play-button","reflectToAttr":false,"docs":"When set to `false`, the play/pause button is not displayed.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePreviousButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-previous-button","reflectToAttr":false,"docs":"When set to `false`, the previous button (or down button when vertical) is not displayed.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"IconName","complexType":{"original":"IconName","resolved":"IconName","references":{"IconName":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"since","text":"5.0"},{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"list-rectangle\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | null | undefined","complexType":{"original":"string | null | undefined","resolved":"string | null | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layout","type":"Layout","complexType":{"original":"Layout","resolved":"Layout","references":{"Layout":{"location":"import","path":"@arcgis/core/widgets/ValuePicker/types.js","id":"notImplemented"}}},"mutable":true,"attr":"layout","reflectToAttr":false,"docs":"Indicates if the component should be orientated horizontally (default) or vertically.\n\nPlease note that [ValuePickerCombobox](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerCombobox/) and\n[ValuePickerLabel](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerLabel/) do not support vertical layout.","docsTags":[{"name":"example","text":"```js\n// Display a Value Picker vertically with a slider component.\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nvaluePicker.component = new ValuePickerSlider({\n min: 0,\n max: 10,\n});\n\nvaluePicker.values = [0];\nvaluePicker.layout = \"vertical\";\n```"}],"default":"\"horizontal\"","values":[{"type":"string","value":"horizontal"},{"type":"string","value":"vertical"}],"optional":true,"required":false},{"name":"loop","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loop","reflectToAttr":false,"docs":"If true, playback will restart when it reaches the end.","docsTags":[{"name":"example","text":"```js\n// Add a ValuePicker with looping enabled and start playing.\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nvaluePicker.component = new ValuePickerSlider({\n min: 0,\n max: 10,\n});\n\nvaluePicker.values = [0];\nvaluePicker.loop = true;\n\nvaluePicker.play();\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"playRate","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"play-rate","reflectToAttr":false,"docs":"The pause, in milliseconds between playback advancement.","docsTags":[{"name":"example","text":"```js\n// Add a playing Value Picker that only passes 100 milliseconds at each step.\n// The slider's thumb will start at 0 and move to 10 in exactly one second.\nconst steps = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];\n\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nvaluePicker.component = new ValuePickerSlider({\n min: 0,\n max: 10,\n steps,\n});\n\nvaluePicker.values = [0];\nvaluePicker.playRate = 100;\n\nvaluePicker.play();\n```"}],"default":"1000","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"values","type":"[any] | null | undefined","complexType":{"original":"[any] | null | undefined","resolved":"[any] | null | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"The current values of the Value Picker component. The type for this property depends on which [component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#component) is being used. For example, a\n[slider](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerSlider/) component will return an array of numbers.\n\nIf the `component` is not set then this property will return `null`. Similarly this property can be `null`\nif the component is created without an initial value.\n\nOnce a `component` and an initial value has been assigned this property will return an array\ncontaining a value.","docsTags":[{"name":"see","text":"[ValuePickerCollection#collection](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerCollection/#collection)"},{"name":"see","text":"[ValuePickerCombobox#items](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerCombobox/#items)"},{"name":"see","text":"[ValuePickerLabel#items](https://developers.arcgis.com/javascript/latest/references/core/widgets/ValuePicker/ValuePickerLabel/#items)"},{"name":"example","text":"```js\nconst basemapCollection = new Collection([\"topo-vector\", \"streets\", \"osm\"]);\n\nvaluePickerBasemap.component = new ValuePickerCollection({\n collection: basemapCollection,\n});\n\nvaluePickerBasemap.values = [\"topo-vector\"];\n\nvaluePickerLandCover.addEventListener(\"arcgisPropertyChange\", () => {\n if (valuePickerLandCover.values?.[0]) {\n layer.rasterFunction = {\n functionName: valuePickerLandCover.values[0],\n };\n }\n});\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisValuePickerLegacy = document.createElement(\"arcgis-value-picker-legacy\");\ndocument.body.append(arcgisValuePickerLegacy);\nawait arcgisValuePickerLegacy.componentOnReady();\nconsole.log(\"arcgis-value-picker-legacy is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"next","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"next(): Promise","parameters":[],"docs":"Select the next value or advance to next.","docsTags":[{"name":"example","text":"```js\n// Create a Value Picker with a slider component.\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nvaluePicker.component = new ValuePickerSlider({\n min: 0,\n max: 3,\n steps: [0, 1, 2, 3],\n labels: [0, 1, 2, 3]\n});\n\nvaluePicker.values = [0];\nconsole.log(\"Current value:\", valuePicker.values[0]); // \"Current value: 0\"\n\nvaluePicker.next();\nconsole.log(\"Current value:\", valuePicker.values[0]); // \"Current value: 1\"\n```"}]},{"name":"pause","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"pause(): Promise","parameters":[],"docs":"Pause playing.","docsTags":[]},{"name":"play","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"play(): Promise","parameters":[],"docs":"Start playing. Value Picker will advance at the rate specified by [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#playRate).","docsTags":[{"name":"example","text":"```js\n// Add a playing Value Picker widget that is continuously looping.\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nvaluePicker.component = new ValuePickerSlider({\n min: 0,\n max: 3,\n steps: [0, 1, 2, 3],\n labels: [0, 1, 2, 3]\n});\n\nvaluePicker.loop = true;\nvaluePicker.values = [0];\n\nvaluePicker.addEventListener(\"arcgisPropertyChange\", () => {\n console.log(\"Current value:\", valuePicker.values[0]);\n});\n\nvaluePicker.play();\n// output: 1, 2, 3, 0, 1, 2, 3, 0...\n```"}]},{"name":"previous","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"previous(): Promise","parameters":[],"docs":"Select the previous value.","docsTags":[{"name":"example","text":"```js\n// Create a Value Picker with a slider component.\nconst valuePicker = document.querySelector(\"arcgis-value-picker-legacy\");\n\nvaluePicker.component = new ValuePickerSlider({\n min: 0,\n max: 3,\n steps: [0, 1, 2, 3],\n labels: [0, 1, 2, 3]\n});\n\nvaluePicker.values = [3];\nconsole.log(\"Current value:\", valuePicker.values[0]); // \"Current value: 3\"\n\nvaluePicker.previous();\nconsole.log(\"Current value:\", valuePicker.values[0]); // \"Current value: 2\"\n```"}]}],"events":[{"event":"arcgisAnimate","detail":"AnimateEvent","bubbles":true,"complexType":{"original":"AnimateEvent","resolved":"AnimateEvent","references":{"AnimateEvent":{"location":"import","path":"@arcgis/core/widgets/ValuePicker/types.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the Value Picker is playing at a rate defined by [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-value-picker-legacy/#playRate).","docsTags":[]},{"event":"arcgisNext","detail":"ValuePickerEvents[\"next\"]","bubbles":true,"complexType":{"original":"ValuePickerEvents[\"next\"]","resolved":"ValuePickerEvents[\"next\"]","references":{"ValuePickerEvents":{"location":"import","path":"@arcgis/core/widgets/ValuePicker.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the Value Picker's next button is clicked.","docsTags":[]},{"event":"arcgisPause","detail":"ValuePickerEvents[\"pause\"]","bubbles":true,"complexType":{"original":"ValuePickerEvents[\"pause\"]","resolved":"ValuePickerEvents[\"pause\"]","references":{"ValuePickerEvents":{"location":"import","path":"@arcgis/core/widgets/ValuePicker.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the Value Picker's pause button is clicked.","docsTags":[]},{"event":"arcgisPlay","detail":"ValuePickerEvents[\"play\"]","bubbles":true,"complexType":{"original":"ValuePickerEvents[\"play\"]","resolved":"ValuePickerEvents[\"play\"]","references":{"ValuePickerEvents":{"location":"import","path":"@arcgis/core/widgets/ValuePicker.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the Value Picker's play button is clicked.","docsTags":[]},{"event":"arcgisPrevious","detail":"ValuePickerEvents[\"previous\"]","bubbles":true,"complexType":{"original":"ValuePickerEvents[\"previous\"]","resolved":"ValuePickerEvents[\"previous\"]","references":{"ValuePickerEvents":{"location":"import","path":"@arcgis/core/widgets/ValuePicker.js","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Fires when the Value Picker's previous button is clicked.","docsTags":[]},{"event":"arcgisPropertyChange","detail":"{ name: \"values\"; }","bubbles":true,"complexType":{"original":"{ name: \"values\"; }","resolved":"{ name: \"values\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[{"name":"example","text":"```js\n// Listen for changes to the values property.\n// Update ImageryLayer's raster function accordingly.\nvaluePicker.addEventListener(\"arcgisPropertyChange\", (event) =>{\n layer.rasterFunction = {\n functionName: rasterFunctionPicker.values[0],\n };\n});\n```"}]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/version-management/version-management.tsx","tag":"arcgis-version-management","overview":"","readme":"","usage":{},"docs":"The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The Version Management component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`","docsTags":[{"name":"since","text":"4.29"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"allowEditingDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"allow-editing-disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-version-management/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"closable","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closable","reflectToAttr":true,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"initialVersionInfos","type":"InitialVersionInfo[]","complexType":{"original":"InitialVersionInfo[]","resolved":"InitialVersionInfo[]","references":{"InitialVersionInfo":{"location":"local","path":"components/arcgis-version-management/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The `initialVersionInfos` property enables users to initialize the Version Management component with a predefined set of versions.\nBy providing an array of `InitialVersionInfo`, the component displays a specified version for each feature service upon initialization.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":true,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"mode","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"mode","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"pageSize","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"page-size","reflectToAttr":false,"docs":"Specifies the number of versions displayed on each page of the Version Management component.","docsTags":[],"default":"5","values":[{"type":"number"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"VersionManagerState","complexType":{"original":"VersionManagerState","resolved":"VersionManagerState","references":{"VersionManagerState":{"location":"import","path":"@arcgis/core/versionManagement/VersionManager.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current component state.\n\n* `disabled` - an error occured during initialization\n* `executing` - an operation is being performed\n* `failed` - an error occurred during execution\n* `loading` - the object is loading\n* `ready` - object loaded successfully or operation completed successfully\n\nWhen the component is ready, all items in [versioningStates](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-version-management/#versioningStates) are loaded.","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"loading"},{"type":"string","value":"failed"},{"type":"string","value":"executing"}],"optional":true,"required":false},{"name":"versioningStates","type":"Collection","complexType":{"original":"Collection","resolved":"Collection","references":{"default":{"location":"import","path":"@arcgis/core/versionManagement/VersioningState.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This class provides functionality for managing versions in a versioned geodatabase.\nIn the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management component.\nThe Version Management component can be reinitialized using a `Collection`, or a predefined `Collection` can be provided during the initial instantiation of the Version Management component.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"view","type":"MapView | undefined","complexType":{"original":"MapView | undefined","resolved":"MapView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"This property defines the target [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/).","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisVersionManagement = document.createElement(\"arcgis-version-management\");\ndocument.body.append(arcgisVersionManagement);\nawait arcgisVersionManagement.componentOnReady();\nconsole.log(\"arcgis-version-management is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisVersioningStateChanged","detail":"VersioningStateEvent","bubbles":true,"complexType":{"original":"VersioningStateEvent","resolved":"VersioningStateEvent","references":{"VersioningStateEvent":{"location":"local","path":"components/arcgis-version-management/types","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/video/video.tsx","tag":"arcgis-video","overview":"","readme":"","usage":{},"docs":"The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.","docsTags":[{"name":"example","text":"```html\n\n\n\n```"},{"name":"since","text":"4.33"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"aria","type":"VideoView[\"aria\"]","complexType":{"original":"VideoView[\"aria\"]","resolved":"VideoView[\"aria\"]","references":{"default":{"location":"import","path":"@arcgis/core/views/VideoView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The ARIA attributes for the view container. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements).","docsTags":[{"name":"since","text":"4.34"}],"values":[],"optional":true,"required":false},{"name":"attributionMode","type":"\"dark\" | \"light\" | null | undefined","complexType":{"original":"\"dark\" | \"light\" | null | undefined","resolved":"\"dark\" | \"light\" | null | undefined","references":{}},"mutable":true,"attr":"attribution-mode","reflectToAttr":false,"docs":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"dark"},{"type":"string","value":"light"}],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-video/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"layer","type":"VideoLayer | null | undefined","complexType":{"original":"VideoLayer | null | undefined","resolved":"VideoLayer | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/VideoLayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/) to display in the view.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"map","type":"Map | WebMap | null | undefined","complexType":{"original":"Map | WebMap | null | undefined","resolved":"Map | WebMap | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/WebMap.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"A reference to the associated [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/) or [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/).","docsTags":[],"values":[],"optional":true,"required":false},{"name":"operationalDataVisible","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"operational-data-visible","reflectToAttr":false,"docs":"Indicates whether map graphics from the reference map element are overlaid on the video player's content.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"ready","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"reflectToAttr":false,"docs":"When `true`, this property indicates whether the view successfully satisfied all dependencies,\nsignaling that the following conditions are met.\n\n- [width](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/#width)\n- [height](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/#height)\n- [videoSize](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/#videoSize)\n- The [layer](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/#layer) is [ready](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/#state).\n\nWhen a view becomes ready it will resolve itself and invoke\nthe callback defined in [when()](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/#when) where code can execute on a working view. Subsequent\nchanges to a view's readiness would typically be handled by watching `view.ready` and providing\nlogic for cases where the [layer](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/#layer) or [container](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/#container) change.","docsTags":[{"name":"see","text":"[when()](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/#when)"},{"name":"readonly","text":""}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"view","type":"VideoView","complexType":{"original":"VideoView","resolved":"VideoView","references":{"default":{"location":"import","path":"@arcgis/core/views/VideoView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [VideoView](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/) instance created and manged by the component. Accessible once the component is fully loaded.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisVideo = document.createElement(\"arcgis-video\");\ndocument.body.append(arcgisVideo);\nawait arcgisVideo.componentOnReady();\nconsole.log(\"arcgis-video is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Destroys the view, and any associated resources, including its map, popup, and UI elements.","docsTags":[]}],"events":[{"event":"arcgisViewReadyChange","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[{"name":"--arcgis-layout-overlay-space-top","annotation":"prop","docs":"_Since 4.34_ Specifies the top padding for the layout."},{"name":"--arcgis-layout-overlay-space-bottom","annotation":"prop","docs":"_Since 4.34_ Specifies the bottom padding for the layout."},{"name":"--arcgis-layout-overlay-space-left","annotation":"prop","docs":"_Since 4.34_ Specifies the left padding for the layout."},{"name":"--arcgis-layout-overlay-space-right","annotation":"prop","docs":"_Since 4.34_ Specifies the right padding for the layout."},{"name":"--arcgis-view-color-focus","annotation":"prop","docs":"_Since 5.0_ Specifies the focus outline color for the view."},{"name":"--arcgis-table-row-background-color","annotation":"prop","docs":"_Since 5.1_ Specifies the background color for table rows."},{"name":"--arcgis-table-row-alt-background-color","annotation":"prop","docs":"_Since 5.1_ Specifies the background color for alternate table rows."}],"slots":[{"name":"","docs":"Default slot for adding components to the video. User is responsible for positioning the content via CSS."},{"name":"top-left","docs":"Slot for components positioned in the top-left corner."},{"name":"top-right","docs":"Slot for components positioned in the top-right corner."},{"name":"bottom-left","docs":"Slot for components positioned in the bottom-left corner."},{"name":"bottom-right","docs":"Slot for components positioned in the bottom-right corner."},{"name":"top-start","docs":"Slot for components positioned at the top-start (top-left in LTR, top-right in RTL)."},{"name":"top-end","docs":"Slot for components positioned at the top-end (top-right in LTR, top-left in RTL)."},{"name":"bottom-start","docs":"Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL)."},{"name":"bottom-end","docs":"Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."}],"parts":[],"listeners":[]},{"filePath":"src/components/video-player/video-player.tsx","tag":"arcgis-video-player","overview":"","readme":"","usage":{},"docs":"The Video Player component provides a user interface for interacting with a [VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/VideoPlayer/VideoPlayerViewModel/) class provides the logic for the Video Player.\n\n**Known limitations**\n\n* Not supported in 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[![](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/video-player-video-preview.avif)](https://mediaspace.esri.com/media/1_ctc3psfr)","docsTags":[{"name":"example","text":"```html\n\n \n\n\n\n```"},{"name":"since","text":"4.33"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-video-player/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"followingMode","type":"VideoPlayerViewModel[\"followingMode\"]","complexType":{"original":"VideoPlayerViewModel[\"followingMode\"]","resolved":"VideoPlayerViewModel[\"followingMode\"]","references":{"default":{"location":"import","path":"@arcgis/core/widgets/VideoPlayer/VideoPlayerViewModel.js","id":"notImplemented"}}},"mutable":true,"attr":"following-mode","reflectToAttr":false,"docs":"Determines which telemetry elements to follow when the video layer is playing.","docsTags":[],"default":"\"follow-both\"","values":[{"type":"string","value":"none"},{"type":"string","value":"follow-sensor"},{"type":"string","value":"follow-frame"},{"type":"string","value":"follow-both"}],"optional":true,"required":false},{"name":"hideHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-header","reflectToAttr":false,"docs":"Indicates whether to display the video player's header information.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"video-web\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"inline","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"inline","reflectToAttr":true,"docs":"Indicates whether to render the video player in inline mode.\nIn inline mode, the component uses a compact control layout without a [VideoView](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/).","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":true,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layer","type":"VideoLayer | null | undefined","complexType":{"original":"VideoLayer | null | undefined","resolved":"VideoLayer | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/layers/VideoLayer.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/) to use as the data source for the video player.","docsTags":[{"name":"example","text":"```js\n// Create a new Video Player with a VideoLayer\nvideoPlayer.layer = videoLayer;\n```"}],"default":"null","values":[],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"operationalDataVisible","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"operational-data-visible","reflectToAttr":false,"docs":"Indicates whether map graphics from the reference map element are overlaid on the video player's content.","docsTags":[{"name":"since","text":"5.1"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"showFullscreenToggle","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"show-fullscreen-toggle","reflectToAttr":false,"docs":"Indicates whether to display an action in the header that toggles between inline and the default fullscreen layout.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"state","type":"\"error\" | VideoState","complexType":{"original":"\"error\" | VideoState","resolved":"\"error\" | VideoState","references":{"VideoState":{"location":"import","path":"@arcgis/core/layers/video/types.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"ready"},{"type":"string","value":"error"},{"type":"string","value":"playing"},{"type":"string","value":"waiting"},{"type":"string","value":"paused"},{"type":"string","value":"can-play"},{"type":"string","value":"not-ready"},{"type":"string","value":"data-loaded"}],"optional":true,"required":false},{"name":"view","type":"MapView | null | undefined","complexType":{"original":"MapView | null | undefined","resolved":"MapView | null | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/MapView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-video-player component will be associated with a map or scene component rather than using the `view` property.","docsTags":[{"name":"example","text":"// Set the video player view model's view to a map view.\nvideoPlayerViewModel.view = mapView;"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisVideoPlayer = document.createElement(\"arcgis-video-player\");\ndocument.body.append(arcgisVideoPlayer);\nawait arcgisVideoPlayer.componentOnReady();\nconsole.log(\"arcgis-video-player is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\" | \"layer\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\" | \"layer\"; }","resolved":"{ name: \"state\" | \"layer\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]},{"event":"arcgisVideoReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/view-popover/view-popover.tsx","tag":"arcgis-view-popover","overview":"","readme":"","usage":{},"docs":"The View Popover component provides view-aware placement and sizing for popovers anchored to actions inside\na map or scene view. This component is critical to enabling a great user experience with popovers\nwhen the exact placement and content of the popover is highly variable.\n\nThis component was originally added to support arcgis-sketch, which can be placed in all corners\nof the view, in multiple orientations, and with highly configurable settings contents.\n\nBecause layer lists and grid controls are included in the settings popover, it is very common for\nthe popover to overflow the view. It is equally common for the settings popover to be quite compact.\n\nProvide the popover content through the default slot and assign a [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#view),\n[anchorElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#anchorElement), and [actionBarElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#actionBarElement)\nto enable automatic positioning within the view.","docsTags":[{"name":"since","text":"5.1"},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"actionBarElement","type":"ActionBar | undefined","complexType":{"original":"ActionBar | undefined","resolved":"ActionBar | undefined","references":{"ActionBar":{"location":"import","path":"@esri/calcite-components/components/calcite-action-bar","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The calcite action bar that owns the anchor action; must be set for correct layout.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"actionBarLayout","type":"ActionBarLayout","complexType":{"original":"ActionBarLayout","resolved":"ActionBarLayout","references":{"ActionBarLayout":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"horizontal"},{"type":"string","value":"vertical"}],"optional":true,"required":false},{"name":"anchorElement","type":"HTMLElement | undefined","complexType":{"original":"HTMLElement | undefined","resolved":"HTMLElement | undefined","references":{"HTMLElement":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The action element that anchors the popover.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"closable","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"closable","reflectToAttr":false,"docs":"Indicates whether the popover includes a close action in the header.","docsTags":[],"default":"true","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"heading","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"heading","reflectToAttr":false,"docs":"The popover heading.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"Accessible label for the popover.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"maxContentWidth","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"max-content-width","reflectToAttr":false,"docs":"Maximum content width, in pixels, applied to the slotted popover content.","docsTags":[],"default":"400","values":[{"type":"number"}],"optional":true,"required":false},{"name":"minContentWidth","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"min-content-width","reflectToAttr":false,"docs":"Minimum content width, in pixels, applied to the slotted popover content.","docsTags":[],"default":"300","values":[{"type":"number"}],"optional":true,"required":false},{"name":"open","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"open","reflectToAttr":false,"docs":"Indicates whether the popover is open.\n\nListen for [@arcgisPropertyChange](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#event-arcgisPropertyChange) to react to user-driven close actions.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"tailAttachmentAppearance","type":"TailAttachmentAppearance","complexType":{"original":"TailAttachmentAppearance","resolved":"TailAttachmentAppearance","references":{"TailAttachmentAppearance":{"location":"local","id":"notImplemented"}}},"mutable":true,"attr":"tail-attachment-appearance","reflectToAttr":false,"docs":"Controls whether the popover appears attached to the action itself or to the containing action bar.","docsTags":[],"default":"\"bar\"","values":[{"type":"string","value":"action"},{"type":"string","value":"bar"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view that constrains popover placement and sizing.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"viewEdgeMargin","type":"number","complexType":{"original":"number","resolved":"number","references":{}},"mutable":true,"attr":"view-edge-margin","reflectToAttr":false,"docs":"Minimum inset, in pixels, between the popover and the edges of the view.\nThe bottom edge will be relative to the attribution bar, if it is visible.","docsTags":[],"default":"16","values":[{"type":"number"}],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Visual scale for the popover; this applies only to the header and close button.","docsTags":[],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisViewPopover = document.createElement(\"arcgis-view-popover\");\ndocument.body.append(arcgisViewPopover);\nawait arcgisViewPopover.componentOnReady();\nconsole.log(\"arcgis-view-popover is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"open\"; }","bubbles":true,"complexType":{"original":"{ name: \"open\"; }","resolved":"{ name: \"open\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/volume-measurement/volume-measurement.tsx","tag":"arcgis-volume-measurement","overview":"","readme":"","usage":{},"docs":"The Volume Measurement component is currently [in preview](https://support.esri.com/en-us/knowledge-base/faq-what-is-preview-000036425).\n\nThe Volume Measurement component can be added to a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) to\ncalculate and visualize the volume of ground surfaces within a defined polygonal area.\n\n![measurement-volume](https://developers.arcgis.com/javascript/latest/assets/references/components/volume-measurement/volume_measurement_poster.avif)\n\nThe Volume Measurement component offers multiple volume measurement modes:\n\n- **Cut & Fill Volume**: Computes cut and fill volumes relative to a flat, horizontal surface defined by the input\npolygon. Ideal for estimating the amount of material to remove or add to level terrain for construction.\n\n- **Stockpile Volume**: Calculates cut and fill volumes against a surface approximated from the polygon's coordinates.\nUseful for estimating the volume of temporary ground features such as piles of material, mounds or depressions.\n\nThe analysis depends on the scene's spatial reference, and the length of the measured perimeter:\n\n- In **Projected Coordinate Systems (PCS)**, apart from Web Mercator used in **local** viewing mode, there is no limit\nto the measurement's perimeter, making it the recommended setup for analysis as accuracy is not compromised.\n\n- In **Web Mercator PCS** used in **local** viewing mode, if the measurement's perimeter exceeds 10 km, the analysis is considered invalid due to potential accuracy issues.\n\n- In **Geographic Coordinate Systems (GCS)** and **Web Mercator** in **global** viewing mode, if the measurement's perimeter exceeds 50 km, the analysis is considered invalid due to potential accuracy issues.\n\n\n**Known Limitations**\n\n- The Volume Measurement component can only be added to a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n- The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.\n- If the view is too close or too far from the measurement polygon, the results will not be computed due to LOD-induced inaccuracies.\n- The elevation of the target surface in the \"Cut & Fill Volume\" mode is restricted to the range of -11 km and +9 km.\n- This tool operates only on the non-transparent [Map.ground](https://developers.arcgis.com/javascript/latest/references/core/Map/#ground),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMeshLayer/)\nand an [IntegratedMesh3DTilesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMesh3DTilesLayer/).\n- This tool does not support WGS 1984 spatial reference in a local\n[viewing mode](https://developers.arcgis.com/javascript/latest/references/core/webscene/InitialViewProperties/#viewingMode).\n\n**Things to consider**\n\n- In \"Cut & Fill Volume\" mode, you can hover over the shift manipulator, press `Tab` to enable tooltip input,\nand enter the target surface elevation.\n- Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n- Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/).\n\n**See also**\n\n- [Volume Measurement Analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurementAnalysis/)\n- [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurementAnalysisView3D/)\n- [VolumeMeasurementResult](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurement/VolumeMeasurementResult/)\n- [VolumeMeasurementDisplayUnits](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurement/VolumeMeasurementDisplayUnits/)\nand [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurement/VolumeMeasurementInputUnits/)\n- [VolumeMeasurementError](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurement/VolumeMeasurementError/)\n- [Sample - Volume measurement analysis object](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)","docsTags":[{"name":"since","text":"5.0"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"analysis","type":"VolumeMeasurementAnalysis","complexType":{"original":"VolumeMeasurementAnalysis","resolved":"VolumeMeasurementAnalysis","references":{"default":{"location":"import","path":"@arcgis/core/analysis/VolumeMeasurementAnalysis.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurementAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Volume Measurement component to the [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses) collection.\nYou can then wait for the [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurementAnalysisView3D/)\nto be created before accessing the analysis results.\n\n```js\n// Get the Scene component and the Volume Measurement component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst volumeMeasurementElement = document.querySelector(\"arcgis-volume-measurement\");\nawait volumeMeasurementElement.componentOnReady();\n\n// Get the VolumeMeasurementAnalysis created by the Volume Measurement component.\nconst analysis = volumeMeasurementElement.analysis;\n\n// Get the VolumeMeasurementAnalysisView3D and watch for results.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysisView?.result,\n () => {\n console.log(\"Analysis results:\", analysisView.result);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [VolumeMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurementAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.\n\n```js\n// Create the VolumeMeasurementAnalysis.\nconst volumeMeasurementAnalysis = new VolumeMeasurementAnalysis({\n geometry: new Polygon({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n rings: [\n [\n [-13624861.22274897, 4550346.5519295, 63.378210234455764],\n [-13624935.305160372, 4550273.144585712, 63.37829629518092],\n [-13624995.61798748, 4550334.030096778, 63.37819860037416],\n [-13624921.53589075, 4550407.42357004, 63.3783810287714],\n [-13624861.22274897, 4550346.5519295, 63.378210234455764]\n ]\n ]\n })\n});\n// Get the Scene component and the Volume Measurement component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst volumeMeasurementElement = document.querySelector(\"arcgis-volume-measurement\");\nawait volumeMeasurementElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Scene component.\nviewElement.analyses.add(volumeMeasurementAnalysis);\n\n// Connect the analysis to the measurement component:\nvolumeMeasurementElement.analysis = volumeMeasurementAnalysis;\n```","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"areaDisplayUnit","type":"SystemOrAreaUnit","complexType":{"original":"SystemOrAreaUnit","resolved":"SystemOrAreaUnit","references":{"SystemOrAreaUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"area-display-unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the area. Possible values are listed in\n[areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions).","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"metric"},{"type":"string","value":"imperial"},{"type":"string","value":"square-inches"},{"type":"string","value":"square-feet"},{"type":"string","value":"square-yards"},{"type":"string","value":"square-miles"},{"type":"string","value":"square-nautical-miles"},{"type":"string","value":"square-us-feet"},{"type":"string","value":"square-millimeters"},{"type":"string","value":"square-centimeters"},{"type":"string","value":"square-decimeters"},{"type":"string","value":"square-meters"},{"type":"string","value":"square-kilometers"},{"type":"string","value":"acres"},{"type":"string","value":"ares"},{"type":"string","value":"hectares"}],"optional":true,"required":false},{"name":"areaDisplayUnitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrAreaUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units and unit systems (imperial, metric) that are shown in the component's area display unit dropdown.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-yards`, `square-miles`, `square-nautical-miles`, `square-us-feet`, `square-millimeters`, `square-centimeters`, `square-decimeters`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [areaDisplayUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnit) values can only be a subset of this list.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"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 component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"elevationDisplayUnit","type":"SystemOrLengthUnit","complexType":{"original":"SystemOrLengthUnit","resolved":"SystemOrLengthUnit","references":{"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"elevation-display-unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation. Possible values are listed in\n[elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions).","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"metric"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"},{"type":"string","value":"imperial"}],"optional":true,"required":false},{"name":"elevationDisplayUnitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `meters`, `millimeters`, `centimeters`, `decimeters`, `kilometers`, `inches`, `feet`, `yards`, `miles`, `nautical-miles`, `us-feet`.\nPossible [elevationDisplayUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnit) values can only be a subset of this list.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"elevationInputUnit","type":"LengthUnit","complexType":{"original":"LengthUnit","resolved":"LengthUnit","references":{"LengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"elevation-input-unit","reflectToAttr":false,"docs":"Unit used for inputting the cut and fill target elevation.\nPossible values are listed in [elevationInputUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnitOptions).\n\nThis controls which unit is used when entering an elevation value via the tool's UI (for example, using the\nshift manipulator tooltip input in \"Cut & Fill Volume\" mode).","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"}],"optional":true,"required":false},{"name":"elevationInputUnitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"LengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units that are shown in the elevation input unit dropdown.\n\nBy default, the following units are included: `inches`, `feet`, `yards`, `miles`, `nautical-miles`, `us-feet`,\n`millimeters`, `centimeters`, `decimeters`, `meters`, `kilometers`.\nThe current [elevationInputUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnit) value can only be a subset of this list.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the headings in the component.","docsTags":[],"default":"2","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideAreaDisplayUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-area-display-unit-select","reflectToAttr":false,"docs":"If true, the area display unit dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideElevationDisplayUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-elevation-display-unit-select","reflectToAttr":false,"docs":"If true, the elevation display unit dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideElevationInputUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-elevation-input-unit-select","reflectToAttr":false,"docs":"If true, the elevation input unit dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-header","reflectToAttr":false,"docs":"If true, the header will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideModeSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-mode-select","reflectToAttr":false,"docs":"If true, the mode selection dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hidePerimeterDisplayUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-perimeter-display-unit-select","reflectToAttr":false,"docs":"If true, the perimeter display unit dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSettingsButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-settings-button","reflectToAttr":false,"docs":"If true, the settings button that opens the settings popover will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideStartButton","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-start-button","reflectToAttr":false,"docs":"If true, the button that starts a new measurement will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVisualization","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-visualization","reflectToAttr":false,"docs":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideVolumeDisplayUnitSelect","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-volume-display-unit-select","reflectToAttr":false,"docs":"If true, the volume display unit dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"Icon[\"icon\"] | undefined","complexType":{"original":"Icon[\"icon\"] | undefined","resolved":"Icon[\"icon\"] | undefined","references":{"Icon":{"location":"import","path":"@esri/calcite-components/components/calcite-icon","id":"notImplemented"}}},"mutable":true,"attr":"icon","reflectToAttr":true,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"measure-area\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"mode","type":"VolumeMeasureType","complexType":{"original":"VolumeMeasureType","resolved":"VolumeMeasureType","references":{"VolumeMeasureType":{"location":"import","path":"@arcgis/core/analysis/VolumeMeasurement/types.js","id":"notImplemented"}}},"mutable":true,"attr":"mode","reflectToAttr":false,"docs":"Specifies the analysis' desired measurement type.","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"cut-fill"},{"type":"string","value":"stockpile"}],"optional":true,"required":false},{"name":"perimeterDisplayUnit","type":"SystemOrLengthUnit","complexType":{"original":"SystemOrLengthUnit","resolved":"SystemOrLengthUnit","references":{"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"perimeter-display-unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the perimeter values. Possible values are\nlisted in [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions).","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"meters"},{"type":"string","value":"feet"},{"type":"string","value":"miles"},{"type":"string","value":"nautical-miles"},{"type":"string","value":"kilometers"},{"type":"string","value":"metric"},{"type":"string","value":"millimeters"},{"type":"string","value":"centimeters"},{"type":"string","value":"us-feet"},{"type":"string","value":"yards"},{"type":"string","value":"decimeters"},{"type":"string","value":"inches"},{"type":"string","value":"imperial"}],"optional":true,"required":false},{"name":"perimeterDisplayUnitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrLengthUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units and unit systems (imperial, metric) that are shown in the component's perimeter display unit dropdown.\nBy default, the following units are included: `metric`, `imperial`, `meters`, `millimeters`, `centimeters`, `decimeters`, `kilometers`, `inches`, `feet`, `yards`, `miles`, `nautical-miles`, `us-feet`.\nPossible [perimeterDisplayUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnit) values can only be a subset of this list.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"VolumeMeasurementState","complexType":{"original":"VolumeMeasurementState","resolved":"VolumeMeasurementState","references":{"VolumeMeasurementState":{"location":"local","path":"components/arcgis-volume-measurement/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished","docsTags":[{"name":"since","text":"5.0"},{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"unsupported"},{"type":"string","value":"measured"},{"type":"string","value":"measuring"}],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-volume-measurement component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"volumeDisplayUnit","type":"SystemOrVolumeUnit","complexType":{"original":"SystemOrVolumeUnit","resolved":"SystemOrVolumeUnit","references":{"SystemOrVolumeUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"attr":"volume-display-unit","reflectToAttr":false,"docs":"Unit system (imperial, metric) or specific unit used for displaying the volume values. Possible values are listed in\n[volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions).","docsTags":[{"name":"since","text":"5.0"}],"values":[{"type":"string","value":"metric"},{"type":"string","value":"imperial"},{"type":"string","value":"cubic-inches"},{"type":"string","value":"cubic-feet"},{"type":"string","value":"cubic-yards"},{"type":"string","value":"cubic-miles"},{"type":"string","value":"cubic-us-feet"},{"type":"string","value":"liters"},{"type":"string","value":"megaliters"},{"type":"string","value":"gigaliters"},{"type":"string","value":"cubic-millimeters"},{"type":"string","value":"cubic-centimeters"},{"type":"string","value":"cubic-decimeters"},{"type":"string","value":"cubic-meters"},{"type":"string","value":"cubic-kilometers"}],"optional":true,"required":false},{"name":"volumeDisplayUnitOptions","type":"Array","complexType":{"original":"Array","resolved":"Array","references":{"Array":{"location":"global","path":"global:","id":"notImplemented"},"SystemOrVolumeUnit":{"location":"import","path":"@arcgis/core/core/units.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `imperial`, `metric`, `liters`, `megaliters`, `gigaliters`, `cubic-millimeters`, `cubic-centimeters`, `cubic-decimeters`, `cubic-meters`, `cubic-kilometers`, `cubic-inches`, `cubic-us-feet`, `cubic-feet`, `cubic-yards`, `cubic-miles`.\nPossible [volumeDisplayUnit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnit) values can only be a subset of this list.","docsTags":[{"name":"since","text":"5.0"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"clear","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"clear(): Promise","parameters":[],"docs":"Clears the current measurement.","docsTags":[{"name":"since","text":"5.0"}]},{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisVolumeMeasurement = document.createElement(\"arcgis-volume-measurement\");\ndocument.body.append(arcgisVolumeMeasurement);\nawait arcgisVolumeMeasurement.componentOnReady();\nconsole.log(\"arcgis-volume-measurement is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"start","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"start(): Promise","parameters":[],"docs":"Starts a new measurement.","docsTags":[{"name":"since","text":"5.0"}]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"analysis\" | \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"analysis\" | \"state\"; }","resolved":"{ name: \"analysis\" | \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/weather/weather.tsx","tag":"arcgis-weather","overview":"","readme":"","usage":{},"docs":"The Weather component allows easy selection and configuration of weather effects in a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\nThe available weather types are:\n[sunny](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunnyWeather/),\n[cloudy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/CloudyWeather/),\n[rainy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/RainyWeather/),\n[snowy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SnowyWeather/), and\n[foggy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/FoggyWeather/).\n\nTo set the weather programmatically, apply the desired weather type to the\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) property of the Scene component.\n\n```js\n// Access the Scene component.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// Specify the weather settings.\nviewElement.environment.weather = {\n type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n cloudCover: 0.7,\n precipitation: 0.3\n};\n```\n\nTo determine if the weather visualization is available, check the boolean value of `viewElement.environment.weatherAvailable`. The weather is only available:\n * in `global` [arcgis-scene.viewingMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#viewingMode),\n * when `atmosphereEnabled` property on [arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) is `true`,\n * at lower altitudes, near the ground.\n\n**Known limitations**\n\nWeather is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunnyWeather/)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/CloudyWeather/)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/RainyWeather/)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SnowyWeather/)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/FoggyWeather/)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-weather/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"headingLevel","type":"HeadingLevel","complexType":{"original":"HeadingLevel","resolved":"HeadingLevel","references":{"HeadingLevel":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"heading-level","reflectToAttr":false,"docs":"Indicates the heading level to use for the title of the component. By default, this message is rendered as a level 4\nheading (e.g. `

Time range

`). Depending on the component's placement in your app, you may need to adjust\nthis heading for proper semantics. This is important for meeting accessibility standards.","docsTags":[{"name":"see","text":"[Heading Elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)"}],"default":"4","values":[{"type":"number","value":"6"},{"type":"number","value":"1"},{"type":"number","value":"2"},{"type":"number","value":"3"},{"type":"number","value":"4"},{"type":"number","value":"5"}],"optional":true,"required":false},{"name":"hideHeader","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-header","reflectToAttr":false,"docs":"Whether to hide the component's header.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"partly-cloudy\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"default":"\"Weather\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"WeatherState","complexType":{"original":"WeatherState","resolved":"WeatherState","references":{"WeatherState":{"location":"local","path":"components/arcgis-weather/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"error"}],"optional":true,"required":false},{"name":"view","type":"SceneView | undefined","complexType":{"original":"SceneView | undefined","resolved":"SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-weather component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisWeather = document.createElement(\"arcgis-weather\");\ndocument.body.append(arcgisWeather);\nawait arcgisWeather.componentOnReady();\nconsole.log(\"arcgis-weather is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]}],"events":[{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/zoom/zoom.tsx","tag":"arcgis-zoom","overview":"","readme":"","usage":{},"docs":"The Zoom component allows users to zoom in/out within a map or scene.","docsTags":[{"name":"since","text":"4.28"},{"name":"superclass","text":"{\"name\":\"HTMLElement\",\"package\":\"global:\",\"viewUrl\":\"https://developer.mozilla.org/docs/Web/API/HTMLElement\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"autoDestroyDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"auto-destroy-disabled","reflectToAttr":false,"docs":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-zoom/#destroy) method when you are done to\nprevent memory leaks.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"icon","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"icon","reflectToAttr":false,"docs":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"default":"\"magnifying-glass-plus\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"label","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"label","reflectToAttr":false,"docs":"The component's default label.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"layout","type":"Layout","complexType":{"original":"Layout","resolved":"Layout","references":{"Layout":{"location":"local","path":"components/arcgis-zoom/types","id":"notImplemented"}}},"mutable":true,"attr":"layout","reflectToAttr":true,"docs":"Determines the layout/orientation of the Zoom component.","docsTags":[],"default":"\"vertical\"","values":[{"type":"string","value":"horizontal"},{"type":"string","value":"vertical"}],"optional":true,"required":false},{"name":"messageOverrides","type":"Record | undefined","complexType":{"original":"Record | undefined","resolved":"Record | undefined","references":{"Record":{"location":"global","path":"global:","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","docsTags":[],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisReferenceElement | string | undefined","complexType":{"original":"ArcgisReferenceElement | string | undefined","resolved":"ArcgisReferenceElement | string | undefined","references":{"ArcgisReferenceElement":{"location":"local","path":"components/types","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"state","type":"State","complexType":{"original":"State","resolved":"State","references":{"State":{"location":"local","path":"components/arcgis-zoom/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The current state of the component.","docsTags":[{"name":"readonly","text":""}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"}],"optional":true,"required":false},{"name":"view","type":"MapView | SceneView | undefined","complexType":{"original":"MapView | SceneView | undefined","resolved":"MapView | SceneView | undefined","references":{"default":{"location":"import","path":"@arcgis/core/views/SceneView.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-zoom component will be associated with a map or scene component rather than using the `view` property.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"visualScale","type":"Button[\"scale\"]","complexType":{"original":"Button[\"scale\"]","resolved":"Button[\"scale\"]","references":{"Button":{"location":"import","path":"@esri/calcite-components/components/calcite-button","id":"notImplemented"}}},"mutable":true,"attr":"visual-scale","reflectToAttr":false,"docs":"Specifies the size of the component.","docsTags":[{"name":"since","text":"5.0"}],"default":"\"m\"","values":[{"type":"string","value":"s"},{"type":"string","value":"m"},{"type":"string","value":"l"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisZoom = document.createElement(\"arcgis-zoom\");\ndocument.body.append(arcgisZoom);\nawait arcgisZoom.componentOnReady();\nconsole.log(\"arcgis-zoom is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"this\"}"}]},{"name":"destroy","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"destroy(): Promise","parameters":[],"docs":"Permanently destroy the component.","docsTags":[]},{"name":"zoomIn","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomIn(): Promise","parameters":[],"docs":"Zooms the view in by an LOD factor of 0.5.","docsTags":[]},{"name":"zoomOut","returns":{"type":"Promise","docs":""},"complexType":{"signature":"(): Promise","parameters":[],"return":"Promise","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"zoomOut(): Promise","parameters":[],"docs":"Zooms the view out by an LOD factor of 2.","docsTags":[]}],"events":[{"event":"arcgisActionZoom","detail":"{ action: \"zoomIn\" | \"zoomOut\"; }","bubbles":true,"complexType":{"original":"{ action: \"zoomIn\" | \"zoomOut\"; }","resolved":"{ action: \"zoomIn\" | \"zoomOut\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when one of the zoom controls is activated.","docsTags":[{"name":"since","text":"5.0"}]},{"event":"arcgisPropertyChange","detail":"{ name: \"state\"; }","bubbles":true,"complexType":{"original":"{ name: \"state\"; }","resolved":"{ name: \"state\"; }","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","docsTags":[]},{"event":"arcgisReady","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the component associated with a map or scene view is ready to be interacted with.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]}],"typeLibrary":{}}