@arcgis/map-components

{ "timestamp": "2025-03-26T22:39:01", "compiler": { "name": "@arcgis/lumina-compiler", "version": "4.32.13", "typescriptVersion": "5.6.3" }, "components": [ { "filePath": "src/components/area-measurement-2d/area-measurement-2d.tsx", "tag": "arcgis-area-measurement-2d", "overview": "", "readme": "", "usage": {}, "docs": "AreaMeasurement2D 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).", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "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\\` method when you are done to prevent\nmemory leaks.", "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).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "docsTags": [], "default": "\"measure-area\"", "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": "position", "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"", "complexType": { "original": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"", "resolved": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"", "references": {} }, "mutable": true, "attr": "position", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "\"bottom-left\"", "values": [ { "value": "bottom-leading", "type": "string" }, { "value": "bottom-left", "type": "string" }, { "value": "bottom-right", "type": "string" }, { "value": "bottom-trailing", "type": "string" }, { "value": "manual", "type": "string" }, { "value": "top-leading", "type": "string" }, { "value": "top-left", "type": "string" }, { "value": "top-right", "type": "string" }, { "value": "top-trailing", "type": "string" } ], "optional": true, "required": false }, { "name": "referenceElement", "type": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string", "complexType": { "original": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string", "resolved": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string", "references": { "ArcgisLinkChart": { "location": "local", "path": "dist/components/arcgis-link-chart/customElement.d.ts", "id": "notImplemented" }, "ArcgisMap": { "location": "local", "path": "dist/components/arcgis-map/customElement.d.ts", "id": "notImplemented" }, "ArcgisScene": { "location": "local", "path": "dist/components/arcgis-scene/customElement.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "reference-element", "reflectToAttr": false, "docs": "", "docsTags": [], "values": [ { "type": "ArcgisLinkChart" }, { "type": "ArcgisMap" }, { "type": "ArcgisScene" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "snappingOptions", "type": "SnappingOptions", "complexType": { "original": "SnappingOptions", "resolved": "SnappingOptions", "references": { "SnappingOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "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)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"", "resolved": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The ViewModel's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "measured", "type": "string" }, { "value": "measuring", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "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\"", "complexType": { "original": "\"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\"", "resolved": "\"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\"", "references": {} }, "mutable": true, "attr": "unit", "reflectToAttr": false, "docs": "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)", "docsTags": [], "values": [ { "value": "acres", "type": "string" }, { "value": "ares", "type": "string" }, { "value": "hectares", "type": "string" }, { "value": "imperial", "type": "string" }, { "value": "metric", "type": "string" }, { "value": "square-centimeters", "type": "string" }, { "value": "square-decimeters", "type": "string" }, { "value": "square-feet", "type": "string" }, { "value": "square-inches", "type": "string" }, { "value": "square-kilometers", "type": "string" }, { "value": "square-meters", "type": "string" }, { "value": "square-miles", "type": "string" }, { "value": "square-millimeters", "type": "string" }, { "value": "square-nautical-miles", "type": "string" }, { "value": "square-us-feet", "type": "string" }, { "value": "square-yards", "type": "string" } ], "optional": true, "required": false }, { "name": "unitOptions", "type": "Array<\"metric\" | \"imperial\" | \"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\">", "complexType": { "original": "Array<\"metric\" | \"imperial\" | \"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\">", "resolved": "Array<\"metric\" | \"imperial\" | \"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\">", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "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)", "docsTags": [], "values": [], "optional": true, "required": false } ], "methods": [ { "name": "componentOnReady", "returns": { "type": "Promise<void>", "docs": "" }, "complexType": { "signature": "(): Promise<void>", "parameters": [], "return": "Promise<void>", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "componentOnReady(): Promise<void>", "parameters": [], "docs": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisAreaMeasurement2d = document.createElement(\"arcgis-area-measurement-2d\");\ndocument.body.append(arcgisAreaMeasurement2d);\narcgisAreaMeasurement2d.componentOnReady().then(() => {\n console.log(\"arcgis-area-measurement-2d is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise<void>", "docs": "" }, "complexType": { "signature": "(): Promise<void>", "parameters": [], "return": "Promise<void>", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise<void>", "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": "undefined", "bubbles": true, "complexType": { "original": "undefined", "resolved": "undefined", "references": {} }, "cancelable": true, "composed": true, "docs": "Emitted when the component associated with a map view is 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": "AreaMeasurement3D component calculates and displays the area and perimeter of a polygon. This component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the area and perimeter of a polygon.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "analysis", "type": "AreaMeasurementAnalysis", "complexType": { "original": "AreaMeasurementAnalysis", "resolved": "AreaMeasurementAnalysis", "references": { "AreaMeasurementAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The area measurement analysis object being created or modified by the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#analysis)", "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\\` method when you are done to prevent\nmemory leaks.", "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).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "docsTags": [], "default": "\"measure-area\"", "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": "position", "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"", "complexType": { "original": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"", "resolved": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"", "references": {} }, "mutable": true, "attr": "position", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "\"bottom-left\"", "values": [ { "value": "bottom-leading", "type": "string" }, { "value": "bottom-left", "type": "string" }, { "value": "bottom-right", "type": "string" }, { "value": "bottom-trailing", "type": "string" }, { "value": "manual", "type": "string" }, { "value": "top-leading", "type": "string" }, { "value": "top-left", "type": "string" }, { "value": "top-right", "type": "string" }, { "value": "top-trailing", "type": "string" } ], "optional": true, "required": false }, { "name": "referenceElement", "type": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string", "complexType": { "original": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string", "resolved": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string", "references": { "ArcgisLinkChart": { "location": "local", "path": "dist/components/arcgis-link-chart/customElement.d.ts", "id": "notImplemented" }, "ArcgisMap": { "location": "local", "path": "dist/components/arcgis-map/customElement.d.ts", "id": "notImplemented" }, "ArcgisScene": { "location": "local", "path": "dist/components/arcgis-scene/customElement.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "reference-element", "reflectToAttr": false, "docs": "", "docsTags": [], "values": [ { "type": "ArcgisLinkChart" }, { "type": "ArcgisMap" }, { "type": "ArcgisScene" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"", "resolved": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "measured", "type": "string" }, { "value": "measuring", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "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\"", "complexType": { "original": "\"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\"", "resolved": "\"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\"", "references": {} }, "mutable": true, "attr": "unit", "reflectToAttr": false, "docs": "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-AreaMeasurement3D.html#unit)", "docsTags": [], "values": [ { "value": "acres", "type": "string" }, { "value": "ares", "type": "string" }, { "value": "hectares", "type": "string" }, { "value": "imperial", "type": "string" }, { "value": "metric", "type": "string" }, { "value": "square-centimeters", "type": "string" }, { "value": "square-decimeters", "type": "string" }, { "value": "square-feet", "type": "string" }, { "value": "square-inches", "type": "string" }, { "value": "square-kilometers", "type": "string" }, { "value": "square-meters", "type": "string" }, { "value": "square-miles", "type": "string" }, { "value": "square-millimeters", "type": "string" }, { "value": "square-nautical-miles", "type": "string" }, { "value": "square-us-feet", "type": "string" }, { "value": "square-yards", "type": "string" } ], "optional": true, "required": false }, { "name": "unitOptions", "type": "Array<\"metric\" | \"imperial\" | \"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\">", "complexType": { "original": "Array<\"metric\" | \"imperial\" | \"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\">", "resolved": "Array<\"metric\" | \"imperial\" | \"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\">", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "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-AreaMeasurement3D.html#unitOptions)", "docsTags": [], "values": [], "optional": true, "required": false } ], "methods": [ { "name": "clear", "returns": { "type": "Promise<void>", "docs": "" }, "complexType": { "signature": "(): Promise<void>", "parameters": [], "return": "Promise<void>", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clear(): Promise<void>", "parameters": [], "docs": "Clears the component.", "docsTags": [] }, { "name": "componentOnReady", "returns": { "type": "Promise<void>", "docs": "" }, "complexType": { "signature": "(): Promise<void>", "parameters": [], "return": "Promise<void>", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "componentOnReady(): Promise<void>", "parameters": [], "docs": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisAreaMeasurement3d = document.createElement(\"arcgis-area-measurement-3d\");\ndocument.body.append(arcgisAreaMeasurement3d);\narcgisAreaMeasurement3d.componentOnReady().then(() => {\n console.log(\"arcgis-area-measurement-3d is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise<void>", "docs": "" }, "complexType": { "signature": "(): Promise<void>", "parameters": [], "return": "Promise<void>", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise<void>", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "start", "returns": { "type": "Promise<void>", "docs": "" }, "complexType": { "signature": "(): Promise<void>", "parameters": [], "return": "Promise<void>", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "start(): Promise<void>", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"analysis\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"analysis\"; }", "resolved": "{ name: \"state\" | \"analysis\"; }", "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": "undefined", "bubbles": true, "complexType": { "original": "undefined", "resolved": "undefined", "references": {} }, "cancelable": true, "composed": true, "docs": "Emitted when the component associated with a map view is 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\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "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\\` method when you are done to prevent\nmemory 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/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "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)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "displayType", "type": "\"auto\" | \"list\" | \"preview\"", "complexType": { "original": "\"auto\" | \"list\" | \"preview\"", "resolved": "\"auto\" | \"list\" | \"preview\"", "references": {} }, "mutable": true, "attr": "display-type", "reflectToAttr": false, "docs": "A string value indicating how to display an attachment.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#displayType)", "docsTags": [], "default": "\"auto\"", "values": [ { "value": "auto", "type": "string" }, { "value": "list", "type": "string" }, { "value": "preview", "type": "string" } ], "optional": true, "required": false }, { "name": "graphic", "type": "Graphic", "complexType": { "original": "Graphic", "resolved": "Graphic", "references": { "Graphic": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The graphic for the attachments.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#graphic)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "hideAddButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-add-button", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideAddSubmitButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-add-submit-button", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideCancelAddButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-cancel-add-button", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideCancelUpdateButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-cancel-update-button", "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideErrorMessage", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-error-message", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideProgressBar", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-progress-bar", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideUpdateButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-update-button", "reflectToAttr": false, "docs": "", "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).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "docsTags": [], "default": "\"attachment\"", "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": "position", "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"", "complexType": { "original": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"", "resolved": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"", "references": {} }, "mutable": true, "attr": "position", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "\"bottom-left\"", "values": [ { "value": "bottom-leading", "type": "string" }, { "value": "bottom-left", "type": "string" }, { "value": "bottom-right", "type": "string" }, { "value": "bottom-trailing", "type": "string" }, { "value": "manual", "type": "string" }, { "value": "top-leading", "type": "string" }, { "value": "top-left", "type": "string" }, { "value": "top-right", "type": "string" }, { "value": "top-trailing", "type": "string" } ], "optional": true, "required": false }, { "name": "referenceElement", "type": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string", "complexType": { "original": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string", "resolved": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string", "references": { "ArcgisLinkChart": { "location": "local", "path": "dist/components/arcgis-link-chart/customElement.d.ts", "id": "notImplemented" }, "ArcgisMap": { "location": "local", "path": "dist/components/arcgis-map/customElement.d.ts", "id": "notImplemented" }, "ArcgisScene": { "location": "local", "path": "dist/components/arcgis-scene/customElement.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "reference-element", "reflectToAttr": false, "docs": "", "docsTags": [], "values": [ { "type": "ArcgisLinkChart" }, { "type": "ArcgisMap" }, { "type": "ArcgisScene" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"loading\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"loading\" | \"ready\"", "resolved": "\"disabled\" | \"loading\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"ready\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#submitting)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false } ], "methods": [ { "name": "componentOnReady", "returns": { "type": "Promise<void>", "docs": "" }, "complexType": { "signature": "(): Promise<void>", "parameters": [], "return": "Promise<void>", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "componentOnReady(): Promise<void>", "parameters": [], "docs": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisAttachments = document.createElement(\"arcgis-a