@arcgis/map-components
Version:
ArcGIS Map Components
1,344 lines (1,343 loc) • 1.94 MB
JSON
{
"timestamp": "2025-03-26T22:39:01",
"compiler": {
"name": "@arcgis/lumina-compiler",
"version": "4.32.13",
"typescriptVersion": "5.6.3"
},
"schemaVersion": "1.0.0",
"modules": [
{
"kind": "javascript-module",
"path": "src/components/area-measurement-2d/area-measurement-2d.tsx",
"declarations": [
{
"kind": "class",
"customElement": true,
"name": "ArcgisAreaMeasurement2d",
"tagName": "arcgis-area-measurement-2d",
"description": "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).",
"demos": [
{
"description": "Docs",
"url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/"
},
{
"description": "Demo",
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"
}
],
"superclass": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"encapsulation": "none",
"pascalCaseName": "ArcgisAreaMeasurement2d",
"importPath": "components/arcgis-area-measurement-2d",
"members": [
{
"kind": "field",
"name": "autoDestroyDisabled",
"description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "auto-destroy-disabled"
},
{
"kind": "method",
"name": "componentOnReady",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"module": "lib/lib.es5.d.ts",
"name": "Promise",
"package": "typescript",
"start": 0,
"end": 7
}
]
}
},
"description": "Create a promise that resolves once component is fully loaded.",
"signature": "(): Promise<void>",
"async": true,
"inheritedFrom": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"docsTags": [
{
"name": "example",
"text": "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});"
}
]
},
{
"kind": "method",
"name": "destroy",
"description": "Permanently destroy the component.",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"name": "Promise",
"package": "typescript",
"module": "lib/lib.es5.d.ts",
"start": 0,
"end": 7
}
]
}
},
"signature": "(): Promise<void>",
"async": true
},
{
"kind": "field",
"name": "icon",
"description": "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.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"default": "\"measure-area\"",
"attribute": "icon"
},
{
"kind": "field",
"name": "label",
"description": "The component's default label.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "label"
},
{
"kind": "field",
"name": "position",
"type": {
"text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
"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"
}
]
},
"default": "\"bottom-left\"",
"attribute": "position"
},
{
"kind": "field",
"name": "referenceElement",
"type": {
"text": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string",
"references": [
{
"name": "ArcgisLinkChart",
"module": "dist/components/arcgis-link-chart/customElement.d.ts",
"start": 0,
"end": 15
},
{
"name": "ArcgisMap",
"module": "dist/components/arcgis-map/customElement.d.ts",
"start": 18,
"end": 27
},
{
"name": "ArcgisScene",
"module": "dist/components/arcgis-scene/customElement.d.ts",
"start": 30,
"end": 41
}
],
"values": [
{
"type": "ArcgisLinkChart"
},
{
"type": "ArcgisMap"
},
{
"type": "ArcgisScene"
},
{
"type": "string"
}
]
},
"attribute": "reference-element"
},
{
"kind": "field",
"name": "snappingOptions",
"description": "The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#snappingOptions)",
"type": {
"text": "SnappingOptions",
"references": [
{
"name": "SnappingOptions",
"package": "@arcgis/core",
"module": "interfaces.d.ts",
"viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html",
"start": 0,
"end": 15
}
]
}
},
{
"kind": "field",
"name": "state",
"description": "The ViewModel's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#state)",
"type": {
"text": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"",
"values": [
{
"value": "disabled",
"type": "string"
},
{
"value": "measured",
"type": "string"
},
{
"value": "measuring",
"type": "string"
},
{
"value": "ready",
"type": "string"
}
]
},
"default": "\"disabled\"",
"readonly": true,
"attribute": "state",
"reflects": true,
"docsOnlyReadonly": true
},
{
"kind": "field",
"name": "unit",
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit)",
"type": {
"text": "\"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\"",
"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"
}
]
},
"attribute": "unit"
},
{
"kind": "field",
"name": "unitOptions",
"description": "List of available units and unit systems (imperial, metric) for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unitOptions)",
"type": {
"text": "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": [
{
"name": "Array",
"package": "typescript",
"module": "lib/lib.es5.d.ts",
"start": 0,
"end": 5
}
]
}
}
],
"attributes": [
{
"name": "auto-destroy-disabled",
"description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "autoDestroyDisabled"
},
{
"name": "icon",
"description": "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.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"default": "\"measure-area\"",
"fieldName": "icon"
},
{
"name": "label",
"description": "The component's default label.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "label"
},
{
"name": "position",
"type": {
"text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
"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"
}
]
},
"default": "\"bottom-left\"",
"fieldName": "position"
},
{
"name": "reference-element",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "referenceElement"
},
{
"name": "state",
"description": "The ViewModel's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#state)",
"type": {
"text": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"",
"values": [
{
"value": "disabled",
"type": "string"
},
{
"value": "measured",
"type": "string"
},
{
"value": "measuring",
"type": "string"
},
{
"value": "ready",
"type": "string"
}
]
},
"default": "\"disabled\"",
"fieldName": "state"
},
{
"name": "unit",
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit)",
"type": {
"text": "\"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\"",
"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"
}
]
},
"fieldName": "unit"
}
],
"events": [
{
"name": "arcgisPropertyChange",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties.",
"type": {
"text": "{ name: \"state\"; }"
}
},
{
"name": "arcgisReady",
"description": "Emitted when the component associated with a map view is is ready to be interacted with.",
"type": {
"text": "undefined"
}
}
]
}
],
"exports": [
{
"kind": "custom-element-definition",
"name": "arcgis-area-measurement-2d",
"declaration": {
"name": "ArcgisAreaMeasurement2d",
"module": "src/components/area-measurement-2d/area-measurement-2d.tsx"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/components/area-measurement-3d/area-measurement-3d.tsx",
"declarations": [
{
"kind": "class",
"customElement": true,
"name": "ArcgisAreaMeasurement3d",
"tagName": "arcgis-area-measurement-3d",
"description": "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.",
"demos": [
{
"description": "Docs",
"url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/"
},
{
"description": "Demo",
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-area-measurement-3d--demo&singleStory=true"
}
],
"superclass": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"encapsulation": "none",
"pascalCaseName": "ArcgisAreaMeasurement3d",
"importPath": "components/arcgis-area-measurement-3d",
"members": [
{
"kind": "field",
"name": "analysis",
"description": "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)",
"type": {
"text": "AreaMeasurementAnalysis",
"references": [
{
"name": "AreaMeasurementAnalysis",
"package": "@arcgis/core",
"module": "interfaces.d.ts",
"viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html",
"start": 0,
"end": 23
}
]
},
"readonly": true,
"docsOnlyReadonly": true
},
{
"kind": "field",
"name": "autoDestroyDisabled",
"description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "auto-destroy-disabled"
},
{
"kind": "method",
"name": "clear",
"description": "Clears the component.",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"name": "Promise",
"package": "typescript",
"module": "lib/lib.es5.d.ts",
"start": 0,
"end": 7
}
]
}
},
"signature": "(): Promise<void>",
"async": true
},
{
"kind": "method",
"name": "componentOnReady",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"module": "lib/lib.es5.d.ts",
"name": "Promise",
"package": "typescript",
"start": 0,
"end": 7
}
]
}
},
"description": "Create a promise that resolves once component is fully loaded.",
"signature": "(): Promise<void>",
"async": true,
"inheritedFrom": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"docsTags": [
{
"name": "example",
"text": "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});"
}
]
},
{
"kind": "method",
"name": "destroy",
"description": "Permanently destroy the component.",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"name": "Promise",
"package": "typescript",
"module": "lib/lib.es5.d.ts",
"start": 0,
"end": 7
}
]
}
},
"signature": "(): Promise<void>",
"async": true
},
{
"kind": "field",
"name": "icon",
"description": "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.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"default": "\"measure-area\"",
"attribute": "icon"
},
{
"kind": "field",
"name": "label",
"description": "The component's default label.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"attribute": "label"
},
{
"kind": "field",
"name": "position",
"type": {
"text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
"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"
}
]
},
"default": "\"bottom-left\"",
"attribute": "position"
},
{
"kind": "field",
"name": "referenceElement",
"type": {
"text": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string",
"references": [
{
"name": "ArcgisLinkChart",
"module": "dist/components/arcgis-link-chart/customElement.d.ts",
"start": 0,
"end": 15
},
{
"name": "ArcgisMap",
"module": "dist/components/arcgis-map/customElement.d.ts",
"start": 18,
"end": 27
},
{
"name": "ArcgisScene",
"module": "dist/components/arcgis-scene/customElement.d.ts",
"start": 30,
"end": 41
}
],
"values": [
{
"type": "ArcgisLinkChart"
},
{
"type": "ArcgisMap"
},
{
"type": "ArcgisScene"
},
{
"type": "string"
}
]
},
"attribute": "reference-element"
},
{
"kind": "method",
"name": "start",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"name": "Promise",
"package": "typescript",
"module": "lib/lib.es5.d.ts",
"start": 0,
"end": 7
}
]
}
},
"signature": "(): Promise<void>",
"async": true
},
{
"kind": "field",
"name": "state",
"description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#state)",
"type": {
"text": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"",
"values": [
{
"value": "disabled",
"type": "string"
},
{
"value": "measured",
"type": "string"
},
{
"value": "measuring",
"type": "string"
},
{
"value": "ready",
"type": "string"
}
]
},
"default": "\"disabled\"",
"readonly": true,
"attribute": "state",
"reflects": true,
"docsOnlyReadonly": true
},
{
"kind": "field",
"name": "unit",
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unit)",
"type": {
"text": "\"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\"",
"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"
}
]
},
"attribute": "unit"
},
{
"kind": "field",
"name": "unitOptions",
"description": "List of available units and unit systems (imperial, metric) for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unitOptions)",
"type": {
"text": "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": [
{
"name": "Array",
"package": "typescript",
"module": "lib/lib.es5.d.ts",
"start": 0,
"end": 5
}
]
}
}
],
"attributes": [
{
"name": "auto-destroy-disabled",
"description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"fieldName": "autoDestroyDisabled"
},
{
"name": "icon",
"description": "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.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"default": "\"measure-area\"",
"fieldName": "icon"
},
{
"name": "label",
"description": "The component's default label.",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "label"
},
{
"name": "position",
"type": {
"text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
"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"
}
]
},
"default": "\"bottom-left\"",
"fieldName": "position"
},
{
"name": "reference-element",
"type": {
"text": "string",
"values": [
{
"type": "string"
}
]
},
"fieldName": "referenceElement"
},
{
"name": "state",
"description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#state)",
"type": {
"text": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\"",
"values": [
{
"value": "disabled",
"type": "string"
},
{
"value": "measured",
"type": "string"
},
{
"value": "measuring",
"type": "string"
},
{
"value": "ready",
"type": "string"
}
]
},
"default": "\"disabled\"",
"fieldName": "state"
},
{
"name": "unit",
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unit)",
"type": {
"text": "\"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\"",
"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"
}
]
},
"fieldName": "unit"
}
],
"events": [
{
"name": "arcgisPropertyChange",
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties.",
"type": {
"text": "{ name: \"state\" | \"analysis\"; }"
}
},
{
"name": "arcgisReady",
"description": "Emitted when the component associated with a map view is is ready to be interacted with.",
"type": {
"text": "undefined"
}
}
]
}
],
"exports": [
{
"kind": "custom-element-definition",
"name": "arcgis-area-measurement-3d",
"declaration": {
"name": "ArcgisAreaMeasurement3d",
"module": "src/components/area-measurement-3d/area-measurement-3d.tsx"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/components/attachments/attachments.tsx",
"declarations": [
{
"kind": "class",
"customElement": true,
"name": "ArcgisAttachments",
"tagName": "arcgis-attachments",
"demos": [
{
"description": "Docs",
"url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-attachments/"
},
{
"description": "Demo",
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-attachments--demo&singleStory=true"
}
],
"docsTags": [
{
"name": "internal"
}
],
"superclass": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"encapsulation": "none",
"pascalCaseName": "ArcgisAttachments",
"importPath": "components/arcgis-attachments",
"members": [
{
"kind": "field",
"name": "autoDestroyDisabled",
"description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.",
"type": {
"text": "boolean",
"values": [
{
"type": "boolean"
}
]
},
"default": "false",
"attribute": "auto-destroy-disabled"
},
{
"kind": "field",
"name": "capabilities",
"description": "Configures the attachment editing functionality that can be performed by the user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#capabilities)",
"type": {
"text": "AttachmentsCapabilities",
"references": [
{
"name": "AttachmentsCapabilities",
"package": "@arcgis/core",
"module": "interfaces.d.ts",
"viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#AttachmentsCapabilities",
"start": 0,
"end": 23
}
]
}
},
{
"kind": "method",
"name": "componentOnReady",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"module": "lib/lib.es5.d.ts",
"name": "Promise",
"package": "typescript",
"start": 0,
"end": 7
}
]
}
},
"description": "Create a promise that resolves once component is fully loaded.",
"signature": "(): Promise<void>",
"async": true,
"inheritedFrom": {
"name": "LitElement",
"package": "@arcgis/lumina"
},
"docsTags": [
{
"name": "example",
"text": "const arcgisAttachments = document.createElement(\"arcgis-attachments\");\ndocument.body.append(arcgisAttachments);\narcgisAttachments.componentOnReady().then(() => {\n console.log(\"arcgis-attachments is ready to go!\");\n});"
}
]
},
{
"kind": "method",
"name": "destroy",
"description": "Permanently destroy the component.",
"return": {
"type": {
"text": "Promise<void>",
"references": [
{
"name": "Promise",
"package": "typescript",
"module": "lib/lib.es5.d.ts",
"start": 0,
"end": 7
}
]
}
},
"signature": "(): Promise<void>",
"async": true
},
{
"kind": "field",