@arcgis/map-components
Version:
ArcGIS Map Components
887 lines (886 loc) • 975 kB
JSON
{
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
"name": "@arcgis/map-components",
"version": "4.33.13",
"description-markup": "markdown",
"contributions": {
"html": {
"elements": [
{
"name": "arcgis-area-measurement-2d",
"description": "The Area Measurement 2D component calculates and displays the area and perimeter of a polygon only in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/",
"attributes": [
{
"name": "auto-destroy-disabled",
"description": "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/arcgis-area-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "icon",
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
"default": "\"measure-area\"",
"value": {
"type": "string"
}
},
{
"name": "label",
"description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#label)",
"value": {
"type": "string"
}
},
{
"name": "position",
"default": "\"bottom-left\"",
"value": {
"type": [
"\"bottom-leading\"",
"\"bottom-left\"",
"\"bottom-right\"",
"\"bottom-trailing\"",
"\"manual\"",
"\"top-leading\"",
"\"top-left\"",
"\"top-right\"",
"\"top-trailing\""
]
}
},
{
"name": "reference-element",
"description": "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.",
"value": {
"type": "string"
}
},
{
"name": "state",
"description": "The current state of the component.",
"default": "\"disabled\"",
"value": {
"type": [
"\"disabled\"",
"\"measured\"",
"\"measuring\"",
"\"ready\""
]
}
},
{
"name": "unit",
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit)",
"value": {
"type": [
"\"acres\"",
"\"ares\"",
"\"hectares\"",
"\"imperial\"",
"\"metric\"",
"\"square-centimeters\"",
"\"square-decimeters\"",
"\"square-feet\"",
"\"square-inches\"",
"\"square-kilometers\"",
"\"square-meters\"",
"\"square-miles\"",
"\"square-millimeters\"",
"\"square-nautical-miles\"",
"\"square-us-feet\"",
"\"square-yards\""
]
}
}
],
"events": [
{
"name": "arcgisPropertyChange",
"type": "{ name: \"state\"; }",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
},
{
"name": "arcgisReady",
"type": "void",
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
}
],
"js": {
"properties": [
{
"name": "autoDestroyDisabled",
"description": "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/arcgis-area-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.",
"type": "boolean"
},
{
"name": "icon",
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
"type": "string"
},
{
"name": "label",
"description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#label)",
"type": "string"
},
{
"name": "position",
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
},
{
"name": "referenceElement",
"description": "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.",
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
},
{
"name": "snappingOptions",
"description": "The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#snappingOptions)",
"type": "SnappingOptions"
},
{
"name": "state",
"description": "The current state of the component.",
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
},
{
"name": "unit",
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit)",
"type": "\"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\" | \"square-centimeters\" | \"square-decimeters\" | \"square-feet\" | \"square-inches\" | \"square-kilometers\" | \"square-meters\" | \"square-miles\" | \"square-millimeters\" | \"square-nautical-miles\" | \"square-us-feet\" | \"square-yards\""
},
{
"name": "unitOptions",
"description": "List of available units and unit systems (imperial, metric) for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unitOptions)",
"type": "Array<\"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\">"
}
],
"events": [
{
"name": "arcgisPropertyChange",
"type": "{ name: \"state\"; }",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
},
{
"name": "arcgisReady",
"type": "void",
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
}
]
}
},
{
"name": "arcgis-area-measurement-3d",
"description": "The Area Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to calculate and display area and perimeter of polygons.\n\n[](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\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 [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Area Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\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--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/",
"attributes": [
{
"name": "auto-destroy-disabled",
"description": "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/arcgis-area-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "icon",
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
"default": "\"measure-area\"",
"value": {
"type": "string"
}
},
{
"name": "label",
"description": "The component's default label.",
"value": {
"type": "string"
}
},
{
"name": "position",
"default": "\"bottom-left\"",
"value": {
"type": [
"\"bottom-leading\"",
"\"bottom-left\"",
"\"bottom-right\"",
"\"bottom-trailing\"",
"\"manual\"",
"\"top-leading\"",
"\"top-left\"",
"\"top-right\"",
"\"top-trailing\""
]
}
},
{
"name": "reference-element",
"description": "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.",
"value": {
"type": "string"
}
},
{
"name": "state",
"description": "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",
"value": {
"type": [
"\"disabled\"",
"\"measured\"",
"\"measuring\"",
"\"ready\""
]
}
},
{
"name": "unit",
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
"value": {
"type": [
"\"acres\"",
"\"ares\"",
"\"hectares\"",
"\"imperial\"",
"\"metric\"",
"\"square-centimeters\"",
"\"square-decimeters\"",
"\"square-feet\"",
"\"square-inches\"",
"\"square-kilometers\"",
"\"square-meters\"",
"\"square-miles\"",
"\"square-millimeters\"",
"\"square-nautical-miles\"",
"\"square-us-feet\"",
"\"square-yards\""
]
}
}
],
"events": [
{
"name": "arcgisPropertyChange",
"type": "{ name: \"state\" | \"analysis\"; }",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
},
{
"name": "arcgisReady",
"type": "void",
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
}
],
"js": {
"properties": [
{
"name": "analysis",
"description": "The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Area Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\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 and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst areaMeasurement3d = document.querySelector(\"arcgis-area-measurement-3d\");\nawait areaMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(areaMeasurementAnalysis);\n// Connect the analysis to the measurement component:\nareaMeasurement3d.analysis = areaMeasurementAnalysis;\n```",
"type": "AreaMeasurementAnalysis"
},
{
"name": "autoDestroyDisabled",
"description": "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/arcgis-area-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.",
"type": "boolean"
},
{
"name": "icon",
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
"type": "string"
},
{
"name": "label",
"description": "The component's default label.",
"type": "string"
},
{
"name": "position",
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
},
{
"name": "referenceElement",
"description": "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.",
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
},
{
"name": "state",
"description": "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",
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
},
{
"name": "unit",
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
"type": "\"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\" | \"square-centimeters\" | \"square-decimeters\" | \"square-feet\" | \"square-inches\" | \"square-kilometers\" | \"square-meters\" | \"square-miles\" | \"square-millimeters\" | \"square-nautical-miles\" | \"square-us-feet\" | \"square-yards\""
},
{
"name": "unitOptions",
"description": "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](#unit) values can only be a subset of this list.",
"type": "Array<\"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\">"
}
],
"events": [
{
"name": "arcgisPropertyChange",
"type": "{ name: \"state\" | \"analysis\"; }",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
},
{
"name": "arcgisReady",
"type": "void",
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
}
]
}
},
{
"name": "arcgis-attachments",
"description": "### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-attachments/",
"attributes": [
{
"name": "auto-destroy-disabled",
"description": "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/arcgis-attachments/#destroy) method when you are done to\nprevent memory leaks.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "display-type",
"description": "A string value indicating how to display an attachment.",
"default": "\"auto\"",
"value": {
"type": [
"\"auto\"",
"\"list\"",
"\"preview\""
]
}
},
{
"name": "hide-add-button",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-add-submit-button",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-cancel-add-button",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-cancel-update-button",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-delete-button",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-error-message",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-progress-bar",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-update-button",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "icon",
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
"default": "\"attachment\"",
"value": {
"type": "string"
}
},
{
"name": "label",
"description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
"value": {
"type": "string"
}
},
{
"name": "position",
"default": "\"bottom-left\"",
"value": {
"type": [
"\"bottom-leading\"",
"\"bottom-left\"",
"\"bottom-right\"",
"\"bottom-trailing\"",
"\"manual\"",
"\"top-leading\"",
"\"top-left\"",
"\"top-right\"",
"\"top-trailing\""
]
}
},
{
"name": "reference-element",
"description": "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.",
"value": {
"type": "string"
}
},
{
"name": "state",
"description": "The current state of the component.",
"default": "\"ready\"",
"value": {
"type": [
"\"disabled\"",
"\"loading\"",
"\"ready\""
]
}
}
],
"events": [
{
"name": "arcgisPropertyChange",
"type": "{ name: \"state\" | \"submitting\"; }",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
},
{
"name": "arcgisReady",
"type": "void",
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
}
],
"js": {
"properties": [
{
"name": "autoDestroyDisabled",
"description": "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/arcgis-attachments/#destroy) method when you are done to\nprevent memory leaks.",
"type": "boolean"
},
{
"name": "capabilities",
"description": "Configures the attachment editing functionality that can be performed by the user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#capabilities)",
"type": "AttachmentsCapabilities"
},
{
"name": "displayType",
"description": "A string value indicating how to display an attachment.",
"type": "\"auto\" | \"list\" | \"preview\""
},
{
"name": "graphic",
"description": "The graphic for the attachments.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#graphic)",
"type": "Graphic"
},
{
"name": "hideAddButton",
"type": "boolean"
},
{
"name": "hideAddSubmitButton",
"type": "boolean"
},
{
"name": "hideCancelAddButton",
"type": "boolean"
},
{
"name": "hideCancelUpdateButton",
"type": "boolean"
},
{
"name": "hideDeleteButton",
"type": "boolean"
},
{
"name": "hideErrorMessage",
"type": "boolean"
},
{
"name": "hideProgressBar",
"type": "boolean"
},
{
"name": "hideUpdateButton",
"type": "boolean"
},
{
"name": "icon",
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
"type": "string"
},
{
"name": "label",
"description": "The widget's label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)",
"type": "string"
},
{
"name": "position",
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
},
{
"name": "referenceElement",
"description": "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.",
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
},
{
"name": "state",
"description": "The current state of the component.",
"type": "\"disabled\" | \"loading\" | \"ready\""
},
{
"name": "submitting",
"description": "Indicates whether there is currently an attachment being added, updated or deleted.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#submitting)",
"type": "boolean"
}
],
"events": [
{
"name": "arcgisPropertyChange",
"type": "{ name: \"state\" | \"submitting\"; }",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
},
{
"name": "arcgisReady",
"type": "void",
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
}
]
}
},
{
"name": "arcgis-basemap-gallery",
"description": "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.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/",
"attributes": [
{
"name": "active-basemap",
"description": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).",
"value": {
"type": "string"
}
},
{
"name": "auto-destroy-disabled",
"description": "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/arcgis-basemap-gallery/#destroy) method when you are done to\nprevent memory leaks.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "disabled",
"description": "When `true`, sets the component to a disabled state so the user cannot interact with it.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "heading-level",
"description": "Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the Basemap Gallery.",
"default": "2",
"value": {
"type": [
"1",
"2",
"3",
"4",
"5",
"6"
]
}
},
{
"name": "icon",
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
"default": "\"basemap\"",
"value": {
"type": "string"
}
},
{
"name": "label",
"description": "The component's default label.",
"default": "\"\"",
"value": {
"type": "string"
}
},
{
"name": "position",
"default": "\"bottom-left\"",
"value": {
"type": [
"\"bottom-leading\"",
"\"bottom-left\"",
"\"bottom-right\"",
"\"bottom-trailing\"",
"\"manual\"",
"\"top-leading\"",
"\"top-left\"",
"\"top-right\"",
"\"top-trailing\""
]
}
},
{
"name": "reference-element",
"description": "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.",
"value": {
"type": "string"
}
},
{
"name": "state",
"description": "The current state of the component.",
"default": "\"disabled\"",
"value": {
"type": [
"\"disabled\"",
"\"loading\"",
"\"ready\"",
"\"unsupported\""
]
}
}
],
"events": [
{
"name": "arcgisPropertyChange",
"type": "{ name: \"state\" | \"activeBasemap\"; }",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
},
{
"name": "arcgisReady",
"type": "void",
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
}
],
"js": {
"properties": [
{
"name": "activeBasemap",
"description": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).",
"type": "BasemapProperties | string"
},
{
"name": "autoDestroyDisabled",
"description": "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/arcgis-basemap-gallery/#destroy) method when you are done to\nprevent memory leaks.",
"type": "boolean"
},
{
"name": "disabled",
"description": "When `true`, sets the component to a disabled state so the user cannot interact with it.",
"type": "boolean"
},
{
"name": "headingLevel",
"description": "Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the Basemap Gallery.",
"type": "1 | 2 | 3 | 4 | 5 | 6"
},
{
"name": "icon",
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
"type": "string"
},
{
"name": "label",
"description": "The component's default label.",
"type": "string"
},
{
"name": "messageOverrides",
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
"type": "Record<string, unknown>"
},
{
"name": "position",
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
},
{
"name": "referenceElement",
"description": "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.",
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
},
{
"name": "source",
"description": "The source for basemaps that the component will display.",
"type": "LocalBasemapsSource | PortalBasemapsSource"
},
{
"name": "state",
"description": "The current state of the component.",
"type": "\"disabled\" | \"loading\" | \"ready\" | \"unsupported\""
}
],
"events": [
{
"name": "arcgisPropertyChange",
"type": "{ name: \"state\" | \"activeBasemap\"; }",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
},
{
"name": "arcgisReady",
"type": "void",
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
}
]
}
},
{
"name": "arcgis-basemap-layer-list",
"description": "The Basemap Layer List component provides a way to display a list of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers and switch on/off their visibility. [Base layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#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.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/",
"attributes": [
{
"name": "auto-destroy-disabled",
"description": "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/arcgis-basemap-layer-list/#destroy) method when you are done to\nprevent memory leaks.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "base-filter-text",
"description": "The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.",
"default": "\"\"",
"value": {
"type": "string"
}
},
{
"name": "basemap-title",
"description": "The current basemap's title.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#basemapTitle)",
"value": {
"type": "string"
}
},
{
"name": "closed",
"description": "Indicates whether a component is closed. When `true`, the component will be hidden.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "collapsed",
"description": "Indicates whether the widget is collapsed.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "drag-enabled",
"description": "Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "editing-title",
"description": "Indicates whether the form to edit the basemap's title is currently visible.",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "filter-placeholder",
"description": "Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.",
"default": "\"\"",
"value": {
"type": "string"
}
},
{
"name": "heading-level",
"description": "Indicates the heading level to use for the widget title (i.e.",
"default": "2",
"value": {
"type": "number"
}
},
{
"name": "hide-base-layers",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-flow",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-heading",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-reference-layers",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "hide-status-indicators",
"default": "false",
"value": {
"type": "boolean"
}
},
{
"name": "icon",
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
"default": "\"layers\"",
"value": {
"type": "string"
}
},
{
"name": "label",
"description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#label)",
"value": {
"type": "string"
}
},
{
"name": "min-filter-items",
"description": "The minimum number of list items required to display the visibleElements.filter input box.",
"default": "10",