{ "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", "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": "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", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clear(): Promise", "parameters": [], "docs": "Clears 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": "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", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "start(): Promise", "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", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisAttachments = document.createElement(\"arcgis-attachments\");\ndocument.body.append(arcgisAttachments);\narcgisAttachments.componentOnReady().then(() => {\n console.log(\"arcgis-attachments is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"submitting\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"submitting\"; }", "resolved": "{ name: \"state\" | \"submitting\"; }", "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/basemap-gallery/basemap-gallery.tsx", "tag": "arcgis-basemap-gallery", "overview": "", "readme": "", "usage": {}, "docs": "BasemapGallery 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 BasemapGallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeBasemap", "type": "Basemap", "complexType": { "original": "Basemap", "resolved": "Basemap", "references": { "Basemap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).", "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\\` method when you are done to prevent\nmemory 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`, sets the component to a disabled state so the user cannot interact with it.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "1 | 2 | 3 | 4 | 5 | 6", "complexType": { "original": "1 | 2 | 3 | 4 | 5 | 6", "resolved": "1 | 2 | 3 | 4 | 5 | 6", "references": {} }, "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 BasemapGallery.", "docsTags": [], "default": "2", "values": [ { "value": "1", "type": "number" }, { "value": "2", "type": "number" }, { "value": "3", "type": "number" }, { "value": "4", "type": "number" }, { "value": "5", "type": "number" }, { "value": "6", "type": "number" } ], "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": "\"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": "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": "source", "type": "LocalBasemapsSource | PortalBasemapsSource", "complexType": { "original": "LocalBasemapsSource | PortalBasemapsSource", "resolved": "LocalBasemapsSource | PortalBasemapsSource", "references": { "LocalBasemapsSource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "PortalBasemapsSource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The source for basemaps that the component will display.", "docsTags": [], "values": [ { "type": "LocalBasemapsSource" }, { "type": "PortalBasemapsSource" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"loading\" | \"ready\" | \"unsupported\"", "complexType": { "original": "\"disabled\" | \"loading\" | \"ready\" | \"unsupported\"", "resolved": "\"disabled\" | \"loading\" | \"ready\" | \"unsupported\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" }, { "value": "unsupported", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisBasemapGallery = document.createElement(\"arcgis-basemap-gallery\");\ndocument.body.append(arcgisBasemapGallery);\narcgisBasemapGallery.componentOnReady().then(() => {\n console.log(\"arcgis-basemap-gallery is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"activeBasemap\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"activeBasemap\"; }", "resolved": "{ name: \"state\" | \"activeBasemap\"; }", "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/basemap-layer-list/basemap-layer-list.tsx", "tag": "arcgis-basemap-layer-list", "overview": "", "readme": "", "usage": {}, "docs": "BasemapLayerList 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.", "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": "baseFilterPredicate", "type": "(((item: ListItem) => void))", "complexType": { "original": "(((item: ListItem) => void))", "resolved": "(((item: ListItem) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Specifies a function to handle filtering base layer [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseFilterPredicate)", "docsTags": [], "default": "null", "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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseFilterText)", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "baseItems", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "(((event: any) => void))", "complexType": { "original": "(((event: any) => void))", "resolved": "(((event: any) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a base layer.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseListItemCreatedFunction)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "basemapTitle", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "basemap-title", "reflectToAttr": false, "docs": "The current basemap's title.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#basemapTitle)", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "catalogLayerList", "type": "CatalogLayerList", "complexType": { "original": "CatalogLayerList", "resolved": "CatalogLayerList", "references": { "CatalogLayerList": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "BasemapLayerListCatalogOptions", "complexType": { "original": "BasemapLayerListCatalogOptions", "resolved": "BasemapLayerListCatalogOptions", "references": { "BasemapLayerListCatalogOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "[CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) specific properties.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#catalogOptions)", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "collapsed", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "collapsed", "reflectToAttr": true, "docs": "Indicates whether the widget is collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#collapsed)", "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 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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#dragEnabled)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#editingTitle)", "docsTags": [], "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/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#filterPlaceholder)", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the widget title (i.e.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#headingLevel)", "docsTags": [], "default": "2", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideBaseLayers", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-base-layers", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideFlow", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-flow", "reflectToAttr": false, "docs": "", "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": "", "docsTags": [], "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": "", "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": "", "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": "\"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 visibleElements.filter input box.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#minFilterItems)", "docsTags": [], "default": "10", "values": [ { "type": "number" } ], "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": "referenceFilterPredicate", "type": "(((item: ListItem) => void))", "complexType": { "original": "(((item: ListItem) => void))", "resolved": "(((item: ListItem) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Specifies a function to handle filtering reference layer [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#referenceFilterPredicate)", "docsTags": [], "default": "null", "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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#referenceFilterText)", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "referenceItems", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "(((event: any) => void))", "complexType": { "original": "(((event: any) => void))", "resolved": "(((event: any) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a reference layer.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#referenceListItemCreatedFunction)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "selectedItems", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing basemap layers\nselected by the user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectedItems)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "selectionMode", "type": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "complexType": { "original": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "resolved": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "references": {} }, "mutable": true, "attr": "selection-mode", "reflectToAttr": false, "docs": "Specifies the selection mode.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectionMode)", "docsTags": [], "default": "\"none\"", "values": [ { "value": "multiple", "type": "string" }, { "value": "none", "type": "string" }, { "value": "single", "type": "string" }, { "value": "single-persist", "type": "string" } ], "optional": true, "required": false }, { "name": "showCloseButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-close-button", "reflectToAttr": false, "docs": "", "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": "", "docsTags": [], "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": "", "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": "", "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": "", "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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 view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "visibilityAppearance", "type": "\"checkbox\" | \"default\"", "complexType": { "original": "\"checkbox\" | \"default\"", "resolved": "\"checkbox\" | \"default\"", "references": {} }, "mutable": true, "attr": "visibility-appearance", "reflectToAttr": false, "docs": "Determines the icons used to indicate visibility.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibilityAppearance)", "docsTags": [], "default": "\"default\"", "values": [ { "value": "checkbox", "type": "string" }, { "value": "default", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisBasemapLayerList = document.createElement(\"arcgis-basemap-layer-list\");\ndocument.body.append(arcgisBasemapLayerList);\narcgisBasemapLayerList.componentOnReady().then(() => {\n console.log(\"arcgis-basemap-layer-list is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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": [] }, { "event": "arcgisTriggerAction", "detail": "BasemapLayerListTriggerActionEvent", "bubbles": true, "complexType": { "original": "BasemapLayerListTriggerActionEvent", "resolved": "BasemapLayerListTriggerActionEvent", "references": { "BasemapLayerListTriggerActionEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "Basemap Toggle component allows an end-user to switch between two basemaps.\n\nThe basemaps can have different spatial references.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeBasemap", "type": "Basemap", "complexType": { "original": "Basemap", "resolved": "Basemap", "references": { "Basemap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#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\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory 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": true, "docs": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).", "docsTags": [], "default": "\"layer-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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "messageOverrides", "type": "{\n componentLabel?: string | undefined;\n incompatibleSpatialReference?: string | undefined;\n}", "complexType": { "original": "{\n componentLabel?: string | undefined;\n incompatibleSpatialReference?: string | undefined;\n}", "resolved": "{\n componentLabel?: string | undefined;\n incompatibleSpatialReference?: string | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "nextBasemap", "type": "Basemap", "complexType": { "original": "Basemap", "resolved": "Basemap", "references": { "Basemap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The next basemap for toggling.", "docsTags": [], "values": [], "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": true, "docs": "", "docsTags": [], "default": "\"top-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": "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": "\"disabled\" | \"incompatible-next-basemap\" | \"loading\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"incompatible-next-basemap\" | \"loading\" | \"ready\"", "resolved": "\"disabled\" | \"incompatible-next-basemap\" | \"loading\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "incompatible-next-basemap", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisBasemapToggle = document.createElement(\"arcgis-basemap-toggle\");\ndocument.body.append(arcgisBasemapToggle);\narcgisBasemapToggle.componentOnReady().then(() => {\n console.log(\"arcgis-basemap-toggle is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "toggle(): Promise", "parameters": [], "docs": "Toggles to the [next basemap](#nextBasemap).", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"nextBasemap\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"nextBasemap\"; }", "resolved": "{ name: \"state\" | \"nextBasemap\"; }", "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/bookmarks/bookmarks.tsx", "tag": "arcgis-bookmarks", "overview": "", "readme": "", "usage": {}, "docs": "Bookmarks component allow end users to quickly navigate to a particular area of interest. It displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html), which are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks).", "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": "bookmarks", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Bookmark": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#bookmarks)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "defaultCreateOptions", "type": "BookmarkOptions", "complexType": { "original": "BookmarkOptions", "resolved": "BookmarkOptions", "references": { "BookmarkOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Specifies how new bookmarks will be created if [visibleElements.addBookmarkButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#defaultCreateOptions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "defaultEditOptions", "type": "BookmarkOptions", "complexType": { "original": "BookmarkOptions", "resolved": "BookmarkOptions", "references": { "BookmarkOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Specifies how bookmarks will be edited, if [visibleElements.editBookmarkButton](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#VisibleElements) is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#defaultEditOptions)", "docsTags": [], "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 widget is visually withdrawn and cannot be interacted with.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#disabled)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#dragEnabled)", "docsTags": [], "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 visibleElements.filter is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterPlaceholder)", "docsTags": [], "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 visibleElements.filter is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterText)", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "hideFlow", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-flow", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideThumbnail", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-thumbnail", "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "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": "\"bookmark\"", "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": "showAddBookmarkButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-add-bookmark-button", "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "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": "", "docsTags": [], "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": "", "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": "", "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "state", "type": "\"loading\" | \"ready\"", "complexType": { "original": "\"loading\" | \"ready\"", "resolved": "\"loading\" | \"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-Bookmarks-BookmarksViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"ready\"", "values": [ { "value": "loading", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisBookmarks = document.createElement(\"arcgis-bookmarks\");\ndocument.body.append(arcgisBookmarks);\narcgisBookmarks.componentOnReady().then(() => {\n console.log(\"arcgis-bookmarks is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "event": "arcgisEdit", "detail": "BookmarksBookmarkEditEvent", "bubbles": true, "complexType": { "original": "BookmarksBookmarkEditEvent", "resolved": "BookmarksBookmarkEditEvent", "references": { "BookmarksBookmarkEditEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "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": [] }, { "event": "arcgisSelect", "detail": "BookmarksBookmarkSelectEvent", "bubbles": true, "complexType": { "original": "BookmarksBookmarkSelectEvent", "resolved": "BookmarksBookmarkSelectEvent", "references": { "BookmarksBookmarkSelectEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when the component is selected.", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/building-explorer/building-explorer.tsx", "tag": "arcgis-building-explorer", "overview": "", "readme": "", "usage": {}, "docs": "BuildingExplorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.", "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": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the headings in the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#headingLevel)", "docsTags": [], "default": "3", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideDisciplines", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-disciplines", "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "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": "\"organization\"", "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": "layers", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "BuildingSceneLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html)\nthat are added to the widget for exploration.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#layers)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "level", "type": "BuildingLevel", "complexType": { "original": "BuildingLevel", "resolved": "BuildingLevel", "references": { "BuildingLevel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Contains information about the level filter, such as\nthe value selected by the user in the Level element\nor the minimum and maximum allowed values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#level)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "phase", "type": "BuildingPhase", "complexType": { "original": "BuildingPhase", "resolved": "BuildingPhase", "references": { "BuildingPhase": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Contains information about the construction phase filter, such as\nthe value selected by the user in the Construction phases element\nand the minimum and maximum allowed values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#phase)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "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\" | \"failed\" | \"loading\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"failed\" | \"loading\" | \"ready\"", "resolved": "\"disabled\" | \"failed\" | \"loading\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the view model that can be used for rendering the UI of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "failed", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisBuildingExplorer = document.createElement(\"arcgis-building-explorer\");\ndocument.body.append(arcgisBuildingExplorer);\narcgisBuildingExplorer.componentOnReady().then(() => {\n console.log(\"arcgis-building-explorer is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"level\" | \"phase\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"level\" | \"phase\"; }", "resolved": "{ name: \"state\" | \"level\" | \"phase\"; }", "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/catalog-layer-list/catalog-layer-list.tsx", "tag": "arcgis-catalog-layer-list", "overview": "", "readme": "", "usage": {}, "docs": "The CatalogLayerList component provides a way to display and interact with CatalogLayers.", "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": "catalogItems", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of ListItems representing the catalogLayers dynamicGroupLayer.", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "catalogLayer", "type": "CatalogLayer", "complexType": { "original": "CatalogLayer", "resolved": "CatalogLayer", "references": { "CatalogLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) to display in the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#catalogLayer)", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "collapsed", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "collapsed", "reflectToAttr": true, "docs": "Indicates whether the widget is collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#collapsed)", "docsTags": [], "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/api-reference/esri-widgets-CatalogLayerList.html#visibleElements) is true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#filterPlaceholder)", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "filterPredicate", "type": "(((item: ListItem) => void))", "complexType": { "original": "(((item: ListItem) => void))", "resolved": "(((item: ListItem) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#filterPredicate)", "docsTags": [], "default": "null", "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/api-reference/esri-widgets-CatalogLayerList.html#visibleElements) is true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#filterText)", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the heading of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#headingLevel)", "docsTags": [], "default": "2", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideFlow", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-flow", "reflectToAttr": false, "docs": "", "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": "", "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": "\"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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "listItemCreatedFunction", "type": "(((event: any) => void))", "complexType": { "original": "(((event: any) => void))", "resolved": "(((event: any) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) is created.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#listItemCreatedFunction)", "docsTags": [], "default": "null", "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 visibleElements.filter input box.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#minFilterItems)", "docsTags": [], "default": "10", "values": [ { "type": "number" } ], "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": "selectedItems", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of selected [ListItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing [catalogItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#catalogItems)\nselected by the user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#selectedItems)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "selectionMode", "type": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "complexType": { "original": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "resolved": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "references": {} }, "mutable": true, "attr": "selection-mode", "reflectToAttr": false, "docs": "Specifies the selection mode.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#selectionMode)", "docsTags": [], "default": "\"none\"", "values": [ { "value": "multiple", "type": "string" }, { "value": "none", "type": "string" }, { "value": "single", "type": "string" }, { "value": "single-persist", "type": "string" } ], "optional": true, "required": false }, { "name": "showCloseButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-close-button", "reflectToAttr": false, "docs": "", "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": "", "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": "", "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": "", "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": "", "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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 view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList-CatalogLayerListViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "visibilityAppearance", "type": "\"checkbox\" | \"default\"", "complexType": { "original": "\"checkbox\" | \"default\"", "resolved": "\"checkbox\" | \"default\"", "references": {} }, "mutable": true, "attr": "visibility-appearance", "reflectToAttr": false, "docs": "Determines the icons used to indicate visibility.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#visibilityAppearance)", "docsTags": [], "default": "\"default\"", "values": [ { "value": "checkbox", "type": "string" }, { "value": "default", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisCatalogLayerList = document.createElement(\"arcgis-catalog-layer-list\");\ndocument.body.append(arcgisCatalogLayerList);\narcgisCatalogLayerList.componentOnReady().then(() => {\n console.log(\"arcgis-catalog-layer-list is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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": [] }, { "event": "arcgisTriggerAction", "detail": "CatalogLayerListTriggerActionEvent", "bubbles": true, "complexType": { "original": "CatalogLayerListTriggerActionEvent", "resolved": "CatalogLayerListTriggerActionEvent", "references": { "CatalogLayerListTriggerActionEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-MapView.html#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading).", "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": true, "docs": "", "docsTags": [], "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": "messageOverrides", "type": "{\n componentLabel?: string | undefined;\n reset?: string | undefined;\n}", "complexType": { "original": "{\n componentLabel?: string | undefined;\n reset?: string | undefined;\n}", "resolved": "{\n componentLabel?: string | undefined;\n reset?: string | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "orientation", "type": "Orientation", "complexType": { "original": "Orientation", "resolved": "Orientation", "references": { "Orientation": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The z axis orientation.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "{ z: 0 }", "values": [], "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": true, "docs": "", "docsTags": [], "default": "\"top-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": "\"compass\" | \"disabled\" | \"rotation\"", "complexType": { "original": "\"compass\" | \"disabled\" | \"rotation\"", "resolved": "\"compass\" | \"disabled\" | \"rotation\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "compass", "type": "string" }, { "value": "disabled", "type": "string" }, { "value": "rotation", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisCompass = document.createElement(\"arcgis-compass\");\ndocument.body.append(arcgisCompass);\narcgisCompass.componentOnReady().then(() => {\n console.log(\"arcgis-compass is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "reset", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "reset(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"orientation\" | \"state\"; }", "bubbles": true, "complexType": { "original": "{ name: \"orientation\" | \"state\"; }", "resolved": "{ name: \"orientation\" | \"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/coordinate-conversion/coordinate-conversion.tsx", "tag": "arcgis-coordinate-conversion", "overview": "", "readme": "", "usage": {}, "docs": "CoordinateConversion component provides a way to display user cursor position either as map coordinates or as any of several popular coordinate notations. Additionally, the component provides a way to convert user input coordinates into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.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": "conversions", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Conversion": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Conversion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Conversion.html)\nthat the widget is currently displaying.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#conversions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "currentLocation", "type": "Point", "complexType": { "original": "Point", "resolved": "Point", "references": { "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Describes the location of the coordinates currently displayed by the widget as a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#currentLocation)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "formats", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Format": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) containing every [Format](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-support-Format.html)\nthat the widget is capable of displaying.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#formats)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the coordinate input and coordinate settings headings.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#headingLevel)", "docsTags": [], "default": "4", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideCaptureButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-capture-button", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideEditButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-edit-button", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideExpandButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-expand-button", "reflectToAttr": false, "docs": "", "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": "", "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": "\"coordinate-system\"", "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": "locationSymbol", "type": "CIMSymbol | PictureMarkerSymbol | PointSymbol3D | SimpleMarkerSymbol", "complexType": { "original": "CIMSymbol | PictureMarkerSymbol | PointSymbol3D | SimpleMarkerSymbol", "resolved": "CIMSymbol | PictureMarkerSymbol | PointSymbol3D | SimpleMarkerSymbol", "references": { "CIMSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "PictureMarkerSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "PointSymbol3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SimpleMarkerSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "This symbol is used to visualize the location currently described by the widget when `capture` mode\nis active.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#locationSymbol)", "docsTags": [], "values": [ { "type": "CIMSymbol" }, { "type": "PictureMarkerSymbol" }, { "type": "PointSymbol3D" }, { "type": "SimpleMarkerSymbol" } ], "optional": true, "required": false }, { "name": "mode", "type": "\"capture\" | \"live\"", "complexType": { "original": "\"capture\" | \"live\"", "resolved": "\"capture\" | \"live\"", "references": {} }, "mutable": true, "attr": "mode", "reflectToAttr": false, "docs": "Describes the current mode of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#mode)", "docsTags": [], "default": "\"live\"", "values": [ { "value": "capture", "type": "string" }, { "value": "live", "type": "string" } ], "optional": true, "required": false }, { "name": "multipleConversionsDisabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "multiple-conversions-disabled", "reflectToAttr": false, "docs": "If this property is set to `false`, multiple conversions cannot be displayed.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "orientation", "type": "\"auto\" | \"expand-down\" | \"expand-up\"", "complexType": { "original": "\"auto\" | \"expand-down\" | \"expand-up\"", "resolved": "\"auto\" | \"expand-down\" | \"expand-up\"", "references": {} }, "mutable": true, "attr": "orientation", "reflectToAttr": false, "docs": "Determines whether the widget should expand up or down.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#orientation)", "docsTags": [], "default": "\"auto\"", "values": [ { "value": "auto", "type": "string" }, { "value": "expand-down", "type": "string" }, { "value": "expand-up", "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 view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion-CoordinateConversionViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "storageDisabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "storage-disabled", "reflectToAttr": false, "docs": "Unless this property is set to `false`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageType))\nwill be used to hydrate and persist the CoordinateConversion widget's state.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "storageType", "type": "\"local\" | \"session\"", "complexType": { "original": "\"local\" | \"session\"", "resolved": "\"local\" | \"session\"", "references": {} }, "mutable": true, "attr": "storage-type", "reflectToAttr": false, "docs": "This property determines whether sessionStorage or localStorage will be used to store widget state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#storageType)", "docsTags": [], "default": "\"session\"", "values": [ { "value": "local", "type": "string" }, { "value": "session", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisCoordinateConversion = document.createElement(\"arcgis-coordinate-conversion\");\ndocument.body.append(arcgisCoordinateConversion);\narcgisCoordinateConversion.componentOnReady().then(() => {\n console.log(\"arcgis-coordinate-conversion is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "reverseConvert", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(coordinate: string, format: __esri.Format): Promise<__esri.Point | nullish>", "parameters": [ { "name": "coordinate", "type": "string", "docs": "" }, { "name": "format", "type": "Format", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Format": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "reverseConvert(coordinate: string, format: __esri.Format): Promise<__esri.Point | nullish>", "parameters": [ { "name": "coordinate", "type": "string", "docs": "" }, { "name": "format", "type": "Format", "docs": "" } ], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"currentLocation\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"currentLocation\"; }", "resolved": "{ name: \"state\" | \"currentLocation\"; }", "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/daylight/daylight.tsx", "tag": "arcgis-daylight", "overview": "", "readme": "", "usage": {}, "docs": "Daylight component can be used to manipulate the lighting conditions of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.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": "currentSeason", "type": "\"fall\" | \"spring\" | \"summer\" | \"winter\"", "complexType": { "original": "\"fall\" | \"spring\" | \"summer\" | \"winter\"", "resolved": "\"fall\" | \"spring\" | \"summer\" | \"winter\"", "references": {} }, "mutable": true, "attr": "current-season", "reflectToAttr": false, "docs": "A season can be set instead of a date.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#currentSeason)", "docsTags": [], "values": [ { "value": "fall", "type": "string" }, { "value": "spring", "type": "string" }, { "value": "summer", "type": "string" }, { "value": "winter", "type": "string" } ], "optional": true, "required": false }, { "name": "dateOrSeason", "type": "\"date\" | \"season\"", "complexType": { "original": "\"date\" | \"season\"", "resolved": "\"date\" | \"season\"", "references": {} }, "mutable": true, "attr": "date-or-season", "reflectToAttr": false, "docs": "Controls whether the widget displays a date or a season picker.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)", "docsTags": [], "default": "\"date\"", "values": [ { "value": "date", "type": "string" }, { "value": "season", "type": "string" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#dayPlaying)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the widget title.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#headingLevel)", "docsTags": [], "default": "3", "values": [ { "type": "number" } ], "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": "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": "\"brightness\"", "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": "playSpeedMultiplier", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "play-speed-multiplier", "reflectToAttr": false, "docs": "Controls the speed of the daytime and date animation.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#playSpeedMultiplier)", "docsTags": [], "default": "1.0", "values": [ { "type": "number" } ], "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": "timeSliderSteps", "type": "Array | number", "complexType": { "original": "Array | number", "resolved": "Array | number", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "time-slider-steps", "reflectToAttr": false, "docs": "Sets steps, or intervals, on the time slider to restrict the times\nof the day that can be selected when dragging the thumb.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps)", "docsTags": [], "default": "5", "values": [ { "type": "Array" }, { "type": "number" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight-DaylightViewModel.html#yearPlaying)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisDaylight = document.createElement(\"arcgis-daylight\");\ndocument.body.append(arcgisDaylight);\narcgisDaylight.componentOnReady().then(() => {\n console.log(\"arcgis-daylight is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "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/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": "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\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent 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": "Indicates whether interaction is allowed on the component. When `true`,\nthis property sets the component to a disabled state to disable any user\ninteraction.", "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", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "icon", "reflectToAttr": true, "docs": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).", "docsTags": [ { "name": "see", "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)" } ], "default": "\"move\"", "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": "messageOverrides", "type": "{\n componentLabel?: string | undefined;\n northWest?: string | undefined;\n north?: string | undefined;\n northEast?: string | undefined;\n east?: string | undefined;\n southEast?: string | undefined;\n south?: string | undefined;\n southWest?: string | undefined;\n west?: string | undefined;\n heading?: string | undefined;\n resetHeading?: string | undefined;\n unsupported?: string | undefined;\n}", "complexType": { "original": "{\n componentLabel?: string | undefined;\n northWest?: string | undefined;\n north?: string | undefined;\n northEast?: string | undefined;\n east?: string | undefined;\n southEast?: string | undefined;\n south?: string | undefined;\n southWest?: string | undefined;\n west?: string | undefined;\n heading?: string | undefined;\n resetHeading?: string | undefined;\n unsupported?: string | undefined;\n}", "resolved": "{\n componentLabel?: string | undefined;\n northWest?: string | undefined;\n north?: string | undefined;\n northEast?: string | undefined;\n east?: string | undefined;\n southEast?: string | undefined;\n south?: string | undefined;\n southWest?: string | undefined;\n west?: string | undefined;\n heading?: string | undefined;\n resetHeading?: string | undefined;\n unsupported?: string | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Overwrite localized strings for this component", "docsTags": [], "values": [], "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": true, "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": "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": "\"disabled\" | \"moving\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"moving\" | \"ready\"", "resolved": "\"disabled\" | \"moving\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "value": "disabled", "type": "string" }, { "value": "moving", "type": "string" }, { "value": "ready", "type": "string" } ], "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": "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": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisDirectionalPad = document.createElement(\"arcgis-directional-pad\");\ndocument.body.append(arcgisDirectionalPad);\narcgisDirectionalPad.componentOnReady().then(() => {\n console.log(\"arcgis-directional-pad is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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/directions/directions.tsx", "tag": "arcgis-directions", "overview": "", "readme": "", "usage": {}, "docs": "Directions component provides a way to calculate directions, between two or more input locations with a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html), using ArcGIS Online and custom Network Analysis Route services.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "apiKey", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "api-key", "reflectToAttr": false, "docs": "An authorization string used to access a resource or service.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#apiKey)", "docsTags": [], "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\\` method when you are done to prevent\nmemory leaks.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the origin and destination addresses (i.e.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#headingLevel)", "docsTags": [], "default": "2", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideLayerDetails", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-layer-details", "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "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": "\"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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "lastRoute", "type": "DirectionsLastRoute", "complexType": { "original": "DirectionsLastRoute", "resolved": "DirectionsLastRoute", "references": { "DirectionsLastRoute": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The most recent route result.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "null", "values": [], "optional": true, "required": false }, { "name": "layer", "type": "RouteLayer", "complexType": { "original": "RouteLayer", "resolved": "RouteLayer", "references": { "RouteLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) associated with the Directions widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#layer)", "docsTags": [], "values": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#maxStops)", "docsTags": [], "default": "50", "values": [ { "type": "number" } ], "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": "routeLayerItemId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "route-layer-item-id", "reflectToAttr": false, "docs": "", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "searchProperties", "type": "DirectionsSearchProperties", "complexType": { "original": "DirectionsSearchProperties", "resolved": "DirectionsSearchProperties", "references": { "DirectionsSearchProperties": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Controls the default properties used when [searching](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#searchProperties)", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"error\" | \"initializing\" | \"ready\" | \"routing\" | \"unauthenticated\"", "complexType": { "original": "\"disabled\" | \"error\" | \"initializing\" | \"ready\" | \"routing\" | \"unauthenticated\"", "resolved": "\"disabled\" | \"error\" | \"initializing\" | \"ready\" | \"routing\" | \"unauthenticated\"", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "The current state of the view model.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions-DirectionsViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "error", "type": "string" }, { "value": "initializing", "type": "string" }, { "value": "ready", "type": "string" }, { "value": "routing", "type": "string" }, { "value": "unauthenticated", "type": "string" } ], "optional": true, "required": false }, { "name": "unit", "type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "complexType": { "original": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "resolved": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "references": {} }, "mutable": true, "attr": "unit", "reflectToAttr": false, "docs": "Unit system (imperial, metric) or specific unit used for displaying the distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#unit)", "docsTags": [], "values": [ { "value": "centimeters", "type": "string" }, { "value": "decimeters", "type": "string" }, { "value": "feet", "type": "string" }, { "value": "imperial", "type": "string" }, { "value": "inches", "type": "string" }, { "value": "kilometers", "type": "string" }, { "value": "meters", "type": "string" }, { "value": "metric", "type": "string" }, { "value": "miles", "type": "string" }, { "value": "millimeters", "type": "string" }, { "value": "nautical-miles", "type": "string" }, { "value": "us-feet", "type": "string" }, { "value": "yards", "type": "string" } ], "optional": true, "required": false }, { "name": "useDefaultRouteLayer", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "use-default-route-layer", "reflectToAttr": false, "docs": "", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisDirections = document.createElement(\"arcgis-directions\");\ndocument.body.append(arcgisDirections);\narcgisDirections.componentOnReady().then(() => {\n console.log(\"arcgis-directions is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "getDirections", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise<__esri.RouteLayerSolveResult>", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "RouteLayerSolveResult": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "getDirections(): Promise<__esri.RouteLayerSolveResult>", "parameters": [], "docs": "", "docsTags": [] }, { "name": "save", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise<__esri.PortalItem>", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "PortalItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "save(): Promise<__esri.PortalItem>", "parameters": [], "docs": "", "docsTags": [] }, { "name": "saveAs", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem>", "parameters": [ { "name": "portalItem", "type": "PortalItem", "docs": "" }, { "name": "options", "type": "{ folder: PortalFolder; }", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "PortalItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "saveAs(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem>", "parameters": [ { "name": "portalItem", "type": "PortalItem", "docs": "" }, { "name": "options", "type": "{ folder: PortalFolder; }", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "zoomToRoute", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "zoomToRoute(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"lastRoute\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"lastRoute\"; }", "resolved": "{ name: \"state\" | \"lastRoute\"; }", "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/directline-measurement-3d/directline-measurement-3d.tsx", "tag": "arcgis-directline-measurement-3d", "overview": "", "readme": "", "usage": {}, "docs": "DirectLineMeasurement3D component calculates and displays the 3D distance between two points. This component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the vertical, horizontal, and direct distance between two points.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "analysis", "type": "DirectLineMeasurementAnalysis", "complexType": { "original": "DirectLineMeasurementAnalysis", "resolved": "DirectLineMeasurementAnalysis", "references": { "DirectLineMeasurementAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The direct line measurement analysis object being created or modified by the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.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-line\"", "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-DirectLineMeasurement3D-DirectLineMeasurement3DViewModel.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": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "complexType": { "original": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "resolved": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "references": {} }, "mutable": true, "attr": "unit", "reflectToAttr": false, "docs": "Unit system (imperial, metric) or specific unit used for displaying the distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unit)", "docsTags": [], "values": [ { "value": "centimeters", "type": "string" }, { "value": "decimeters", "type": "string" }, { "value": "feet", "type": "string" }, { "value": "imperial", "type": "string" }, { "value": "inches", "type": "string" }, { "value": "kilometers", "type": "string" }, { "value": "meters", "type": "string" }, { "value": "metric", "type": "string" }, { "value": "miles", "type": "string" }, { "value": "millimeters", "type": "string" }, { "value": "nautical-miles", "type": "string" }, { "value": "us-feet", "type": "string" }, { "value": "yards", "type": "string" } ], "optional": true, "required": false }, { "name": "unitOptions", "type": "Array<\"metric\" | \"imperial\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">", "complexType": { "original": "Array<\"metric\" | \"imperial\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">", "resolved": "Array<\"metric\" | \"imperial\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "List of unit systems (imperial, metric) and specific units for displaying the distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DirectLineMeasurement3D.html#unitOptions)", "docsTags": [], "values": [], "optional": true, "required": false } ], "methods": [ { "name": "clear", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clear(): Promise", "parameters": [], "docs": "Clears 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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisDirectLineMeasurement3d = document.createElement(\"arcgis-directline-measurement-3d\");\ndocument.body.append(arcgisDirectLineMeasurement3d);\narcgisDirectLineMeasurement3d.componentOnReady().then(() => {\n console.log(\"arcgis-directline-measurement-3d is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "start(): Promise", "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/distance-measurement-2d/distance-measurement-2d.tsx", "tag": "arcgis-distance-measurement-2d", "overview": "", "readme": "", "usage": {}, "docs": "DistanceMeasurement2D component calculates and displays the distance between two or more points 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-line\"", "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-DistanceMeasurement2D-DistanceMeasurement2DViewModel.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": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "complexType": { "original": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "resolved": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "references": {} }, "mutable": true, "attr": "unit", "reflectToAttr": false, "docs": "Unit system (imperial, metric) or specific unit used for displaying the distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unit)", "docsTags": [], "values": [ { "value": "centimeters", "type": "string" }, { "value": "decimeters", "type": "string" }, { "value": "feet", "type": "string" }, { "value": "imperial", "type": "string" }, { "value": "inches", "type": "string" }, { "value": "kilometers", "type": "string" }, { "value": "meters", "type": "string" }, { "value": "metric", "type": "string" }, { "value": "miles", "type": "string" }, { "value": "millimeters", "type": "string" }, { "value": "nautical-miles", "type": "string" }, { "value": "us-feet", "type": "string" }, { "value": "yards", "type": "string" } ], "optional": true, "required": false }, { "name": "unitOptions", "type": "Array<\"metric\" | \"imperial\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">", "complexType": { "original": "Array<\"metric\" | \"imperial\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">", "resolved": "Array<\"metric\" | \"imperial\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">", "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 distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unitOptions)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisDistanceMeasurement2d = document.createElement(\"arcgis-distance-measurement-2d\");\ndocument.body.append(arcgisDistanceMeasurement2d);\narcgisDistanceMeasurement2d.componentOnReady().then(() => {\n console.log(\"arcgis-distance-measurement-2d is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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/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": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeWorkflow", "type": "CreateFeaturesWorkflow | UpdateWorkflow", "complexType": { "original": "CreateFeaturesWorkflow | UpdateWorkflow", "resolved": "CreateFeaturesWorkflow | UpdateWorkflow", "references": { "CreateFeaturesWorkflow": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "UpdateWorkflow": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A property indicating the current active workflow.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#activeWorkflow)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "type": "CreateFeaturesWorkflow" }, { "type": "UpdateWorkflow" } ], "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": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for title of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#headingLevel)", "docsTags": [], "default": "4", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideCreateFeaturesSection", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-create-features-section", "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "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": "", "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": "\"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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "labelOptions", "type": "SketchLabelOptions", "complexType": { "original": "SketchLabelOptions", "resolved": "SketchLabelOptions", "references": { "SketchLabelOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#labelOptions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "layerInfos", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "EditorLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of editing configurations for individual layers.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#layerInfos)", "docsTags": [], "values": [], "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": "showSnappingControlsElementsHeader", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-snapping-controls-elements-header", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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 editing.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#snappingOptions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "state", "type": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"creating-features\" | \"disabled\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-new-feature\" | \"ready\"", "complexType": { "original": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"creating-features\" | \"disabled\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-new-feature\" | \"ready\"", "resolved": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"creating-features\" | \"disabled\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-new-feature\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The widget's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "value": "add-association-create-association", "type": "string" }, { "value": "add-association-select-feature", "type": "string" }, { "value": "add-association-select-layer", "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": "creating-features", "type": "string" }, { "value": "disabled", "type": "string" }, { "value": "editing-attachment", "type": "string" }, { "value": "editing-attributes", "type": "string" }, { "value": "editing-existing-feature", "type": "string" }, { "value": "editing-new-feature", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "supportingWidgetDefaults", "type": "SupportingWidgetDefaults", "complexType": { "original": "SupportingWidgetDefaults", "resolved": "SupportingWidgetDefaults", "references": { "SupportingWidgetDefaults": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "This property allows customization of supporting Editor widgets and their default behavior.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#supportingWidgetDefaults)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "tooltipOptions", "type": "SketchTooltipOptions", "complexType": { "original": "SketchTooltipOptions", "resolved": "SketchTooltipOptions", "references": { "SketchTooltipOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Options to configure the tooltip shown next to the cursor when creating or updating graphics.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#tooltipOptions)", "docsTags": [], "values": [], "optional": true, "required": false } ], "methods": [ { "name": "cancelWorkflow", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisEditor = document.createElement(\"arcgis-editor\");\ndocument.body.append(arcgisEditor);\narcgisEditor.componentOnReady().then(() => {\n console.log(\"arcgis-editor is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "deleteFeatureFromWorkflow", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "deleteFeatureFromWorkflow(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "startCreateFeaturesWorkflowAtFeatureCreation", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(info: __esri.CreateFeaturesCreationInfo): Promise", "parameters": [ { "name": "info", "type": "CreateFeaturesCreationInfo", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "CreateFeaturesCreationInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "startCreateFeaturesWorkflowAtFeatureCreation(info: __esri.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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "startUpdateWorkflowAtFeatureEdit", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(feature: __esri.Graphic): Promise", "parameters": [ { "name": "feature", "type": "Graphic", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Graphic": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "startUpdateWorkflowAtFeatureEdit(feature: __esri.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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "startUpdateWorkflowAtFeatureSelection(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "startUpdateWorkflowAtMultipleFeatureSelection", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(candidates: __esri.Graphic[]): Promise", "parameters": [ { "name": "candidates", "type": "Array", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Graphic": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "startUpdateWorkflowAtMultipleFeatureSelection(candidates: __esri.Graphic[]): Promise", "parameters": [ { "name": "candidates", "type": "Array", "docs": "" } ], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"activeWorkflow\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"activeWorkflow\"; }", "resolved": "{ name: \"state\" | \"activeWorkflow\"; }", "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/elevation-profile/elevation-profile.tsx", "tag": "arcgis-elevation-profile", "overview": "", "readme": "", "usage": {}, "docs": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).", "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": "effectiveUnits", "type": "EffectiveUnits", "complexType": { "original": "EffectiveUnits", "resolved": "EffectiveUnits", "references": { "EffectiveUnits": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Units which have been selected according to the magnitude of the elevations and distances\nthat are to be displayed in the widget, according to the selected unit or unit system.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#effectiveUnits)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "hideChart", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-chart", "reflectToAttr": false, "docs": "", "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": "", "docsTags": [], "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": "", "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": "", "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideSketchButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-sketch-button", "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideUnitSelector", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-unit-selector", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "highlightEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "highlight-enabled", "reflectToAttr": false, "docs": "Whether the graphic used as [input](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input)\nis highlighted.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#highlightEnabled)", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hoveredChartPosition", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "hovered-chart-position", "reflectToAttr": false, "docs": "The position, in the range [0, 1], being hovered in the graph.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#hoveredChartPosition)", "docsTags": [], "values": [ { "type": "number" } ], "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": "\"altitude\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "input", "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 input line graphic along which elevation will be queried in order to generate an elevation profile.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input)", "docsTags": [], "default": "null", "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": "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": "profiles", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ElevationProfileLineGround": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ElevationProfileLineInput": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ElevationProfileLineQuery": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ElevationProfileLineView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Collection of elevation profile lines which are to be generated and displayed in the widget's\nchart.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#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\nprofiles.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#progress)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "type": "number" } ], "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": "\"created\" | \"creating\" | \"disabled\" | \"ready\" | \"selected\" | \"selecting\"", "complexType": { "original": "\"created\" | \"creating\" | \"disabled\" | \"ready\" | \"selected\" | \"selecting\"", "resolved": "\"created\" | \"creating\" | \"disabled\" | \"ready\" | \"selected\" | \"selecting\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the view model that can be used for rendering the UI\nof the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "created", "type": "string" }, { "value": "creating", "type": "string" }, { "value": "disabled", "type": "string" }, { "value": "ready", "type": "string" }, { "value": "selected", "type": "string" }, { "value": "selecting", "type": "string" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#uniformChartScaling)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "unit", "type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "complexType": { "original": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "resolved": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "references": {} }, "mutable": true, "attr": "unit", "reflectToAttr": false, "docs": "Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unit)", "docsTags": [], "values": [ { "value": "centimeters", "type": "string" }, { "value": "decimeters", "type": "string" }, { "value": "feet", "type": "string" }, { "value": "imperial", "type": "string" }, { "value": "inches", "type": "string" }, { "value": "kilometers", "type": "string" }, { "value": "meters", "type": "string" }, { "value": "metric", "type": "string" }, { "value": "miles", "type": "string" }, { "value": "millimeters", "type": "string" }, { "value": "nautical-miles", "type": "string" }, { "value": "us-feet", "type": "string" }, { "value": "yards", "type": "string" } ], "optional": true, "required": false }, { "name": "unitOptions", "type": "Array<\"metric\" | \"imperial\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">", "complexType": { "original": "Array<\"metric\" | \"imperial\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">", "resolved": "Array<\"metric\" | \"imperial\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">", "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 elevation and distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unitOptions)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisElevationProfile = document.createElement(\"arcgis-elevation-profile\");\ndocument.body.append(arcgisElevationProfile);\narcgisElevationProfile.componentOnReady().then(() => {\n console.log(\"arcgis-elevation-profile is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "start(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "stop", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "stop(): Promise", "parameters": [], "docs": "Stops the component.", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"input\" | \"state\" | \"progress\" | \"effectiveUnits\"; }", "bubbles": true, "complexType": { "original": "{ name: \"input\" | \"state\" | \"progress\" | \"effectiveUnits\"; }", "resolved": "{ name: \"input\" | \"state\" | \"progress\" | \"effectiveUnits\"; }", "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/expand/expand.tsx", "tag": "arcgis-expand", "overview": "", "readme": "", "usage": {}, "docs": "Expand component acts as a clickable button for opening content.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "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 widget instance when the view's\nviewpoint updates.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#autoCollapse)", "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\\` method when you are done to prevent\nmemory leaks.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "closeOnEsc", "type": "Function | boolean", "complexType": { "original": "Function | boolean", "resolved": "Function | boolean", "references": { "Function": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "close-on-esc", "reflectToAttr": false, "docs": "When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#closeOnEsc)", "docsTags": [], "default": "true", "values": [ { "type": "Function" }, { "type": "boolean" } ], "optional": true, "required": false }, { "name": "collapseIcon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "collapse-icon", "reflectToAttr": false, "docs": "Calcite icon used to style the Expand button when the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) can be collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseIcon)", "docsTags": [], "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 Expand widget can be collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseTooltip)", "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 widget is currently expanded or not.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expanded)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "expandIcon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "expand-icon", "reflectToAttr": false, "docs": "Calcite icon used when the widget is collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandIcon)", "docsTags": [], "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 widget can be expanded.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandTooltip)", "docsTags": [], "default": "\"Expand\" (English locale)", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "focusTrapEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "focus-trap-enabled", "reflectToAttr": false, "docs": "Disables focus trapping within the expand widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "group", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "group", "reflectToAttr": false, "docs": "This value associates two or more Expand widget instances with each other, allowing one\ninstance to auto collapse when another instance in the same group is expanded.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#group)", "docsTags": [], "values": [ { "type": "string" } ], "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": "null", "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 widget to indicate the number of, for example, open issues or unread notices.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#iconNumber)", "docsTags": [], "values": [ { "type": "number" } ], "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": "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 widget displays.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#mode)", "docsTags": [], "default": "\"auto\"", "values": [ { "value": "auto", "type": "string" }, { "value": "drawer", "type": "string" }, { "value": "floating", "type": "string" } ], "optional": true, "required": false }, { "name": "placement", "type": "\"auto\" | \"auto-end\" | \"auto-start\" | \"bottom\" | \"bottom-end\" | \"bottom-start\" | \"leading\" | \"leading-end\" | \"leading-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\" | \"trailing\" | \"trailing-end\" | \"trailing-start\"", "complexType": { "original": "\"auto\" | \"auto-end\" | \"auto-start\" | \"bottom\" | \"bottom-end\" | \"bottom-start\" | \"leading\" | \"leading-end\" | \"leading-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\" | \"trailing\" | \"trailing-end\" | \"trailing-start\"", "resolved": "\"auto\" | \"auto-end\" | \"auto-start\" | \"bottom\" | \"bottom-end\" | \"bottom-start\" | \"leading\" | \"leading-end\" | \"leading-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\" | \"trailing\" | \"trailing-end\" | \"trailing-start\"", "references": {} }, "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 widget is expanded.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#placement)", "docsTags": [], "default": "null", "values": [ { "value": "auto", "type": "string" }, { "value": "auto-end", "type": "string" }, { "value": "auto-start", "type": "string" }, { "value": "bottom", "type": "string" }, { "value": "bottom-end", "type": "string" }, { "value": "bottom-start", "type": "string" }, { "value": "leading", "type": "string" }, { "value": "leading-end", "type": "string" }, { "value": "leading-start", "type": "string" }, { "value": "left", "type": "string" }, { "value": "left-end", "type": "string" }, { "value": "left-start", "type": "string" }, { "value": "right", "type": "string" }, { "value": "right-end", "type": "string" }, { "value": "right-start", "type": "string" }, { "value": "top", "type": "string" }, { "value": "top-end", "type": "string" }, { "value": "top-start", "type": "string" }, { "value": "trailing", "type": "string" }, { "value": "trailing-end", "type": "string" }, { "value": "trailing-start", "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": "\"top-right\"", "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 } ], "methods": [ { "name": "collapse", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "collapse(): 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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisExpand = document.createElement(\"arcgis-expand\");\ndocument.body.append(arcgisExpand);\narcgisExpand.componentOnReady().then(() => {\n console.log(\"arcgis-expand is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "expand(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "toggle", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "toggle(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "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/feature/feature.tsx", "tag": "arcgis-feature", "overview": "", "readme": "", "usage": {}, "docs": "Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). This component is useful in instances where you want to display information about a feature but without the use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.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": "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#defaultPopupTemplateEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#graphic)", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#title) of the feature widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#headingLevel)", "docsTags": [], "default": "2", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideContentAttachments", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-content-attachments", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideContentExpression", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-content-expression", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideContentFields", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-content-fields", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideContentMedia", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-content-media", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideContentText", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-content-text", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideLastEditInfo", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-last-edit-info", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideTitle", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-title", "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": "\"polygon\"", "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": "location", "type": "Point", "complexType": { "original": "Point", "resolved": "Point", "references": { "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the location of the\n[MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) interaction used to trigger the opening of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#location)", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "map", "type": "Map", "complexType": { "original": "Map", "resolved": "Map", "references": { "Map": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A map is required when the input [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#graphic) has a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) that may use the `$map` profile variable to access data from layers within a map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#map)", "docsTags": [], "default": "null", "values": [], "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": "spatialReference", "type": "SpatialReference", "complexType": { "original": "SpatialReference", "resolved": "SpatialReference", "references": { "SpatialReference": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#spatialReference)", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"error\" | \"loading\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"error\" | \"loading\" | \"ready\"", "resolved": "\"disabled\" | \"error\" | \"loading\" | \"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-Feature-FeatureViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "error", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisFeature = document.createElement(\"arcgis-feature\");\ndocument.body.append(arcgisFeature);\narcgisFeature.componentOnReady().then(() => {\n console.log(\"arcgis-feature is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "nextMedia(contentElementIndex: number): Promise", "parameters": [ { "name": "contentElementIndex", "type": "number", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "previousMedia", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(contentElementIndex: number): Promise", "parameters": [ { "name": "contentElementIndex", "type": "number", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "previousMedia(contentElementIndex: number): Promise", "parameters": [ { "name": "contentElementIndex", "type": "number", "docs": "" } ], "docs": "", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise", "parameters": [ { "name": "contentElementIndex", "type": "number", "docs": "" }, { "name": "mediaInfoIndex", "type": "number", "docs": "" } ], "docs": "", "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/feature-form/feature-form.tsx", "tag": "arcgis-feature-form", "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": "feature", "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 associated feature containing the editable attributes.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#feature)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "formTemplate", "type": "FormTemplate", "complexType": { "original": "FormTemplate", "resolved": "FormTemplate", "references": { "FormTemplate": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html) used for the form.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate)", "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": "Defines how groups will be displayed to the user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#groupDisplay)", "docsTags": [], "default": "\"all\"", "values": [ { "value": "all", "type": "string" }, { "value": "sequential", "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#title) of the form.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#headingLevel)", "docsTags": [], "default": "2", "values": [ { "type": "number" } ], "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": "\"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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layer", "type": "FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer", "complexType": { "original": "FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer", "resolved": "FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer", "references": { "FeatureLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "GeoJSONLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "OrientedImageryLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SubtypeSublayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Layer containing the editable feature attributes.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#layer)", "docsTags": [], "values": [ { "type": "FeatureLayer" }, { "type": "GeoJSONLayer" }, { "type": "OrientedImageryLayer" }, { "type": "SceneLayer" }, { "type": "SubtypeSublayer" } ], "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\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"ready\"", "resolved": "\"disabled\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The widget's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "type": "string" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#timeZone)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisFeatureForm = document.createElement(\"arcgis-feature-form\");\ndocument.body.append(arcgisFeatureForm);\narcgisFeatureForm.componentOnReady().then(() => {\n console.log(\"arcgis-feature-form is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "getValues(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "submit", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "submit(): Promise", "parameters": [], "docs": "", "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": [] }, { "event": "arcgisSubmit", "detail": "FeatureFormSubmitEvent", "bubbles": true, "complexType": { "original": "FeatureFormSubmitEvent", "resolved": "FeatureFormSubmitEvent", "references": { "FeatureFormSubmitEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when the component is submitted.", "docsTags": [] }, { "event": "arcgisValueChange", "detail": "FeatureFormValueChangeEvent", "bubbles": true, "complexType": { "original": "FeatureFormValueChangeEvent", "resolved": "FeatureFormValueChangeEvent", "references": { "FeatureFormValueChangeEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "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": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "actionColumnConfig", "type": "ActionColumnConfig", "complexType": { "original": "ActionColumnConfig", "resolved": "ActionColumnConfig", "references": { "ActionColumnConfig": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Configuration for the [ActionColumn](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-ActionColumn.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#actionColumnConfig)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "activeFilters", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "GeometryFilter": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SelectionFilter": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "activeSortOrders", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "ColumnSortOrder": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "readonly", "text": "" } ], "default": "[]", "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": "readonly", "text": "" } ], "default": "false", "values": [ { "type": "boolean" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#attachmentsEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "attributeTableTemplate", "type": "AttributeTableTemplate", "complexType": { "original": "AttributeTableTemplate", "resolved": "AttributeTableTemplate", "references": { "AttributeTableTemplate": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#attributeTableTemplate)", "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\\` method when you are done to prevent\nmemory 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": "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": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Column": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "FieldColumn": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "GroupColumn": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ActionColumn": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "AttachmentsColumn": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "RelationshipColumn": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "description", "type": "Function | string", "complexType": { "original": "Function | string", "resolved": "Function | string", "references": { "Function": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "description", "reflectToAttr": false, "docs": "Text displayed in the table header, under the title.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#description)", "docsTags": [], "values": [ { "type": "Function" }, { "type": "string" } ], "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/api-reference/esri-widgets-FeatureTable.html#editing-in-featuretable) is enabled on the data within the feature table.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#editingEnabled)", "docsTags": [], "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": "readonly", "text": "" } ], "values": [ { "type": "number" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#filterBySelectionEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "filterGeometry", "type": "Extent | Mesh | Multipoint | Point | Polygon | Polyline", "complexType": { "original": "Extent | Mesh | Multipoint | Point | Polygon | Polyline", "resolved": "Extent | Mesh | Multipoint | Point | Polygon | Polyline", "references": { "Extent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Mesh": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Multipoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Polygon": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Polyline": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Set this property to filter the features displayed in the table.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#filterGeometry)", "docsTags": [], "default": "null", "values": [ { "type": "Extent" }, { "type": "Mesh" }, { "type": "Multipoint" }, { "type": "Point" }, { "type": "Polygon" }, { "type": "Polyline" } ], "optional": true, "required": false }, { "name": "hiddenFields", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of string values which indicate [field.names](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html) that should be hidden within the table.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#hiddenFields)", "docsTags": [], "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.", "docsTags": [], "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.", "docsTags": [], "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": "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 information.", "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": [], "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": [], "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": [], "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": [], "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": [], "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": [], "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": [], "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 enable toggling column visibility within the menu.", "docsTags": [], "default": "false", "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 selected menu item.", "docsTags": [], "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": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "highlightIds", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "This property accepts and returns a collection of feature object IDs.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#highlightIds)", "docsTags": [], "values": [], "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": "\"table\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "initialSize", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "initial-size", "reflectToAttr": false, "docs": "The user-provided number of total features accessed from the data source.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#initialSize)", "docsTags": [], "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": "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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layer", "type": "CSVLayer | CatalogFootprintLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | Sublayer | WFSLayer", "complexType": { "original": "CSVLayer | CatalogFootprintLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | Sublayer | WFSLayer", "resolved": "CSVLayer | CatalogFootprintLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | Sublayer | WFSLayer", "references": { "CSVLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "CatalogFootprintLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "FeatureLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "GeoJSONLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ImageryLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "KnowledgeGraphSublayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "OrientedImageryLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Sublayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "WFSLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The associated [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html),\n[KnowledgeGraphSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html), [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), or [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) containing the fields and attributes to display within the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#layer)", "docsTags": [], "values": [ { "type": "CSVLayer" }, { "type": "CatalogFootprintLayer" }, { "type": "FeatureLayer" }, { "type": "GeoJSONLayer" }, { "type": "ImageryLayer" }, { "type": "KnowledgeGraphSublayer" }, { "type": "OrientedImageryLayer" }, { "type": "SceneLayer" }, { "type": "Sublayer" }, { "type": "WFSLayer" } ], "optional": true, "required": false }, { "name": "layerItemId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "layer-item-id", "reflectToAttr": false, "docs": "Portal Item Id for a layer to load. You can set, `layer`, `layerUrl`, or `itemId`,\nbut not more than one.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layers", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FeatureLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "GeoJSONLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "WFSLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "CSVLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ImageryLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "CatalogFootprintLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "KnowledgeGraphSublayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "values": [], "optional": true, "required": false }, { "name": "layerUrl", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "layer-url", "reflectToAttr": false, "docs": "Url for a layer to load. You can set, `layer`, `layerUrl`, or `itemId`,\nbut not more than one.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layerView", "type": "LayerView", "complexType": { "original": "LayerView", "resolved": "LayerView", "references": { "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The layer view associated with the table's layer.", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "maxSize", "type": "number", "complexType": { "original": "number", "resolved": "number", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#maxSize)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "menuConfig", "type": "TableMenuConfig", "complexType": { "original": "TableMenuConfig", "resolved": "TableMenuConfig", "references": { "TableMenuConfig": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Set this object to customize the feature table's menu content.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#menuConfig)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#multipleSelectionEnabled)", "docsTags": [], "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": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "objectIds", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "This property accepts and returns a collection of feature object IDs.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#objectIds)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "outFields", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#outFields)", "docsTags": [], "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/api-reference/esri-widgets-FeatureTable.html#size) and configured [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageSize).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageCount)", "docsTags": [ { "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageIndex)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageSize)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#paginationEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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": "\"manual\"", "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": "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#relatedRecordsEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "relatedTable", "type": "FeatureTable", "complexType": { "original": "FeatureTable", "resolved": "FeatureTable", "references": { "FeatureTable": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Reference to a nested table instance representing a relationship with another table.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "relatedTables", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "FeatureTable": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of nested table instances.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#relatedTables)", "docsTags": [], "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[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#returnGeometryEnabled)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#returnMEnabled)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#returnZEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "rowHighlightIds", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "This property accepts and returns a collection of feature object IDs.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#rowHighlightIds)", "docsTags": [], "values": [], "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": "readonly", "text": "" } ], "default": "0", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"error\" | \"loaded\" | \"loading\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"error\" | \"loaded\" | \"loading\" | \"ready\"", "resolved": "\"disabled\" | \"error\" | \"loaded\" | \"loading\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "error", "type": "string" }, { "value": "loaded", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "tableController", "type": "FeatureTable", "complexType": { "original": "FeatureTable", "resolved": "FeatureTable", "references": { "FeatureTable": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "values": [], "optional": true, "required": false }, { "name": "tableDisabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "table-disabled", "reflectToAttr": false, "docs": "Indicates whether the table is disabled.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#disabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "tableParent", "type": "FeatureTable", "complexType": { "original": "FeatureTable", "resolved": "FeatureTable", "references": { "FeatureTable": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Reference to a table instance that this table is directly related to.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "tableTemplate", "type": "TableTemplate", "complexType": { "original": "TableTemplate", "resolved": "TableTemplate", "references": { "TableTemplate": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The associated [template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable-support-TableTemplate.html) used for the feature table.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#tableTemplate)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "timeExtent", "type": "TimeExtent", "complexType": { "original": "TimeExtent", "resolved": "TimeExtent", "references": { "TimeExtent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The [TimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-time-TimeExtent.html) in which to filter and display data within the FeatureTable widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeExtent)", "docsTags": [], "values": [], "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 widget will be in terms of this time zone.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeZone)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisFeatureTable = document.createElement(\"arcgis-feature-table\");\ndocument.body.append(arcgisFeatureTable);\narcgisFeatureTable.componentOnReady().then(() => {\n console.log(\"arcgis-feature-table is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "deleteSelection", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(showWarningPrompt?: boolean): Promise", "parameters": [ { "name": "showWarningPrompt", "type": "boolean | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "deleteSelection(showWarningPrompt?: boolean): Promise", "parameters": [ { "name": "showWarningPrompt", "type": "boolean | undefined", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "exportSelectionToCSV", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(includeGeometry?: boolean): Promise", "parameters": [ { "name": "includeGeometry", "type": "boolean | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "exportSelectionToCSV(includeGeometry?: boolean): Promise", "parameters": [ { "name": "includeGeometry", "type": "boolean | undefined", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "findColumn", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(fieldName: string): Promise<__esri.ActionColumn | __esri.AttachmentsColumn | __esri.Column | __esri.GroupColumn | __esri.RelationshipColumn | nullish>", "parameters": [ { "name": "fieldName", "type": "string", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Column": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "GroupColumn": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ActionColumn": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "AttachmentsColumn": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "RelationshipColumn": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "findColumn(fieldName: string): Promise<__esri.ActionColumn | __esri.AttachmentsColumn | __esri.Column | __esri.GroupColumn | __esri.RelationshipColumn | nullish>", "parameters": [ { "name": "fieldName", "type": "string", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "goToPage", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(index: number): Promise", "parameters": [ { "name": "index", "type": "number", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "nextPage(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "previousPage", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "previousPage(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "refresh", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "refresh(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "scrollToBottom", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "scrollToLeft(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "scrollToRow", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(objectId: number): Promise", "parameters": [ { "name": "objectId", "type": "number", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "scrollToRow(objectId: number): Promise", "parameters": [ { "name": "objectId", "type": "number", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "scrollToTop", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "scrollToTop(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "showAllColumns", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "zoomToSelection", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "zoomToSelection(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisCellClick", "detail": "FeatureTableCellClickEvent", "bubbles": true, "complexType": { "original": "FeatureTableCellClickEvent", "resolved": "FeatureTableCellClickEvent", "references": { "FeatureTableCellClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisCellKeydown", "detail": "FeatureTableCellKeydownEvent", "bubbles": true, "complexType": { "original": "FeatureTableCellKeydownEvent", "resolved": "FeatureTableCellKeydownEvent", "references": { "FeatureTableCellKeydownEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisCellPointerout", "detail": "FeatureTableCellPointeroutEvent", "bubbles": true, "complexType": { "original": "FeatureTableCellPointeroutEvent", "resolved": "FeatureTableCellPointeroutEvent", "references": { "FeatureTableCellPointeroutEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisCellPointerover", "detail": "FeatureTableCellPointeroverEvent", "bubbles": true, "complexType": { "original": "FeatureTableCellPointeroverEvent", "resolved": "FeatureTableCellPointeroverEvent", "references": { "FeatureTableCellPointeroverEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisColumnReorder", "detail": "FeatureTableColumnReorderEvent", "bubbles": true, "complexType": { "original": "FeatureTableColumnReorderEvent", "resolved": "FeatureTableColumnReorderEvent", "references": { "FeatureTableColumnReorderEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisPropertyChange", "detail": "{ name: \"size\" | \"state\" | \"effectiveSize\" | \"isQueryingOrSyncing\" | \"layerView\"; }", "bubbles": true, "complexType": { "original": "{ name: \"size\" | \"state\" | \"effectiveSize\" | \"isQueryingOrSyncing\" | \"layerView\"; }", "resolved": "{ name: \"size\" | \"state\" | \"effectiveSize\" | \"isQueryingOrSyncing\" | \"layerView\"; }", "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": [] }, { "event": "arcgisSelectionChange", "detail": "CollectionChangeEvent", "bubbles": true, "complexType": { "original": "CollectionChangeEvent", "resolved": "CollectionChangeEvent", "references": { "CollectionChangeEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/feature-templates/feature-templates.tsx", "tag": "arcgis-feature-templates", "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": "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/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) should scroll within its containing element.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#enableListScroll)", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "filterFunction", "type": "(((filterName: any) => boolean))", "complexType": { "original": "(((filterName: any) => boolean))", "resolved": "(((filterName: any) => boolean))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "[Function](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#FilterFunction) can be defined to help filter\n[template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) within the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#filterFunction)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#filterText)", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "groupBy", "type": "(((grouping: any) => )) | string", "complexType": { "original": "(((grouping: any) => )) | string", "resolved": "(((grouping: any) => )) | string", "references": {} }, "mutable": true, "attr": "group-by", "reflectToAttr": false, "docs": "It is possible to group [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#groupBy)", "docsTags": [], "default": "\"layer\"", "values": [ { "type": "(((grouping: any) => ))" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the labels of grouped feature templates.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#headingLevel)", "docsTags": [], "default": "4", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideFilter", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-filter", "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": "\"list-rectangle\"", "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": "layers", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FeatureLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SubtypeGroupLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "GeoJSONLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "OrientedImageryLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SubtypeSublayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)\nto display within the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#layers)", "docsTags": [], "values": [], "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": "selectionMode", "type": "\"none\" | \"single\"", "complexType": { "original": "\"none\" | \"single\"", "resolved": "\"none\" | \"single\"", "references": {} }, "mutable": true, "attr": "selection-mode", "reflectToAttr": false, "docs": "Specifies the selection behavior of list items.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates.html#selectionMode)", "docsTags": [], "values": [ { "value": "none", "type": "string" }, { "value": "single", "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 widget's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-FeatureTemplatesViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisFeatureTemplates = document.createElement(\"arcgis-feature-templates\");\ndocument.body.append(arcgisFeatureTemplates);\narcgisFeatureTemplates.componentOnReady().then(() => {\n console.log(\"arcgis-feature-templates is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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": [] }, { "event": "arcgisSelect", "detail": "FeatureTemplatesSelectEvent", "bubbles": true, "complexType": { "original": "FeatureTemplatesSelectEvent", "resolved": "FeatureTemplatesSelectEvent", "references": { "FeatureTemplatesSelectEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when the component is selected.", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/features/features.tsx", "tag": "arcgis-features", "overview": "", "readme": "", "usage": {}, "docs": "Features component allows users to view a feature's popupTemplate content such as attributes, actions, related records, etc., without having to be tied to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html).", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "actions", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ActionButton": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ActionToggle": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "[Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#actions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "active", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "active", "reflectToAttr": true, "docs": "Indicates if the widget is active when it is visible and is not [waiting for results](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#waitingForResult).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#active)", "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\\` method when you are done to prevent\nmemory 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": true, "docs": "Indicates whether the popup displays its content.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#collapsed)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "content", "type": "HTMLElement | Widget | string", "complexType": { "original": "HTMLElement | Widget | string", "resolved": "HTMLElement | Widget | string", "references": { "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" }, "Widget": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "content", "reflectToAttr": false, "docs": "The content of the Features widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#content)", "docsTags": [], "values": [ { "type": "HTMLElement" }, { "type": "Widget" }, { "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 widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#featureNavigationTop)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "features", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Graphic": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of features associated with the Features widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#features)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featuresPerPage)", "docsTags": [], "default": "20", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "featuresTitle", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "features-title", "reflectToAttr": false, "docs": "The title of the Features widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title)", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "featureViewModelAbilities", "type": "Abilities", "complexType": { "original": "Abilities", "resolved": "Abilities", "references": { "Abilities": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#Abilities) that can be used when querying and displaying content.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#featureViewModelAbilities)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "goToOverride", "type": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "complexType": { "original": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "resolved": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "This function provides the ability to override either the\n[MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or\n[SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#goToOverride)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "headerActions", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ActionBase": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The actions that are displayed in the header of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#headerActions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#title) of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#headingLevel)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideActionBar", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-action-bar", "reflectToAttr": false, "docs": "", "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": "", "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": "", "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideFlow", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-flow", "reflectToAttr": false, "docs": "", "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": "", "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": "", "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": "null", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "includeDefaultActions", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-default-actions", "reflectToAttr": false, "docs": "Indicates whether or not to include [defaultActions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#defaultActions).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features-FeaturesViewModel.html#includeDefaultActions)", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "initialDisplayMode", "type": "\"feature\" | \"list\"", "complexType": { "original": "\"feature\" | \"list\"", "resolved": "\"feature\" | \"list\"", "references": {} }, "mutable": true, "attr": "initial-display-mode", "reflectToAttr": false, "docs": "Indicates whether to initially display a list of features, or the content for one feature.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#initialDisplayMode)", "docsTags": [], "default": "\"feature\"", "values": [ { "value": "feature", "type": "string" }, { "value": "list", "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": "map", "type": "Map", "complexType": { "original": "Map", "resolved": "Map", "references": { "Map": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A map is required when the input [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#features) have a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) that may use the `$map` profile variable to access data from layers within a map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#map)", "docsTags": [], "default": "null", "values": [], "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": "promises", "type": "Array>", "complexType": { "original": "Array>", "resolved": "Array>", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of pending Promises that have not yet been fulfilled.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#promises)", "docsTags": [], "values": [], "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": "selectedFeature", "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 selected feature accessed by the Features widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeature)", "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 [selected](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeature).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#selectedFeatureIndex)", "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "spatialReference", "type": "SpatialReference", "complexType": { "original": "SpatialReference", "resolved": "SpatialReference", "references": { "SpatialReference": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#spatialReference)", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"ready\"", "resolved": "\"disabled\" | \"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-Features-FeaturesViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "type": "string" } ], "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 widget will be displayed in this time zone.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Features.html#timeZone)", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "clear", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clear(): Promise", "parameters": [], "docs": "Clears the component.", "docsTags": [] }, { "name": "close", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "close(): 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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisFeatures = document.createElement(\"arcgis-features\");\ndocument.body.append(arcgisFeatures);\narcgisFeatures.componentOnReady().then(() => {\n console.log(\"arcgis-features is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "fetchFeatures", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(screenPoint: __esri.FeaturesFetchFeaturesScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>", "parameters": [ { "name": "screenPoint", "type": "FeaturesFetchFeaturesScreenPoint", "docs": "" }, { "name": "options", "type": "FetchFeaturesOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FetchPopupFeaturesResult": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "FeaturesFetchFeaturesScreenPoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "FetchFeaturesOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "fetchFeatures(screenPoint: __esri.FeaturesFetchFeaturesScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>", "parameters": [ { "name": "screenPoint", "type": "FeaturesFetchFeaturesScreenPoint", "docs": "" }, { "name": "options", "type": "FetchFeaturesOptions | undefined", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "next", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise<__esri.FeaturesViewModel>", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FeaturesViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "next(): Promise<__esri.FeaturesViewModel>", "parameters": [], "docs": "Moves to the next item.", "docsTags": [] }, { "name": "open", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(options?: __esri.FeaturesOpenOptions): Promise", "parameters": [ { "name": "options", "type": "FeaturesOpenOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FeaturesOpenOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "open(options?: __esri.FeaturesOpenOptions): Promise", "parameters": [ { "name": "options", "type": "FeaturesOpenOptions | undefined", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "previous", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise<__esri.FeaturesViewModel>", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FeaturesViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "previous(): Promise<__esri.FeaturesViewModel>", "parameters": [], "docs": "Moves to the previous item.", "docsTags": [] }, { "name": "triggerAction", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(actionIndex: number): Promise", "parameters": [ { "name": "actionIndex", "type": "number", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "triggerAction(actionIndex: number): Promise", "parameters": [ { "name": "actionIndex", "type": "number", "docs": "" } ], "docs": "Triggers an action on the component.", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"selectedFeature\" | \"selectedFeatureIndex\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"selectedFeature\" | \"selectedFeatureIndex\"; }", "resolved": "{ name: \"state\" | \"selectedFeature\" | \"selectedFeatureIndex\"; }", "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": [] }, { "event": "arcgisTriggerAction", "detail": "FeaturesTriggerActionEvent", "bubbles": true, "complexType": { "original": "FeaturesTriggerActionEvent", "resolved": "FeaturesTriggerActionEvent", "references": { "FeaturesTriggerActionEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when an action is triggered on the component.", "docsTags": [] } ], "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 building in your application.", "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": "facility", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "facility", "reflectToAttr": true, "docs": "The currently selected facility.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#facility)", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the headings separating floors in buildings.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#headingLevel)", "docsTags": [], "default": "2", "values": [ { "type": "number" } ], "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": "\"floor-plan\"", "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": "level", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "level", "reflectToAttr": true, "docs": "The currently selected floor level.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#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": false, "docs": "Determines if the widget is expanded or collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#longNames)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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": "site", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "site", "reflectToAttr": true, "docs": "The currently selected site.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#site)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisFloorFilter = document.createElement(\"arcgis-floor-filter\");\ndocument.body.append(arcgisFloorFilter);\narcgisFloorFilter.componentOnReady().then(() => {\n console.log(\"arcgis-floor-filter is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "updateWebDocument", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(webMap: __esri.WebMap): Promise", "parameters": [ { "name": "webMap", "type": "WebMap", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "WebMap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "updateWebDocument(webMap: __esri.WebMap): Promise", "parameters": [ { "name": "webMap", "type": "WebMap", "docs": "" } ], "docs": "", "docsTags": [] } ], "events": [ { "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/fullscreen/fullscreen.tsx", "tag": "arcgis-fullscreen", "overview": "", "readme": "", "usage": {}, "docs": "Provides a simple component to present the View or a user-defined HTMLElement using the entire screen", "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": "element", "type": "HTMLElement", "complexType": { "original": "HTMLElement", "resolved": "HTMLElement", "references": { "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "icon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "icon", "reflectToAttr": true, "docs": "Icon displayed in the component's button.\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "docsTags": [], "default": "\"zoom-out-fixed\"", "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": "messageOverrides", "type": "{\n componentLabel?: string | undefined;\n enter?: string | undefined;\n exit?: string | undefined;\n}", "complexType": { "original": "{\n componentLabel?: string | undefined;\n enter?: string | undefined;\n exit?: string | undefined;\n}", "resolved": "{\n componentLabel?: string | undefined;\n enter?: string | undefined;\n exit?: string | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "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": true, "docs": "", "docsTags": [], "default": "\"top-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": "\"active\" | \"disabled\" | \"feature-unsupported\" | \"ready\"", "complexType": { "original": "\"active\" | \"disabled\" | \"feature-unsupported\" | \"ready\"", "resolved": "\"active\" | \"disabled\" | \"feature-unsupported\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "active", "type": "string" }, { "value": "disabled", "type": "string" }, { "value": "feature-unsupported", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisFullscreen = document.createElement(\"arcgis-fullscreen\");\ndocument.body.append(arcgisFullscreen);\narcgisFullscreen.componentOnReady().then(() => {\n console.log(\"arcgis-fullscreen is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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/histogram/histogram.tsx", "tag": "arcgis-histogram", "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": "average", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "average", "reflectToAttr": false, "docs": "The statistical average of the data in the histogram.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#average)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "barCreatedFunction", "type": "(((index: number, element: any) => void))", "complexType": { "original": "(((index: number, element: any) => void))", "resolved": "(((index: number, element: any) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Function for styling bars representing histogram bins.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#barCreatedFunction)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "bins", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Bin": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of objects representing each bin in the histogram.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#bins)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "dataLineCreatedFunction", "type": "(((lineElement: any, labelElement?: any, index?: number | undefined) => void))", "complexType": { "original": "(((lineElement: any, labelElement?: any, index?: number | undefined) => void))", "resolved": "(((lineElement: any, labelElement?: any, index?: number | undefined) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Function that fires each time a data line is created.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#dataLineCreatedFunction)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "dataLines", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "HistogramDataLines": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "When set, renders lines on the histogram that indicate important or\nmeaningful values to the end user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#dataLines)", "docsTags": [], "values": [], "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": "\"graph-histogram\"", "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": "labelFormatFunction", "type": "(((value: number, type?: string | undefined, index?: number | undefined) => string))", "complexType": { "original": "(((value: number, type?: string | undefined, index?: number | undefined) => string))", "resolved": "(((value: number, type?: string | undefined, index?: number | undefined) => string))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "A function used to format labels on the histogram.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#labelFormatFunction)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "layout", "type": "\"horizontal\" | \"vertical\"", "complexType": { "original": "\"horizontal\" | \"vertical\"", "resolved": "\"horizontal\" | \"vertical\"", "references": {} }, "mutable": true, "attr": "layout", "reflectToAttr": false, "docs": "Determines the orientation of the Histogram widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#layout)", "docsTags": [], "default": "\"horizontal\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "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 bound of the entire histogram.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#max)", "docsTags": [], "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 bound of the entire histogram.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#min)", "docsTags": [], "values": [ { "type": "number" } ], "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\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"ready\"", "resolved": "\"disabled\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisHistogram = document.createElement(\"arcgis-histogram\");\ndocument.body.append(arcgisHistogram);\narcgisHistogram.componentOnReady().then(() => {\n console.log(\"arcgis-histogram is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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/histogram-range-slider/histogram-range-slider.tsx", "tag": "arcgis-histogram-range-slider", "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": "average", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "average", "reflectToAttr": false, "docs": "The statistical average of the data in the histogram.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#average)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "barCreatedFunction", "type": "(((index: number, element: any) => void))", "complexType": { "original": "(((index: number, element: any) => void))", "resolved": "(((index: number, element: any) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Function for styling bars representing histogram bins.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#barCreatedFunction)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "bins", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Bin": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of objects representing each bin in the histogram.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#bins)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "dataLineCreatedFunction", "type": "(((lineElement: any, labelElement?: any, index?: number | undefined) => void))", "complexType": { "original": "(((lineElement: any, labelElement?: any, index?: number | undefined) => void))", "resolved": "(((lineElement: any, labelElement?: any, index?: number | undefined) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Function that fires each time a data line is created.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLineCreatedFunction)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "dataLines", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "HistogramRangeSliderDataLines": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "When set, renders lines on the histogram that indicate important or\nmeaningful values to the end user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLines)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "excludedBarColor", "type": "Color", "complexType": { "original": "Color", "resolved": "Color", "references": { "Color": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "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/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#excludedBarColor)", "docsTags": [], "default": "\"#d7e5f0\"", "values": [], "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": "\"arrow-double-horizontal\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "includedBarColor", "type": "Color", "complexType": { "original": "Color", "resolved": "Color", "references": { "Color": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Sets the color of the histogram bars that are included in the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor)", "docsTags": [], "default": "\"#599dd4\"", "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": "labelFormatFunction", "type": "(value: number, type?: \"max\" | \"min\" | \"average\" | \"value\" | \"tick\" | undefined, index?: number | undefined) => string", "complexType": { "original": "(value: number, type?: \"max\" | \"min\" | \"average\" | \"value\" | \"tick\" | undefined, index?: number | undefined) => string", "resolved": "(value: number, type?: \"max\" | \"min\" | \"average\" | \"value\" | \"tick\" | undefined, index?: number | undefined) => string", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "A function used to format labels.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#labelFormatFunction)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#max)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#min)", "docsTags": [], "values": [ { "type": "number" } ], "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": "precision", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "precision", "reflectToAttr": false, "docs": "Defines how slider thumb values should be rounded.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#precision)", "docsTags": [], "default": "4", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "rangeType", "type": "\"at-least\" | \"at-most\" | \"between\" | \"equal\" | \"greater-than\" | \"less-than\" | \"not-between\" | \"not-equal\"", "complexType": { "original": "\"at-least\" | \"at-most\" | \"between\" | \"equal\" | \"greater-than\" | \"less-than\" | \"not-between\" | \"not-equal\"", "resolved": "\"at-least\" | \"at-most\" | \"between\" | \"equal\" | \"greater-than\" | \"less-than\" | \"not-between\" | \"not-equal\"", "references": {} }, "mutable": true, "attr": "range-type", "reflectToAttr": false, "docs": "Indicates how the histogram bins should be rendered as the user slides the thumbs.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType)", "docsTags": [], "values": [ { "value": "at-least", "type": "string" }, { "value": "at-most", "type": "string" }, { "value": "between", "type": "string" }, { "value": "equal", "type": "string" }, { "value": "greater-than", "type": "string" }, { "value": "less-than", "type": "string" }, { "value": "not-between", "type": "string" }, { "value": "not-equal", "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": "standardDeviation", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "standard-deviation", "reflectToAttr": false, "docs": "Indicates the standard deviation of the dataset.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#standardDeviation)", "docsTags": [], "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].\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#standardDeviationCount)", "docsTags": [], "default": "1", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"ready\"", "resolved": "\"disabled\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The state of the view model.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider-SliderViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "values", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of either one or two numbers representing thumb positions on the slider.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisHistogramRangeSlider = document.createElement(\"arcgis-histogram-range-slider\");\ndocument.body.append(arcgisHistogramRangeSlider);\narcgisHistogramRangeSlider.componentOnReady().then(() => {\n console.log(\"arcgis-histogram-range-slider is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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/home/home.tsx", "tag": "arcgis-home", "overview": "", "readme": "", "usage": {}, "docs": "Home component is a button that switches the view to its\ninitial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor a previously defined `viewpoint`.", "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": "goToOverride", "type": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "complexType": { "original": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "resolved": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "This function provides the ability to override either the\n[MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or\n[SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#goToOverride)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "icon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "icon", "reflectToAttr": true, "docs": "Icon displayed in the component's button.", "docsTags": [ { "name": "see", "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)" } ], "default": "\"home\"", "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": "messageOverrides", "type": "{\n componentLabel?: string | undefined;\n title?: string | undefined;\n cancel?: string | undefined;\n}", "complexType": { "original": "{\n componentLabel?: string | undefined;\n title?: string | undefined;\n cancel?: string | undefined;\n}", "resolved": "{\n componentLabel?: string | undefined;\n title?: string | undefined;\n cancel?: string | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "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": true, "docs": "", "docsTags": [], "default": "\"top-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\" | \"going-home\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"going-home\" | \"ready\"", "resolved": "\"disabled\" | \"going-home\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "going-home", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "viewpoint", "type": "Viewpoint", "complexType": { "original": "Viewpoint", "resolved": "Viewpoint", "references": { "Viewpoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The esri/Viewpoint, or point of view, to zoom to when\ngoing home. The initial value is determined a few different ways:\n\nIf no esri/views/View is provided, the value is `null`.\nIf the esri/views/View is ready, but the esri/Viewpoint is not defined, the initial\nvalue of the esri/Viewpoint is determined when the esri/views/View became ready.\nIf the esri/views/View is ready and the esri/Viewpoint is defined by the user, the initial viewpoint value is the user-defined esri/Viewpoint.", "docsTags": [ { "name": "example", "text": "// Creates a viewpoint centered on the extent of a polygon geometry\nlet vp = new Viewpoint({\n targetGeometry: geom.extent\n});\n\n// Sets the model's viewpoint to the Viewpoint based on a polygon geometry\nhome.viewpoint = vp;" } ], "default": "null", "values": [], "optional": true, "required": false } ], "methods": [ { "name": "cancelGo", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "cancelGo(): Promise", "parameters": [], "docs": "This function provides the ability to interrupt and cancel the process\nof navigating the view back to the view's initial extent.", "docsTags": [ { "name": "since", "text": "4.9" } ] }, { "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisHome = document.createElement(\"arcgis-home\");\ndocument.body.append(arcgisHome);\narcgisHome.componentOnReady().then(() => {\n console.log(\"arcgis-home is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "go(): Promise", "parameters": [], "docs": "Animates the view to the initial Viewpoint of the view or the\nvalue of `viewpoint`", "docsTags": [] } ], "events": [ { "event": "arcgisGo", "detail": "HomeViewModelGoEvent", "bubbles": true, "complexType": { "original": "HomeViewModelGoEvent", "resolved": "HomeViewModelGoEvent", "references": { "HomeViewModelGoEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires when the go() method is called.", "docsTags": [ { "name": "example", "text": "home.addEventListener(\"go\", (event) => {\n console.log(\"updating viewpoint\");\n});" } ] }, { "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/layer-list/layer-list.tsx", "tag": "arcgis-layer-list", "overview": "", "readme": "", "usage": {}, "docs": "The Layer List component provides a way to display a list of layers, and switch on/off their visibility.", "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": "catalogLayerList", "type": "CatalogLayerList", "complexType": { "original": "CatalogLayerList", "resolved": "CatalogLayerList", "references": { "CatalogLayerList": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "LayerListCatalogOptions", "complexType": { "original": "LayerListCatalogOptions", "resolved": "LayerListCatalogOptions", "references": { "LayerListCatalogOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "[CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) specific properties.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogOptions)", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "collapsed", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "collapsed", "reflectToAttr": true, "docs": "Indicates whether the widget is collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#collapsed)", "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 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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled)", "docsTags": [], "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/api-reference/esri-widgets-LayerList.html#visibleElements) is true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterPlaceholder)", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "filterPredicate", "type": "(((item: ListItem) => void))", "complexType": { "original": "(((item: ListItem) => void))", "resolved": "(((item: ListItem) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterPredicate)", "docsTags": [], "default": "null", "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/api-reference/esri-widgets-LayerList.html#visibleElements) is true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#filterText)", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the heading of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#headingLevel)", "docsTags": [], "default": "2", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideCatalogLayerList", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-catalog-layer-list", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideFlow", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-flow", "reflectToAttr": false, "docs": "", "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": "", "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": "\"layers\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "knowledgeGraphOptions", "type": "LayerListKnowledgeGraphOptions", "complexType": { "original": "LayerListKnowledgeGraphOptions", "resolved": "LayerListKnowledgeGraphOptions", "references": { "LayerListKnowledgeGraphOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "[KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html) specific properties.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#knowledgeGraphOptions)", "docsTags": [], "default": "null", "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": "listItemCreatedFunction", "type": "(((event: any) => void))", "complexType": { "original": "(((event: any) => void))", "resolved": "(((event: any) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) is created.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#listItemCreatedFunction)", "docsTags": [], "default": "null", "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/api-reference/esri-widgets-LayerList.html#dragEnabled).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minDragEnabledItems)", "docsTags": [], "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 input box.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minFilterItems)", "docsTags": [], "default": "10", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "openedLayers", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that are opened\nin a [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList) or [tableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#tableList) flow item.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#openedLayers)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "[]", "values": [], "optional": true, "required": false }, { "name": "operationalItems", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of ListItems representing operational layers.", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "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": "selectedItems", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing operational layers\nselected by the user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectedItems)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "selectionMode", "type": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "complexType": { "original": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "resolved": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "references": {} }, "mutable": true, "attr": "selection-mode", "reflectToAttr": false, "docs": "Specifies the selection mode.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectionMode)", "docsTags": [], "default": "\"none\"", "values": [ { "value": "multiple", "type": "string" }, { "value": "none", "type": "string" }, { "value": "single", "type": "string" }, { "value": "single-persist", "type": "string" } ], "optional": true, "required": false }, { "name": "showCloseButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-close-button", "reflectToAttr": false, "docs": "", "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": "", "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": "", "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": "", "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": "", "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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 view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "tableList", "type": "TableList", "complexType": { "original": "TableList", "resolved": "TableList", "references": { "TableList": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "visibilityAppearance", "type": "\"checkbox\" | \"default\"", "complexType": { "original": "\"checkbox\" | \"default\"", "resolved": "\"checkbox\" | \"default\"", "references": {} }, "mutable": true, "attr": "visibility-appearance", "reflectToAttr": false, "docs": "Determines the icons used to indicate visibility.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibilityAppearance)", "docsTags": [], "default": "\"default\"", "values": [ { "value": "checkbox", "type": "string" }, { "value": "default", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisLayerList = document.createElement(\"arcgis-layer-list\");\ndocument.body.append(arcgisLayerList);\narcgisLayerList.componentOnReady().then(() => {\n console.log(\"arcgis-layer-list is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "triggerAction", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): Promise", "parameters": [ { "name": "action", "type": "ActionButton | ActionToggle", "docs": "" }, { "name": "item", "type": "ListItem", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "ActionButton": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ActionToggle": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): Promise", "parameters": [ { "name": "action", "type": "ActionButton | ActionToggle", "docs": "" }, { "name": "item", "type": "ListItem", "docs": "" } ], "docs": "Triggers an action on 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": [] }, { "event": "arcgisTriggerAction", "detail": "LayerListTriggerActionEvent", "bubbles": true, "complexType": { "original": "LayerListTriggerActionEvent", "resolved": "LayerListTriggerActionEvent", "references": { "LayerListTriggerActionEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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 describes the symbols used to represent layers in a map.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeLayerInfos", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ActiveLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Collection of [ActiveLayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-support-ActiveLayerInfo.html) objects used by the legend view to\ndisplay data in the legend.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#activeLayerInfos)", "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\\` method when you are done to prevent\nmemory 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/api-reference/esri-Basemap.html) layers in the Legend.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#basemapLegendVisible)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the legend title.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#headingLevel)", "docsTags": [], "default": "3", "values": [ { "type": "number" } ], "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\nthey are visible in the view's extent.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#hideLayersNotInCurrentView)", "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": "\"legend\"", "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": "layerInfos", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "LegendLayerInfos": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Specifies a subset of the layers to display in the legend.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#layerInfos)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "legendStyle", "type": "LegendStyle | string", "complexType": { "original": "LegendStyle | string", "resolved": "LegendStyle | string", "references": { "LegendStyle": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "legend-style", "reflectToAttr": false, "docs": "Indicates the style of the legend.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#style)", "docsTags": [], "default": "\"classic\"", "values": [ { "type": "LegendStyle" }, { "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": "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 expression](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#definitionExpression)\nwill be displayed in the legend when set to true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#respectLayerDefinitionExpression)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "respectLayerVisibilityDisabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "respect-layer-visibility-disabled", "reflectToAttr": false, "docs": "Determines whether to respect the properties of the layers in the map that\ncontrol the legend's visibility (`minScale`, `maxScale`, `legendEnabled`).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend.html#respectLayerVisibility)", "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, "attr": "state", "reflectToAttr": true, "docs": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Legend-LegendViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisLegend = document.createElement(\"arcgis-legend\");\ndocument.body.append(arcgisLegend);\narcgisLegend.componentOnReady().then(() => {\n console.log(\"arcgis-legend is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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/line-of-sight/line-of-sight.tsx", "tag": "arcgis-line-of-sight", "overview": "", "readme": "", "usage": {}, "docs": "LineOfSight component is a 3D analysis tool that allows you to perform visibility analysis in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "analysis", "type": "LineOfSightAnalysis", "complexType": { "original": "LineOfSightAnalysis", "resolved": "LineOfSightAnalysis", "references": { "LineOfSightAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The line of sight analysis object being created or modified by the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LineOfSight.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": "\"line-of-sight\"", "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": "\"created\" | \"creating\" | \"disabled\" | \"ready\"", "complexType": { "original": "\"created\" | \"creating\" | \"disabled\" | \"ready\"", "resolved": "\"created\" | \"creating\" | \"disabled\" | \"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-LineOfSight-LineOfSightViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "created", "type": "string" }, { "value": "creating", "type": "string" }, { "value": "disabled", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "clear", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clear(): Promise", "parameters": [], "docs": "Clears 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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisLineOfSight = document.createElement(\"arcgis-line-of-sight\");\ndocument.body.append(arcgisLineOfSight);\narcgisLineOfSight.componentOnReady().then(() => {\n console.log(\"arcgis-line-of-sight is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "continue", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "continue(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "start(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "stop", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "stop(): Promise", "parameters": [], "docs": "Stops the component.", "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/link-chart/link-chart.tsx", "tag": "arcgis-link-chart", "overview": "", "readme": "", "usage": {}, "docs": "Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html) from an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html).\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "allLayerViews", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "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": "background", "type": "ColorBackground", "complexType": { "original": "ColorBackground", "resolved": "ColorBackground", "references": { "ColorBackground": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "basemap", "type": "Basemap | string", "complexType": { "original": "Basemap | string", "resolved": "Basemap | string", "references": { "Basemap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "Basemap" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "basemapView", "type": "BasemapView", "complexType": { "original": "BasemapView", "resolved": "BasemapView", "references": { "BasemapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "center", "type": "Array | Point | string", "complexType": { "original": "Array | Point | string", "resolved": "Array | Point | string", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "Array" }, { "type": "Point" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "constraints", "type": "View2DConstraints", "complexType": { "original": "View2DConstraints", "resolved": "View2DConstraints", "references": { "View2DConstraints": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Specifies constraints to scale, zoom, and rotation that may be applied to the LinkChartView.", "docsTags": [], "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": "Extent", "complexType": { "original": "Extent", "resolved": "Extent", "references": { "Extent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-geometry-Extent.html).\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", "complexType": { "original": "Error", "resolved": "Error", "references": { "Error": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A rejected view indicates a fatal error making it unable to display.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "graphics", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Graphic": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Allows for adding graphics directly to the default graphics in the View.\nExample:\n```\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n```\nExample:\n```\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "highlights", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HighlightOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "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": "string", "complexType": { "original": "string", "resolved": "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/api-reference/esri-config.html#portalUrl) before the `arcgis-linkchart` component loads.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layerViews", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-layers-LayerView.html) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html#layers) in the link chart.", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "magnifier", "type": "Magnifier", "complexType": { "original": "Magnifier", "resolved": "Magnifier", "references": { "Magnifier": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "map", "type": "WebLinkChart", "complexType": { "original": "WebLinkChart", "resolved": "WebLinkChart", "references": { "WebLinkChart": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An instance of a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html)\nobject 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": { "Navigation": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Options to configure the navigation behavior of the View.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "padding", "type": "ViewPadding", "complexType": { "original": "ViewPadding", "resolved": "ViewPadding", "references": { "ViewPadding": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center),\nand [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent), etc.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding)", "docsTags": [], "default": "{left: 0, top: 0, right: 0, bottom: 0}", "values": [], "optional": true, "required": false }, { "name": "popup", "type": "Popup", "complexType": { "original": "Popup", "resolved": "Popup", "references": { "Popup": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) object that displays general content or attributes from\n[layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#map).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#popup)", "docsTags": [], "values": [], "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 popup opens when users click on the view.", "docsTags": [], "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.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "resizeAlign", "type": "\"bottom\" | \"bottom-left\" | \"bottom-right\" | \"center\" | \"left\" | \"right\" | \"top\" | \"top-left\" | \"top-right\"", "complexType": { "original": "\"bottom\" | \"bottom-left\" | \"bottom-right\" | \"center\" | \"left\" | \"right\" | \"top\" | \"top-left\" | \"top-right\"", "resolved": "\"bottom\" | \"bottom-left\" | \"bottom-right\" | \"center\" | \"left\" | \"right\" | \"top\" | \"top-left\" | \"top-right\"", "references": {} }, "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": [ { "value": "bottom", "type": "string" }, { "value": "bottom-left", "type": "string" }, { "value": "bottom-right", "type": "string" }, { "value": "center", "type": "string" }, { "value": "left", "type": "string" }, { "value": "right", "type": "string" }, { "value": "top", "type": "string" }, { "value": "top-left", "type": "string" }, { "value": "top-right", "type": "string" } ], "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": "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](#constraints) to `false`.", "docsTags": [], "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": "spatialReference", "type": "SpatialReference", "complexType": { "original": "SpatialReference", "resolved": "SpatialReference", "references": { "SpatialReference": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "default": "null", "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": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "theme", "type": "Theme", "complexType": { "original": "Theme", "resolved": "Theme", "references": { "Theme": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "This property specifies the base colors used by some widgets\nand components to render graphics and labels.", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "timeExtent", "type": "TimeExtent", "complexType": { "original": "TimeExtent", "resolved": "TimeExtent", "references": { "TimeExtent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "default": "null", "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": [], "default": "\"system\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "updating", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "updating", "reflectToAttr": true, "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": { "LinkChartView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": { "Viewpoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "addLayer", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(layer: __esri.Layer | Promise, index?: number): Promise", "parameters": [ { "name": "layer", "type": "Layer | Promise", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addLayer(layer: __esri.Layer | Promise, index?: number): Promise", "parameters": [ { "name": "layer", "type": "Layer | Promise", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "docs": "Adds a layer to the layers collection.", "docsTags": [] }, { "name": "addLayers", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(layers: __esri.Layer[], index?: number): Promise", "parameters": [ { "name": "layers", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addLayers(layers: __esri.Layer[], index?: number): Promise", "parameters": [ { "name": "layers", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "docs": "Adds a layer or array of layers to the layers collection.", "docsTags": [] }, { "name": "closePopup", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisLinkChart = document.createElement(\"arcgis-link-chart\");\ndocument.body.append(arcgisLinkChart);\narcgisLinkChart.componentOnReady().then(() => {\n console.log(\"arcgis-link-chart is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "goTo", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise", "parameters": [ { "name": "target", "type": "any", "docs": "" }, { "name": "options", "type": "GoToOptions2D | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "GoToOptions2D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise", "parameters": [ { "name": "target", "type": "any", "docs": "" }, { "name": "options", "type": "GoToOptions2D | undefined", "docs": "" } ], "docs": "Sets the view to a given target.", "docsTags": [] }, { "name": "openPopup", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(options?: __esri.PopupViewOpenPopupOptions): Promise", "parameters": [ { "name": "options", "type": "PopupViewOpenPopupOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "PopupViewOpenPopupOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise", "parameters": [ { "name": "options", "type": "PopupViewOpenPopupOptions | undefined", "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: __esri.MapViewScreenPoint | MouseEvent): __esri.Point", "parameters": [ { "name": "screenPoint", "type": "MapViewScreenPoint | MouseEvent", "docs": "" } ], "return": "Point", "references": { "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "MapViewScreenPoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "MouseEvent": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "signature": "toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point", "parameters": [ { "name": "screenPoint", "type": "MapViewScreenPoint | MouseEvent", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "toScreen", "returns": { "type": "MapViewScreenPoint | null | undefined", "docs": "" }, "complexType": { "signature": "(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish", "parameters": [ { "name": "point", "type": "Point", "docs": "" }, { "name": "options", "type": "ToScreenOptions2D | undefined", "docs": "" } ], "return": "MapViewScreenPoint | null | undefined", "references": { "MapViewScreenPoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ToScreenOptions2D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish", "parameters": [ { "name": "point", "type": "Point", "docs": "" }, { "name": "options", "type": "ToScreenOptions2D | undefined", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "tryFatalErrorRecovery", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "tryFatalErrorRecovery(): Promise", "parameters": [], "docs": "Call this method to clear any fatal errors resulting from a lost WebGL context.", "docsTags": [] }, { "name": "whenLayerView", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>", "parameters": [ { "name": "layer", "type": "Layer", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>", "parameters": [ { "name": "layer", "type": "Layer", "docs": "" } ], "docs": "Gets the LayerView created on the view for the given layer.", "docsTags": [] } ], "events": [ { "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": "ViewClickEvent", "bubbles": true, "complexType": { "original": "ViewClickEvent", "resolved": "ViewClickEvent", "references": { "ViewClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a user clicks on the view.", "docsTags": [] }, { "event": "arcgisViewDoubleClick", "detail": "ViewDoubleClickEvent", "bubbles": true, "complexType": { "original": "ViewDoubleClickEvent", "resolved": "ViewDoubleClickEvent", "references": { "ViewDoubleClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after double-clicking on the view.", "docsTags": [] }, { "event": "arcgisViewDrag", "detail": "ViewDragEvent", "bubbles": true, "complexType": { "original": "ViewDragEvent", "resolved": "ViewDragEvent", "references": { "ViewDragEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires during a pointer drag on the view.", "docsTags": [] }, { "event": "arcgisViewHold", "detail": "ViewHoldEvent", "bubbles": true, "complexType": { "original": "ViewHoldEvent", "resolved": "ViewHoldEvent", "references": { "ViewHoldEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires during a pointer drag on the view.", "docsTags": [] }, { "event": "arcgisViewImmediateClick", "detail": "ViewImmediateClickEvent", "bubbles": true, "complexType": { "original": "ViewImmediateClickEvent", "resolved": "ViewImmediateClickEvent", "references": { "ViewImmediateClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires right after a user clicks on the view.", "docsTags": [] }, { "event": "arcgisViewImmediateDoubleClick", "detail": "ViewImmediateDoubleClickEvent", "bubbles": true, "complexType": { "original": "ViewImmediateDoubleClickEvent", "resolved": "ViewImmediateDoubleClickEvent", "references": { "ViewImmediateDoubleClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Is emitted after two consecutive immediate-click events.", "docsTags": [] }, { "event": "arcgisViewKeyDown", "detail": "ViewKeyDownEvent", "bubbles": true, "complexType": { "original": "ViewKeyDownEvent", "resolved": "ViewKeyDownEvent", "references": { "ViewKeyDownEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a keyboard key is pressed.", "docsTags": [] }, { "event": "arcgisViewKeyUp", "detail": "ViewKeyUpEvent", "bubbles": true, "complexType": { "original": "ViewKeyUpEvent", "resolved": "ViewKeyUpEvent", "references": { "ViewKeyUpEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a keyboard key is pressed.", "docsTags": [] }, { "event": "arcgisViewLayerviewCreate", "detail": "ViewLayerviewCreateEvent", "bubbles": true, "complexType": { "original": "ViewLayerviewCreateEvent", "resolved": "ViewLayerviewCreateEvent", "references": { "ViewLayerviewCreateEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "ViewLayerviewCreateErrorEvent", "bubbles": true, "complexType": { "original": "ViewLayerviewCreateErrorEvent", "resolved": "ViewLayerviewCreateErrorEvent", "references": { "ViewLayerviewCreateErrorEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "ViewLayerviewDestroyEvent", "bubbles": true, "complexType": { "original": "ViewLayerviewDestroyEvent", "resolved": "ViewLayerviewDestroyEvent", "references": { "ViewLayerviewDestroyEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/interfaces.d.ts", "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": "ViewPointerDownEvent", "bubbles": true, "complexType": { "original": "ViewPointerDownEvent", "resolved": "ViewPointerDownEvent", "references": { "ViewPointerDownEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a mouse button is pressed, or a finger touches the display.", "docsTags": [] }, { "event": "arcgisViewPointerEnter", "detail": "ViewPointerEnterEvent", "bubbles": true, "complexType": { "original": "ViewPointerEnterEvent", "resolved": "ViewPointerEnterEvent", "references": { "ViewPointerEnterEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a mouse cursor enters the view, or a display touch begins.", "docsTags": [] }, { "event": "arcgisViewPointerLeave", "detail": "ViewPointerLeaveEvent", "bubbles": true, "complexType": { "original": "ViewPointerLeaveEvent", "resolved": "ViewPointerLeaveEvent", "references": { "ViewPointerLeaveEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a mouse cursor leaves the view, or a display touch ends.", "docsTags": [] }, { "event": "arcgisViewPointerMove", "detail": "ViewPointerMoveEvent", "bubbles": true, "complexType": { "original": "ViewPointerMoveEvent", "resolved": "ViewPointerMoveEvent", "references": { "ViewPointerMoveEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after the mouse or a finger on the display moves.", "docsTags": [] }, { "event": "arcgisViewPointerUp", "detail": "ViewPointerUpEvent", "bubbles": true, "complexType": { "original": "ViewPointerUpEvent", "resolved": "ViewPointerUpEvent", "references": { "ViewPointerUpEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [] } ], "styles": [], "slots": [], "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\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`", "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": true, "docs": "Icon displayed in the widget's button.", "docsTags": [ { "name": "see", "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)" }, { "name": "since", "text": "4.28" } ], "default": "\"nodes-link\"", "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": "layout", "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\"", "complexType": { "original": "\"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\"", "resolved": "\"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\"", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "The current selected link chart layout.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#layout)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"organic-standard\"", "values": [ { "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", "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": true, "docs": "", "docsTags": [], "default": "\"top-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": "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#preventExtentUpdate)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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-LinkChartLayoutSwitcher-LinkChartLayoutSwitcherViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"loading\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisLinkChartLayoutSwitcher = document.createElement(\"arcgis-link-chart-layout-switcher\");\ndocument.body.append(arcgisLinkChartLayoutSwitcher);\narcgisLinkChartLayoutSwitcher.componentOnReady().then(() => {\n console.log(\"arcgis-link-chart-layout-switcher is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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": [] }, { "event": "arcgisSwitchLayout", "detail": "LinkChartLayoutSwitcherViewModelSwitchLayoutEvent", "bubbles": true, "complexType": { "original": "LinkChartLayoutSwitcherViewModelSwitchLayoutEvent", "resolved": "LinkChartLayoutSwitcherViewModelSwitchLayoutEvent", "references": { "LinkChartLayoutSwitcherViewModelSwitchLayoutEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires when component has completed the layout switch", "docsTags": [ { "name": "example", "text": "layoutswitcher.addEventListener(\"arcgisSwitchLayout\", (event) => {\n console.log(\"Layout Switched\");\n});" } ] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/locate/locate.tsx", "tag": "arcgis-locate", "overview": "", "readme": "", "usage": {}, "docs": "Locate component animates the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) to the user's current location.", "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\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory leaks.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "geolocationOptions", "type": "any", "complexType": { "original": "any", "resolved": "any", "references": {} }, "mutable": true, "attr": "geolocation-options", "reflectToAttr": false, "docs": "An object used for setting optional position parameters.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#geolocationOptions)", "docsTags": [], "default": "null", "values": [ { "type": "any" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#goToLocationEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "goToOverride", "type": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "complexType": { "original": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "resolved": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "This function provides the ability to override either the\n[MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or\n[SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#goToOverride)", "docsTags": [], "values": [], "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 used to show the user's location on the map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#graphic)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "icon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "icon", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "\"gps-off\"", "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": "messageOverrides", "type": "{\n componentLabel?: string | undefined;\n title?: string | undefined;\n currentLocation?: string | undefined;\n timestamp?: string | undefined;\n latitude?: string | undefined;\n longitude?: string | undefined;\n accuracy?: string | undefined;\n altitude?: string | undefined;\n altitudeAccuracy?: string | undefined;\n heading?: string | undefined;\n speed?: string | undefined;\n permissionError?: string | undefined;\n timeoutError?: string | undefined;\n positionUnavailable?: string | undefined;\n cancel?: string | undefined;\n}", "complexType": { "original": "{\n componentLabel?: string | undefined;\n title?: string | undefined;\n currentLocation?: string | undefined;\n timestamp?: string | undefined;\n latitude?: string | undefined;\n longitude?: string | undefined;\n accuracy?: string | undefined;\n altitude?: string | undefined;\n altitudeAccuracy?: string | undefined;\n heading?: string | undefined;\n speed?: string | undefined;\n permissionError?: string | undefined;\n timeoutError?: string | undefined;\n positionUnavailable?: string | undefined;\n cancel?: string | undefined;\n}", "resolved": "{\n componentLabel?: string | undefined;\n title?: string | undefined;\n currentLocation?: string | undefined;\n timestamp?: string | undefined;\n latitude?: string | undefined;\n longitude?: string | undefined;\n accuracy?: string | undefined;\n altitude?: string | undefined;\n altitudeAccuracy?: string | undefined;\n heading?: string | undefined;\n speed?: string | undefined;\n permissionError?: string | undefined;\n timeoutError?: string | undefined;\n positionUnavailable?: string | undefined;\n cancel?: string | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "popupDisabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "popup-disabled", "reflectToAttr": false, "docs": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) of the result graphic from the\n[locate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#locate) method.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#popupEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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": true, "docs": "", "docsTags": [], "default": "\"top-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": "scale", "type": "number", "complexType": { "original": "number", "resolved": "number", "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 [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#event-track) event.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Locate-LocateViewModel.html#scale)", "docsTags": [], "default": "null", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"locating\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"locating\" | \"ready\"", "resolved": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"locating\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "error", "type": "string" }, { "value": "feature-unsupported", "type": "string" }, { "value": "locating", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "cancelLocate", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisLocate = document.createElement(\"arcgis-locate\");\ndocument.body.append(arcgisLocate);\narcgisLocate.componentOnReady().then(() => {\n console.log(\"arcgis-locate is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "GeolocationPosition": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "signature": "locate(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisError", "detail": "LocateViewModelLocateErrorEvent", "bubbles": true, "complexType": { "original": "LocateViewModelLocateErrorEvent", "resolved": "LocateViewModelLocateErrorEvent", "references": { "LocateViewModelLocateErrorEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when an error occurs.", "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": "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": [] }, { "event": "arcgisSuccess", "detail": "LocateLocateEvent", "bubbles": true, "complexType": { "original": "LocateLocateEvent", "resolved": "LocateLocateEvent", "references": { "LocateLocateEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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 component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and loads a WebMap from either [ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n\n```\n\nAlternatively, the Map component can be initialized without a WebMap item.\n\n```html\n\n```\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/api-reference/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst arcgisMap = document.querySelector(\"arcgis-map\");\narcgisMap.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My Layer\" });\n arcgisMap.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- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "allLayerViews", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "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": "background", "type": "ColorBackground", "complexType": { "original": "ColorBackground", "resolved": "ColorBackground", "references": { "ColorBackground": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The background color of the MapView. If the view's map changes, the view's `background` is reset to the map's background,\neven if the user set it previously.", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "basemap", "type": "Basemap | string", "complexType": { "original": "Basemap | string", "resolved": "Basemap | string", "references": { "Basemap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-Map.html#basemap)),\n[Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)\nor [BasemapStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)", "docsTags": [], "values": [ { "type": "Basemap" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "basemapView", "type": "BasemapView", "complexType": { "original": "BasemapView", "resolved": "BasemapView", "references": { "BasemapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "center", "type": "Array | Point | string", "complexType": { "original": "Array | Point | string", "resolved": "Array | Point | string", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "Array" }, { "type": "Point" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "constraints", "type": "View2DConstraints", "complexType": { "original": "View2DConstraints", "resolved": "View2DConstraints", "references": { "View2DConstraints": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Specifies constraints to scale, zoom, and rotation that may be applied to the MapView.", "docsTags": [], "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": "Extent", "complexType": { "original": "Extent", "resolved": "Extent", "references": { "Extent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The extent represents the visible portion of a map within the view as an instance of esri/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 map.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "fatalError", "type": "Error", "complexType": { "original": "Error", "resolved": "Error", "references": { "Error": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A rejected view indicates a fatal error making it unable to display.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "floors", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": { "GamepadSettings": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Graphic": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Allows for adding graphics directly to the default graphics in the View.\nExample:\n```\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n```\nExample:\n```\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "ground", "type": "Ground | string", "complexType": { "original": "Ground | string", "resolved": "Ground | string", "references": { "Ground": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "ground", "reflectToAttr": false, "docs": "Specifies the surface properties for the map.", "docsTags": [], "values": [ { "type": "Ground" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "highlightOptions", "type": "HighlightOptions", "complexType": { "original": "HighlightOptions", "resolved": "HighlightOptions", "references": { "HighlightOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Options for configuring the highlight.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#highlightOptions)", "docsTags": [], "deprecation": "Options for configuring the highlight. Use the highlight method on the\nappropriate esri/views/layers/LayerView to highlight a feature.\nThe layerView's `highlightOptions` will take precedence over the MapView's `highlightOptions` if both properties are set.", "values": [], "optional": true, "required": false }, { "name": "highlights", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HighlightOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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 map.", "docsTags": [], "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": "ipsInfo", "type": "IPSInfo", "complexType": { "original": "IPSInfo", "resolved": "IPSInfo", "references": { "IPSInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Contains indoor positioning system information for the map.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "itemId", "type": "string", "complexType": { "original": "string", "resolved": "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/api-reference/esri-config.html#portalUrl) before the `arcgis-map` component loads.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layerViews", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection containing a hierarchical list of all the created\nesri/views/layers/LayerView LayerViews of the\nesri/Map#layers operational layers in the map.", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "magnifier", "type": "Magnifier", "complexType": { "original": "Magnifier", "resolved": "Magnifier", "references": { "Magnifier": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "map", "type": "Map", "complexType": { "original": "Map", "resolved": "Map", "references": { "Map": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An instance of a esri/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": { "Navigation": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Options to configure the navigation behavior of the View.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "padding", "type": "ViewPadding", "complexType": { "original": "ViewPadding", "resolved": "ViewPadding", "references": { "ViewPadding": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#center),\nand [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#extent), etc.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#padding)", "docsTags": [], "default": "{left: 0, top: 0, right: 0, bottom: 0}", "values": [], "optional": true, "required": false }, { "name": "popup", "type": "Popup", "complexType": { "original": "Popup", "resolved": "Popup", "references": { "Popup": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) object that displays general content or attributes from\n[layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#map).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#popup)", "docsTags": [], "values": [], "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 popup opens when users click on the view.", "docsTags": [], "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.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "resizeAlign", "type": "\"bottom\" | \"bottom-left\" | \"bottom-right\" | \"center\" | \"left\" | \"right\" | \"top\" | \"top-left\" | \"top-right\"", "complexType": { "original": "\"bottom\" | \"bottom-left\" | \"bottom-right\" | \"center\" | \"left\" | \"right\" | \"top\" | \"top-left\" | \"top-right\"", "resolved": "\"bottom\" | \"bottom-left\" | \"bottom-right\" | \"center\" | \"left\" | \"right\" | \"top\" | \"top-left\" | \"top-right\"", "references": {} }, "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": [ { "value": "bottom", "type": "string" }, { "value": "bottom-left", "type": "string" }, { "value": "bottom-right", "type": "string" }, { "value": "center", "type": "string" }, { "value": "left", "type": "string" }, { "value": "right", "type": "string" }, { "value": "top", "type": "string" }, { "value": "top-left", "type": "string" }, { "value": "top-right", "type": "string" } ], "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": "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](#constraints) to `false`. See the code snippet below for\nan example of this.", "docsTags": [], "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() method.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "spatialReference", "type": "SpatialReference", "complexType": { "original": "SpatialReference", "resolved": "SpatialReference", "references": { "SpatialReference": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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 map.", "docsTags": [], "default": "null", "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": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "theme", "type": "Theme", "complexType": { "original": "Theme", "resolved": "Theme", "references": { "Theme": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "This property specifies the base colors used by some widgets\nand components to render graphics and labels.", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "timeExtent", "type": "TimeExtent", "complexType": { "original": "TimeExtent", "resolved": "TimeExtent", "references": { "TimeExtent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "default": "null", "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": [], "default": "\"system\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "updating", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "updating", "reflectToAttr": true, "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": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": { "Viewpoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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 map appear in a map 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 MapView converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\nMapView can display maps 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": "addLayer", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(layer: __esri.Layer | Promise, index?: number): Promise", "parameters": [ { "name": "layer", "type": "Layer | Promise", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addLayer(layer: __esri.Layer | Promise, index?: number): Promise", "parameters": [ { "name": "layer", "type": "Layer | Promise", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "docs": "Adds a layer to the map layers collection.", "docsTags": [] }, { "name": "addLayers", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(layers: __esri.Layer[], index?: number): Promise", "parameters": [ { "name": "layers", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addLayers(layers: __esri.Layer[], index?: number): Promise", "parameters": [ { "name": "layers", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "docs": "Adds a layer or array of layers to the map layers collection.", "docsTags": [] }, { "name": "addTable", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(table: __esri.FeatureLayer): Promise", "parameters": [ { "name": "table", "type": "FeatureLayer", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FeatureLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addTable(table: __esri.FeatureLayer): Promise", "parameters": [ { "name": "table", "type": "FeatureLayer", "docs": "" } ], "docs": "Adds a table to the map tables collection.", "docsTags": [] }, { "name": "addTables", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(tables: __esri.FeatureLayer[], index?: number): Promise", "parameters": [ { "name": "tables", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FeatureLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addTables(tables: __esri.FeatureLayer[], index?: number): Promise", "parameters": [ { "name": "tables", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "docs": "Adds a table or array of tables to the map tables collection.", "docsTags": [] }, { "name": "closePopup", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisMap = document.createElement(\"arcgis-map\");\ndocument.body.append(arcgisMap);\narcgisMap.componentOnReady().then(() => {\n console.log(\"arcgis-map is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "goTo", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise", "parameters": [ { "name": "target", "type": "any", "docs": "" }, { "name": "options", "type": "GoToOptions2D | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "GoToOptions2D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise", "parameters": [ { "name": "target", "type": "any", "docs": "" }, { "name": "options", "type": "GoToOptions2D | undefined", "docs": "" } ], "docs": "Sets the view to a given target.", "docsTags": [] }, { "name": "hitTest", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>", "parameters": [ { "name": "screenPoint", "type": "MapViewScreenPoint | MouseEvent", "docs": "" }, { "name": "options", "type": "MapViewHitTestOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "HitTestResult": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "MapViewScreenPoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "MouseEvent": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" }, "MapViewHitTestOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>", "parameters": [ { "name": "screenPoint", "type": "MapViewScreenPoint | MouseEvent", "docs": "" }, { "name": "options", "type": "MapViewHitTestOptions | undefined", "docs": "" } ], "docs": "Returns hit test results from each layer that intersects the specified screen coordinates.", "docsTags": [] }, { "name": "openPopup", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(options?: __esri.PopupViewOpenPopupOptions): Promise", "parameters": [ { "name": "options", "type": "PopupViewOpenPopupOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "PopupViewOpenPopupOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise", "parameters": [ { "name": "options", "type": "PopupViewOpenPopupOptions | undefined", "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?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>", "parameters": [ { "name": "options", "type": "MapViewTakeScreenshotOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Screenshot": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "MapViewTakeScreenshotOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "takeScreenshot(options?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>", "parameters": [ { "name": "options", "type": "MapViewTakeScreenshotOptions | undefined", "docs": "" } ], "docs": "Create a screenshot of the current view.", "docsTags": [] }, { "name": "toMap", "returns": { "type": "Point", "docs": "" }, "complexType": { "signature": "(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point", "parameters": [ { "name": "screenPoint", "type": "MapViewScreenPoint | MouseEvent", "docs": "" } ], "return": "Point", "references": { "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "MapViewScreenPoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "MouseEvent": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "signature": "toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point", "parameters": [ { "name": "screenPoint", "type": "MapViewScreenPoint | MouseEvent", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "toScreen", "returns": { "type": "MapViewScreenPoint | null | undefined", "docs": "" }, "complexType": { "signature": "(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish", "parameters": [ { "name": "point", "type": "Point", "docs": "" }, { "name": "options", "type": "ToScreenOptions2D | undefined", "docs": "" } ], "return": "MapViewScreenPoint | null | undefined", "references": { "MapViewScreenPoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ToScreenOptions2D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish", "parameters": [ { "name": "point", "type": "Point", "docs": "" }, { "name": "options", "type": "ToScreenOptions2D | undefined", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "tryFatalErrorRecovery", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "tryFatalErrorRecovery(): Promise", "parameters": [], "docs": "Call this method to clear any fatal errors resulting from a lost WebGL context.", "docsTags": [] }, { "name": "whenLayerView", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>", "parameters": [ { "name": "layer", "type": "Layer", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>", "parameters": [ { "name": "layer", "type": "Layer", "docs": "" } ], "docs": "Gets the LayerView created on the view for the given layer.", "docsTags": [] } ], "events": [ { "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": "ViewClickEvent", "bubbles": true, "complexType": { "original": "ViewClickEvent", "resolved": "ViewClickEvent", "references": { "ViewClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a user clicks on the view.", "docsTags": [] }, { "event": "arcgisViewDoubleClick", "detail": "ViewDoubleClickEvent", "bubbles": true, "complexType": { "original": "ViewDoubleClickEvent", "resolved": "ViewDoubleClickEvent", "references": { "ViewDoubleClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after double-clicking on the view.", "docsTags": [] }, { "event": "arcgisViewDrag", "detail": "ViewDragEvent", "bubbles": true, "complexType": { "original": "ViewDragEvent", "resolved": "ViewDragEvent", "references": { "ViewDragEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires during a pointer drag on the view.", "docsTags": [] }, { "event": "arcgisViewHold", "detail": "ViewHoldEvent", "bubbles": true, "complexType": { "original": "ViewHoldEvent", "resolved": "ViewHoldEvent", "references": { "ViewHoldEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires during a pointer drag on the view.", "docsTags": [] }, { "event": "arcgisViewImmediateClick", "detail": "ViewImmediateClickEvent", "bubbles": true, "complexType": { "original": "ViewImmediateClickEvent", "resolved": "ViewImmediateClickEvent", "references": { "ViewImmediateClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires right after a user clicks on the view.", "docsTags": [] }, { "event": "arcgisViewImmediateDoubleClick", "detail": "ViewImmediateDoubleClickEvent", "bubbles": true, "complexType": { "original": "ViewImmediateDoubleClickEvent", "resolved": "ViewImmediateDoubleClickEvent", "references": { "ViewImmediateDoubleClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Is emitted after two consecutive immediate-click events.", "docsTags": [] }, { "event": "arcgisViewKeyDown", "detail": "ViewKeyDownEvent", "bubbles": true, "complexType": { "original": "ViewKeyDownEvent", "resolved": "ViewKeyDownEvent", "references": { "ViewKeyDownEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a keyboard key is pressed.", "docsTags": [] }, { "event": "arcgisViewKeyUp", "detail": "ViewKeyUpEvent", "bubbles": true, "complexType": { "original": "ViewKeyUpEvent", "resolved": "ViewKeyUpEvent", "references": { "ViewKeyUpEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a keyboard key is pressed.", "docsTags": [] }, { "event": "arcgisViewLayerviewCreate", "detail": "ViewLayerviewCreateEvent", "bubbles": true, "complexType": { "original": "ViewLayerviewCreateEvent", "resolved": "ViewLayerviewCreateEvent", "references": { "ViewLayerviewCreateEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after each layer in the map has a corresponding LayerView created and rendered in the view.", "docsTags": [] }, { "event": "arcgisViewLayerviewCreateError", "detail": "ViewLayerviewCreateErrorEvent", "bubbles": true, "complexType": { "original": "ViewLayerviewCreateErrorEvent", "resolved": "ViewLayerviewCreateErrorEvent", "references": { "ViewLayerviewCreateErrorEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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.", "docsTags": [] }, { "event": "arcgisViewLayerviewDestroy", "detail": "ViewLayerviewDestroyEvent", "bubbles": true, "complexType": { "original": "ViewLayerviewDestroyEvent", "resolved": "ViewLayerviewDestroyEvent", "references": { "ViewLayerviewDestroyEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/interfaces.d.ts", "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": "ViewPointerDownEvent", "bubbles": true, "complexType": { "original": "ViewPointerDownEvent", "resolved": "ViewPointerDownEvent", "references": { "ViewPointerDownEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a mouse button is pressed, or a finger touches the display.", "docsTags": [] }, { "event": "arcgisViewPointerEnter", "detail": "ViewPointerEnterEvent", "bubbles": true, "complexType": { "original": "ViewPointerEnterEvent", "resolved": "ViewPointerEnterEvent", "references": { "ViewPointerEnterEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a mouse cursor enters the view, or a display touch begins.", "docsTags": [] }, { "event": "arcgisViewPointerLeave", "detail": "ViewPointerLeaveEvent", "bubbles": true, "complexType": { "original": "ViewPointerLeaveEvent", "resolved": "ViewPointerLeaveEvent", "references": { "ViewPointerLeaveEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a mouse cursor leaves the view, or a display touch ends.", "docsTags": [] }, { "event": "arcgisViewPointerMove", "detail": "ViewPointerMoveEvent", "bubbles": true, "complexType": { "original": "ViewPointerMoveEvent", "resolved": "ViewPointerMoveEvent", "references": { "ViewPointerMoveEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after the mouse or a finger on the display moves.", "docsTags": [] }, { "event": "arcgisViewPointerUp", "detail": "ViewPointerUpEvent", "bubbles": true, "complexType": { "original": "ViewPointerUpEvent", "resolved": "ViewPointerUpEvent", "references": { "ViewPointerUpEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/measurement/measurement.tsx", "tag": "arcgis-measurement", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "internal" }, { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeTool", "type": "\"area\" | \"direct-line\" | \"distance\"", "complexType": { "original": "\"area\" | \"direct-line\" | \"distance\"", "resolved": "\"area\" | \"direct-line\" | \"distance\"", "references": {} }, "mutable": true, "attr": "active-tool", "reflectToAttr": false, "docs": "Specifies the current measurement tool to display.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#activeTool)", "docsTags": [], "default": "null", "values": [ { "value": "area", "type": "string" }, { "value": "direct-line", "type": "string" }, { "value": "distance", "type": "string" } ], "optional": true, "required": false }, { "name": "activeWidget", "type": "AreaMeasurement2D | AreaMeasurement3D | DirectLineMeasurement3D | DistanceMeasurement2D", "complexType": { "original": "AreaMeasurement2D | AreaMeasurement3D | DirectLineMeasurement3D | DistanceMeasurement2D", "resolved": "AreaMeasurement2D | AreaMeasurement3D | DirectLineMeasurement3D | DistanceMeasurement2D", "references": { "AreaMeasurement2D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "AreaMeasurement3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "DirectLineMeasurement3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "DistanceMeasurement2D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The measurement widget that is currently being used.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#activeWidget)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "null", "values": [ { "type": "AreaMeasurement2D" }, { "type": "AreaMeasurement3D" }, { "type": "DirectLineMeasurement3D" }, { "type": "DistanceMeasurement2D" } ], "optional": true, "required": false }, { "name": "areaUnit", "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": "area-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-Measurement.html#areaUnit)", "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": "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\"", "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": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "complexType": { "original": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "resolved": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "references": {} }, "mutable": true, "attr": "linear-unit", "reflectToAttr": false, "docs": "Unit system (imperial, metric) or specific unit used for displaying the distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement.html#linearUnit)", "docsTags": [], "values": [ { "value": "centimeters", "type": "string" }, { "value": "decimeters", "type": "string" }, { "value": "feet", "type": "string" }, { "value": "imperial", "type": "string" }, { "value": "inches", "type": "string" }, { "value": "kilometers", "type": "string" }, { "value": "meters", "type": "string" }, { "value": "metric", "type": "string" }, { "value": "miles", "type": "string" }, { "value": "millimeters", "type": "string" }, { "value": "nautical-miles", "type": "string" }, { "value": "us-feet", "type": "string" }, { "value": "yards", "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 ViewModel's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Measurement-MeasurementViewModel.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 } ], "methods": [ { "name": "clear", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clear(): Promise", "parameters": [], "docs": "Clears 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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisMeasurement = document.createElement(\"arcgis-measurement\");\ndocument.body.append(arcgisMeasurement);\narcgisMeasurement.componentOnReady().then(() => {\n console.log(\"arcgis-measurement is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "startMeasurement(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"activeTool\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"activeTool\"; }", "resolved": "{ name: \"state\" | \"activeTool\"; }", "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/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\nThe Navigation Toggle component is only supported in 3D.", "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": true, "docs": "Icon which represents the component. It is typically used when the\ncomponent is controlled by another one (e.g. in the arcgis-expand\ncomponent).", "docsTags": [ { "name": "see", "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)" } ], "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": "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": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "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. See the table below for a list of\npossible values.\n\nPossible Value | Description\n---------------|-------------\npan | The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\nrotate | 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": [ { "value": "pan", "type": "string" }, { "value": "rotate", "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": "\"top-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\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"ready\"", "resolved": "\"disabled\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisNavigationToggle = document.createElement(\"arcgis-navigation-toggle\");\ndocument.body.append(arcgisNavigationToggle);\narcgisNavigationToggle.componentOnReady().then(() => {\n console.log(\"arcgis-navigation-toggle is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "toggle(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"layout\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"layout\"; }", "resolved": "{ name: \"state\" | \"layout\"; }", "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/oriented-imagery-viewer/oriented-imagery-viewer.tsx", "tag": "arcgis-oriented-imagery-viewer", "overview": "", "readme": "", "usage": {}, "docs": "The OrientedImageryViewer component allows the user to explore and use their oriented images.", "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": "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#currentCoverageVisible)", "docsTags": [], "default": "true", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#dataCaptureEnabled)", "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 `false`, the view click interaction is enabled for the oriented imagery viewer widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#disabled)", "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 widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#galleryOpened)", "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": "\"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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#imageEnhancementToolActive)", "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 widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#imageGalleryEnabled)", "docsTags": [ { "name": "readonly", "text": "" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#isAdditionalCoverageVisible)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#isAdditionalPointSourcesVisible)", "docsTags": [], "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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layer", "type": "OrientedImageryLayer", "complexType": { "original": "OrientedImageryLayer", "resolved": "OrientedImageryLayer", "references": { "OrientedImageryLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Specifies the current [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html) to use.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#layer)", "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 widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#mapImageConversionToolState)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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 widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#navigationToolActive)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "orientedImageryLayerItemId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "oriented-imagery-layer-item-id", "reflectToAttr": false, "docs": "", "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": "referencePoint", "type": "Point", "complexType": { "original": "Point", "resolved": "Point", "references": { "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#referencePoint)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisOrientedImageryViewer = document.createElement(\"arcgis-oriented-imagery-viewer\");\ndocument.body.append(arcgisOrientedImageryViewer);\narcgisOrientedImageryViewer.componentOnReady().then(() => {\n console.log(\"arcgis-oriented-imagery-viewer is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"layer\" | \"imageGalleryEnabled\"; }", "bubbles": true, "complexType": { "original": "{ name: \"layer\" | \"imageGalleryEnabled\"; }", "resolved": "{ name: \"layer\" | \"imageGalleryEnabled\"; }", "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/placement/placement.tsx", "tag": "arcgis-placement", "overview": "", "readme": "", "usage": {}, "docs": "The placement component is used to position content relative to the map. This component may be **temporary** until we offer a more robust solution.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "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 } ], "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisPlacement = document.createElement(\"arcgis-placement\");\ndocument.body.append(arcgisPlacement);\narcgisPlacement.componentOnReady().then(() => {\n console.log(\"arcgis-placement is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "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/print/print.tsx", "tag": "arcgis-print", "overview": "", "readme": "", "usage": {}, "docs": "Print component connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "allowedFormats", "type": "Array | string", "complexType": { "original": "Array | string", "resolved": "Array | string", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#allowedFormats)", "docsTags": [], "default": "\"all\"", "values": [ { "type": "Array" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "allowedLayouts", "type": "Array | string", "complexType": { "original": "Array | string", "resolved": "Array | string", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#allowedLayouts)", "docsTags": [], "default": "\"all\"", "values": [ { "type": "Array" }, { "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\\` method when you are done to prevent\nmemory leaks.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "exportedLinks", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "FileLink": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The collection of links exported from the Print widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#exportedLinks)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "extraParameters", "type": "any", "complexType": { "original": "any", "resolved": "any", "references": {} }, "mutable": true, "attr": "extra-parameters", "reflectToAttr": false, "docs": "This option allows passing extra parameters (in addition to [templateOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateOptions)) to the print (export webmap) requests.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#extraParameters)", "docsTags": [], "values": [ { "type": "any" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#headingLevel)", "docsTags": [], "default": "3", "values": [ { "type": "number" } ], "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": "\"print\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "includeDefaultTemplatesDisabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-default-templates-disabled", "reflectToAttr": false, "docs": "Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#defaultTemplates).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#includeDefaultTemplates)", "docsTags": [], "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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "portal", "type": "Portal", "complexType": { "original": "Portal", "resolved": "Portal", "references": { "Portal": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#portal)", "docsTags": [], "values": [], "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": "printServiceUrl", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "print-service-url", "reflectToAttr": false, "docs": "The URL of the REST endpoint of the Export Web Map Task.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#printServiceUrl)", "docsTags": [], "values": [ { "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": "showPrintAreaEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-print-area-enabled", "reflectToAttr": true, "docs": "The initial state of the print area toggle in the Print widget UI.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#showPrintAreaEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"error\" | \"initializing\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"error\" | \"initializing\" | \"ready\"", "resolved": "\"disabled\" | \"error\" | \"initializing\" | \"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-Print-PrintViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "error", "type": "string" }, { "value": "initializing", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "templateCustomTextElements", "type": "{\n [x: string]: Array> | undefined;\n}", "complexType": { "original": "{\n [x: string]: Array> | undefined;\n}", "resolved": "{\n [x: string]: Array> | undefined;\n}", "references": { "HashMap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateCustomTextElements)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "templateOptions", "type": "TemplateOptions", "complexType": { "original": "TemplateOptions", "resolved": "TemplateOptions", "references": { "TemplateOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Defines the layout template options used by the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget to generate the print page.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html#templateOptions)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisPrint = document.createElement(\"arcgis-print\");\ndocument.body.append(arcgisPrint);\narcgisPrint.componentOnReady().then(() => {\n console.log(\"arcgis-print is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "event": "arcgisComplete", "detail": "PrintCompleteEvent", "bubbles": true, "complexType": { "original": "PrintCompleteEvent", "resolved": "PrintCompleteEvent", "references": { "PrintCompleteEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "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": [] }, { "event": "arcgisSubmit", "detail": "PrintSubmitEvent", "bubbles": true, "complexType": { "original": "PrintSubmitEvent", "resolved": "PrintSubmitEvent", "references": { "PrintSubmitEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when the component is submitted.", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/scale-bar/scale-bar.tsx", "tag": "arcgis-scale-bar", "overview": "", "readme": "", "usage": {}, "docs": "The Scale Bar componenent 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 an `arcgis-scene` component.", "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\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory leaks.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "barStyle", "type": "\"line\" | \"ruler\"", "complexType": { "original": "\"line\" | \"ruler\"", "resolved": "\"line\" | \"ruler\"", "references": {} }, "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": [ { "value": "line", "type": "string" }, { "value": "ruler", "type": "string" } ], "optional": true, "required": false }, { "name": "icon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "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).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "docsTags": [], "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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "messageOverrides", "type": "{ componentLabel?: string | undefined; }", "complexType": { "original": "{ componentLabel?: string | undefined; }", "resolved": "{ componentLabel?: string | undefined; }", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "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": true, "docs": "", "docsTags": [], "default": "\"top-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": "unit", "type": "\"dual\" | \"imperial\" | \"metric\"", "complexType": { "original": "\"dual\" | \"imperial\" | \"metric\"", "resolved": "\"dual\" | \"imperial\" | \"metric\"", "references": {} }, "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": [ { "value": "dual", "type": "string" }, { "value": "imperial", "type": "string" }, { "value": "metric", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisScaleBar = document.createElement(\"arcgis-scale-bar\");\ndocument.body.append(arcgisScaleBar);\narcgisScaleBar.componentOnReady().then(() => {\n console.log(\"arcgis-scale-bar is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "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/scale-range-slider/scale-range-slider.tsx", "tag": "arcgis-scale-range-slider", "overview": "", "readme": "", "usage": {}, "docs": "The ScaleRangeSlider component allows the user to set a minimum and maximum scale based on named scale ranges.", "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": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "disabled", "reflectToAttr": true, "docs": "When `true`, sets the widget to a disabled state so the user cannot interact with it.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#disabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hidePreview", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-preview", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideScaleMenusMaxScaleMenu", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-scale-menus-max-scale-menu", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "hideScaleMenusMinScaleMenu", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-scale-menus-min-scale-menu", "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": "\"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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layer", "type": "Layer | Sublayer", "complexType": { "original": "Layer | Sublayer", "resolved": "Layer | Sublayer", "references": { "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Sublayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "When provided, the initial [minScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScale) and [maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScale) values will match the layer's.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#layer)", "docsTags": [], "values": [ { "type": "Layer" }, { "type": "Sublayer" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScale)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScaleLimit)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScale)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScaleLimit)", "docsTags": [], "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 widget, indicating which slider thumbs can be adjusted.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#mode)", "docsTags": [], "default": "\"range\"", "values": [ { "value": "max-scale-only", "type": "string" }, { "value": "min-scale-only", "type": "string" }, { "value": "range", "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": "region", "type": "SupportedRegion", "complexType": { "original": "SupportedRegion", "resolved": "SupportedRegion", "references": { "SupportedRegion": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The region that the scale thumbnails will focus on.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#region)", "docsTags": [], "default": "\"US\"", "values": [], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"ready\"", "resolved": "\"disabled\" | \"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-ScaleRangeSlider-ScaleRangeSliderViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisScaleRangeSlider = document.createElement(\"arcgis-scale-range-slider\");\ndocument.body.append(arcgisScaleRangeSlider);\narcgisScaleRangeSlider.componentOnReady().then(() => {\n console.log(\"arcgis-scale-range-slider is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"state\" | \"maxScale\" | \"minScale\"; }", "bubbles": true, "complexType": { "original": "{ name: \"state\" | \"maxScale\" | \"minScale\"; }", "resolved": "{ name: \"state\" | \"maxScale\" | \"minScale\"; }", "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/scene/scene.tsx", "tag": "arcgis-scene", "overview": "", "readme": "", "usage": {}, "docs": "ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\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/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst arcgisScene = document.querySelector(\"arcgis-scene\");\narcgisScene.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n arcgisScene.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "allLayerViews", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Collection containing a flat list of all the created [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nrelated to the basemap, operational layers, and group layers in this view.", "docsTags": [ { "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\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#alphaCompositingEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "analyses", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "DimensionAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "DirectLineMeasurementAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "AreaMeasurementAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SliceAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LineOfSightAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ViewshedAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Allows for adding analyses directly to the default analyses in the View.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#analyses)", "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\\` method when you are done to prevent\nmemory leaks.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "basemap", "type": "Basemap | string", "complexType": { "original": "Basemap | string", "resolved": "Basemap | string", "references": { "Basemap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-Map.html#basemap)),\n[Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)\nor [BasemapStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)", "docsTags": [], "values": [ { "type": "Basemap" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "basemapView", "type": "BasemapView", "complexType": { "original": "BasemapView", "resolved": "BasemapView", "references": { "BasemapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Represents the [view for a single basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-BasemapView.html)\nafter it has been added to the map.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "camera", "type": "Camera", "complexType": { "original": "Camera", "resolved": "Camera", "references": { "Camera": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) 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\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint), and\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-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/arcgis-scene/#goTo) method.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "cameraFov", "type": "number", "complexType": { "original": "number", "resolved": "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/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "cameraHeading", "type": "number", "complexType": { "original": "number", "resolved": "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/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "cameraPosition", "type": "Array | Point | string", "complexType": { "original": "Array | Point | string", "resolved": "Array | Point | string", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "camera-position", "reflectToAttr": false, "docs": "The position of the camera defined by a map point. It can be a string with the format `\", , \"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\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/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)", "docsTags": [], "values": [ { "type": "Array" }, { "type": "Point" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "cameraTilt", "type": "number", "complexType": { "original": "number", "resolved": "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/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "center", "type": "Array | Point | string", "complexType": { "original": "Array | Point | string", "resolved": "Array | Point | string", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-geometry-Point.html) 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/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)", "docsTags": [], "values": [ { "type": "Array" }, { "type": "Point" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "clippingArea", "type": "Extent", "complexType": { "original": "Extent", "resolved": "Extent", "references": { "Extent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html)\nof a [local scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewingMode).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "constraints", "type": "SceneViewConstraints", "complexType": { "original": "SceneViewConstraints", "resolved": "SceneViewConstraints", "references": { "SceneViewConstraints": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#constraints)", "docsTags": [], "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": "SceneViewEnvironment", "complexType": { "original": "SceneViewEnvironment", "resolved": "SceneViewEnvironment", "references": { "SceneViewEnvironment": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Specifies various properties of the environment's visualization in the view, like the lighting, background, weather, etc.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "extent", "type": "Extent", "complexType": { "original": "Extent", "resolved": "Extent", "references": { "Extent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The extent represents the visible portion of a map within the view as an instance of\n[Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).\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/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/api-reference/esri-views-SceneView.html#extent)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "fatalError", "type": "Error", "complexType": { "original": "Error", "resolved": "Error", "references": { "Error": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A rejected view indicates a fatal [error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html)\nmaking it unable to display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#fatalError)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "floors", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": { "GamepadSettings": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Graphic": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Allows for adding graphics directly to the default graphics in the view.\nExamples:\n```\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "ground", "type": "Ground | string", "complexType": { "original": "Ground | string", "resolved": "Ground | string", "references": { "Ground": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "ground", "reflectToAttr": false, "docs": "Specifies the surface properties for the map. It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\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/api-reference/esri-Map.html#ground)", "docsTags": [], "values": [ { "type": "Ground" }, { "type": "string" } ], "optional": true, "required": false }, { "name": "groundView", "type": "GroundView", "complexType": { "original": "GroundView", "resolved": "GroundView", "references": { "GroundView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The view for the ground of the map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#groundView)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "highlightOptions", "type": "HighlightOptions", "complexType": { "original": "HighlightOptions", "resolved": "HighlightOptions", "references": { "HighlightOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Options for configuring the highlight.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#highlightOptions)", "docsTags": [], "deprecation": "As of 4.32, use [highlights](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#highlights) property instead.", "values": [], "optional": true, "required": false }, { "name": "highlights", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HighlightOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Represents a collection of [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html) objects which can be used to\nhighlight features throughout an application.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#highlights)", "docsTags": [], "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": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "item-id", "reflectToAttr": true, "docs": "The ID of a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\nTo configure the portal url you must set the [config.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#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": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-layers-LayerView.html) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map.", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "magnifier", "type": "Magnifier", "complexType": { "original": "Magnifier", "resolved": "Magnifier", "references": { "Magnifier": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "map", "type": "Map", "complexType": { "original": "Map", "resolved": "Map", "references": { "Map": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An instance of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) 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": { "Navigation": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#navigation)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "padding", "type": "ViewPadding", "complexType": { "original": "ViewPadding", "resolved": "ViewPadding", "references": { "ViewPadding": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Use the padding property to make the [center](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center),\nand [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent),\netc. work off a subsection of the full view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#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": { "SceneViewPerformanceInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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", "complexType": { "original": "Popup", "resolved": "Popup", "references": { "Popup": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) object that displays general content or attributes from\n[layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#map).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#popup)", "docsTags": [], "values": [], "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 popup opens when users click on the view.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "qualityProfile", "type": "\"high\" | \"low\" | \"medium\"", "complexType": { "original": "\"high\" | \"low\" | \"medium\"", "resolved": "\"high\" | \"low\" | \"medium\"", "references": {} }, "mutable": true, "attr": "quality-profile", "reflectToAttr": false, "docs": "SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)", "docsTags": [], "values": [ { "value": "high", "type": "string" }, { "value": "low", "type": "string" }, { "value": "medium", "type": "string" } ], "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/api-reference/esri-views-SceneView.html#ready)", "docsTags": [ { "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/arcgis-scene/#spatialReference).\nThe resolution is calculated by dividing the view's [extent width](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#width)\nby [its width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#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/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "spatialReference", "type": "SpatialReference", "complexType": { "original": "SpatialReference", "resolved": "SpatialReference", "references": { "SpatialReference": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) of the view.\nThis indicates the projected or geographic coordinate system used\nto locate geographic features in the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#spatialReference)", "docsTags": [], "default": "null", "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/api-reference/esri-views-SceneView.html#suspended)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "theme", "type": "Theme", "complexType": { "original": "Theme", "resolved": "Theme", "references": { "Theme": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "This property specifies the base colors used by some widgets\nand components to render graphics and labels.\nThis only affects those elements that would otherwise use the default orange pattern.", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "timeExtent", "type": "TimeExtent", "complexType": { "original": "TimeExtent", "resolved": "TimeExtent", "references": { "TimeExtent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "updating", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "updating", "reflectToAttr": true, "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": { "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Internal [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) of the component.\nOnce the Scene component is loaded, it can be accessed as follows:\n```\nconst arcgisScene = document.querySelector(\"arcgis-scene\");\narcgisScene.addEventListener(\"arcgisViewReadyChange\", () => {\n const view = arcgisScene.view;\n});\n```", "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/api-reference/esri-views-SceneView.html#supported-coordinate-systems) are available.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode)", "docsTags": [], "default": "\"global\"", "values": [ { "value": "global", "type": "string" }, { "value": "local", "type": "string" } ], "optional": true, "required": false }, { "name": "viewpoint", "type": "Viewpoint", "complexType": { "original": "Viewpoint", "resolved": "Viewpoint", "references": { "Viewpoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\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/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint)", "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.\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/arcgis-scene/#goTo) method.\nSetting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-views-SceneView.html#zoom)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false } ], "methods": [ { "name": "addLayer", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(layer: __esri.Layer | Promise, index?: number): Promise", "parameters": [ { "name": "layer", "type": "Layer | Promise", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addLayer(layer: __esri.Layer | Promise, index?: number): Promise", "parameters": [ { "name": "layer", "type": "Layer | Promise", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "docs": "Adds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.", "docsTags": [] }, { "name": "addLayers", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(layers: __esri.Layer[], index?: number): Promise", "parameters": [ { "name": "layers", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addLayers(layers: __esri.Layer[], index?: number): Promise", "parameters": [ { "name": "layers", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "docs": "Adds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.", "docsTags": [] }, { "name": "addTable", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(table: __esri.FeatureLayer): Promise", "parameters": [ { "name": "table", "type": "FeatureLayer", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FeatureLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addTable(table: __esri.FeatureLayer): Promise", "parameters": [ { "name": "table", "type": "FeatureLayer", "docs": "" } ], "docs": "Adds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.", "docsTags": [] }, { "name": "addTables", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(tables: __esri.FeatureLayer[], index?: number): Promise", "parameters": [ { "name": "tables", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FeatureLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "addTables(tables: __esri.FeatureLayer[], index?: number): Promise", "parameters": [ { "name": "tables", "type": "Array", "docs": "" }, { "name": "index", "type": "number | undefined", "docs": "" } ], "docs": "Adds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.", "docsTags": [] }, { "name": "closePopup", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "closePopup(): Promise", "parameters": [], "docs": "Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisScene = document.createElement(\"arcgis-scene\");\ndocument.body.append(arcgisScene);\narcgisScene.componentOnReady().then(() => {\n console.log(\"arcgis-scene is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "goTo", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise", "parameters": [ { "name": "target", "type": "any", "docs": "" }, { "name": "options", "type": "GoToOptions3D | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "GoToOptions3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise", "parameters": [ { "name": "target", "type": "any", "docs": "" }, { "name": "options", "type": "GoToOptions3D | undefined", "docs": "" } ], "docs": "Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)", "docsTags": [] }, { "name": "hitTest", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>", "parameters": [ { "name": "screenPoint", "type": "MouseEvent | SceneViewScreenPoint", "docs": "" }, { "name": "options", "type": "SceneViewHitTestOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "SceneViewHitTestResult": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "MouseEvent": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" }, "SceneViewScreenPoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneViewHitTestOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>", "parameters": [ { "name": "screenPoint", "type": "MouseEvent | SceneViewScreenPoint", "docs": "" }, { "name": "options", "type": "SceneViewHitTestOptions | undefined", "docs": "" } ], "docs": "Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```\narcgisScene.addEventListener(\"arcgisViewClick\", (event) => {\n arcgisScene.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/api-reference/esri-views-SceneView.html#hitTest)", "docsTags": [] }, { "name": "openPopup", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(options?: __esri.PopupViewOpenPopupOptions): Promise", "parameters": [ { "name": "options", "type": "PopupViewOpenPopupOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "PopupViewOpenPopupOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise", "parameters": [ { "name": "options", "type": "PopupViewOpenPopupOptions | undefined", "docs": "" } ], "docs": "Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)", "docsTags": [] }, { "name": "takeScreenshot", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>", "parameters": [ { "name": "options", "type": "SceneViewTakeScreenshotOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "SceneViewScreenshot": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneViewTakeScreenshotOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>", "parameters": [ { "name": "options", "type": "SceneViewTakeScreenshotOptions | undefined", "docs": "" } ], "docs": "Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)", "docsTags": [] }, { "name": "toMap", "returns": { "type": "Point | null | undefined", "docs": "" }, "complexType": { "signature": "(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish", "parameters": [ { "name": "screenPoint", "type": "MouseEvent | SceneViewScreenPoint", "docs": "" }, { "name": "options", "type": "SceneViewToMapOptions | undefined", "docs": "" } ], "return": "Point | null | undefined", "references": { "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "MouseEvent": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" }, "SceneViewScreenPoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneViewToMapOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish", "parameters": [ { "name": "screenPoint", "type": "MouseEvent | SceneViewScreenPoint", "docs": "" }, { "name": "options", "type": "SceneViewToMapOptions | undefined", "docs": "" } ], "docs": "Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).", "docsTags": [] }, { "name": "toScreen", "returns": { "type": "SceneViewScreenPoint", "docs": "" }, "complexType": { "signature": "(point: __esri.Point): __esri.SceneViewScreenPoint", "parameters": [ { "name": "point", "type": "Point", "docs": "" } ], "return": "SceneViewScreenPoint", "references": { "SceneViewScreenPoint": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "toScreen(point: __esri.Point): __esri.SceneViewScreenPoint", "parameters": [ { "name": "point", "type": "Point", "docs": "" } ], "docs": "Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.", "docsTags": [] }, { "name": "tryFatalErrorRecovery", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "tryFatalErrorRecovery(): Promise", "parameters": [], "docs": "Call this method to clear any fatal errors resulting from a lost WebGL context.", "docsTags": [] }, { "name": "whenAnalysisView", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>", "parameters": [ { "name": "analysis", "type": "AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | LineOfSightAnalysis | SliceAnalysis | ViewshedAnalysis", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "AreaMeasurementAnalysisView3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "DimensionAnalysisView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "DirectLineMeasurementAnalysisView3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LineOfSightAnalysisView3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SliceAnalysisView3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ViewshedAnalysisView3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "AreaMeasurementAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "DimensionAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "DirectLineMeasurementAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LineOfSightAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SliceAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ViewshedAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>", "parameters": [ { "name": "analysis", "type": "AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | LineOfSightAnalysis | SliceAnalysis | ViewshedAnalysis", "docs": "" } ], "docs": "Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)", "docsTags": [] }, { "name": "whenLayerView", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(layer: __esri.Layer): Promise<__esri.LayerView>", "parameters": [ { "name": "layer", "type": "Layer", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "LayerView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>", "parameters": [ { "name": "layer", "type": "Layer", "docs": "" } ], "docs": "Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)", "docsTags": [] } ], "events": [ { "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:\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[rotation](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#rotation),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#camera),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint).\nThis event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#stationary)\ntoggles from `true` to `false`.", "docsTags": [] }, { "event": "arcgisViewClick", "detail": "ViewClickEvent", "bubbles": true, "complexType": { "original": "ViewClickEvent", "resolved": "ViewClickEvent", "references": { "ViewClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a user clicks on the view.\n\n```\narcgisScene.addEventListener(\"arcgisViewClick\", (event) => {\n arcgisScene.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/api-reference/esri-views-SceneView.html#event-click)", "docsTags": [] }, { "event": "arcgisViewDoubleClick", "detail": "ViewDoubleClickEvent", "bubbles": true, "complexType": { "original": "ViewDoubleClickEvent", "resolved": "ViewDoubleClickEvent", "references": { "ViewDoubleClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)", "docsTags": [] }, { "event": "arcgisViewDrag", "detail": "ViewDragEvent", "bubbles": true, "complexType": { "original": "ViewDragEvent", "resolved": "ViewDragEvent", "references": { "ViewDragEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-drag)", "docsTags": [] }, { "event": "arcgisViewHold", "detail": "ViewHoldEvent", "bubbles": true, "complexType": { "original": "ViewHoldEvent", "resolved": "ViewHoldEvent", "references": { "ViewHoldEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-hold)", "docsTags": [] }, { "event": "arcgisViewImmediateClick", "detail": "ViewImmediateClickEvent", "bubbles": true, "complexType": { "original": "ViewImmediateClickEvent", "resolved": "ViewImmediateClickEvent", "references": { "ViewImmediateClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-immediate-click)", "docsTags": [] }, { "event": "arcgisViewImmediateDoubleClick", "detail": "ViewImmediateDoubleClickEvent", "bubbles": true, "complexType": { "original": "ViewImmediateDoubleClickEvent", "resolved": "ViewImmediateDoubleClickEvent", "references": { "ViewImmediateDoubleClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-immediate-double-click)", "docsTags": [] }, { "event": "arcgisViewKeyDown", "detail": "ViewKeyDownEvent", "bubbles": true, "complexType": { "original": "ViewKeyDownEvent", "resolved": "ViewKeyDownEvent", "references": { "ViewKeyDownEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)", "docsTags": [] }, { "event": "arcgisViewKeyUp", "detail": "ViewKeyUpEvent", "bubbles": true, "complexType": { "original": "ViewKeyUpEvent", "resolved": "ViewKeyUpEvent", "references": { "ViewKeyUpEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)", "docsTags": [] }, { "event": "arcgisViewLayerviewCreate", "detail": "ViewLayerviewCreateEvent", "bubbles": true, "complexType": { "original": "ViewLayerviewCreateEvent", "resolved": "ViewLayerviewCreateEvent", "references": { "ViewLayerviewCreateEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-layerview-create)", "docsTags": [] }, { "event": "arcgisViewLayerviewCreateError", "detail": "ViewLayerviewCreateErrorEvent", "bubbles": true, "complexType": { "original": "ViewLayerviewCreateErrorEvent", "resolved": "ViewLayerviewCreateErrorEvent", "references": { "ViewLayerviewCreateErrorEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-layerview-create-error)", "docsTags": [] }, { "event": "arcgisViewLayerviewDestroy", "detail": "ViewLayerviewDestroyEvent", "bubbles": true, "complexType": { "original": "ViewLayerviewDestroyEvent", "resolved": "ViewLayerviewDestroyEvent", "references": { "ViewLayerviewDestroyEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-layerview-destroy)", "docsTags": [] }, { "event": "arcgisViewMouseWheel", "detail": "ViewMouseWheelEvent", "bubbles": true, "complexType": { "original": "ViewMouseWheelEvent", "resolved": "ViewMouseWheelEvent", "references": { "ViewMouseWheelEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-mouse-wheel)", "docsTags": [] }, { "event": "arcgisViewPointerDown", "detail": "ViewPointerDownEvent", "bubbles": true, "complexType": { "original": "ViewPointerDownEvent", "resolved": "ViewPointerDownEvent", "references": { "ViewPointerDownEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-pointer-down)", "docsTags": [] }, { "event": "arcgisViewPointerEnter", "detail": "ViewPointerEnterEvent", "bubbles": true, "complexType": { "original": "ViewPointerEnterEvent", "resolved": "ViewPointerEnterEvent", "references": { "ViewPointerEnterEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-pointer-enter)", "docsTags": [] }, { "event": "arcgisViewPointerLeave", "detail": "ViewPointerLeaveEvent", "bubbles": true, "complexType": { "original": "ViewPointerLeaveEvent", "resolved": "ViewPointerLeaveEvent", "references": { "ViewPointerLeaveEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-pointer-leave)", "docsTags": [] }, { "event": "arcgisViewPointerMove", "detail": "ViewPointerMoveEvent", "bubbles": true, "complexType": { "original": "ViewPointerMoveEvent", "resolved": "ViewPointerMoveEvent", "references": { "ViewPointerMoveEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#event-pointer-move)", "docsTags": [] }, { "event": "arcgisViewPointerUp", "detail": "ViewPointerUpEvent", "bubbles": true, "complexType": { "original": "ViewPointerUpEvent", "resolved": "ViewPointerUpEvent", "references": { "ViewPointerUpEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/api-reference/esri-views-SceneView.html#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/arcgis-scene/#ready)\nproperty 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/arcgis-scene/#map) property is changed.\n\n```\narcgisScene.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n arcgisScene.map.add(layer);\n});\n```", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/search/search.tsx", "tag": "arcgis-search", "overview": "", "readme": "", "usage": {}, "docs": "Search component provides a way to perform search operations", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeMenu", "type": "\"none\" | \"source\" | \"suggestion\" | \"warning\"", "complexType": { "original": "\"none\" | \"source\" | \"suggestion\" | \"warning\"", "resolved": "\"none\" | \"source\" | \"suggestion\" | \"warning\"", "references": {} }, "mutable": true, "attr": "active-menu", "reflectToAttr": false, "docs": "The current active menu of the Search widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeMenu)", "docsTags": [], "default": "\"none\"", "values": [ { "value": "none", "type": "string" }, { "value": "source", "type": "string" }, { "value": "suggestion", "type": "string" }, { "value": "warning", "type": "string" } ], "optional": true, "required": false }, { "name": "activeSource", "type": "LayerSearchSource | LocatorSearchSource", "complexType": { "original": "LayerSearchSource | LocatorSearchSource", "resolved": "LayerSearchSource | LocatorSearchSource", "references": { "LayerSearchSource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LocatorSearchSource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources) object currently selected.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeSource)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "null", "values": [ { "type": "LayerSearchSource" }, { "type": "LocatorSearchSource" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#activeSourceIndex)", "docsTags": [], "default": "0", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "allPlaceholder", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "all-placeholder", "reflectToAttr": false, "docs": "String value used as a hint for input text when searching on multiple sources.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#allPlaceholder)", "docsTags": [], "default": "\"Find address or place\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "allSources", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LayerSearchSource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LocatorSearchSource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The combined collection of [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources)\nand [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#allSources)", "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": "autoSelectDisabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "auto-select-disabled", "reflectToAttr": false, "docs": "Indicates whether to automatically select and zoom to the first geocoded result.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#autoSelect)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "defaultSources", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LayerSearchSource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LocatorSearchSource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A read-only property that is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)\nof [LayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html)\nand/or [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#defaultSources)", "docsTags": [ { "name": "readonly", "text": "" } ], "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 widget is visually withdrawn and cannot be interacted with.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#disabled)", "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": "\"search\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "includeDefaultSourcesDisabled", "type": "Function | boolean", "complexType": { "original": "Function | boolean", "resolved": "Function | boolean", "references": { "Function": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "include-default-sources-disabled", "reflectToAttr": false, "docs": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#includeDefaultSources)", "docsTags": [], "default": "false", "values": [ { "type": "Function" }, { "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": [], "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": "Enables location services within the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#locationEnabled)", "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 widget if not specified by the source.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxResults)", "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 widget if not specified by the source.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#maxSuggestions)", "docsTags": [], "default": "6", "values": [ { "type": "number" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#minSuggestCharacters)", "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": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "popupTemplate", "type": "PopupTemplate", "complexType": { "original": "PopupTemplate", "resolved": "PopupTemplate", "references": { "PopupTemplate": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A customized [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for the selected feature.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#popupTemplate)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "portal", "type": "Portal", "complexType": { "original": "Portal", "resolved": "Portal", "references": { "Portal": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "It is possible to search a specified portal instance's [locator services](http://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm)\nUse this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#portal)", "docsTags": [], "values": [], "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": "\"top-right\"", "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": "resultGraphic", "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 used to highlight the resulting feature or location.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphic)", "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": "Indicates if the [resultGraphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphic) will display at the\nlocation of the selected feature.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#resultGraphicEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "results", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of objects, each containing a [SearchResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#SearchResult) from the search.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#results)", "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": "Indicates whether to display the option to search all sources.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchAllEnabled)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#searchTerm)", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "selectedResult", "type": "SearchResult", "complexType": { "original": "SearchResult", "resolved": "SearchResult", "references": { "SearchResult": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The result selected from a search.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#selectedResult)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "sources", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SearchSource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The Search widget may be used to search features in a\n[map](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)/[feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) service feature\nlayer(s), [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) with an associated feature layer,\n[BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html) with an associated feature layer,\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) or\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html), or [table](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html),\nor geocode locations with a [locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#sources)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"loading\" | \"ready\" | \"searching\"", "complexType": { "original": "\"disabled\" | \"loading\" | \"ready\" | \"searching\"", "resolved": "\"disabled\" | \"loading\" | \"ready\" | \"searching\"", "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-Search-SearchViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"ready\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" }, { "value": "searching", "type": "string" } ], "optional": true, "required": false }, { "name": "suggestions", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "SearchResultsSuggestions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of results from the [suggest method](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggest).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggestions)", "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": "Enable suggestions for the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html#suggestionsEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false } ], "methods": [ { "name": "blurSearch", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "blurSearch(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "clearSearch", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clearSearch(): 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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisSearch = document.createElement(\"arcgis-search\");\ndocument.body.append(arcgisSearch);\narcgisSearch.componentOnReady().then(() => {\n console.log(\"arcgis-search is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "focusSearch", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "focusSearch(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "search", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(term: __esri.Point | __esri.SuggestResult | nullish | number[] | string): Promise<__esri.SearchResponse | nullish>", "parameters": [ { "name": "term", "type": "Array | Point | SuggestResult | null | string | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "SearchResponse": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SuggestResult": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "search(term: __esri.Point | __esri.SuggestResult | nullish | number[] | string): Promise<__esri.SearchResponse | nullish>", "parameters": [ { "name": "term", "type": "Array | Point | SuggestResult | null | string | undefined", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "suggest", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(term: string): Promise<__esri.SuggestResponse | nullish>", "parameters": [ { "name": "term", "type": "string", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "SuggestResponse": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "suggest(term: string): Promise<__esri.SuggestResponse | nullish>", "parameters": [ { "name": "term", "type": "string", "docs": "" } ], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisBlur", "detail": "SearchSearchBlurEvent", "bubbles": true, "complexType": { "original": "SearchSearchBlurEvent", "resolved": "SearchSearchBlurEvent", "references": { "SearchSearchBlurEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisClear", "detail": "SearchSearchClearEvent", "bubbles": true, "complexType": { "original": "SearchSearchClearEvent", "resolved": "SearchSearchClearEvent", "references": { "SearchSearchClearEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisComplete", "detail": "SearchSearchCompleteEvent", "bubbles": true, "complexType": { "original": "SearchSearchCompleteEvent", "resolved": "SearchSearchCompleteEvent", "references": { "SearchSearchCompleteEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when the component is complete.", "docsTags": [] }, { "event": "arcgisFocus", "detail": "SearchSearchFocusEvent", "bubbles": true, "complexType": { "original": "SearchSearchFocusEvent", "resolved": "SearchSearchFocusEvent", "references": { "SearchSearchFocusEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "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": [] }, { "event": "arcgisSelectResult", "detail": "SearchSelectResultEvent", "bubbles": true, "complexType": { "original": "SearchSelectResultEvent", "resolved": "SearchSelectResultEvent", "references": { "SearchSelectResultEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisStart", "detail": "SearchSearchStartEvent", "bubbles": true, "complexType": { "original": "SearchSearchStartEvent", "resolved": "SearchSearchStartEvent", "references": { "SearchSearchStartEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisSuggestComplete", "detail": "SearchSuggestCompleteEvent", "bubbles": true, "complexType": { "original": "SearchSuggestCompleteEvent", "resolved": "SearchSuggestCompleteEvent", "references": { "SearchSuggestCompleteEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisSuggestStart", "detail": "SearchSuggestStartEvent", "bubbles": true, "complexType": { "original": "SearchSuggestStartEvent", "resolved": "SearchSuggestStartEvent", "references": { "SearchSuggestStartEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/shadow-cast/shadow-cast.tsx", "tag": "arcgis-shadow-cast", "overview": "", "readme": "", "usage": {}, "docs": "ShadowCast component displays the cumulative shadows of 3D features in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.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": "discreteOptions", "type": "ShadowCastViewModelDiscreteOptions", "complexType": { "original": "ShadowCastViewModelDiscreteOptions", "resolved": "ShadowCastViewModelDiscreteOptions", "references": { "ShadowCastViewModelDiscreteOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to \"discrete\".\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "durationOptions", "type": "ShadowCastViewModelDurationOptions", "complexType": { "original": "ShadowCastViewModelDurationOptions", "resolved": "ShadowCastViewModelDurationOptions", "references": { "ShadowCastViewModelDurationOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to \"duration\".\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions)", "docsTags": [], "values": [], "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/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date)) when the shadow cast computation should stop.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)", "docsTags": [], "default": "16 * 3600 * 1000", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the titles \"Time range\" and \"Visualization\".\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#headingLevel)", "docsTags": [], "default": "4", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "hideColorPicker", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-color-picker", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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": "hideTimeRangeSlider", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-time-range-slider", "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": "hideTooltip", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-tooltip", "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "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-building-height-shadow\"", "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": "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/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date))\nwhen the shadow cast computation should start.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)", "docsTags": [], "default": "10 * 3600 * 1000", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"ready\"", "resolved": "\"disabled\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the view model that can be used for rendering the UI\nof the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "thresholdOptions", "type": "ShadowCastViewModelThresholdOptions", "complexType": { "original": "ShadowCastViewModelThresholdOptions", "resolved": "ShadowCastViewModelThresholdOptions", "references": { "ShadowCastViewModelThresholdOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to \"threshold\".\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "utcOffset", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "utc-offset", "reflectToAttr": false, "docs": "The difference in hours between UTC time and the times displayed in the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#utcOffset)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "visualizationType", "type": "\"discrete\" | \"duration\" | \"threshold\"", "complexType": { "original": "\"discrete\" | \"duration\" | \"threshold\"", "resolved": "\"discrete\" | \"duration\" | \"threshold\"", "references": {} }, "mutable": true, "attr": "visualization-type", "reflectToAttr": false, "docs": "Type of visualization to use when showing the shadows.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType)", "docsTags": [], "default": "\"threshold\"", "values": [ { "value": "discrete", "type": "string" }, { "value": "duration", "type": "string" }, { "value": "threshold", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisShadowCast = document.createElement(\"arcgis-shadow-cast\");\ndocument.body.append(arcgisShadowCast);\narcgisShadowCast.componentOnReady().then(() => {\n console.log(\"arcgis-shadow-cast is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "getDuration", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(point: __esri.Point): Promise", "parameters": [ { "name": "point", "type": "Point", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Point": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "getDuration(point: __esri.Point): Promise", "parameters": [ { "name": "point", "type": "Point", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "start", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "start(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "stop", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "stop(): Promise", "parameters": [], "docs": "Stops 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/sketch/sketch.tsx", "tag": "arcgis-sketch", "overview": "", "readme": "", "usage": {}, "docs": "Sketch component provides a simple UI for creating and updating graphics on a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeTool", "type": "\"circle\" | \"custom-selection\" | \"freehandPolygon\" | \"freehandPolyline\" | \"lasso-selection\" | \"mesh\" | \"move\" | \"multipoint\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\" | \"rectangle-selection\" | \"reshape\" | \"transform\"", "complexType": { "original": "\"circle\" | \"custom-selection\" | \"freehandPolygon\" | \"freehandPolyline\" | \"lasso-selection\" | \"mesh\" | \"move\" | \"multipoint\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\" | \"rectangle-selection\" | \"reshape\" | \"transform\"", "resolved": "\"circle\" | \"custom-selection\" | \"freehandPolygon\" | \"freehandPolyline\" | \"lasso-selection\" | \"mesh\" | \"move\" | \"multipoint\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\" | \"rectangle-selection\" | \"reshape\" | \"transform\"", "references": {} }, "mutable": true, "attr": "active-tool", "reflectToAttr": true, "docs": "When creating new graphics (for example after [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) has been called),\nthis property reflects the create tool being used.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#activeTool)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "value": "circle", "type": "string" }, { "value": "custom-selection", "type": "string" }, { "value": "freehandPolygon", "type": "string" }, { "value": "freehandPolyline", "type": "string" }, { "value": "lasso-selection", "type": "string" }, { "value": "mesh", "type": "string" }, { "value": "move", "type": "string" }, { "value": "multipoint", "type": "string" }, { "value": "point", "type": "string" }, { "value": "polygon", "type": "string" }, { "value": "polyline", "type": "string" }, { "value": "rectangle", "type": "string" }, { "value": "rectangle-selection", "type": "string" }, { "value": "reshape", "type": "string" }, { "value": "transform", "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\\` method when you are done to prevent\nmemory leaks.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "availableCreateTools", "type": "Array<\"point\" | \"multipoint\" | \"polygon\" | \"polyline\" | \"mesh\" | \"rectangle\" | \"circle\" | \"freehandPolyline\" | \"freehandPolygon\">", "complexType": { "original": "Array<\"point\" | \"multipoint\" | \"polygon\" | \"polyline\" | \"mesh\" | \"rectangle\" | \"circle\" | \"freehandPolyline\" | \"freehandPolygon\">", "resolved": "Array<\"point\" | \"multipoint\" | \"polygon\" | \"polyline\" | \"mesh\" | \"rectangle\" | \"circle\" | \"freehandPolyline\" | \"freehandPolygon\">", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Property controlling the visibility and order of create tool buttons.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#availableCreateTools)", "docsTags": [], "default": "[\"point\", \"polyline\", \"polygon\", \"rectangle\", \"circle\"]", "values": [], "optional": true, "required": false }, { "name": "createGraphic", "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 that is being created.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#createGraphic)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "creationMode", "type": "\"continuous\" | \"single\" | \"update\"", "complexType": { "original": "\"continuous\" | \"single\" | \"update\"", "resolved": "\"continuous\" | \"single\" | \"update\"", "references": {} }, "mutable": true, "attr": "creation-mode", "reflectToAttr": false, "docs": "Defines the default behavior once the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) operation is completed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#creationMode)", "docsTags": [], "default": "\"continuous\"", "values": [ { "value": "continuous", "type": "string" }, { "value": "single", "type": "string" }, { "value": "update", "type": "string" } ], "optional": true, "required": false }, { "name": "defaultCreateOptions", "type": "SketchDefaultCreateOptions", "complexType": { "original": "SketchDefaultCreateOptions", "resolved": "SketchDefaultCreateOptions", "references": { "SketchDefaultCreateOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Default create options set for the Sketch widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultCreateOptions)", "docsTags": [], "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": "SketchDefaultUpdateOptions", "complexType": { "original": "SketchDefaultUpdateOptions", "resolved": "SketchDefaultUpdateOptions", "references": { "SketchDefaultUpdateOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Default update options set for the Sketch widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions)", "docsTags": [], "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": "", "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "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": "hideDuplicateButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-duplicate-button", "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "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": "", "docsTags": [], "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": "", "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": "\"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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "labelOptions", "type": "SketchLabelOptions", "complexType": { "original": "SketchLabelOptions", "resolved": "SketchLabelOptions", "references": { "SketchLabelOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#labelOptions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "layer", "type": "GraphicsLayer", "complexType": { "original": "GraphicsLayer", "resolved": "GraphicsLayer", "references": { "GraphicsLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) associated with the Sketch widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#layer)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "layout", "type": "\"horizontal\" | \"vertical\"", "complexType": { "original": "\"horizontal\" | \"vertical\"", "resolved": "\"horizontal\" | \"vertical\"", "references": {} }, "mutable": true, "attr": "layout", "reflectToAttr": false, "docs": "Determines the layout/orientation of the Sketch widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#layout)", "docsTags": [], "default": "\"horizontal\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": true, "required": false }, { "name": "pointSymbol", "type": "CIMSymbol | PictureMarkerSymbol | PointSymbol3D | SimpleMarkerSymbol | TextSymbol | WebStyleSymbol", "complexType": { "original": "CIMSymbol | PictureMarkerSymbol | PointSymbol3D | SimpleMarkerSymbol | TextSymbol | WebStyleSymbol", "resolved": "CIMSymbol | PictureMarkerSymbol | PointSymbol3D | SimpleMarkerSymbol | TextSymbol | WebStyleSymbol", "references": { "CIMSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "PictureMarkerSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "PointSymbol3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SimpleMarkerSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "TextSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "WebStyleSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html), [TextSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html), [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html), or [WebStyleSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html) used for representing the point geometry that is being drawn.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#pointSymbol)", "docsTags": [], "values": [ { "type": "CIMSymbol" }, { "type": "PictureMarkerSymbol" }, { "type": "PointSymbol3D" }, { "type": "SimpleMarkerSymbol" }, { "type": "TextSymbol" }, { "type": "WebStyleSymbol" } ], "optional": true, "required": false }, { "name": "polygonSymbol", "type": "CIMSymbol | PolygonSymbol3D | SimpleFillSymbol", "complexType": { "original": "CIMSymbol | PolygonSymbol3D | SimpleFillSymbol", "resolved": "CIMSymbol | PolygonSymbol3D | SimpleFillSymbol", "references": { "CIMSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "PolygonSymbol3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SimpleFillSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html), [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polygon geometry that is being drawn.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polygonSymbol)", "docsTags": [], "values": [ { "type": "CIMSymbol" }, { "type": "PolygonSymbol3D" }, { "type": "SimpleFillSymbol" } ], "optional": true, "required": false }, { "name": "polylineSymbol", "type": "CIMSymbol | LineSymbol3D | SimpleLineSymbol", "complexType": { "original": "CIMSymbol | LineSymbol3D | SimpleLineSymbol", "resolved": "CIMSymbol | LineSymbol3D | SimpleLineSymbol", "references": { "CIMSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "LineSymbol3D": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SimpleLineSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), [LineSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polyline geometry that is being drawn.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polylineSymbol)", "docsTags": [], "values": [ { "type": "CIMSymbol" }, { "type": "LineSymbol3D" }, { "type": "SimpleLineSymbol" } ], "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": "scale", "type": "\"l\" | \"m\" | \"s\"", "complexType": { "original": "\"l\" | \"m\" | \"s\"", "resolved": "\"l\" | \"m\" | \"s\"", "references": {} }, "mutable": true, "attr": "scale", "reflectToAttr": false, "docs": "Determines the size of widget elements.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#scale)", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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-Sketch.html#snappingOptions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "state", "type": "\"active\" | \"disabled\" | \"ready\"", "complexType": { "original": "\"active\" | \"disabled\" | \"ready\"", "resolved": "\"active\" | \"disabled\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The Sketch widget's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "value": "active", "type": "string" }, { "value": "disabled", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "toolbarKind", "type": "\"docked\" | \"floating\"", "complexType": { "original": "\"docked\" | \"floating\"", "resolved": "\"docked\" | \"floating\"", "references": {} }, "mutable": true, "attr": "toolbar-kind", "reflectToAttr": false, "docs": "Controls the appearance of the sketch widget, allowing\nthe toolbar to adapt its appearance appropriately based on context.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#toolbarKind)", "docsTags": [], "default": "\"floating\"", "values": [ { "value": "docked", "type": "string" }, { "value": "floating", "type": "string" } ], "optional": true, "required": false }, { "name": "tooltipOptions", "type": "SketchTooltipOptions", "complexType": { "original": "SketchTooltipOptions", "resolved": "SketchTooltipOptions", "references": { "SketchTooltipOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Options to configure the tooltip shown next to the cursor when creating or updating graphics.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#tooltipOptions)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "updateGraphics", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Graphic": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) that are being updated by the Sketch widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#updateGraphics)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false } ], "methods": [ { "name": "cancel", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "cancel(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "complete", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisSketch = document.createElement(\"arcgis-sketch\");\ndocument.body.append(arcgisSketch);\narcgisSketch.componentOnReady().then(() => {\n console.log(\"arcgis-sketch is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "create", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(tool: \"circle\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\", createOptions?: __esri.SketchViewModelCreateCreateOptions): Promise", "parameters": [ { "name": "tool", "type": "\"circle\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\"", "docs": "" }, { "name": "createOptions", "type": "SketchViewModelCreateCreateOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "SketchViewModelCreateCreateOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "create(tool: \"circle\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\", createOptions?: __esri.SketchViewModelCreateCreateOptions): Promise", "parameters": [ { "name": "tool", "type": "\"circle\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\"", "docs": "" }, { "name": "createOptions", "type": "SketchViewModelCreateCreateOptions | undefined", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "delete", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "delete(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] }, { "name": "duplicate", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "duplicate(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "redo", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "redo(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "triggerUpdate", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(graphic: __esri.Graphic | __esri.Graphic[], updateOptions?: __esri.SketchViewModelUpdateUpdateOptions): Promise", "parameters": [ { "name": "graphic", "type": "Array | Graphic", "docs": "" }, { "name": "updateOptions", "type": "SketchViewModelUpdateUpdateOptions | undefined", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Graphic": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SketchViewModelUpdateUpdateOptions": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "triggerUpdate(graphic: __esri.Graphic | __esri.Graphic[], updateOptions?: __esri.SketchViewModelUpdateUpdateOptions): Promise", "parameters": [ { "name": "graphic", "type": "Array | Graphic", "docs": "" }, { "name": "updateOptions", "type": "SketchViewModelUpdateUpdateOptions | undefined", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "undo", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "undo(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisCreate", "detail": "SketchCreateEvent", "bubbles": true, "complexType": { "original": "SketchCreateEvent", "resolved": "SketchCreateEvent", "references": { "SketchCreateEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisDelete", "detail": "SketchDeleteEvent", "bubbles": true, "complexType": { "original": "SketchDeleteEvent", "resolved": "SketchDeleteEvent", "references": { "SketchDeleteEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "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": [] }, { "event": "arcgisRedo", "detail": "SketchRedoEvent", "bubbles": true, "complexType": { "original": "SketchRedoEvent", "resolved": "SketchRedoEvent", "references": { "SketchRedoEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisUndo", "detail": "SketchUndoEvent", "bubbles": true, "complexType": { "original": "SketchUndoEvent", "resolved": "SketchUndoEvent", "references": { "SketchUndoEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisUpdate", "detail": "SketchUpdateEvent", "bubbles": true, "complexType": { "original": "SketchUpdateEvent", "resolved": "SketchUpdateEvent", "references": { "SketchUpdateEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/slice/slice.tsx", "tag": "arcgis-slice", "overview": "", "readme": "", "usage": {}, "docs": "Slice component is a 3D analysis tool that can be used to reveal occluded content in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "analysis", "type": "SliceAnalysis", "complexType": { "original": "SliceAnalysis", "resolved": "SliceAnalysis", "references": { "SliceAnalysis": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The slice analysis object being created or modified by the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.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": "excludedLayers", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "BuildingComponentSublayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Add layers to this collection to exclude them from the slice.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#excludedLayers)", "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/api-reference/esri-Ground.html) and layers that\nare draped on the ground surface are excluded from the slice.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#excludeGroundSurface)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the \"Excluded layers\" heading.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice.html#headingLevel)", "docsTags": [], "default": "3", "values": [ { "type": "number" } ], "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": "\"slice\"", "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": "shape", "type": "SlicePlane", "complexType": { "original": "SlicePlane", "resolved": "SlicePlane", "references": { "SlicePlane": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The shape used to slice elements in a 3D scene.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#shape)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"ready\" | \"sliced\" | \"slicing\"", "complexType": { "original": "\"disabled\" | \"ready\" | \"sliced\" | \"slicing\"", "resolved": "\"disabled\" | \"ready\" | \"sliced\" | \"slicing\"", "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-Slice-SliceViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "type": "string" }, { "value": "sliced", "type": "string" }, { "value": "slicing", "type": "string" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slice-SliceViewModel.html#tiltEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false } ], "methods": [ { "name": "clear", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clear(): Promise", "parameters": [], "docs": "Clears 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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisSlice = document.createElement(\"arcgis-slice\");\ndocument.body.append(arcgisSlice);\narcgisSlice.componentOnReady().then(() => {\n console.log(\"arcgis-slice is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "start(): Promise", "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/slider/slider.tsx", "tag": "arcgis-slider", "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": "draggableSegmentsEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "draggable-segments-enabled", "reflectToAttr": false, "docs": "Indicates if the user can drag the segment between thumbs\nto update thumb positions.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#draggableSegmentsEnabled)", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "effectiveMax", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "effective-max", "reflectToAttr": false, "docs": "When set, the user is restricted from moving slider thumbs to positions higher than\nthis value.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMax)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "effectiveMin", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "effective-min", "reflectToAttr": false, "docs": "When set, the user is restricted from moving slider thumbs to positions less than\nthis value.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMin)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "effectiveSegmentElements", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The HTML Element nodes representing the slider segment between the [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) and [effectiveMin](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMin), and the segment between the\n[effectiveMax](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMax) and [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveSegmentElements)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "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": "\"caret-double-horizontal\"", "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": "labelElements", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The HTML Element nodes representing [labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labels) attached to slider thumbs.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelElements)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "labelInputsEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "label-inputs-enabled", "reflectToAttr": false, "docs": "Indicates whether to enable editing input values via keyboard input\nwhen the user clicks a label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelInputsEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "labels", "type": "LabelInfos", "complexType": { "original": "LabelInfos", "resolved": "LabelInfos", "references": { "LabelInfos": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An array of strings associated with 'values' generated using an internal label formatter or\nthe values returned from [labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labelFormatFunction).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#labels)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "layout", "type": "\"horizontal\" | \"horizontal-reversed\" | \"vertical\" | \"vertical-reversed\"", "complexType": { "original": "\"horizontal\" | \"horizontal-reversed\" | \"vertical\" | \"vertical-reversed\"", "resolved": "\"horizontal\" | \"horizontal-reversed\" | \"vertical\" | \"vertical-reversed\"", "references": {} }, "mutable": true, "attr": "layout", "reflectToAttr": false, "docs": "Determines the layout/orientation of the Slider widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#layout)", "docsTags": [], "default": "\"horizontal\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "horizontal-reversed", "type": "string" }, { "value": "vertical", "type": "string" }, { "value": "vertical-reversed", "type": "string" } ], "optional": true, "required": false }, { "name": "max", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "max", "reflectToAttr": false, "docs": "The maximum possible data/thumb value of the slider.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "maxLabelElement", "type": "HTMLElement", "complexType": { "original": "HTMLElement", "resolved": "HTMLElement", "references": { "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The HTML Element node representing the [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) value label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#maxLabelElement)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "min", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "min", "reflectToAttr": false, "docs": "The minimum possible data/thumb value of the slider.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min)", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "minLabelElement", "type": "HTMLElement", "complexType": { "original": "HTMLElement", "resolved": "HTMLElement", "references": { "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The HTML Element node representing the [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) value label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#minLabelElement)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "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": "precision", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "precision", "reflectToAttr": false, "docs": "Defines how slider thumb values should be rounded.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#precision)", "docsTags": [], "default": "4", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "rangeLabelInputsEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "range-label-inputs-enabled", "reflectToAttr": false, "docs": "Indicates whether to enable editing range values via keyboard input\nwhen the user clicks a [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) or [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#rangeLabelInputsEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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": "segmentElements", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The HTML Element nodes representing interactive slider segments.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#segmentElements)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "snapOnClickEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "snap-on-click-enabled", "reflectToAttr": false, "docs": "Indicates if the closest thumb will snap to the clicked location on the track.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#snapOnClickEnabled)", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"dragging\" | \"editing\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"dragging\" | \"editing\" | \"ready\"", "resolved": "\"disabled\" | \"dragging\" | \"editing\" | \"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-Slider.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "value": "disabled", "type": "string" }, { "value": "dragging", "type": "string" }, { "value": "editing", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "steps", "type": "Array | number", "complexType": { "original": "Array | number", "resolved": "Array | number", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "steps", "reflectToAttr": false, "docs": "Sets steps, or intervals, on the slider that restrict user\ninput to specific values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#steps)", "docsTags": [], "values": [ { "type": "Array" }, { "type": "number" } ], "optional": true, "required": false }, { "name": "syncedSegmentsEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "synced-segments-enabled", "reflectToAttr": false, "docs": "When `true`, all segments will sync together in updating thumb values when the user drags any segment.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#syncedSegmentsEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "thumbElements", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The HTML Element nodes representing slider thumbs.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#thumbElements)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "thumbsConstrained", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "thumbs-constrained", "reflectToAttr": false, "docs": "When `false`, the user can freely move any slider thumb to any\nposition along the track.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#thumbsConstrained)", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "tickConfigs", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "TickConfig": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "When set, renders ticks along the slider track.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickConfigs)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "tickElements", "type": "Collection>", "complexType": { "original": "Collection>", "resolved": "Collection>", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "TickElementGroup": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The HTML Element nodes representing slider ticks and their associated labels.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickElements)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "trackElement", "type": "HTMLElement", "complexType": { "original": "HTMLElement", "resolved": "HTMLElement", "references": { "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The HTML Element node representing the slider track.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#trackElement)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "values", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "values", "reflectToAttr": false, "docs": "An array of numbers representing absolute thumb positions on the slider.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#values)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisSlider = document.createElement(\"arcgis-slider\");\ndocument.body.append(arcgisSlider);\narcgisSlider.componentOnReady().then(() => {\n console.log(\"arcgis-slider is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "event": "arcgisMaxChange", "detail": "SliderMaxChangeEvent", "bubbles": true, "complexType": { "original": "SliderMaxChangeEvent", "resolved": "SliderMaxChangeEvent", "references": { "SliderMaxChangeEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisMaxClick", "detail": "SliderMaxClickEvent", "bubbles": true, "complexType": { "original": "SliderMaxClickEvent", "resolved": "SliderMaxClickEvent", "references": { "SliderMaxClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisMinChange", "detail": "SliderMinChangeEvent", "bubbles": true, "complexType": { "original": "SliderMinChangeEvent", "resolved": "SliderMinChangeEvent", "references": { "SliderMinChangeEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisMinClick", "detail": "SliderMinClickEvent", "bubbles": true, "complexType": { "original": "SliderMinClickEvent", "resolved": "SliderMinClickEvent", "references": { "SliderMinClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "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": [] }, { "event": "arcgisSegmentClick", "detail": "SliderSegmentClickEvent", "bubbles": true, "complexType": { "original": "SliderSegmentClickEvent", "resolved": "SliderSegmentClickEvent", "references": { "SliderSegmentClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisSegmentDrag", "detail": "SliderSegmentDragEvent", "bubbles": true, "complexType": { "original": "SliderSegmentDragEvent", "resolved": "SliderSegmentDragEvent", "references": { "SliderSegmentDragEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisThumbChange", "detail": "SliderThumbChangeEvent", "bubbles": true, "complexType": { "original": "SliderThumbChangeEvent", "resolved": "SliderThumbChangeEvent", "references": { "SliderThumbChangeEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisThumbClick", "detail": "SliderThumbClickEvent", "bubbles": true, "complexType": { "original": "SliderThumbClickEvent", "resolved": "SliderThumbClickEvent", "references": { "SliderThumbClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisThumbDrag", "detail": "SliderThumbDragEvent", "bubbles": true, "complexType": { "original": "SliderThumbDragEvent", "resolved": "SliderThumbDragEvent", "references": { "SliderThumbDragEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisTickClick", "detail": "SliderTickClickEvent", "bubbles": true, "complexType": { "original": "SliderTickClickEvent", "resolved": "SliderTickClickEvent", "references": { "SliderTickClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisTrackClick", "detail": "SliderTrackClickEvent", "bubbles": true, "complexType": { "original": "SliderTrackClickEvent", "resolved": "SliderTrackClickEvent", "references": { "SliderTrackClickEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "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 `leadingLayers` and `trailingLayers`\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 an `arcgis-scene` component.", "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\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory leaks.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "direction", "type": "\"horizontal\" | \"vertical\"", "complexType": { "original": "\"horizontal\" | \"vertical\"", "resolved": "\"horizontal\" | \"vertical\"", "references": {} }, "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": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "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`, sets the component to a disabled state so the user cannot interact with it.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "icon", "reflectToAttr": true, "docs": "Icon which represents the component.", "docsTags": [], "default": "\"compare\"", "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": "\"Swipe\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "leadingLayers", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "values": [], "optional": true, "required": false }, { "name": "messageOverrides", "type": "{\n componentLabel?: string | undefined;\n dragLabel?: string | undefined;\n}", "complexType": { "original": "{\n componentLabel?: string | undefined;\n dragLabel?: string | undefined;\n}", "resolved": "{\n componentLabel?: string | undefined;\n dragLabel?: string | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "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": true, "docs": "", "docsTags": [], "default": "\"manual\"", "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\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"ready\"", "resolved": "\"disabled\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "type": "string" } ], "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 [leadingLayers](#leadingLayers).", "docsTags": [], "default": "25", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "trailingLayers", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Layer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisSwipe = document.createElement(\"arcgis-swipe\");\ndocument.body.append(arcgisSwipe);\narcgisSwipe.componentOnReady().then(() => {\n console.log(\"arcgis-swipe is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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/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/api-reference/esri-Map.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": "collapsed", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "collapsed", "reflectToAttr": true, "docs": "Indicates whether the widget is collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#collapsed)", "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 whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html) may be reordered within the list by dragging and dropping.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#dragEnabled)", "docsTags": [], "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/api-reference/esri-widgets-TableList.html#visibleElements) is true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#filterPlaceholder)", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "filterPredicate", "type": "(((item: TableListListItem) => void))", "complexType": { "original": "(((item: TableListListItem) => void))", "resolved": "(((item: TableListListItem) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#filterPredicate)", "docsTags": [], "default": "null", "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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#filterText)", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "hideFlow", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-flow", "reflectToAttr": false, "docs": "", "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": "", "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": "\"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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "listItemCreatedFunction", "type": "(((event: any) => void))", "complexType": { "original": "(((event: any) => void))", "resolved": "(((event: any) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#listItemCreatedFunction)", "docsTags": [], "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/api-reference/esri-widgets-TableList.html#dragEnabled).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minDragEnabledItems)", "docsTags": [], "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 input box.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minFilterItems)", "docsTags": [], "default": "10", "values": [ { "type": "number" } ], "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": "selectedItems", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "TableListListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-ListItem.html)s representing table list items\nselected by the user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectedItems)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "selectionMode", "type": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "complexType": { "original": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "resolved": "\"multiple\" | \"none\" | \"single\" | \"single-persist\"", "references": {} }, "mutable": true, "attr": "selection-mode", "reflectToAttr": false, "docs": "Specifies the selection mode.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#selectionMode)", "docsTags": [], "default": "\"none\"", "values": [ { "value": "multiple", "type": "string" }, { "value": "none", "type": "string" }, { "value": "single", "type": "string" }, { "value": "single-persist", "type": "string" } ], "optional": true, "required": false }, { "name": "showCloseButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-close-button", "reflectToAttr": false, "docs": "", "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": "", "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": "", "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": "", "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": "", "docsTags": [], "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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 view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList-TableListViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "tableItems", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "TableListListItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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 } ], "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisTableList = document.createElement(\"arcgis-table-list\");\ndocument.body.append(arcgisTableList);\narcgisTableList.componentOnReady().then(() => {\n console.log(\"arcgis-table-list is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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": [] }, { "event": "arcgisTriggerAction", "detail": "TableListTriggerActionEvent", "bubbles": true, "complexType": { "original": "TableListTriggerActionEvent", "resolved": "TableListTriggerActionEvent", "references": { "TableListTriggerActionEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "actions", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Action": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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/img/apiref/widgets/timeslider/ellipsis.png) in the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#actions)", "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\\` method when you are done to prevent\nmemory 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`, sets the widget to a disabled state so the user cannot interact with it.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#disabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "effectiveStops", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "Date": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Lists the specific locations on the timeline where handle(s) will snap to when manipulated.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#effectiveStops)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "null", "values": [], "optional": true, "required": false }, { "name": "fullTimeExtent", "type": "TimeExtent", "complexType": { "original": "TimeExtent", "resolved": "TimeExtent", "references": { "TimeExtent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The temporal extent of the entire slider.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#fullTimeExtent)", "docsTags": [], "values": [], "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": "\"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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "layout", "type": "\"auto\" | \"compact\" | \"wide\"", "complexType": { "original": "\"auto\" | \"compact\" | \"wide\"", "resolved": "\"auto\" | \"compact\" | \"wide\"", "references": {} }, "mutable": true, "attr": "layout", "reflectToAttr": false, "docs": "Determines the layout used by the TimeSlider widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#layout)", "docsTags": [], "default": "\"auto\"", "values": [ { "value": "auto", "type": "string" }, { "value": "compact", "type": "string" }, { "value": "wide", "type": "string" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#loop)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "mode", "type": "\"cumulative-from-end\" | \"cumulative-from-start\" | \"instant\" | \"time-window\"", "complexType": { "original": "\"cumulative-from-end\" | \"cumulative-from-start\" | \"instant\" | \"time-window\"", "resolved": "\"cumulative-from-end\" | \"cumulative-from-start\" | \"instant\" | \"time-window\"", "references": {} }, "mutable": true, "attr": "mode", "reflectToAttr": false, "docs": "The time slider mode.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#mode)", "docsTags": [], "default": "\"time-window\"", "values": [ { "value": "cumulative-from-end", "type": "string" }, { "value": "cumulative-from-start", "type": "string" }, { "value": "instant", "type": "string" }, { "value": "time-window", "type": "string" } ], "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[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#playRate)", "docsTags": [], "default": "1000", "values": [ { "type": "number" } ], "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\" | \"playing\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"playing\" | \"ready\"", "resolved": "\"disabled\" | \"playing\" | \"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-TimeSlider-TimeSliderViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "playing", "type": "string" }, { "value": "ready", "type": "string" } ], "optional": true, "required": false }, { "name": "stops", "type": "StopsByCount | StopsByDates | StopsByInterval", "complexType": { "original": "StopsByCount | StopsByDates | StopsByInterval", "resolved": "StopsByCount | StopsByDates | StopsByInterval", "references": { "StopsByCount": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "StopsByDates": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "StopsByInterval": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Defines specific locations on the time slider where thumbs will snap to when manipulated.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#stops)", "docsTags": [], "default": "{ count : 10 }", "values": [ { "type": "StopsByCount" }, { "type": "StopsByDates" }, { "type": "StopsByInterval" } ], "optional": true, "required": false }, { "name": "tickConfigs", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "TickConfig": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "When set, overrides the default TimeSlider ticks labelling system.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#tickConfigs)", "docsTags": [], "default": "null", "values": [], "optional": true, "required": false }, { "name": "timeExtent", "type": "TimeExtent", "complexType": { "original": "TimeExtent", "resolved": "TimeExtent", "references": { "TimeExtent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The current time extent of the time slider.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeExtent)", "docsTags": [], "default": "null", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeVisible)", "docsTags": [], "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 widget will be displayed in this time zone.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeZone)", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false } ], "methods": [ { "name": "applyTimeSliderSettings", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(settings: Pick<__esri.TimeSliderProperties, \"fullTimeExtent\" | \"loop\" | \"stops\">): Promise", "parameters": [ { "name": "settings", "type": "{\n loop?: boolean | undefined;\n fullTimeExtent?: nullish | TimeExtentProperties;\n stops?: nullish | Array;\n}", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "applyTimeSliderSettings(settings: Pick<__esri.TimeSliderProperties, \"fullTimeExtent\" | \"loop\" | \"stops\">): Promise", "parameters": [ { "name": "settings", "type": "{\n loop?: boolean | undefined;\n fullTimeExtent?: nullish | TimeExtentProperties;\n stops?: nullish | Array;\n}", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisTimeSlider = document.createElement(\"arcgis-time-slider\");\ndocument.body.append(arcgisTimeSlider);\narcgisTimeSlider.componentOnReady().then(() => {\n console.log(\"arcgis-time-slider is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "next(): Promise", "parameters": [], "docs": "Moves to the next item.", "docsTags": [] }, { "name": "play", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "play(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "previous", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "previous(): Promise", "parameters": [], "docs": "Moves to the previous item.", "docsTags": [] }, { "name": "stop", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "stop(): Promise", "parameters": [], "docs": "Stops the component.", "docsTags": [] }, { "name": "updateWebDocument", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(webmap: __esri.WebMap): Promise", "parameters": [ { "name": "webmap", "type": "WebMap", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "WebMap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "updateWebDocument(webmap: __esri.WebMap): Promise", "parameters": [ { "name": "webmap", "type": "WebMap", "docs": "" } ], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisPropertyChange", "detail": "{ name: \"timeExtent\" | \"state\" | \"effectiveStops\" | \"fullTimeExtent\"; }", "bubbles": true, "complexType": { "original": "{ name: \"timeExtent\" | \"state\" | \"effectiveStops\" | \"fullTimeExtent\"; }", "resolved": "{ name: \"timeExtent\" | \"state\" | \"effectiveStops\" | \"fullTimeExtent\"; }", "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": [] }, { "event": "arcgisTriggerAction", "detail": "TimeSliderTriggerActionEvent", "bubbles": true, "complexType": { "original": "TimeSliderTriggerActionEvent", "resolved": "TimeSliderTriggerActionEvent", "references": { "TimeSliderTriggerActionEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when an action is triggered on the component.", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/track/track.tsx", "tag": "arcgis-track", "overview": "", "readme": "", "usage": {}, "docs": "Track component is a button that animates the map or scene to the user's location when clicked.\nThe view rotates based on device heading.\nThe default heading symbol will display when speed is greater than zero and the browser provides heading information.\n\n**Known Limitations**\n\n- The heading symbol is not currently supported within an `arcgis-scene` component.", "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\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory leaks.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "error", "type": "any", "complexType": { "original": "any", "resolved": "any", "references": {} }, "mutable": true, "attr": "error", "reflectToAttr": false, "docs": "Error that caused the last [track-error](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#event:track-error) event to fire.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#error)", "docsTags": [], "default": "null", "values": [ { "type": "any" } ], "optional": true, "required": false }, { "name": "geolocationOptions", "type": "any", "complexType": { "original": "any", "resolved": "any", "references": {} }, "mutable": true, "attr": "geolocation-options", "reflectToAttr": false, "docs": "An object used for setting optional position parameters.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#geolocationOptions)", "docsTags": [], "default": "null", "values": [ { "type": "any" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#goToLocationEnabled)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "goToOverride", "type": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "complexType": { "original": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "resolved": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "This function provides the ability to override either the\n[MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or\n[SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#goToOverride)", "docsTags": [], "values": [], "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 used to show the user's location on the map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#graphic)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "icon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "icon", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "\"compass-north-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": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "messageOverrides", "type": "{\n componentLabel?: string | undefined;\n startTracking?: string | undefined;\n stopTracking?: string | undefined;\n permissionError?: string | undefined;\n timeoutError?: string | undefined;\n positionUnavailable?: string | undefined;\n}", "complexType": { "original": "{\n componentLabel?: string | undefined;\n startTracking?: string | undefined;\n stopTracking?: string | undefined;\n permissionError?: string | undefined;\n timeoutError?: string | undefined;\n positionUnavailable?: string | undefined;\n}", "resolved": "{\n componentLabel?: string | undefined;\n startTracking?: string | undefined;\n stopTracking?: string | undefined;\n permissionError?: string | undefined;\n timeoutError?: string | undefined;\n positionUnavailable?: string | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "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": true, "docs": "", "docsTags": [], "default": "\"top-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": "positionFilterFunction", "type": "Function", "complexType": { "original": "Function", "resolved": "Function", "references": { "Function": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A function that is used as an expression to evaluate geolocation points, and returns a boolean\nvalue.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#positionFilterFunction)", "docsTags": [], "default": "null", "values": [], "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": "scale", "type": "number", "complexType": { "original": "number", "resolved": "number", "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 [track](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#event-track) event.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#scale)", "docsTags": [], "default": "null", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "state", "type": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"ready\" | \"tracking\" | \"waiting\"", "complexType": { "original": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"ready\" | \"tracking\" | \"waiting\"", "resolved": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"ready\" | \"tracking\" | \"waiting\"", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "error", "type": "string" }, { "value": "feature-unsupported", "type": "string" }, { "value": "ready", "type": "string" }, { "value": "tracking", "type": "string" }, { "value": "waiting", "type": "string" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#tracking)", "docsTags": [ { "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisTrack = document.createElement(\"arcgis-track\");\ndocument.body.append(arcgisTrack);\narcgisTrack.componentOnReady().then(() => {\n console.log(\"arcgis-track is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "start(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "stop", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "stop(): Promise", "parameters": [], "docs": "Stops the component.", "docsTags": [] } ], "events": [ { "event": "arcgisComplete", "detail": "TrackViewModelTrackEvent", "bubbles": true, "complexType": { "original": "TrackViewModelTrackEvent", "resolved": "TrackViewModelTrackEvent", "references": { "TrackViewModelTrackEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when the component is complete.", "docsTags": [] }, { "event": "arcgisError", "detail": "TrackViewModelTrackErrorEvent", "bubbles": true, "complexType": { "original": "TrackViewModelTrackErrorEvent", "resolved": "TrackViewModelTrackErrorEvent", "references": { "TrackViewModelTrackErrorEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emitted when an error occurs.", "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": "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/utility-network-associations/utility-network-associations.tsx", "tag": "arcgis-utility-network-associations", "overview": "", "readme": "", "usage": {}, "docs": "The UtilityNetworkAssociations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The UtilityNetworkAssociations 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": "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": "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#autoRefreshAssociations)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "connectivityAssociationsLineSymbol", "type": "SimpleLineSymbol", "complexType": { "original": "SimpleLineSymbol", "resolved": "SimpleLineSymbol", "references": { "SimpleLineSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being\ndrawn for connectivity associations.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#connectivityAssociationsLineSymbol)", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "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": "\"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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#includeConnectivityAssociations)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#includeStructuralAttachmentAssociations)", "docsTags": [], "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": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociations)", "docsTags": [], "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\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMax)", "docsTags": [], "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\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMin)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderStep)", "docsTags": [], "values": [ { "type": "number" } ], "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": "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#showArrowsConnectivity)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#showArrowsStructuralAttachment)", "docsTags": [], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#showAssociationsEnabled)", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "structuralAttachmentAssociationsLineSymbol", "type": "SimpleLineSymbol", "complexType": { "original": "SimpleLineSymbol", "resolved": "SimpleLineSymbol", "references": { "SimpleLineSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for structural attachment associations.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#structuralAttachmentAssociationsLineSymbol)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "utilityNetwork", "type": "UtilityNetwork", "complexType": { "original": "UtilityNetwork", "resolved": "UtilityNetwork", "references": { "UtilityNetwork": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Determines the utility network to use.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#utilityNetwork)", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "visibleElementsConnectivityAssociationsSettingsArrowsToggle", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-connectivity-associations-settings-arrows-toggle", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "deprecation": "Use hideConnectivityAssociationsSettingsArrowsToggle instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsConnectivityAssociationsSettingsCapSelect", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-connectivity-associations-settings-cap-select", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "deprecation": "Use hideConnectivityAssociationsSettingsCapSelect instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsConnectivityAssociationsSettingsColorPicker", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-connectivity-associations-settings-color-picker", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "true", "deprecation": "Use hideConnectivityAssociationsSettingsColorPicker instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsConnectivityAssociationsSettingsStylePicker", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-connectivity-associations-settings-style-picker", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "true", "deprecation": "Use hideConnectivityAssociationsSettingsStylePicker instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsConnectivityAssociationsSettingsWidthInput", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-connectivity-associations-settings-width-input", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "true", "deprecation": "Use hideConnectivityAssociationsSettingsWidthInput instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsMaxAllowableAssociationsSlider", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-max-allowable-associations-slider", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "deprecation": "Use hideMaxAllowableAssociationsSlider instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsStructuralAttachmentAssociationsSettingsArrowsToggle", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-structural-attachment-associations-settings-arrows-toggle", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "deprecation": "Use hideStructuralAttachmentAssociationsSettingsArrowsToggle instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsStructuralAttachmentAssociationsSettingsCapSelect", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-structural-attachment-associations-settings-cap-select", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "deprecation": "Use hideStructuralAttachmentAssociationsSettingsCapSelect instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsStructuralAttachmentAssociationsSettingsColorPicker", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-structural-attachment-associations-settings-color-picker", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "true", "deprecation": "Use hideStructuralAttachmentAssociationsSettingsColorPicker instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsStructuralAttachmentAssociationsSettingsStylePicker", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-structural-attachment-associations-settings-style-picker", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "true", "deprecation": "Use hideStructuralAttachmentAssociationsSettingsStylePicker instead", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "visibleElementsStructuralAttachmentAssociationsSettingsWidthInput", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "visible-elements-structural-attachment-associations-settings-width-input", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "true", "deprecation": "Use hideStructuralAttachmentAssociationsSettingsWidthInput instead", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisUtilityNetworkAssociations = document.createElement(\"arcgis-utility-network-associations\");\ndocument.body.append(arcgisUtilityNetworkAssociations);\narcgisUtilityNetworkAssociations.componentOnReady().then(() => {\n console.log(\"arcgis-utility-network-associations is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "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/utility-network-trace/utility-network-trace.tsx", "tag": "arcgis-utility-network-trace", "overview": "", "readme": "", "usage": {}, "docs": "UtilityNetworkTrace component provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. Input flags (starting points and barriers) can be set by clicking the view.\n\n> The UtilityNetworkTrace 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": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "defaultGraphicColor", "type": "GraphicColor", "complexType": { "original": "GraphicColor", "resolved": "GraphicColor", "references": { "GraphicColor": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "disabled", "reflectToAttr": true, "docs": "", "docsTags": [], "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "flags", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FlagProperty": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "gdbVersion", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "gdb-version", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "\"sde.DEFAULT\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "inputSettings", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "InputSetting": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "values": [], "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": "resultAreaProperties", "type": "ResultAreaPropertiesExtend", "complexType": { "original": "ResultAreaPropertiesExtend", "resolved": "ResultAreaPropertiesExtend", "references": { "ResultAreaPropertiesExtend": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "selectedTraces", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "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": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false } ], "methods": [ { "name": "checkCanTrace", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisUtilityNetworkTrace = document.createElement(\"arcgis-utility-network-trace\");\ndocument.body.append(arcgisUtilityNetworkTrace);\narcgisUtilityNetworkTrace.componentOnReady().then(() => {\n console.log(\"arcgis-utility-network-trace is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "confirmReset", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "confirmReset(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "arcgisAddFlag", "detail": "UtilityNetworkTraceAddFlagEvent", "bubbles": true, "complexType": { "original": "UtilityNetworkTraceAddFlagEvent", "resolved": "UtilityNetworkTraceAddFlagEvent", "references": { "UtilityNetworkTraceAddFlagEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisAddFlagComplete", "detail": "UtilityNetworkTraceAddFlagCompleteEvent", "bubbles": true, "complexType": { "original": "UtilityNetworkTraceAddFlagCompleteEvent", "resolved": "UtilityNetworkTraceAddFlagCompleteEvent", "references": { "UtilityNetworkTraceAddFlagCompleteEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisAddFlagError", "detail": "UtilityNetworkTraceAddFlagErrorEvent", "bubbles": true, "complexType": { "original": "UtilityNetworkTraceAddFlagErrorEvent", "resolved": "UtilityNetworkTraceAddFlagErrorEvent", "references": { "UtilityNetworkTraceAddFlagErrorEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisAddResultArea", "detail": "UtilityNetworkTraceAddResultAreaEvent", "bubbles": true, "complexType": { "original": "UtilityNetworkTraceAddResultAreaEvent", "resolved": "UtilityNetworkTraceAddResultAreaEvent", "references": { "UtilityNetworkTraceAddResultAreaEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "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": [] }, { "event": "arcgisRemoveResultArea", "detail": "UtilityNetworkTraceRemoveResultAreaEvent", "bubbles": true, "complexType": { "original": "UtilityNetworkTraceRemoveResultAreaEvent", "resolved": "UtilityNetworkTraceRemoveResultAreaEvent", "references": { "UtilityNetworkTraceRemoveResultAreaEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/utility-network-validate-topology/utility-network-validate-topology.tsx", "tag": "arcgis-utility-network-validate-topology", "overview": "", "readme": "", "usage": {}, "docs": "The UtilityNetworkValidateTopology component simplifies the process of validating a DirtyArea within a utility network. It offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The UtilityNetworkValidateTopology 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": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "extentToValidate", "type": "\"current\" | \"entire\"", "complexType": { "original": "\"current\" | \"entire\"", "resolved": "\"current\" | \"entire\"", "references": {} }, "mutable": true, "attr": "extent-to-validate", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "\"current\"", "values": [ { "value": "current", "type": "string" }, { "value": "entire", "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": "utilityNetwork", "type": "UtilityNetwork", "complexType": { "original": "UtilityNetwork", "resolved": "UtilityNetwork", "references": { "UtilityNetwork": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisUtilityNetworkValidateTopology = document.createElement(\"arcgis-utility-network-validate-topology\");\ndocument.body.append(arcgisUtilityNetworkValidateTopology);\narcgisUtilityNetworkValidateTopology.componentOnReady().then(() => {\n console.log(\"arcgis-utility-network-validate-topology is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "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/value-picker/value-picker.tsx", "tag": "arcgis-value-picker", "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": "canNext", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "can-next", "reflectToAttr": true, "docs": "Returns `true` if the ValuePicker can be advanced to the next position.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canNext)", "docsTags": [], "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": true, "docs": "Returns `true` if the ValuePicker can be played.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canPlay)", "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": true, "docs": "Returns `true` if the ValuePicker can moved to the previous item.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canPrevious)", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "caption", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "caption", "reflectToAttr": false, "docs": "An optional caption that appears on the ValuePicker widget to give context for the user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#caption)", "docsTags": [], "default": "null", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "component", "type": "ValuePickerCollection | ValuePickerCombobox | ValuePickerLabel | ValuePickerSlider", "complexType": { "original": "ValuePickerCollection | ValuePickerCombobox | ValuePickerLabel | ValuePickerSlider", "resolved": "ValuePickerCollection | ValuePickerCombobox | ValuePickerLabel | ValuePickerSlider", "references": { "ValuePickerCollection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ValuePickerCombobox": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ValuePickerLabel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "ValuePickerSlider": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "An optional component for presenting and managing data.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#component)", "docsTags": [], "default": "null", "values": [ { "type": "ValuePickerCollection" }, { "type": "ValuePickerCombobox" }, { "type": "ValuePickerLabel" }, { "type": "ValuePickerSlider" } ], "optional": true, "required": false }, { "name": "hideNextButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "hide-next-button", "reflectToAttr": false, "docs": "", "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": "", "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": "", "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": "\"list-rectangle\"", "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": "layout", "type": "\"horizontal\" | \"vertical\"", "complexType": { "original": "\"horizontal\" | \"vertical\"", "resolved": "\"horizontal\" | \"vertical\"", "references": {} }, "mutable": true, "attr": "layout", "reflectToAttr": false, "docs": "Indicates if the widget should be orientated horizontally (default) or vertically.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#layout)", "docsTags": [], "default": "\"horizontal\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#loop)", "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": "The pause, in milliseconds between playback advancement.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#playRate)", "docsTags": [], "default": "1000", "values": [ { "type": "number" } ], "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": "values", "type": "Array | Array | Array", "complexType": { "original": "Array | Array | Array", "resolved": "Array | Array | Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The current value of the ValuePicker.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#values)", "docsTags": [], "default": "null", "values": [ { "type": "Array" }, { "type": "Array" }, { "type": "Array" } ], "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisValuePicker = document.createElement(\"arcgis-value-picker\");\ndocument.body.append(arcgisValuePicker);\narcgisValuePicker.componentOnReady().then(() => {\n console.log(\"arcgis-value-picker is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "next(): Promise", "parameters": [], "docs": "Moves to the next item.", "docsTags": [] }, { "name": "pause", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "pause(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "play", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "play(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "previous", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "previous(): Promise", "parameters": [], "docs": "Moves to the previous item.", "docsTags": [] } ], "events": [ { "event": "arcgisAnimate", "detail": "ValuePickerAnimateEvent", "bubbles": true, "complexType": { "original": "ValuePickerAnimateEvent", "resolved": "ValuePickerAnimateEvent", "references": { "ValuePickerAnimateEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisNext", "detail": "ValuePickerNextEvent", "bubbles": true, "complexType": { "original": "ValuePickerNextEvent", "resolved": "ValuePickerNextEvent", "references": { "ValuePickerNextEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisPause", "detail": "ValuePickerPauseEvent", "bubbles": true, "complexType": { "original": "ValuePickerPauseEvent", "resolved": "ValuePickerPauseEvent", "references": { "ValuePickerPauseEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisPlay", "detail": "ValuePickerPlayEvent", "bubbles": true, "complexType": { "original": "ValuePickerPlayEvent", "resolved": "ValuePickerPlayEvent", "references": { "ValuePickerPlayEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "arcgisPrevious", "detail": "ValuePickerPreviousEvent", "bubbles": true, "complexType": { "original": "ValuePickerPreviousEvent", "resolved": "ValuePickerPreviousEvent", "references": { "ValuePickerPreviousEvent": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "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": [] }, { "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/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/api-reference/esri-views-View.html) 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 VersionManagement 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": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "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\\` method when you are done to prevent\nmemory 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", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "icon", "reflectToAttr": true, "docs": "", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "initialVersionInfos", "type": "Array<{\n url: string;\n name: string;\n}>", "complexType": { "original": "Array<{\n url: string;\n name: string;\n}>", "resolved": "Array<{\n url: string;\n name: string;\n}>", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "label", "reflectToAttr": true, "docs": "", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "messageOverrides", "type": "{\n label?: string | undefined;\n actions?: {\n cancelSave?: string | undefined;\n deleteVersion?: string | undefined;\n editVersion?: string | undefined;\n newVersion?: string | undefined;\n refreshVersions?: string | undefined;\n saveVersion?: string | undefined;\n searchVersions?: string | undefined;\n switchToVersion?: string | undefined;\n } | undefined;\n accessLevels?: {\n private?: string | undefined;\n protected?: string | undefined;\n public?: string | undefined;\n } | undefined;\n executionErrors?: {\n invalidVersionName?: string | undefined;\n noAdvancedEditingUserTypeExtension?: string | undefined;\n noFeatureServiceFound?: string | undefined;\n notValidEnterpriseVersion?: string | undefined;\n noVersionManagementServiceFound?: string | undefined;\n } | undefined;\n headers?: {\n currentVersion?: string | undefined;\n manageVersions?: string | undefined;\n filterVersions?: string | undefined;\n versionProperties?: string | undefined;\n invalidInitialVersion?: string | undefined;\n invalidInitialFeatureService?: string | undefined;\n } | undefined;\n input?: {\n versionAccess?: string | undefined;\n versionDescription?: string | undefined;\n versionName?: string | undefined;\n versionOwner?: string | undefined;\n } | undefined;\n loadErrors?: {\n invalidInitialVersion?: string | undefined;\n invalidInitialFeatureService?: string | undefined;\n noFeatureServices?: string | undefined;\n noViewProperty?: string | undefined;\n } | undefined;\n}", "complexType": { "original": "{\n label?: string | undefined;\n actions?: {\n cancelSave?: string | undefined;\n deleteVersion?: string | undefined;\n editVersion?: string | undefined;\n newVersion?: string | undefined;\n refreshVersions?: string | undefined;\n saveVersion?: string | undefined;\n searchVersions?: string | undefined;\n switchToVersion?: string | undefined;\n } | undefined;\n accessLevels?: {\n private?: string | undefined;\n protected?: string | undefined;\n public?: string | undefined;\n } | undefined;\n executionErrors?: {\n invalidVersionName?: string | undefined;\n noAdvancedEditingUserTypeExtension?: string | undefined;\n noFeatureServiceFound?: string | undefined;\n notValidEnterpriseVersion?: string | undefined;\n noVersionManagementServiceFound?: string | undefined;\n } | undefined;\n headers?: {\n currentVersion?: string | undefined;\n manageVersions?: string | undefined;\n filterVersions?: string | undefined;\n versionProperties?: string | undefined;\n invalidInitialVersion?: string | undefined;\n invalidInitialFeatureService?: string | undefined;\n } | undefined;\n input?: {\n versionAccess?: string | undefined;\n versionDescription?: string | undefined;\n versionName?: string | undefined;\n versionOwner?: string | undefined;\n } | undefined;\n loadErrors?: {\n invalidInitialVersion?: string | undefined;\n invalidInitialFeatureService?: string | undefined;\n noFeatureServices?: string | undefined;\n noViewProperty?: string | undefined;\n } | undefined;\n}", "resolved": "{\n label?: string | undefined;\n actions?: {\n cancelSave?: string | undefined;\n deleteVersion?: string | undefined;\n editVersion?: string | undefined;\n newVersion?: string | undefined;\n refreshVersions?: string | undefined;\n saveVersion?: string | undefined;\n searchVersions?: string | undefined;\n switchToVersion?: string | undefined;\n } | undefined;\n accessLevels?: {\n private?: string | undefined;\n protected?: string | undefined;\n public?: string | undefined;\n } | undefined;\n executionErrors?: {\n invalidVersionName?: string | undefined;\n noAdvancedEditingUserTypeExtension?: string | undefined;\n noFeatureServiceFound?: string | undefined;\n notValidEnterpriseVersion?: string | undefined;\n noVersionManagementServiceFound?: string | undefined;\n } | undefined;\n headers?: {\n currentVersion?: string | undefined;\n manageVersions?: string | undefined;\n filterVersions?: string | undefined;\n versionProperties?: string | undefined;\n invalidInitialVersion?: string | undefined;\n invalidInitialFeatureService?: string | undefined;\n } | undefined;\n input?: {\n versionAccess?: string | undefined;\n versionDescription?: string | undefined;\n versionName?: string | undefined;\n versionOwner?: string | undefined;\n } | undefined;\n loadErrors?: {\n invalidInitialVersion?: string | undefined;\n invalidInitialFeatureService?: string | undefined;\n noFeatureServices?: string | undefined;\n noViewProperty?: string | undefined;\n } | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "mode", "type": "string", "complexType": { "original": "string", "resolved": "string", "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": "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": "\"top-right\"", "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\" | \"executing\" | \"failed\" | \"loading\" | \"ready\" | \"success\"", "complexType": { "original": "\"disabled\" | \"executing\" | \"failed\" | \"loading\" | \"ready\" | \"success\"", "resolved": "\"disabled\" | \"executing\" | \"failed\" | \"loading\" | \"ready\" | \"success\"", "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-VersionManagement-VersionManagementViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [ { "value": "disabled", "type": "string" }, { "value": "executing", "type": "string" }, { "value": "failed", "type": "string" }, { "value": "loading", "type": "string" }, { "value": "ready", "type": "string" }, { "value": "success", "type": "string" } ], "optional": true, "required": false }, { "name": "versioningStates", "type": "Collection", "complexType": { "original": "Collection", "resolved": "Collection", "references": { "Collection": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "VersioningState": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "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": [], "values": [], "optional": true, "required": false }, { "name": "view", "type": "MapView", "complexType": { "original": "MapView", "resolved": "MapView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The view from which the widget will operate.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VersionManagement-VersionManagementViewModel.html#view)", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisVersionManagement = document.createElement(\"arcgis-version-management\");\ndocument.body.append(arcgisVersionManagement);\narcgisVersionManagement.componentOnReady().then(() => {\n console.log(\"arcgis-version-management is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "destroy(): Promise", "parameters": [], "docs": "Permanently destroy the component.", "docsTags": [] } ], "events": [ { "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": [] }, { "event": "arcgisVersioningStateChanged", "detail": "VersioningStateEvent", "bubbles": true, "complexType": { "original": "VersioningStateEvent", "resolved": "VersioningStateEvent", "references": { "VersioningStateEvent": { "location": "local", "path": "dist/components/arcgis-version-management/customElement.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/weather/weather.tsx", "tag": "arcgis-weather", "overview": "", "readme": "", "usage": {}, "docs": "Weather component provides an interface for easily selecting and configuring the weather effects in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.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": "headingLevel", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "heading-level", "reflectToAttr": false, "docs": "Indicates the heading level to use for the title of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather.html#headingLevel)", "docsTags": [], "default": "4", "values": [ { "type": "number" } ], "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": "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": "\"partly-cloudy\"", "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\" | \"error\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"error\" | \"ready\"", "resolved": "\"disabled\" | \"error\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the view model that can be used for rendering the UI of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Weather-WeatherViewModel.html#state)", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "error", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisWeather = document.createElement(\"arcgis-weather\");\ndocument.body.append(arcgisWeather);\narcgisWeather.componentOnReady().then(() => {\n console.log(\"arcgis-weather is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "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/zoom/zoom.tsx", "tag": "arcgis-zoom", "overview": "", "readme": "", "usage": {}, "docs": "Zoom component allows users to zoom in/out within a view.", "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\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent memory 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": true, "docs": "Icon which represents the component.", "docsTags": [], "default": "\"magnifying-glass-plus\"", "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": "layout", "type": "\"horizontal\" | \"vertical\"", "complexType": { "original": "\"horizontal\" | \"vertical\"", "resolved": "\"horizontal\" | \"vertical\"", "references": {} }, "mutable": true, "attr": "layout", "reflectToAttr": true, "docs": "Determines the layout/orientation of the Zoom widget.", "docsTags": [], "default": "\"vertical\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": true, "required": false }, { "name": "messageOverrides", "type": "{\n componentLabel?: string | undefined;\n zoomIn?: string | undefined;\n zoomOut?: string | undefined;\n}", "complexType": { "original": "{\n componentLabel?: string | undefined;\n zoomIn?: string | undefined;\n zoomOut?: string | undefined;\n}", "resolved": "{\n componentLabel?: string | undefined;\n zoomIn?: string | undefined;\n zoomOut?: string | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Replace localized message strings with your own strings.", "docsTags": [], "values": [], "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": "\"top-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\" | \"ready\"", "complexType": { "original": "\"disabled\" | \"ready\"", "resolved": "\"disabled\" | \"ready\"", "references": {} }, "mutable": true, "attr": "state", "reflectToAttr": true, "docs": "The current state of the component.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "\"disabled\"", "values": [ { "value": "disabled", "type": "string" }, { "value": "ready", "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": "Create a promise that resolves once component is fully loaded.", "docsTags": [ { "name": "example", "text": "const arcgisZoom = document.createElement(\"arcgis-zoom\");\ndocument.body.append(arcgisZoom);\narcgisZoom.componentOnReady().then(() => {\n console.log(\"arcgis-zoom is ready to go!\");\n});" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "destroy", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "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": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "zoomOut(): Promise", "parameters": [], "docs": "Zooms the view out by an LOD factor of 2.", "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": [] } ], "typeLibrary": {} }