@arcgis/map-components 4.33.0-next.63 → 4.33.0-next.65

package/dist/docs/docs.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-03-30T04:52:30",
+  "timestamp": "2025-04-01T05:03:24",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.33.0-next.63",
+    "version": "4.33.0-next.65",
     "typescriptVersion": "5.6.3"
   },
   "components": [
@@ -40197,6 +40197,406 @@
       "parts": [],
       "listeners": []
     },
+    {
+      "filePath": "src/components/time-zone-label/time-zone-label.tsx",
+      "tag": "arcgis-time-zone-label",
+      "overview": "",
+      "readme": "",
+      "usage": {},
+      "docs": "TimeZoneLabel is component for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeZone) of a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\nThe component has two states, collapsed as a small button and expanded displaying the internationalized name of the Map's time zone.\nUsers can toggle between these states by clicking the component's expand/collapse button.\nBy default the component is collapsed.\n\nWhen expanding, the component will lengthen inwards when [positioned](#position) within a Map.\nThis behavior can be overridden by setting the [expandDirection](#expandDirection) property to either `\"start\"` or `\"end\"`.",
+      "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": 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": "expandDirection",
+          "type": "\"end\" | \"start\"",
+          "complexType": {
+            "original": "\"end\" | \"start\"",
+            "resolved": "\"end\" | \"start\"",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "expand-direction",
+          "reflectToAttr": true,
+          "docs": "The direction the component will expand.\n\nBy default, the component will expand inward if assigned to a View UI corner. If the component is positioned manually,\nthe component will expand towards the \"end\" which is equivalent to right in a LTR application.",
+          "docsTags": [],
+          "values": [
+            {
+              "value": "end",
+              "type": "string"
+            },
+            {
+              "value": "start",
+              "type": "string"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "expanded",
+          "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "expanded",
+          "reflectToAttr": true,
+          "docs": "The expanded state of the component.",
+          "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": "\"time-zone\"",
+          "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    noAdjustment?: string | undefined;\n}",
+          "complexType": {
+            "original": "{\n    componentLabel?: string | undefined;\n    noAdjustment?: string | undefined;\n}",
+            "resolved": "{\n    componentLabel?: string | undefined;\n    noAdjustment?: 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": "\"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": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string",
+          "complexType": {
+            "original": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string",
+            "resolved": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string",
+            "references": {
+              "HTMLArcgisLinkChartElement": {
+                "location": "local",
+                "path": "index.js",
+                "id": "notImplemented"
+              },
+              "HTMLArcgisMapElement": {
+                "location": "local",
+                "path": "index.js",
+                "id": "notImplemented"
+              },
+              "HTMLArcgisSceneElement": {
+                "location": "local",
+                "path": "index.js",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "attr": "reference-element",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "HTMLArcgisLinkChartElement"
+            },
+            {
+              "type": "HTMLArcgisMapElement"
+            },
+            {
+              "type": "HTMLArcgisSceneElement"
+            },
+            {
+              "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 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<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(): Promise<void>",
+            "parameters": [],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "componentOnReady(): Promise<void>",
+          "parameters": [],
+          "docs": "Create a promise that resolves once component is fully loaded.",
+          "docsTags": [
+            {
+              "name": "example",
+              "text": "const arcgisTimeZoneLabel = document.createElement(\"arcgis-time-zone-label\");\ndocument.body.append(arcgisTimeZoneLabel);\narcgisTimeZoneLabel.componentOnReady().then(() => {\n  console.log(\"arcgis-time-zone-label is ready to go!\");\n});"
+            },
+            {
+              "name": "inheritedFrom",
+              "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
+            }
+          ]
+        },
+        {
+          "name": "destroy",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(): Promise<void>",
+            "parameters": [],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "destroy(): Promise<void>",
+          "parameters": [],
+          "docs": "Permanently destroy the component.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "arcgisPropertyChange",
+          "detail": "{ name: \"state\"; }",
+          "bubbles": true,
+          "complexType": {
+            "original": "{ name: \"state\"; }",
+            "resolved": "{ name: \"state\"; }",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the value of a property is changed. Use this to listen to changes to properties.",
+          "docsTags": []
+        },
+        {
+          "event": "arcgisReady",
+          "detail": "undefined",
+          "bubbles": true,
+          "complexType": {
+            "original": "undefined",
+            "resolved": "undefined",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "Emitted when the component associated with a map view is is ready to be interacted with.",
+          "docsTags": []
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "listeners": []
+    },
     {
       "filePath": "src/components/track/track.tsx",
       "tag": "arcgis-track",
@@ -44207,6 +44607,221 @@
       "parts": [],
       "listeners": []
     },
+    {
+      "filePath": "src/components/video/video.tsx",
+      "tag": "arcgis-video",
+      "overview": "",
+      "readme": "",
+      "usage": {},
+      "docs": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid url or layer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.",
+      "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": "",
+          "docsTags": [],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "layer",
+          "type": "VideoLayer",
+          "complexType": {
+            "original": "VideoLayer",
+            "resolved": "VideoLayer",
+            "references": {
+              "VideoLayer": {
+                "location": "import",
+                "path": "@arcgis/core/interfaces.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "The [VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html) to display in the view.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-VideoView.html#layer)",
+          "docsTags": [],
+          "values": [],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "layerUrl",
+          "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
+          "mutable": true,
+          "attr": "layer-url",
+          "reflectToAttr": true,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "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 following conditions are met.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-VideoView.html#ready)",
+          "docsTags": [
+            {
+              "name": "readonly",
+              "text": ""
+            }
+          ],
+          "default": "false",
+          "values": [
+            {
+              "type": "boolean"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
+        {
+          "name": "view",
+          "type": "VideoView",
+          "complexType": {
+            "original": "VideoView",
+            "resolved": "VideoView",
+            "references": {
+              "VideoView": {
+                "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
+        }
+      ],
+      "methods": [
+        {
+          "name": "componentOnReady",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(): Promise<void>",
+            "parameters": [],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "componentOnReady(): Promise<void>",
+          "parameters": [],
+          "docs": "Create a promise that resolves once component is fully loaded.",
+          "docsTags": [
+            {
+              "name": "example",
+              "text": "const arcgisVideo = document.createElement(\"arcgis-video\");\ndocument.body.append(arcgisVideo);\narcgisVideo.componentOnReady().then(() => {\n  console.log(\"arcgis-video is ready to go!\");\n});"
+            },
+            {
+              "name": "inheritedFrom",
+              "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
+            }
+          ]
+        },
+        {
+          "name": "destroy",
+          "returns": {
+            "type": "Promise<void>",
+            "docs": ""
+          },
+          "complexType": {
+            "signature": "(): Promise<void>",
+            "parameters": [],
+            "return": "Promise<void>",
+            "references": {
+              "Promise": {
+                "location": "import",
+                "path": "typescript/lib/lib.es5.d.ts",
+                "id": "notImplemented"
+              }
+            }
+          },
+          "signature": "destroy(): Promise<void>",
+          "parameters": [],
+          "docs": "Permanently destroy the component.",
+          "docsTags": []
+        }
+      ],
+      "events": [
+        {
+          "event": "arcgisViewReadyChange",
+          "detail": "void",
+          "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
+        }
+      ],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "listeners": []
+    },
     {
       "filePath": "src/components/video-player/video-player.tsx",
       "tag": "arcgis-video-player",
@@ -44587,6 +45202,20 @@
           "composed": true,
           "docs": "Emitted when the component associated with a map view is is ready to be interacted with.",
           "docsTags": []
+        },
+        {
+          "event": "arcgisVideoReady",
+          "detail": "undefined",
+          "bubbles": true,
+          "complexType": {
+            "original": "undefined",
+            "resolved": "undefined",
+            "references": {}
+          },
+          "cancelable": true,
+          "composed": true,
+          "docs": "",
+          "docsTags": []
         }
       ],
       "styles": [],