{ "timestamp": "2025-11-06T23:25:12", "compiler": { "name": "@arcgis/lumina-compiler", "version": "4.34.9", "typescriptVersion": "5.8.3" }, "components": [ { "filePath": "src/components/instant-apps-app-error/instant-apps-app-error.tsx", "tag": "instant-apps-app-error", "overview": "", "readme": "", "usage": {}, "docs": "Error message UI", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [], "methods": [ { "name": "clearErrorMessage", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clearErrorMessage(): Promise", "parameters": [], "docs": "clears the error message string from the live region", "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": "```js\nconst instantAppsAppError = document.querySelector(\"instant-apps-app-error\");\ndocument.body.append(instantAppsAppError);\nawait instantAppsAppError.componentOnReady();\nconsole.log(\"instant-apps-app-error is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-app-guide/instant-apps-app-guide.tsx", "tag": "instant-apps-app-guide", "overview": "", "readme": "", "usage": {}, "docs": "The `instant-apps-app-guide` is a component containing page(s) that describe features of a tool or Instant App.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "data", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "AppGuidePage": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A collection of AppGuidePage objects that represent the content of the component", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "header", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "header", "reflectToAttr": false, "docs": "Show a header with the title of the current page", "docsTags": [], "default": "true", "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": "```js\nconst instantAppsAppGuide = document.querySelector(\"instant-apps-app-guide\");\ndocument.body.append(instantAppsAppGuide);\nawait instantAppsAppGuide.componentOnReady();\nconsole.log(\"instant-apps-app-guide is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-buffer/instant-apps-buffer.tsx", "tag": "instant-apps-buffer", "overview": "", "readme": "", "usage": {}, "docs": "Instant Apps component that provides a compound UI for rendering Graphics of buffered input geometries.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "bufferColor", "type": "ReadonlyArray | string | {\n r?: number | undefined;\n g?: number | undefined;\n b?: number | undefined;\n a?: number | undefined;\n}", "complexType": { "original": "ReadonlyArray | string | {\n r?: number | undefined;\n g?: number | undefined;\n b?: number | undefined;\n a?: number | undefined;\n}", "resolved": "ReadonlyArray | string | {\n r?: number | undefined;\n g?: number | undefined;\n b?: number | undefined;\n a?: number | undefined;\n}", "references": { "ReadonlyArray": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "buffer-color", "reflectToAttr": false, "docs": "the buffer Graphic's fill color", "docsTags": [], "default": "[0, 0, 0, 0.25] - black, semitransparent", "values": [ { "type": "ReadonlyArray" }, { "type": "string" }, { "type": "{\n r?: number | undefined;\n g?: number | undefined;\n b?: number | undefined;\n a?: number | undefined;\n}" } ], "optional": true, "required": false }, { "name": "bufferDistance", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "buffer-distance", "reflectToAttr": true, "docs": "The distance value of the rendered buffer(s). The value must be >= `bufferMinDistance` and <= `bufferMaxDistance`", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "bufferGraphicSymbol", "type": "SimpleFillSymbol", "complexType": { "original": "SimpleFillSymbol", "resolved": "SimpleFillSymbol", "references": { "SimpleFillSymbol": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "readonly", "text": "" } ], "values": [], "optional": true, "required": false }, { "name": "bufferInputStep", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "buffer-input-step", "reflectToAttr": true, "docs": "The `step` value for the buffer distance `HTMLCalciteInputNumberElement`'s `step` property", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "bufferLayer", "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 layer in which buffer Graphics will be rendered in. Will be added to the `view` property", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "bufferMaxDistance", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "buffer-max-distance", "reflectToAttr": true, "docs": "The maximum buffer distance value, must be >= `bufferMinDistance`.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "bufferMinDistance", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "buffer-min-distance", "reflectToAttr": true, "docs": "The minimum buffer distance value, must be >= `0` and <= `bufferMaxDistance`.", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "bufferOutlineColor", "type": "ReadonlyArray | string | {\n r?: number | undefined;\n g?: number | undefined;\n b?: number | undefined;\n a?: number | undefined;\n}", "complexType": { "original": "ReadonlyArray | string | {\n r?: number | undefined;\n g?: number | undefined;\n b?: number | undefined;\n a?: number | undefined;\n}", "resolved": "ReadonlyArray | string | {\n r?: number | undefined;\n g?: number | undefined;\n b?: number | undefined;\n a?: number | undefined;\n}", "references": { "ReadonlyArray": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "buffer-outline-color", "reflectToAttr": false, "docs": "the buffer Graphic's outline color", "docsTags": [], "values": [ { "type": "ReadonlyArray" }, { "type": "string" }, { "type": "{\n r?: number | undefined;\n g?: number | undefined;\n b?: number | undefined;\n a?: number | undefined;\n}" } ], "optional": true, "required": false }, { "name": "bufferOutlineWidth", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "buffer-outline-width", "reflectToAttr": false, "docs": "the buffer Graphic's outline width", "docsTags": [], "default": "0.75", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "bufferStyle", "type": "\"backward-diagonal\" | \"cross\" | \"diagonal-cross\" | \"forward-diagonal\" | \"horizontal\" | \"none\" | \"solid\" | \"vertical\"", "complexType": { "original": "\"backward-diagonal\" | \"cross\" | \"diagonal-cross\" | \"forward-diagonal\" | \"horizontal\" | \"none\" | \"solid\" | \"vertical\"", "resolved": "\"backward-diagonal\" | \"cross\" | \"diagonal-cross\" | \"forward-diagonal\" | \"horizontal\" | \"none\" | \"solid\" | \"vertical\"", "references": {} }, "mutable": true, "attr": "buffer-style", "reflectToAttr": false, "docs": "the buffer Graphic's fill style", "docsTags": [], "default": "\"solid\"", "values": [ { "value": "backward-diagonal", "type": "string" }, { "value": "cross", "type": "string" }, { "value": "diagonal-cross", "type": "string" }, { "value": "forward-diagonal", "type": "string" }, { "value": "horizontal", "type": "string" }, { "value": "none", "type": "string" }, { "value": "solid", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": true, "required": false }, { "name": "bufferUnit", "type": "\"feet\" | \"kilometers\" | \"meters\" | \"miles\" | \"us-feet\" | \"yards\"", "complexType": { "original": "\"feet\" | \"kilometers\" | \"meters\" | \"miles\" | \"us-feet\" | \"yards\"", "resolved": "\"feet\" | \"kilometers\" | \"meters\" | \"miles\" | \"us-feet\" | \"yards\"", "references": {} }, "mutable": true, "attr": "buffer-unit", "reflectToAttr": true, "docs": "the unit of the buffer distance, must be a valid `BufferDistanceUnit` type", "docsTags": [], "values": [ { "value": "feet", "type": "string" }, { "value": "kilometers", "type": "string" }, { "value": "meters", "type": "string" }, { "value": "miles", "type": "string" }, { "value": "us-feet", "type": "string" }, { "value": "yards", "type": "string" } ], "optional": true, "required": false }, { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "disabled", "reflectToAttr": true, "docs": "Whether the component's UI controls are in a disabled state and cannot be operated", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "geodesicBufferEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "geodesic-buffer-enabled", "reflectToAttr": true, "docs": "Are we rendering a [Geodesic buffer](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-geodesicBufferOperator.html), not a [Planar buffer](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-bufferOperator.html).", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "inputGraphics", "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 with one or more `Graphic`s containing geometries to be buffered by the component", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "readyToBuffer", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "a reference to the `inputGraphics` property's `MapView` or `SceneView`", "docsTags": [], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "optional": true, "required": false } ], "methods": [ { "name": "clearBufferLayer", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "clearBufferLayer(): Promise", "parameters": [], "docs": "Removes all Graphics from the `bufferLayer`", "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": "```js\nconst instantAppsBuffer = document.querySelector(\"instant-apps-buffer\");\ndocument.body.append(instantAppsBuffer);\nawait instantAppsBuffer.componentOnReady();\nconsole.log(\"instant-apps-buffer is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "setFocus", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "setFocus(): Promise", "parameters": [], "docs": "sets DOM focus on the first focusable element in the component", "docsTags": [] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-control-panel/instant-apps-control-panel.tsx", "tag": "instant-apps-control-panel", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "components", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "ControlPanelComponent": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Determine which widgets or components to display in the control panel", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A reference to the MapView or SceneView", "docsTags": [ { "name": "required" } ], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsControlPanel = document.querySelector(\"instant-apps-control-panel\");\ndocument.body.append(instantAppsControlPanel);\nawait instantAppsControlPanel.componentOnReady();\nconsole.log(\"instant-apps-control-panel is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [ { "name": "components", "docs": "A slot for all the components this control panel manages." } ], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-create/instant-apps-create.tsx", "tag": "instant-apps-create", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "content", "type": "PortalGroup | WebMap | WebScene", "complexType": { "original": "PortalGroup | WebMap | WebScene", "resolved": "PortalGroup | WebMap | WebScene", "references": { "PortalGroup": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "WebMap": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "WebScene": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Content item to create with", "docsTags": [], "values": [ { "type": "PortalGroup" }, { "type": "WebMap" }, { "type": "WebScene" } ], "optional": true, "required": false }, { "name": "mode", "type": "\"inline\" | \"popover\"", "complexType": { "original": "\"inline\" | \"popover\"", "resolved": "\"inline\" | \"popover\"", "references": {} }, "mutable": true, "attr": "mode", "reflectToAttr": true, "docs": "Renders tool as a popover with a trigger button, or inline to place in a custom container.", "docsTags": [], "default": "\"inline\"", "values": [ { "value": "inline", "type": "string" }, { "value": "popover", "type": "string" } ], "optional": true, "required": false }, { "name": "options", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "CreateOption": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "popoverIcon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "popover-icon", "reflectToAttr": false, "docs": "Update popover button icon.", "docsTags": [], "default": "\"grid\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "popoverPlacement", "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": "popover-placement", "reflectToAttr": false, "docs": "Determines where the component will be positioned relative to the `referenceElement`.", "docsTags": [], "default": "\"auto\"", "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": "popoverPositioning", "type": "\"absolute\" | \"fixed\"", "complexType": { "original": "\"absolute\" | \"fixed\"", "resolved": "\"absolute\" | \"fixed\"", "references": {} }, "mutable": true, "attr": "popover-positioning", "reflectToAttr": false, "docs": "Determines the type of positioning to use for the overlaid content. Using `\"absolute\"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `\"fixed\"` value should be used to escape an overflowing parent container, or when the reference element's position CSS property is `\"fixed\"`.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "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": "", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "showHeader", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-header", "reflectToAttr": false, "docs": "Show header with title and subtitle", "docsTags": [], "default": "true", "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": "```js\nconst instantAppsCreate = document.querySelector(\"instant-apps-create\");\ndocument.body.append(instantAppsCreate);\nawait instantAppsCreate.componentOnReady();\nconsole.log(\"instant-apps-create is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [ { "name": "--instant-apps-create-action-background", "annotation": "prop", "docs": "Popup's trigger button's background color." }, { "name": "--instant-apps-create-action-background-hover", "annotation": "prop", "docs": "Popup's trigger button's background color on hover." }, { "name": "--instant-apps-create-action-background-press", "annotation": "prop", "docs": "Popup's trigger button's background color on press." }, { "name": "--instant-apps-create-action-width", "annotation": "prop", "docs": "Popup's trigger button's width." }, { "name": "--instant-apps-create-action-height", "annotation": "prop", "docs": "Popup's trigger button's height." }, { "name": "--instant-apps-create-action-icon-color", "annotation": "prop", "docs": "Popup's trigger button's icon color." }, { "name": "--instant-apps-create-action-icon-hover-color", "annotation": "prop", "docs": "Popup's trigger button's icon color when hovered over." }, { "name": "--instant-apps-create-background", "annotation": "prop", "docs": "Create's container background color." }, { "name": "--instant-apps-create-text-color", "annotation": "prop", "docs": "Create's container text color." }, { "name": "--instant-apps-create-popover-width", "annotation": "prop", "docs": "Create's popover container width." } ], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-export/instant-apps-export.tsx", "tag": "instant-apps-export", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "allowedFileTypes", "type": "Array<\"JPG\" | \"PDF\" | \"PNG\">", "complexType": { "original": "Array<\"JPG\" | \"PDF\" | \"PNG\">", "resolved": "Array<\"JPG\" | \"PDF\" | \"PNG\">", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "File types allowed for export.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "beforeExport", "type": "() => Promise", "complexType": { "original": "() => Promise", "resolved": "() => Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Passes the initial function to run when the Export button is clicked.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "cloneExtraContent", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "clone-extra-content", "reflectToAttr": false, "docs": "When `false`, the extra content will not be cloned for the export.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "defaultFileType", "type": "\"JPG\" | \"PDF\" | \"PNG\"", "complexType": { "original": "\"JPG\" | \"PDF\" | \"PNG\"", "resolved": "\"JPG\" | \"PDF\" | \"PNG\"", "references": {} }, "mutable": true, "attr": "default-file-type", "reflectToAttr": false, "docs": "Default file type to export.", "docsTags": [], "values": [ { "value": "JPG", "type": "string" }, { "value": "PDF", "type": "string" }, { "value": "PNG", "type": "string" } ], "optional": true, "required": false }, { "name": "extraContent", "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": "Extra content that will be added below the view.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "extraContentLabel", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "extra-content-label", "reflectToAttr": false, "docs": "Custom label for `extraContent` checkbox.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headerTitle", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "header-title", "reflectToAttr": false, "docs": "Export header name, updated in input.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "includeExtraContent", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-extra-content", "reflectToAttr": false, "docs": "When `true`, `extraContent` HTML element is included in the PDF.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "includeFileFormat", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-file-format", "reflectToAttr": false, "docs": "When `true`, user has ability to select the file format to be PDF or an image.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "includeLegend", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-legend", "reflectToAttr": false, "docs": "When `true`, legend is included in the export.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "includeMap", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-map", "reflectToAttr": false, "docs": "When `true`, map is included in the export.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "includePopup", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-popup", "reflectToAttr": false, "docs": "When `true`, popup is included in the export.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "logoAltText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "logo-alt-text", "reflectToAttr": false, "docs": "Alt text for logo in export's header.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "logoImage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "logo-image", "reflectToAttr": false, "docs": "Image URL for logo in export's header.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "mapAltText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "map-alt-text", "reflectToAttr": false, "docs": "Alt text for map img.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "maskBackground", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "mask-background", "reflectToAttr": false, "docs": "Adjust the mask background color for when users are setting the map area", "docsTags": [], "default": "\"rgba(255, 51, 0, 0.1)\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "maskBorder", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "mask-border", "reflectToAttr": false, "docs": "Adjust the mask border for when users are setting the map area", "docsTags": [], "default": "\"2px dashed rgb(255, 51, 0)\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "mode", "type": "\"inline\" | \"popover\"", "complexType": { "original": "\"inline\" | \"popover\"", "resolved": "\"inline\" | \"popover\"", "references": {} }, "mutable": true, "attr": "mode", "reflectToAttr": true, "docs": "Renders tool as a popover with a trigger button, or inline to place in a custom container.", "docsTags": [], "default": "\"popover\"", "values": [ { "value": "inline", "type": "string" }, { "value": "popover", "type": "string" } ], "optional": true, "required": false }, { "name": "output", "type": "ExportOutput", "complexType": { "original": "ExportOutput", "resolved": "ExportOutput", "references": { "ExportOutput": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Output to use to set up export.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "popoverIcon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "popover-icon", "reflectToAttr": false, "docs": "Update popover button icon.", "docsTags": [], "default": "\"export\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "popoverPlacement", "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": "popover-placement", "reflectToAttr": false, "docs": "Determines where the component will be positioned relative to the `referenceElement`.", "docsTags": [], "default": "\"auto\"", "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": "popoverPositioning", "type": "\"absolute\" | \"fixed\"", "complexType": { "original": "\"absolute\" | \"fixed\"", "resolved": "\"absolute\" | \"fixed\"", "references": {} }, "mutable": true, "attr": "popover-positioning", "reflectToAttr": false, "docs": "Determines the type of positioning to use for the overlaid content. Using `\"absolute\"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `\"fixed\"` value should be used to escape an overflowing parent container, or when the reference element's position CSS property is `\"fixed\"`.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "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": "Adjusts the scale of the action button.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "showExtraContentInImg", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-extra-content-in-img", "reflectToAttr": false, "docs": "When `true` and `selectedFileType` if JPG or PNG, `extraContent` HTML element is shown to the right of the map.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showHeaderTitle", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-header-title", "reflectToAttr": false, "docs": "Show header title input in export tool.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showIncludeLegend", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-include-legend", "reflectToAttr": false, "docs": "Show include legend checkbox in export tool.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showIncludeMap", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-include-map", "reflectToAttr": false, "docs": "Show include map checkbox in export tool.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showIncludePopup", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-include-popup", "reflectToAttr": false, "docs": "Show popup checkbox in export tool.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showScaleBar", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-scale-bar", "reflectToAttr": false, "docs": "Show scale bar widget in map if view has it.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A reference to the MapView or SceneView.", "docsTags": [], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "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": "```js\nconst instantAppsExport = document.querySelector(\"instant-apps-export\");\ndocument.body.append(instantAppsExport);\nawait instantAppsExport.componentOnReady();\nconsole.log(\"instant-apps-export is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "afterExport", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits after export is complete.", "docsTags": [] }, { "event": "exportOutputUpdated", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits when the instant-apps-export's output prop is updated after the \"Export\" button is clicked.", "docsTags": [] } ], "styles": [ { "name": "--instant-apps-export-action-background", "annotation": "prop", "docs": "Popup's trigger button's background color." }, { "name": "--instant-apps-export-action-background-hover", "annotation": "prop", "docs": "Popup's trigger button's background color on hover." }, { "name": "--instant-apps-export-action-background-press", "annotation": "prop", "docs": "Popup's trigger button's background color on press." }, { "name": "--instant-apps-export-action-width", "annotation": "prop", "docs": "Popup's trigger button's width." }, { "name": "--instant-apps-export-action-height", "annotation": "prop", "docs": "Popup's trigger button's height." }, { "name": "--instant-apps-export-action-icon-color", "annotation": "prop", "docs": "Popup's trigger button's icon color." }, { "name": "--instant-apps-export-action-icon-hover-color", "annotation": "prop", "docs": "Popup's trigger button's icon color when hovered over." }, { "name": "--instant-apps-export-background", "annotation": "prop", "docs": "Export's container background color." }, { "name": "--instant-apps-export-text-color", "annotation": "prop", "docs": "Export's container text color." }, { "name": "--instant-apps-export-popover-width", "annotation": "prop", "docs": "Export's popover container width." } ], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-export-views/instant-apps-export-views.tsx", "tag": "instant-apps-export-views", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "beforeExport", "type": "() => Promise", "complexType": { "original": "() => Promise", "resolved": "() => Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Passes the initial function to run when the Export button is clicked.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "exportViews", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "ExportView": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A reference to an array of MapViews or SceneViews.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "includeHeader", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-header", "reflectToAttr": false, "docs": "When `true`, header is included in the export.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "includeLegend", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-legend", "reflectToAttr": false, "docs": "When `true`, legend is included in the export.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "includeMap", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-map", "reflectToAttr": false, "docs": "When `true`, map is included in the export.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "includePopup", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "include-popup", "reflectToAttr": false, "docs": "When `true`, popup is included in the export.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "mode", "type": "\"inline\" | \"popover\"", "complexType": { "original": "\"inline\" | \"popover\"", "resolved": "\"inline\" | \"popover\"", "references": {} }, "mutable": true, "attr": "mode", "reflectToAttr": true, "docs": "Renders tool as a popover with a trigger button, or inline to place in a custom container.", "docsTags": [], "default": "\"popover\"", "values": [ { "value": "inline", "type": "string" }, { "value": "popover", "type": "string" } ], "optional": true, "required": false }, { "name": "output", "type": "ExportOutput", "complexType": { "original": "ExportOutput", "resolved": "ExportOutput", "references": { "ExportOutput": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Output to use to set up export.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "popoverIcon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "popover-icon", "reflectToAttr": false, "docs": "Update popover button icon.", "docsTags": [], "default": "\"export\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "popoverPlacement", "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": "popover-placement", "reflectToAttr": false, "docs": "Determines where the component will be positioned relative to the `referenceElement`.", "docsTags": [], "default": "\"auto\"", "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": "popoverPositioning", "type": "\"absolute\" | \"fixed\"", "complexType": { "original": "\"absolute\" | \"fixed\"", "resolved": "\"absolute\" | \"fixed\"", "references": {} }, "mutable": true, "attr": "popover-positioning", "reflectToAttr": false, "docs": "Determines the type of positioning to use for the overlaid content. Using `\"absolute\"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `\"fixed\"` value should be used to escape an overflowing parent container, or when the reference element's position CSS property is `\"fixed\"`.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "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": "Adjusts the scale of the action button.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "showIncludeHeader", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-include-header", "reflectToAttr": false, "docs": "Show header checkbox in export tool.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showIncludeLegend", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-include-legend", "reflectToAttr": false, "docs": "Show include legend checkbox in export tool.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showIncludeMap", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-include-map", "reflectToAttr": false, "docs": "Show include map checkbox in export tool.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showIncludePopup", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-include-popup", "reflectToAttr": false, "docs": "Show popup checkbox in export tool.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showScaleBar", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-scale-bar", "reflectToAttr": false, "docs": "Show scale bar widget in map if view has it.", "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": "```js\nconst instantAppsExportViews = document.querySelector(\"instant-apps-export-views\");\ndocument.body.append(instantAppsExportViews);\nawait instantAppsExportViews.componentOnReady();\nconsole.log(\"instant-apps-export-views is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "exportOutputUpdated", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits when the instant-apps-export's output prop is updated after the \"Export\" button is clicked.", "docsTags": [] } ], "styles": [ { "name": "--instant-apps-export-action-background", "annotation": "prop", "docs": "Popup's trigger button's background color." }, { "name": "--instant-apps-export-action-background-hover", "annotation": "prop", "docs": "Popup's trigger button's background color on hover." }, { "name": "--instant-apps-export-action-background-press", "annotation": "prop", "docs": "Popup's trigger button's background color on press." }, { "name": "--instant-apps-export-action-width", "annotation": "prop", "docs": "Popup's trigger button's width." }, { "name": "--instant-apps-export-action-height", "annotation": "prop", "docs": "Popup's trigger button's height." }, { "name": "--instant-apps-export-action-icon-color", "annotation": "prop", "docs": "Popup's trigger button's icon color." }, { "name": "--instant-apps-export-action-icon-hover-color", "annotation": "prop", "docs": "Popup's trigger button's icon color when hovered over." }, { "name": "--instant-apps-export-background", "annotation": "prop", "docs": "Export's container background color." }, { "name": "--instant-apps-export-text-color", "annotation": "prop", "docs": "Export's container text color." }, { "name": "--instant-apps-export-popover-width", "annotation": "prop", "docs": "Export's popover container width." } ], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-filter-list/instant-apps-filter-list.tsx", "tag": "instant-apps-filter-list", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "autoUpdateUrl", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "auto-update-url", "reflectToAttr": false, "docs": "Auto update URL with filter params.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "closeBtn", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "close-btn", "reflectToAttr": false, "docs": "Display close button in footer.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "closeBtnOnClick", "type": "((() => void))", "complexType": { "original": "((() => void))", "resolved": "((() => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Close button onClick function.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "closeBtnText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "close-btn-text", "reflectToAttr": false, "docs": "Close button text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "comboboxOverlayPositioning", "type": "\"absolute\" | \"fixed\"", "complexType": { "original": "\"absolute\" | \"fixed\"", "resolved": "\"absolute\" | \"fixed\"", "references": {} }, "mutable": true, "attr": "combobox-overlay-positioning", "reflectToAttr": false, "docs": "Determines the type of positioning to use for the overlaid content.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "type": "string" } ], "optional": true, "required": false }, { "name": "extentSelector", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "extent-selector", "reflectToAttr": false, "docs": "Turn on the ability to filter by extent.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "extentSelectorConfig", "type": "ExtentSelector", "complexType": { "original": "ExtentSelector", "resolved": "ExtentSelector", "references": { "ExtentSelector": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Limits filtering options based on the view's extent geometry.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "filterCount", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "filter-count", "reflectToAttr": false, "docs": "Number of active filters", "docsTags": [], "default": "0", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "layerExpressions", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "LayerExpression": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Use this to create filters that update a layer's definitionExpression.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "openFilters", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "open-filters", "reflectToAttr": false, "docs": "When `true`, the layer filter block is expanded.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "resetBtn", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "reset-btn", "reflectToAttr": false, "docs": "Display reset button.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "resetFiltersOnDisconnect", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "reset-filters-on-disconnect", "reflectToAttr": false, "docs": "When false filters will not be reset when the component is disconnected from the DOM", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "urlParams", "type": "URLSearchParams", "complexType": { "original": "URLSearchParams", "resolved": "URLSearchParams", "references": { "URLSearchParams": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "URL params set by using filters.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A reference to the MapView or SceneView.", "docsTags": [ { "name": "required" } ], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "optional": false, "required": true }, { "name": "zoomBtn", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "zoom-btn", "reflectToAttr": false, "docs": "Display zoom button.", "docsTags": [], "default": "true", "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": "```js\nconst instantAppsFilterList = document.querySelector(\"instant-apps-filter-list\");\ndocument.body.append(instantAppsFilterList);\nawait instantAppsFilterList.componentOnReady();\nconsole.log(\"instant-apps-filter-list is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "forceReset", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "forceReset(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "getCurrentLayerExpressions", "returns": { "type": "Promise | undefined>", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise | undefined>", "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" }, "LayerExpression": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "getCurrentLayerExpressions(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "getFilterInitState", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FilterInitState": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "getFilterInitState(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "handleUpdatingT9nData", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(t9nLayerExpressions: LayerExpression[]): Promise", "parameters": [ { "name": "t9nLayerExpressions", "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" }, "LayerExpression": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "handleUpdatingT9nData(t9nLayerExpressions: LayerExpression[]): Promise", "parameters": [ { "name": "t9nLayerExpressions", "type": "Array", "docs": "" } ], "docs": "", "docsTags": [] }, { "name": "updateInitDefExpressions", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(filterInitState: FilterInitState): Promise", "parameters": [ { "name": "filterInitState", "type": "FilterInitState", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "FilterInitState": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "updateInitDefExpressions(filterInitState: FilterInitState): Promise", "parameters": [ { "name": "filterInitState", "type": "FilterInitState", "docs": "" } ], "docs": "", "docsTags": [] } ], "events": [ { "event": "filterListReset", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits when the reset button is pushed.", "docsTags": [] }, { "event": "filterUpdate", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits when the filter is updated.", "docsTags": [] } ], "styles": [], "slots": [ { "name": "filter-header-content", "docs": "A slot for adding custom content to the header." }, { "name": "filter-header-actions-end", "docs": "A slot for adding actions or content to the end side of the header." } ], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-header/instant-apps-header.tsx", "tag": "instant-apps-header", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "backgroundColor", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "background-color", "reflectToAttr": false, "docs": "Background color to display in header - accepts a hexadecimal value i.e. `#000000`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "customHeaderCss", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "custom-header-css", "reflectToAttr": false, "docs": "CSS styles to be used in conjunction with `custom-header-html`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "customHeaderHtml", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "custom-header-html", "reflectToAttr": false, "docs": "HTML code for custom headers.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "fontFamily", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "font-family", "reflectToAttr": true, "docs": "Font family to use for text", "docsTags": [], "default": "\"var(--calcite-sans-family);\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "headerAlignment", "type": "\"center\" | \"left\" | \"right\"", "complexType": { "original": "\"center\" | \"left\" | \"right\"", "resolved": "\"center\" | \"left\" | \"right\"", "references": {} }, "mutable": true, "attr": "header-alignment", "reflectToAttr": false, "docs": "Change alignment of header.", "docsTags": [], "default": "\"left\"", "values": [ { "value": "center", "type": "string" }, { "value": "left", "type": "string" }, { "value": "right", "type": "string" } ], "optional": true, "required": false }, { "name": "infoButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "info-button", "reflectToAttr": true, "docs": "Display info button at the end of the title.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "infoIsOpen", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "info-is-open", "reflectToAttr": true, "docs": "Keeps track of the info 'open' state", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "infoTitleText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "info-title-text", "reflectToAttr": false, "docs": "Hover text for info button tooltip", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "logoImage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "logo-image", "reflectToAttr": false, "docs": "Image URL for logo. Displays at the start of the header.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "logoImageAltText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "logo-image-alt-text", "reflectToAttr": false, "docs": "Alternate text for header logo.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "logoLink", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "logo-link", "reflectToAttr": false, "docs": "Logo URL to link out to another page.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "logoScale", "type": "\"l\" | \"m\" | \"s\"", "complexType": { "original": "\"l\" | \"m\" | \"s\"", "resolved": "\"l\" | \"m\" | \"s\"", "references": {} }, "mutable": true, "attr": "logo-scale", "reflectToAttr": true, "docs": "Adjusts scale of logo image.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "mobileWidthBreakpoint", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "mobile-width-breakpoint", "reflectToAttr": false, "docs": "Mobile breakpoint value in pixels(px).", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "textColor", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "text-color", "reflectToAttr": false, "docs": "Text color to display in header - accepts a hexadecimal value i.e. `#FFFFFF`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "titleText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "title-text", "reflectToAttr": false, "docs": "Main text to display in header.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "titleTextLink", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "title-text-link", "reflectToAttr": false, "docs": "Url to link out to from title text", "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": "```js\nconst instantAppsHeader = document.querySelector(\"instant-apps-header\");\ndocument.body.append(instantAppsHeader);\nawait instantAppsHeader.componentOnReady();\nconsole.log(\"instant-apps-header is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "toggleInfo", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "toggleInfo(): Promise", "parameters": [], "docs": "", "docsTags": [] } ], "events": [ { "event": "infoIsOpenChanged", "detail": "boolean", "bubbles": true, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "cancelable": false, "composed": true, "docs": "Fires when the info button is clicked.", "docsTags": [] } ], "styles": [ { "name": "--instant-apps-header-height", "annotation": "prop", "docs": "Height for header. Default: auto;" }, { "name": "--instant-apps-header-min-height", "annotation": "prop", "docs": "Minimum height for header. Default: 50px;" }, { "name": "--instant-apps-header-title-text-link-decoration", "annotation": "prop", "docs": "Text decoration for hyperlinks for `titleTextLink`. Default value is 'underline'." }, { "name": "--instant-apps-header-height--logo-scale--s", "annotation": "prop", "docs": "Header height when logo scale is set to 's'. Default value is 55px." }, { "name": "--instant-apps-header-logo-width--logo-scale--s", "annotation": "prop", "docs": "Logo width when logo scale is set to 's'. Default value: 35px." }, { "name": "--instant-apps-header-logo-height--logo-scale--s", "annotation": "prop", "docs": "Logo height when logo scale is set to 's'. Default value: 35px." }, { "name": "--instant-apps-header-height--logo-scale--m", "annotation": "prop", "docs": "Header height when logo scale is set to 'm'. Default value is 70px." }, { "name": "--instant-apps-header-logo-width--logo-scale--m", "annotation": "prop", "docs": "Logo width when logo scale is set to 'm'. Default value: 50px." }, { "name": "--instant-apps-header-logo-height--logo-scale--m", "annotation": "prop", "docs": "Logo height when logo scale is set to 'm'. Default value: 50px." }, { "name": "--instant-apps-header-height--logo-scale--l", "annotation": "prop", "docs": "Header height when logo scale is set to 'l'. Default value is 80px." }, { "name": "--instant-apps-header-logo-width--logo-scale--l", "annotation": "prop", "docs": "Logo width when logo scale is set to 'l'. Default value: 60px." }, { "name": "--instant-apps-header-logo-height--logo-scale--l", "annotation": "prop", "docs": "Logo height when logo scale is set to 'l'. Default value: 60px." }, { "name": "--instant-apps-header-actions-end-height", "annotation": "prop", "docs": "Height for actions-end-container. Default: auto;" } ], "slots": [ { "name": "actions-end", "docs": "Used to slot an action at the end of the header i.e. `calcite-action`, `instant-apps-social-share`" } ], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend.tsx", "tag": "instant-apps-interactive-legend", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "compact", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "compact", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "featureCount", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "feature-count", "reflectToAttr": false, "docs": "Display the individual counts for categories and total counts for layers in the legend", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "filterMode", "type": "FilterMode", "complexType": { "original": "FilterMode", "resolved": "FilterMode", "references": { "FilterMode": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Use effects to differentiate between features that are included and excluded from legend filter results", "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": "Reference to Map View", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "zoomTo", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "zoom-to", "reflectToAttr": false, "docs": "Displays ‘Zoom to’ button, updates the extent of the view based on the results from the legend", "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": "```js\nconst instantAppsInteractiveLegend = document.querySelector(\"instant-apps-interactive-legend\");\ndocument.body.append(instantAppsInteractiveLegend);\nawait instantAppsInteractiveLegend.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend-classic/instant-apps-interactive-legend-classic.tsx", "tag": "instant-apps-interactive-legend-classic", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "featureCount", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "feature-count", "reflectToAttr": false, "docs": "Display individual counts and total counts for legend infos.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "filterMode", "type": "FilterMode", "complexType": { "original": "FilterMode", "resolved": "FilterMode", "references": { "FilterMode": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Filter mode to use when filtering features.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "legendvm", "type": "LegendViewModel", "complexType": { "original": "LegendViewModel", "resolved": "LegendViewModel", "references": { "LegendViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Legend View model from the 4.x ArcGIS API for JavaScript", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "messages", "type": "{\n [x: string]: string;\n}", "complexType": { "original": "{\n [x: string]: string;\n}", "resolved": "{\n [x: string]: string;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "zoomTo", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "zoom-to", "reflectToAttr": false, "docs": "Displays 'Zoom To' button - updates the extent of the view based on the selected legend infos.", "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": "```js\nconst instantAppsInteractiveLegendClassic = document.querySelector(\"instant-apps-interactive-legend-classic\");\ndocument.body.append(instantAppsInteractiveLegendClassic);\nawait instantAppsInteractiveLegendClassic.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend-classic is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend-count/instant-apps-interactive-legend-count.tsx", "tag": "instant-apps-interactive-legend-count", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeLayerInfo", "type": "ActiveLayerInfo", "complexType": { "original": "ActiveLayerInfo", "resolved": "ActiveLayerInfo", "references": { "ActiveLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "categoryId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "category-id", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "infoIndex", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "info-index", "reflectToAttr": false, "docs": "", "docsTags": [], "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "legendElement", "type": "ColorRampElement | HeatmapRampElement | OpacityRampElement | PieChartRampElement | RelationshipRampElement | SizeRampElement | StretchRampElement | SymbolTableElement | UnivariateColorSizeRampElement", "complexType": { "original": "ColorRampElement | HeatmapRampElement | OpacityRampElement | PieChartRampElement | RelationshipRampElement | SizeRampElement | StretchRampElement | SymbolTableElement | UnivariateColorSizeRampElement", "resolved": "ColorRampElement | HeatmapRampElement | OpacityRampElement | PieChartRampElement | RelationshipRampElement | SizeRampElement | StretchRampElement | SymbolTableElement | UnivariateColorSizeRampElement", "references": { "ColorRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HeatmapRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "OpacityRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "PieChartRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "RelationshipRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SizeRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "StretchRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SymbolTableElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "UnivariateColorSizeRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "values": [ { "type": "ColorRampElement" }, { "type": "HeatmapRampElement" }, { "type": "OpacityRampElement" }, { "type": "PieChartRampElement" }, { "type": "RelationshipRampElement" }, { "type": "SizeRampElement" }, { "type": "StretchRampElement" }, { "type": "SymbolTableElement" }, { "type": "UnivariateColorSizeRampElement" } ], "optional": true, "required": false }, { "name": "legendvm", "type": "LegendViewModel", "complexType": { "original": "LegendViewModel", "resolved": "LegendViewModel", "references": { "LegendViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "selected", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "selected", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "showTotal", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-total", "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": "```js\nconst instantAppsInteractiveLegendCount = document.querySelector(\"instant-apps-interactive-legend-count\");\ndocument.body.append(instantAppsInteractiveLegendCount);\nawait instantAppsInteractiveLegendCount.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend-count is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend-group-legend-element/instant-apps-interactive-legend-group-legend-element.tsx", "tag": "instant-apps-interactive-legend-group-legend-element", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeLayerInfo", "type": "ActiveLayerInfo", "complexType": { "original": "ActiveLayerInfo", "resolved": "ActiveLayerInfo", "references": { "ActiveLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "featureCount", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "feature-count", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": true }, { "name": "isChild", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-child", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "legendvm", "type": "LegendViewModel", "complexType": { "original": "LegendViewModel", "resolved": "LegendViewModel", "references": { "LegendViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true } ], "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": "```js\nconst instantAppsInteractiveLegendGroupLegendElement = document.querySelector(\"instant-apps-interactive-legend-group-legend-element\");\ndocument.body.append(instantAppsInteractiveLegendGroupLegendElement);\nawait instantAppsInteractiveLegendGroupLegendElement.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend-group-legend-element is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend-group-legend-element-caption/instant-apps-interactive-legend-group-legend-element-caption.tsx", "tag": "instant-apps-interactive-legend-group-legend-element-caption", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeLayerInfo", "type": "ActiveLayerInfo", "complexType": { "original": "ActiveLayerInfo", "resolved": "ActiveLayerInfo", "references": { "ActiveLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "expanded", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "expanded", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "featureCount", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "feature-count", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": true }, { "name": "isChild", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-child", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "legendvm", "type": "LegendViewModel", "complexType": { "original": "LegendViewModel", "resolved": "LegendViewModel", "references": { "LegendViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true } ], "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": "```js\nconst instantAppsInteractiveLegendGroupLegendElementCaption = document.querySelector(\"instant-apps-interactive-legend-group-legend-element-caption\");\ndocument.body.append(instantAppsInteractiveLegendGroupLegendElementCaption);\nawait instantAppsInteractiveLegendGroupLegendElementCaption.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend-group-legend-element-caption is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "groupLayerCaptionElementExpandUpdated", "detail": "boolean", "bubbles": true, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend-layer-element/instant-apps-interactive-legend-layer-element.tsx", "tag": "instant-apps-interactive-legend-layer-element", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeLayerInfo", "type": "ActiveLayerInfo", "complexType": { "original": "ActiveLayerInfo", "resolved": "ActiveLayerInfo", "references": { "ActiveLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "featureCount", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "feature-count", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": true }, { "name": "isChild", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-child", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "legendvm", "type": "LegendViewModel", "complexType": { "original": "LegendViewModel", "resolved": "LegendViewModel", "references": { "LegendViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true } ], "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": "```js\nconst instantAppsInteractiveLegendLayerElement = document.querySelector(\"instant-apps-interactive-legend-layer-element\");\ndocument.body.append(instantAppsInteractiveLegendLayerElement);\nawait instantAppsInteractiveLegendLayerElement.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend-layer-element is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend-layer-element-caption/instant-apps-interactive-legend-layer-element-caption.tsx", "tag": "instant-apps-interactive-legend-layer-element-caption", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeLayerInfo", "type": "ActiveLayerInfo", "complexType": { "original": "ActiveLayerInfo", "resolved": "ActiveLayerInfo", "references": { "ActiveLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "expanded", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "expanded", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "featureCount", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "feature-count", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "isChild", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-child", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "legendvm", "type": "LegendViewModel", "complexType": { "original": "LegendViewModel", "resolved": "LegendViewModel", "references": { "LegendViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true } ], "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": "```js\nconst instantAppsInteractiveLegendLayerElementCaption = document.querySelector(\"instant-apps-interactive-legend-layer-element-caption\");\ndocument.body.append(instantAppsInteractiveLegendLayerElementCaption);\nawait instantAppsInteractiveLegendLayerElementCaption.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend-layer-element-caption is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "layerCaptionElementExpandUpdated", "detail": "boolean", "bubbles": true, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend-legend-element/instant-apps-interactive-legend-legend-element.tsx", "tag": "instant-apps-interactive-legend-legend-element", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeLayerInfo", "type": "ActiveLayerInfo", "complexType": { "original": "ActiveLayerInfo", "resolved": "ActiveLayerInfo", "references": { "ActiveLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "isChild", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-child", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "isColorRamp", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-color-ramp", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": true }, { "name": "isInteractive", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-interactive", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "isRelationshipRamp", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-relationship-ramp", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": true }, { "name": "isSizeRamp", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-size-ramp", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": true }, { "name": "legendElement", "type": "ColorRampElement | HeatmapRampElement | OpacityRampElement | PieChartRampElement | RelationshipRampElement | SizeRampElement | StretchRampElement | SymbolTableElement | UnivariateColorSizeRampElement", "complexType": { "original": "ColorRampElement | HeatmapRampElement | OpacityRampElement | PieChartRampElement | RelationshipRampElement | SizeRampElement | StretchRampElement | SymbolTableElement | UnivariateColorSizeRampElement", "resolved": "ColorRampElement | HeatmapRampElement | OpacityRampElement | PieChartRampElement | RelationshipRampElement | SizeRampElement | StretchRampElement | SymbolTableElement | UnivariateColorSizeRampElement", "references": { "ColorRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HeatmapRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "OpacityRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "PieChartRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "RelationshipRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SizeRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "StretchRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SymbolTableElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "UnivariateColorSizeRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "ColorRampElement" }, { "type": "HeatmapRampElement" }, { "type": "OpacityRampElement" }, { "type": "PieChartRampElement" }, { "type": "RelationshipRampElement" }, { "type": "SizeRampElement" }, { "type": "StretchRampElement" }, { "type": "SymbolTableElement" }, { "type": "UnivariateColorSizeRampElement" } ], "optional": false, "required": true }, { "name": "legendElementIndex", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "legend-element-index", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "number" } ], "optional": false, "required": true }, { "name": "legendvm", "type": "LegendViewModel", "complexType": { "original": "LegendViewModel", "resolved": "LegendViewModel", "references": { "LegendViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "titleText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "title-text", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "zoomTo", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "zoom-to", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsInteractiveLegendLegendElement = document.querySelector(\"instant-apps-interactive-legend-legend-element\");\ndocument.body.append(instantAppsInteractiveLegendLegendElement);\nawait instantAppsInteractiveLegendLegendElement.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend-legend-element is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend-legend-element-caption/instant-apps-interactive-legend-legend-element-caption.tsx", "tag": "instant-apps-interactive-legend-legend-element-caption", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeLayerInfo", "type": "ActiveLayerInfo", "complexType": { "original": "ActiveLayerInfo", "resolved": "ActiveLayerInfo", "references": { "ActiveLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "expanded", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "expanded", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "isInteractive", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-interactive", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": true }, { "name": "layer", "type": "FeatureLayer", "complexType": { "original": "FeatureLayer", "resolved": "FeatureLayer", "references": { "FeatureLayer": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "legendElement", "type": "ColorRampElement | HeatmapRampElement | OpacityRampElement | PieChartRampElement | RelationshipRampElement | SizeRampElement | StretchRampElement | SymbolTableElement | UnivariateColorSizeRampElement", "complexType": { "original": "ColorRampElement | HeatmapRampElement | OpacityRampElement | PieChartRampElement | RelationshipRampElement | SizeRampElement | StretchRampElement | SymbolTableElement | UnivariateColorSizeRampElement", "resolved": "ColorRampElement | HeatmapRampElement | OpacityRampElement | PieChartRampElement | RelationshipRampElement | SizeRampElement | StretchRampElement | SymbolTableElement | UnivariateColorSizeRampElement", "references": { "ColorRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "HeatmapRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "OpacityRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "PieChartRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "RelationshipRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SizeRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "StretchRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SymbolTableElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "UnivariateColorSizeRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "ColorRampElement" }, { "type": "HeatmapRampElement" }, { "type": "OpacityRampElement" }, { "type": "PieChartRampElement" }, { "type": "RelationshipRampElement" }, { "type": "SizeRampElement" }, { "type": "StretchRampElement" }, { "type": "SymbolTableElement" }, { "type": "UnivariateColorSizeRampElement" } ], "optional": false, "required": true }, { "name": "legendElementIndex", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "legend-element-index", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "number" } ], "optional": false, "required": true }, { "name": "legendvm", "type": "LegendViewModel", "complexType": { "original": "LegendViewModel", "resolved": "LegendViewModel", "references": { "LegendViewModel": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "titleText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "title-text", "reflectToAttr": false, "docs": "", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "zoomTo", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "zoom-to", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsInteractiveLegendLegendElementCaption = document.querySelector(\"instant-apps-interactive-legend-legend-element-caption\");\ndocument.body.append(instantAppsInteractiveLegendLegendElementCaption);\nawait instantAppsInteractiveLegendLegendElementCaption.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend-legend-element-caption is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "legendLayerExpandUpdated", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "showAllSelected", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-interactive-legend/instant-apps-interactive-legend-relationship/instant-apps-interactive-legend-relationship.tsx", "tag": "instant-apps-interactive-legend-relationship", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeLayerInfo", "type": "ActiveLayerInfo", "complexType": { "original": "ActiveLayerInfo", "resolved": "ActiveLayerInfo", "references": { "ActiveLayerInfo": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "filterMode", "type": "FilterMode", "complexType": { "original": "FilterMode", "resolved": "FilterMode", "references": { "FilterMode": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "legendElement", "type": "RelationshipRampElement", "complexType": { "original": "RelationshipRampElement", "resolved": "RelationshipRampElement", "references": { "RelationshipRampElement": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true } ], "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": "```js\nconst instantAppsInteractiveLegendRelationship = document.querySelector(\"instant-apps-interactive-legend-relationship\");\ndocument.body.append(instantAppsInteractiveLegendRelationship);\nawait instantAppsInteractiveLegendRelationship.componentOnReady();\nconsole.log(\"instant-apps-interactive-legend-relationship is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-keyboard-shortcuts/instant-apps-keyboard-shortcuts.tsx", "tag": "instant-apps-keyboard-shortcuts", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A reference to the MapView or SceneView", "docsTags": [ { "name": "required" } ], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsKeyboardShortcuts = document.querySelector(\"instant-apps-keyboard-shortcuts\");\ndocument.body.append(instantAppsKeyboardShortcuts);\nawait instantAppsKeyboardShortcuts.componentOnReady();\nconsole.log(\"instant-apps-keyboard-shortcuts is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-landing-page/instant-apps-landing-page.tsx", "tag": "instant-apps-landing-page", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "alignment", "type": "AlignmentPositions", "complexType": { "original": "AlignmentPositions", "resolved": "AlignmentPositions", "references": { "AlignmentPositions": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Controls the positioning of the text and image content. This accepts an array containing two values. Possible values for HorizontalAlignment: 'left', 'right', 'center'. Possible values for VeritcalAlignment: 'top', 'middle', 'bottom'.", "docsTags": [], "default": "\"center\"", "values": [], "optional": true, "required": false }, { "name": "backgroundImageSrc", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "background-image-src", "reflectToAttr": false, "docs": "Displays a background image via URL", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "descriptionText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "description-text", "reflectToAttr": false, "docs": "Description text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "disableTransition", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "disable-transition", "reflectToAttr": false, "docs": "Controls whether to enable/disable the transition animation the occurs when dismissing the landing page.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "enableSignIn", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "enable-sign-in", "reflectToAttr": false, "docs": "Add sign in functionality. Requires portal and oauthappid props.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "entryButtonScale", "type": "\"l\" | \"m\" | \"s\"", "complexType": { "original": "\"l\" | \"m\" | \"s\"", "resolved": "\"l\" | \"m\" | \"s\"", "references": {} }, "mutable": true, "attr": "entry-button-scale", "reflectToAttr": false, "docs": "Scale of the entry button.", "docsTags": [], "default": "\"l\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "entryButtonText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "entry-button-text", "reflectToAttr": false, "docs": "Button text which closes/dismisses the landing page.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "fontFamily", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "font-family", "reflectToAttr": true, "docs": "Font family to use for text", "docsTags": [], "default": "\"var(--calcite-sans-family);\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "iconImage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "icon-image", "reflectToAttr": false, "docs": "Image/graphic that is positioned near the text content.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "iconImageAltText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "icon-image-alt-text", "reflectToAttr": false, "docs": "Alternate text for `iconImage`.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "iconImageScale", "type": "\"l\" | \"m\" | \"s\"", "complexType": { "original": "\"l\" | \"m\" | \"s\"", "resolved": "\"l\" | \"m\" | \"s\"", "references": {} }, "mutable": true, "attr": "icon-image-scale", "reflectToAttr": false, "docs": "Scale of icon image/graphic.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "oauthappid", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "oauthappid", "reflectToAttr": false, "docs": "The registered application id, used to setup sign in capabilities.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "open", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "open", "reflectToAttr": false, "docs": "Controls the open/close state of the landing page.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "portal", "type": "IPortal", "complexType": { "original": "IPortal", "resolved": "IPortal", "references": { "IPortal": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The apps Portal, used to setup sign in capabilities.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "subtitleText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "subtitle-text", "reflectToAttr": false, "docs": "Subtitle text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "titleText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "title-text", "reflectToAttr": false, "docs": "Title text.", "docsTags": [ { "name": "required" } ], "values": [ { "type": "string" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsLandingPage = document.querySelector(\"instant-apps-landing-page\");\ndocument.body.append(instantAppsLandingPage);\nawait instantAppsLandingPage.componentOnReady();\nconsole.log(\"instant-apps-landing-page is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "landingPageClose", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits when the landing page is closed.", "docsTags": [] }, { "event": "landingPageOpen", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits when the landing page is opened.", "docsTags": [] } ], "styles": [ { "name": "--instant-apps-landing-page-background-color", "annotation": "prop", "docs": "Brand color of landing page that affects the background (if a backgound image is not set) and entry button colors" }, { "name": "--instant-apps-landing-page-text-color", "annotation": "prop", "docs": "Text color of landing page." }, { "name": "--instant-apps-landing-page-entry-button-color", "annotation": "prop", "docs": "Brand color of the entry button." }, { "name": "--instant-apps-landing-page-title-text-font-size", "annotation": "prop", "docs": "Font size of title text." }, { "name": "--instant-apps-landing-page-subtitle-text-font-size", "annotation": "prop", "docs": "Font size of subtitle text." }, { "name": "--instant-apps-landing-page-description-text-font-size", "annotation": "prop", "docs": "Font size of description text." }, { "name": "--instant-apps-landing-page-icon-image-scale--s", "annotation": "prop", "docs": "Icon image width when scale is set to 's'. Default value is 100px." }, { "name": "--instant-apps-landing-page-icon-image-scale--m", "annotation": "prop", "docs": "Icon image width when scale is set to 'm'. Default value is 250px." }, { "name": "--instant-apps-landing-page-icon-image-scale--l", "annotation": "prop", "docs": "Icon image width when scale is set to 'l'. Default value is 500px." }, { "name": "--instant-apps-landing-page-entry-button-margin", "annotation": "prop", "docs": "Option to provide spacing in case a secondary action is added to the landing page." } ], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-language-switcher/instant-apps-language-switcher.tsx", "tag": "instant-apps-language-switcher", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "calciteDropdownOverlayPositioning", "type": "\"absolute\" | \"fixed\"", "complexType": { "original": "\"absolute\" | \"fixed\"", "resolved": "\"absolute\" | \"fixed\"", "references": {} }, "mutable": true, "attr": "calcite-dropdown-overlay-positioning", "reflectToAttr": false, "docs": "Determines the type of positioning to use for the overlaid content. Using \"absolute\" will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. \"fixed\" should be used to escape an overflowing parent container, or when the reference element's position CSS property is \"fixed\".", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "type": "string" } ], "optional": true, "required": false }, { "name": "defaultLocale", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "default-locale", "reflectToAttr": false, "docs": "Defines the default language of the language switcher dropdown. Set internally if not defined.", "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 to display.", "docsTags": [], "default": "\"language\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "locales", "type": "Array<{\n locale: string;\n data?: Record | undefined;\n webmap?: string | undefined;\n}>", "complexType": { "original": "Array<{\n locale: string;\n data?: Record | undefined;\n webmap?: string | undefined;\n}>", "resolved": "Array<{\n locale: string;\n data?: Record | undefined;\n webmap?: string | undefined;\n}>", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Data used to populate language switcher dropdown.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "portalItem", "type": "PortalItem", "complexType": { "original": "PortalItem", "resolved": "PortalItem", "references": { "PortalItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Instant App portal item - used to fetch it's associated portal item resource. The portal item resource will contain the user defined translated strings.", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "selectedLanguage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "selected-language", "reflectToAttr": false, "docs": "The currently selected language.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Reference to map view to switch web maps if present in locales.", "docsTags": [], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "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": "```js\nconst instantAppsLanguageSwitcher = document.querySelector(\"instant-apps-language-switcher\");\ndocument.body.append(instantAppsLanguageSwitcher);\nawait instantAppsLanguageSwitcher.componentOnReady();\nconsole.log(\"instant-apps-language-switcher is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "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": "Refreshes the component by fetching the latest translation data from the portal item resource.", "docsTags": [] } ], "events": [ { "event": "selectedLanguageUpdated", "detail": "{\n locale: string;\n data?: Record | null | undefined;\n}", "bubbles": true, "complexType": { "original": "{\n locale: string;\n data?: Record | null | undefined;\n}", "resolved": "{\n locale: string;\n data?: Record | null | undefined;\n}", "references": {} }, "cancelable": true, "composed": true, "docs": "Fires when a language is selected from the dropdown. This event will emit an object containing the information on the selected language and a flat object of unique identifiers and their associated values.", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-language-translator/instant-apps-language-translator.tsx", "tag": "instant-apps-language-translator", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "appSettings", "type": "AppSettings", "complexType": { "original": "AppSettings", "resolved": "AppSettings", "references": { "AppSettings": { "location": "local", "path": "dist/components/instant-apps-language-translator/support/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Object used to render each `instant-apps-translator-item`, containing either a `calcite-input` or rich text editor (handles HTML formatting); and, the languages to translate within the dropdown.", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "locales", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "LocaleItem": { "location": "local", "path": "dist/components/instant-apps-language-translator/support/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Specified languages that the user-defined strings will be translated in.", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "open", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "open", "reflectToAttr": false, "docs": "Controls the open/close state of the dialog.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "portalItem", "type": "PortalItem", "complexType": { "original": "PortalItem", "resolved": "PortalItem", "references": { "PortalItem": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Instant App portal item - used to fetch it's associated portal item resource. The portal item resource will contain the user-defined translated strings.", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "translatedLocaleInputOnChangeCallback", "type": "(fieldName: string, value: string, locale: string, resource: PortalItemResource) => Promise", "complexType": { "original": "(fieldName: string, value: string, locale: string, resource: PortalItemResource) => Promise", "resolved": "(fieldName: string, value: string, locale: string, resource: PortalItemResource) => Promise", "references": { "PortalItemResource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Function that is called when the value in a translated locale's input has changed. This function will have 4 arguments - fieldName, value, locale, and resource - and will return a promise. The callback function can be used to construct the data of key-value pairs that will be written to the portal item resource.", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "userLocaleInputOnChangeCallback", "type": "(fieldName: string, value: string) => Promise", "complexType": { "original": "(fieldName: string, value: string) => Promise", "resolved": "(fieldName: string, value: string) => Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Function to be called when the value in a user locale input has changed. This function will have 2 arguments - fieldName and value - and will return a promise.", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true } ], "methods": [ { "name": "batchWriteToPortalItemResource", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(data: PortalItemResourceT9n): Promise", "parameters": [ { "name": "data", "type": "PortalItemResourceT9n", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "PortalItemResourceT9n": { "location": "local", "path": "dist/components/instant-apps-language-translator/support/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "batchWriteToPortalItemResource(data: PortalItemResourceT9n): Promise", "parameters": [ { "name": "data", "type": "PortalItemResourceT9n", "docs": "" } ], "docs": "Batch write data to associated portal item resource.", "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": "```js\nconst instantAppsLanguageTranslator = document.querySelector(\"instant-apps-language-translator\");\ndocument.body.append(instantAppsLanguageTranslator);\nawait instantAppsLanguageTranslator.componentOnReady();\nconsole.log(\"instant-apps-language-translator is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "getPortalItemResource", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise<__esri.PortalItemResource | null>", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "PortalItemResource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "getPortalItemResource(): Promise<__esri.PortalItemResource | null>", "parameters": [], "docs": "Gets portal item resource containing the translation data.", "docsTags": [] }, { "name": "getTranslationData", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "PortalItemResourceT9n": { "location": "local", "path": "dist/components/instant-apps-language-translator/support/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "getTranslationData(): Promise", "parameters": [], "docs": "Gets translation data for all languages and fields.", "docsTags": [] }, { "name": "setTranslationData", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(data: PortalItemResourceT9n): Promise", "parameters": [ { "name": "data", "type": "PortalItemResourceT9n", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "PortalItemResourceT9n": { "location": "local", "path": "dist/components/instant-apps-language-translator/support/interfaces.d.ts", "id": "notImplemented" } } }, "signature": "setTranslationData(data: PortalItemResourceT9n): Promise", "parameters": [ { "name": "data", "type": "PortalItemResourceT9n", "docs": "" } ], "docs": "Updates translation data for all languages and fields.", "docsTags": [] } ], "events": [ { "event": "translatorDataUpdated", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Fires when a translation input's value has changed.", "docsTags": [] } ], "styles": [], "slots": [ { "name": "primary-custom-action", "docs": "A slot for adding a primary action." }, { "name": "secondary-custom-action", "docs": "A slot for adding a secondary action." }, { "name": "translation-custom-action", "docs": "A slot for adding a custom action in the translation header section of the UI." } ], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-language-translator/instant-apps-ckeditor-wrapper/instant-apps-ckeditor-wrapper.tsx", "tag": "instant-apps-ckeditor-wrapper", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "config", "type": "EditorConfig", "complexType": { "original": "EditorConfig", "resolved": "EditorConfig", "references": { "EditorConfig": { "location": "import", "path": "@ckeditor/ckeditor5-core/src/editor/editorconfig.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "editorInstance", "type": "IClassicEditor", "complexType": { "original": "IClassicEditor", "resolved": "IClassicEditor", "references": { "IClassicEditor": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Instance of text editor", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "value", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "string" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsCkeditorWrapper = document.querySelector(\"instant-apps-ckeditor-wrapper\");\ndocument.body.append(instantAppsCkeditorWrapper);\nawait instantAppsCkeditorWrapper.componentOnReady();\nconsole.log(\"instant-apps-ckeditor-wrapper is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "dataChanged", "detail": "string", "bubbles": true, "complexType": { "original": "string", "resolved": "string", "references": {} }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] }, { "event": "isFocused", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-language-translator/instant-apps-language-translator-content/instant-apps-language-translator-content.tsx", "tag": "instant-apps-language-translator-content", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [], "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": "```js\nconst instantAppsLanguageTranslatorContent = document.querySelector(\"instant-apps-language-translator-content\");\ndocument.body.append(instantAppsLanguageTranslatorContent);\nawait instantAppsLanguageTranslatorContent.componentOnReady();\nconsole.log(\"instant-apps-language-translator-content is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-language-translator/instant-apps-language-translator-item/instant-apps-language-translator-item.tsx", "tag": "instant-apps-language-translator-item", "overview": "", "readme": "", "usage": {}, "docs": "TODO: [MIGRATION] This component had a `@Component()` decorator with a \"scoped\" prop. It needs to be migrated manually. Reason: Lit only has shadow root and light dom styling, not scoped.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "fieldName", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "field-name", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "setting", "type": "LocaleSettingData", "complexType": { "original": "LocaleSettingData", "resolved": "LocaleSettingData", "references": { "LocaleSettingData": { "location": "local", "path": "dist/components/instant-apps-language-translator/support/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "translatedLanguageLabels", "type": "{\n [x: string]: string;\n}", "complexType": { "original": "{\n [x: string]: string;\n}", "resolved": "{\n [x: string]: string;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "translatedLocaleInputOnChangeCallback", "type": "(fieldName: string, value: string, locale: string, resource: PortalItemResource) => Promise", "complexType": { "original": "(fieldName: string, value: string, locale: string, resource: PortalItemResource) => Promise", "resolved": "(fieldName: string, value: string, locale: string, resource: PortalItemResource) => Promise", "references": { "PortalItemResource": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "userLocaleInputOnChangeCallback", "type": "(fieldName: string, value: string) => Promise", "complexType": { "original": "(fieldName: string, value: string) => Promise", "resolved": "(fieldName: string, value: string) => Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true } ], "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": "```js\nconst instantAppsLanguageTranslatorItem = document.querySelector(\"instant-apps-language-translator-item\");\ndocument.body.append(instantAppsLanguageTranslatorItem);\nawait instantAppsLanguageTranslatorItem.componentOnReady();\nconsole.log(\"instant-apps-language-translator-item is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "translatorItemDataUpdated", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Fires when a translation input's value has changed.", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-language-translator/instant-apps-language-translator-search/instant-apps-language-translator-search.tsx", "tag": "instant-apps-language-translator-search", "overview": "", "readme": "", "usage": {}, "docs": "TODO: [MIGRATION] This component had a `@Component()` decorator with a \"scoped\" prop. It needs to be migrated manually. Reason: Lit only has shadow root and light dom styling, not scoped.", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "t9nPlaceholder", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "t9n-placeholder", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "string" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsLanguageTranslatorSearch = document.querySelector(\"instant-apps-language-translator-search\");\ndocument.body.append(instantAppsLanguageTranslatorSearch);\nawait instantAppsLanguageTranslatorSearch.componentOnReady();\nconsole.log(\"instant-apps-language-translator-search is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "suggestionSelected", "detail": "string", "bubbles": true, "complexType": { "original": "string", "resolved": "string", "references": {} }, "cancelable": true, "composed": true, "docs": "", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-measurement/instant-apps-measurement.tsx", "tag": "instant-apps-measurement", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeToolType", "type": "\"area\" | \"clear\" | \"distance\" | \"point\"", "complexType": { "original": "\"area\" | \"clear\" | \"distance\" | \"point\"", "resolved": "\"area\" | \"clear\" | \"distance\" | \"point\"", "references": {} }, "mutable": true, "attr": "active-tool-type", "reflectToAttr": false, "docs": "Determine the tool that will be open on load", "docsTags": [ { "name": "required" } ], "values": [ { "value": "area", "type": "string" }, { "value": "clear", "type": "string" }, { "value": "distance", "type": "string" }, { "value": "point", "type": "string" } ], "optional": false, "required": true }, { "name": "areaUnit", "type": "\"acres\" | \"ares\" | \"hectares\" | \"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\" | \"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\" | \"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": "Choose which unit will be used for the area tool by default", "docsTags": [], "values": [ { "value": "acres", "type": "string" }, { "value": "ares", "type": "string" }, { "value": "hectares", "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": "closable", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "closable", "reflectToAttr": false, "docs": "When true the measure widget is closable", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "coordinateFormat", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "coordinate-format", "reflectToAttr": false, "docs": "Choose which formats to include as options while converting coordinates", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "linearUnit", "type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"meters\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "complexType": { "original": "\"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"meters\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "resolved": "\"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"meters\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\"", "references": {} }, "mutable": true, "attr": "linear-unit", "reflectToAttr": false, "docs": "Choose which unit will be used for the distance tool by default", "docsTags": [], "values": [ { "value": "centimeters", "type": "string" }, { "value": "decimeters", "type": "string" }, { "value": "feet", "type": "string" }, { "value": "inches", "type": "string" }, { "value": "kilometers", "type": "string" }, { "value": "meters", "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": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "A reference to the MapView or SceneView", "docsTags": [ { "name": "required" } ], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsMeasurement = document.querySelector(\"instant-apps-measurement\");\ndocument.body.append(instantAppsMeasurement);\nawait instantAppsMeasurement.componentOnReady();\nconsole.log(\"instant-apps-measurement is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "measureActive", "detail": "boolean", "bubbles": true, "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits when there is an active measure tool\nto allow app devs to disable other tools/popups when\ntools are active .", "docsTags": [] } ], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-measurement/instant-apps-measurement-tool/instant-apps-measurement-tool.tsx", "tag": "instant-apps-measurement-tool", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "activeTool", "type": "\"area\" | \"clear\" | \"distance\" | \"point\"", "complexType": { "original": "\"area\" | \"clear\" | \"distance\" | \"point\"", "resolved": "\"area\" | \"clear\" | \"distance\" | \"point\"", "references": {} }, "mutable": true, "attr": "active-tool", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "value": "area", "type": "string" }, { "value": "clear", "type": "string" }, { "value": "distance", "type": "string" }, { "value": "point", "type": "string" } ], "optional": false, "required": true }, { "name": "measureConfiguration", "type": "IMeasureConfiguration", "complexType": { "original": "IMeasureConfiguration", "resolved": "IMeasureConfiguration", "references": { "IMeasureConfiguration": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsMeasurementTool = document.querySelector(\"instant-apps-measurement-tool\");\ndocument.body.append(instantAppsMeasurementTool);\nawait instantAppsMeasurementTool.componentOnReady();\nconsole.log(\"instant-apps-measurement-tool is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-popover/instant-apps-popover.tsx", "tag": "instant-apps-popover", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "content", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "content", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "disableAction", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "disable-action", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "imgAlt", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "img-alt", "reflectToAttr": true, "docs": "", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "imgSrc", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "img-src", "reflectToAttr": true, "docs": "", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "index", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "index", "reflectToAttr": true, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "number" } ], "optional": false, "required": true }, { "name": "mediaSrc", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "media-src", "reflectToAttr": true, "docs": "", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "messageOverrides", "type": "Record", "complexType": { "original": "Record", "resolved": "Record", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Overwrite localized strings for this component", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "pagination", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "pagination", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "parent", "type": "InstantAppsPopovers", "complexType": { "original": "InstantAppsPopovers", "resolved": "InstantAppsPopovers", "references": { "InstantAppsPopovers": { "location": "local", "path": "dist/components/instant-apps-popovers/customElement.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The parent that manages this popover and its siblings.", "docsTags": [], "values": [], "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": "", "docsTags": [], "default": "\"trailing-start\"", "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": "popoverAction", "type": "(event: MouseEvent) => void", "complexType": { "original": "(event: MouseEvent) => void", "resolved": "(event: MouseEvent) => void", "references": { "MouseEvent": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "popoverTitle", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "popover-title", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "referenceElement", "type": "HTMLElement | string", "complexType": { "original": "HTMLElement | string", "resolved": "HTMLElement | string", "references": { "HTMLElement": { "location": "import", "path": "typescript/lib/lib.dom.d.ts", "id": "notImplemented" } } }, "mutable": true, "attr": "reference-element", "reflectToAttr": true, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "HTMLElement" }, { "type": "string" } ], "optional": false, "required": true }, { "name": "refId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "ref-id", "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "subtitle", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "subtitle", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "\"\"", "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": "```js\nconst instantAppsPopover = document.querySelector(\"instant-apps-popover\");\ndocument.body.append(instantAppsPopover);\nawait instantAppsPopover.componentOnReady();\nconsole.log(\"instant-apps-popover is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-popovers/instant-apps-popovers.tsx", "tag": "instant-apps-popovers", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "beforeOpen", "type": "() => Promise", "complexType": { "original": "() => Promise", "resolved": "() => Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "currentId", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "current-id", "reflectToAttr": true, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "instantAppsPopovers", "type": "Map", "complexType": { "original": "Map", "resolved": "Map", "references": { "Map": { "location": "import", "path": "typescript/lib/lib.es2015.collection.d.ts", "id": "notImplemented" }, "HTMLInstantAppsPopoverElement": { "location": "local", "path": "index.js", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "inTour", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "in-tour", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false } ], "methods": [ { "name": "beginTour", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "beginTour(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "close", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(key: string): Promise", "parameters": [ { "name": "key", "type": "string", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "close(key: string): Promise", "parameters": [ { "name": "key", "type": "string", "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": "```js\nconst instantAppsPopovers = document.querySelector(\"instant-apps-popovers\");\ndocument.body.append(instantAppsPopovers);\nawait instantAppsPopovers.componentOnReady();\nconsole.log(\"instant-apps-popovers is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] }, { "name": "done", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "done(): Promise", "parameters": [], "docs": "", "docsTags": [] }, { "name": "endTour", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(): Promise", "parameters": [], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "endTour(): Promise", "parameters": [], "docs": "", "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": "", "docsTags": [] }, { "name": "open", "returns": { "type": "Promise", "docs": "" }, "complexType": { "signature": "(key: string): Promise", "parameters": [ { "name": "key", "type": "string", "docs": "" } ], "return": "Promise", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "signature": "open(key: string): Promise", "parameters": [ { "name": "key", "type": "string", "docs": "" } ], "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": "", "docsTags": [] } ], "events": [], "styles": [], "slots": [ { "name": "popovers", "docs": "A slot to contain all of the ``s that this element manages." } ], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-scoreboard/instant-apps-scoreboard.tsx", "tag": "instant-apps-scoreboard", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "autoDockEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "auto-dock-enabled", "reflectToAttr": false, "docs": "Controls the behavior to auto dock the scoreboard to the bottom in smaller parent containers/mobile devices.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "geometry", "type": "Geometry", "complexType": { "original": "Geometry", "resolved": "Geometry", "references": { "Geometry": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Optional geometry in which the statistics will be calculated. To re-calculate the scoreboard's statistics based on the current view extent, set this property to `null`.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "itemLimit", "type": "number", "complexType": { "original": "number", "resolved": "number", "references": {} }, "mutable": true, "attr": "item-limit", "reflectToAttr": false, "docs": "Number of scoreboard items that can be viewed at a time. Minimum: 2, Maximum : 6.", "docsTags": [], "default": "6", "values": [ { "type": "number" } ], "optional": true, "required": false }, { "name": "items", "type": "Array", "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "ScoreboardItem": { "location": "local", "path": "dist/components/instant-apps-scoreboard/types/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Data on layers, field attribute info, operations, for each scoreboard item", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "mode", "type": "Scoreboard.Floating | Scoreboard.Pinned", "complexType": { "original": "Scoreboard.Floating | Scoreboard.Pinned", "resolved": "Scoreboard.Floating | Scoreboard.Pinned", "references": { "Floating": { "location": "local", "path": "dist/components/instant-apps-scoreboard/types/interfaces.d.ts", "id": "notImplemented" }, "Pinned": { "location": "local", "path": "dist/components/instant-apps-scoreboard/types/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Mode of scoreboard i.e. 'floating' or 'pinned'.", "docsTags": [], "default": "\"floating\"", "values": [ { "type": "Scoreboard.Floating" }, { "type": "Scoreboard.Pinned" } ], "optional": true, "required": false }, { "name": "position", "type": "Scoreboard.Bottom | Scoreboard.Left | Scoreboard.Right", "complexType": { "original": "Scoreboard.Bottom | Scoreboard.Left | Scoreboard.Right", "resolved": "Scoreboard.Bottom | Scoreboard.Left | Scoreboard.Right", "references": { "Bottom": { "location": "local", "path": "dist/components/instant-apps-scoreboard/types/interfaces.d.ts", "id": "notImplemented" }, "Left": { "location": "local", "path": "dist/components/instant-apps-scoreboard/types/interfaces.d.ts", "id": "notImplemented" }, "Right": { "location": "local", "path": "dist/components/instant-apps-scoreboard/types/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Position of scoreboard i.e. 'bottom', 'left', or 'right'.", "docsTags": [], "default": "\"bottom\"", "values": [ { "type": "Scoreboard.Bottom" }, { "type": "Scoreboard.Left" }, { "type": "Scoreboard.Right" } ], "optional": true, "required": false }, { "name": "queryType", "type": "\"layer\" | \"layerView\"", "complexType": { "original": "\"layer\" | \"layerView\"", "resolved": "\"layer\" | \"layerView\"", "references": {} }, "mutable": true, "attr": "query-type", "reflectToAttr": false, "docs": "Determines whether to query against feature layer service or feature layer view. Default: 'layerView'", "docsTags": [], "default": "\"layerView\"", "values": [ { "value": "layer", "type": "string" }, { "value": "layerView", "type": "string" } ], "optional": true, "required": false }, { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "MapView or SceneView to reference extent, viewpoint, and layers in map to perform calculations.", "docsTags": [], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "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": "```js\nconst instantAppsScoreboard = document.querySelector(\"instant-apps-scoreboard\");\ndocument.body.append(instantAppsScoreboard);\nawait instantAppsScoreboard.componentOnReady();\nconsole.log(\"instant-apps-scoreboard is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "scoreboardItemsUpdated", "detail": "Array", "bubbles": true, "complexType": { "original": "Array", "resolved": "Array", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" }, "ScoreboardItem": { "location": "local", "path": "dist/components/instant-apps-scoreboard/types/interfaces.d.ts", "id": "notImplemented" } } }, "cancelable": true, "composed": true, "docs": "Emits when scoreboard item values have been calculated and updated.", "docsTags": [] } ], "styles": [ { "name": "--instant-apps-scoreboard-background-color", "annotation": "prop", "docs": "Background color of scoreboard." }, { "name": "--instant-apps-scoreboard-text-color", "annotation": "prop", "docs": "Text color of scoreboard." }, { "name": "--instant-apps-scoreboard-mobile-position-bottom", "annotation": "prop", "docs": "Scoreboard's bottom position (px) of absolutely positioned element on mobile." } ], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-sign-in/instant-apps-sign-in.tsx", "tag": "instant-apps-sign-in", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "closeLandingPage", "type": "((() => void))", "complexType": { "original": "((() => void))", "resolved": "((() => void))", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "landingPage", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "landing-page", "reflectToAttr": false, "docs": "Set to `true` if app has landing page", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "oauthappid", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "oauthappid", "reflectToAttr": false, "docs": "The registered application id, used to setup sign in capabilities.", "docsTags": [ { "name": "required" } ], "values": [ { "type": "string" } ], "optional": false, "required": true }, { "name": "openInPopup", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "open-in-popup", "reflectToAttr": false, "docs": "Set to true to show the OAuth sign-in page in a popup window.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "portal", "type": "IPortal", "complexType": { "original": "IPortal", "resolved": "IPortal", "references": { "IPortal": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "The apps Portal, used to setup sign in capabilities.", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "showIndicator", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "show-indicator", "reflectToAttr": false, "docs": "Show blue dot indicator on user avatar.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "signInPopoverItems", "type": "(Array<{\n label: string;\n onClick: (event: MouseEvent) => unknown;\n}>)", "complexType": { "original": "(Array<{\n label: string;\n onClick: (event: MouseEvent) => unknown;\n}>)", "resolved": "(Array<{\n label: string;\n onClick: (event: MouseEvent) => unknown;\n}>)", "references": { "Array": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Add items to the sign in popover.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "type", "type": "\"avatar\" | \"landingPage\" | \"navigation\"", "complexType": { "original": "\"avatar\" | \"landingPage\" | \"navigation\"", "resolved": "\"avatar\" | \"landingPage\" | \"navigation\"", "references": {} }, "mutable": true, "attr": "type", "reflectToAttr": false, "docs": "Pick the look of the sign in/out component. `navigation` will put sign out in calcite-navigation-user.\n`avatar` will put sign out in calcite-avatar. `landingPage` is used for instant-apps-landing-page.", "docsTags": [], "default": "\"navigation\"", "values": [ { "value": "avatar", "type": "string" }, { "value": "landingPage", "type": "string" }, { "value": "navigation", "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": "```js\nconst instantAppsSignIn = document.querySelector(\"instant-apps-sign-in\");\ndocument.body.append(instantAppsSignIn);\nawait instantAppsSignIn.componentOnReady();\nconsole.log(\"instant-apps-sign-in is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [ { "name": "--instant-apps-sign-in-indicator-color", "annotation": "prop", "docs": "Color of the indicator that shows in a signed in user's avatar." } ], "slots": [ { "name": "sign-in-popover-top", "docs": "A slot for adding an element to the top of the sign in popover." } ], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-social-share/instant-apps-social-share.tsx", "tag": "instant-apps-social-share", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "autoUpdateShareUrl", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "auto-update-share-url", "reflectToAttr": false, "docs": "Auto update share URL.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "defaultUrlParams", "type": "{\n center?: boolean | undefined;\n level?: boolean | undefined;\n viewpoint?: boolean | undefined;\n selectedFeature?: boolean | undefined;\n hiddenLayers?: boolean | undefined;\n}", "complexType": { "original": "{\n center?: boolean | undefined;\n level?: boolean | undefined;\n viewpoint?: boolean | undefined;\n selectedFeature?: boolean | undefined;\n hiddenLayers?: boolean | undefined;\n}", "resolved": "{\n center?: boolean | undefined;\n level?: boolean | undefined;\n viewpoint?: boolean | undefined;\n selectedFeature?: boolean | undefined;\n hiddenLayers?: boolean | undefined;\n}", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "Configure the default URL parameters that are appended to the generated share URL.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "displayTipText", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "display-tip-text", "reflectToAttr": true, "docs": "Show/hide the tip text below the share options.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "embed", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "embed", "reflectToAttr": true, "docs": "Show/hide the embed UI.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "flipRtl", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "flip-rtl", "reflectToAttr": true, "docs": "When true, the icon will be flipped when the element direction is right-to-left (\"rtl\").", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "iframeInnerText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "iframe-inner-text", "reflectToAttr": true, "docs": "Text to nest in embed iframe code.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "inlineSuccessPopoverPlacement", "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": "inline-success-popover-placement", "reflectToAttr": true, "docs": "Configures the placement of the success message popover for the 'Copy Link' button.\nSee options here: https://github.com/Esri/calcite-components/blob/v1.0.0-beta.83/src/utils/popper.ts#L34", "docsTags": [], "default": "\"trailing\"", "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": "isNativeShareEnabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "is-native-share-enabled", "reflectToAttr": true, "docs": "Determines if the native share API (e.g., drawer menu on mobile) is enabled and available.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "mode", "type": "\"inline\" | \"popover\"", "complexType": { "original": "\"inline\" | \"popover\"", "resolved": "\"inline\" | \"popover\"", "references": {} }, "mutable": true, "attr": "mode", "reflectToAttr": true, "docs": "Renders tool as a popover with a trigger button, or inline to place in a custom container.", "docsTags": [], "default": "\"popover\"", "values": [ { "value": "inline", "type": "string" }, { "value": "popover", "type": "string" } ], "optional": true, "required": false }, { "name": "popoverButtonIconScale", "type": "\"l\" | \"m\" | \"s\"", "complexType": { "original": "\"l\" | \"m\" | \"s\"", "resolved": "\"l\" | \"m\" | \"s\"", "references": {} }, "mutable": true, "attr": "popover-button-icon-scale", "reflectToAttr": true, "docs": "Adjusts the scale of the popover button icon.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "popoverPositioning", "type": "\"absolute\" | \"fixed\"", "complexType": { "original": "\"absolute\" | \"fixed\"", "resolved": "\"absolute\" | \"fixed\"", "references": {} }, "mutable": true, "attr": "popover-positioning", "reflectToAttr": true, "docs": "Adjusts the overlay-positioning of the popover.", "docsTags": [], "default": "\"absolute\"", "values": [ { "value": "absolute", "type": "string" }, { "value": "fixed", "type": "string" } ], "optional": true, "required": false }, { "name": "removePopoverOffset", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "remove-popover-offset", "reflectToAttr": true, "docs": "Remove the pointer and set the vertical offset to 0 for the popover.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "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": true, "docs": "Adjusts the scale of the component.", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "shareButtonColor", "type": "\"inverse\" | \"neutral\"", "complexType": { "original": "\"inverse\" | \"neutral\"", "resolved": "\"inverse\" | \"neutral\"", "references": {} }, "mutable": true, "attr": "share-button-color", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "\"neutral\"", "values": [ { "value": "inverse", "type": "string" }, { "value": "neutral", "type": "string" } ], "optional": true, "required": false }, { "name": "shareButtonScale", "type": "\"l\" | \"m\" | \"s\"", "complexType": { "original": "\"l\" | \"m\" | \"s\"", "resolved": "\"l\" | \"m\" | \"s\"", "references": {} }, "mutable": true, "attr": "share-button-scale", "reflectToAttr": true, "docs": "Adjust scale of popover button", "docsTags": [], "default": "\"m\"", "values": [ { "value": "l", "type": "string" }, { "value": "m", "type": "string" }, { "value": "s", "type": "string" } ], "optional": true, "required": false }, { "name": "shareButtonType", "type": "\"action\" | \"button\"", "complexType": { "original": "\"action\" | \"button\"", "resolved": "\"action\" | \"button\"", "references": {} }, "mutable": true, "attr": "share-button-type", "reflectToAttr": true, "docs": "Renders tool in popover mode with a trigger button or action", "docsTags": [], "default": "\"button\"", "values": [ { "value": "action", "type": "string" }, { "value": "button", "type": "string" } ], "optional": true, "required": false }, { "name": "shareIconsLayout", "type": "\"horizontal\" | \"vertical\"", "complexType": { "original": "\"horizontal\" | \"vertical\"", "resolved": "\"horizontal\" | \"vertical\"", "references": {} }, "mutable": true, "attr": "share-icons-layout", "reflectToAttr": true, "docs": "Display the share icons in a vertical or horizontal layout.", "docsTags": [], "default": "\"vertical\"", "values": [ { "value": "horizontal", "type": "string" }, { "value": "vertical", "type": "string" } ], "optional": true, "required": false }, { "name": "shareText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "share-text", "reflectToAttr": true, "docs": "", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "shareUrl", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "share-url", "reflectToAttr": false, "docs": "Generated share URL. Use this property to append custom URL parameters if needed.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "shortenShareUrl", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "shorten-share-url", "reflectToAttr": true, "docs": "Shortens generated URL.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "socialMedia", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "social-media", "reflectToAttr": true, "docs": "Show/hide social media icons.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "successMessage", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "success-message", "reflectToAttr": true, "docs": "Provides an alternate to the success.url message \"App URL copied to clipboard.\"", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "useNativeShare", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "use-native-share", "reflectToAttr": true, "docs": "Use the device's native share API (e.g., drawer menu on mobile) if available.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "MapView or SceneView to reference when URL parameter values are generated, i.e. center, level, viewpoint, etc.", "docsTags": [], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "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": "```js\nconst instantAppsSocialShare = document.querySelector(\"instant-apps-social-share\");\ndocument.body.append(instantAppsSocialShare);\nawait instantAppsSocialShare.componentOnReady();\nconsole.log(\"instant-apps-social-share is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [ { "name": "--instant-apps-social-share-action-width", "annotation": "prop", "docs": "Width of action button" }, { "name": "--instant-apps-social-share-width--s", "annotation": "prop", "docs": "Width of component when scale is set to `s`" }, { "name": "--instant-apps-social-share-width--m", "annotation": "prop", "docs": "Width of component when scale is set to `m`" }, { "name": "--instant-apps-social-share-width--l", "annotation": "prop", "docs": "Width of component when scale is set to `l`" }, { "name": "--instant-apps-social-share-width-horizontal--s", "annotation": "prop", "docs": "Width of component when `share-icons-layout` is set to `horizontal` and scale is set to 's'" }, { "name": "--instant-apps-social-share-width-horizontal--m", "annotation": "prop", "docs": "Width of component when `share-icons-layout` is set to `horizontal` and scale is set to 'm'" }, { "name": "--instant-apps-social-share-width-horizontal--l", "annotation": "prop", "docs": "Width of component when `share-icons-layout` is set to `horizontal` and scale is set to 'l'" } ], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-splash/instant-apps-splash.tsx", "tag": "instant-apps-splash", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "shadow", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "closeBehavior", "type": "\"confirmation\" | \"dismissal\" | \"permanent-dismissal\"", "complexType": { "original": "\"confirmation\" | \"dismissal\" | \"permanent-dismissal\"", "resolved": "\"confirmation\" | \"dismissal\" | \"permanent-dismissal\"", "references": {} }, "mutable": true, "attr": "close-behavior", "reflectToAttr": false, "docs": "Determines how the splash screen is dismissed.\n'permanent-dismissal' displays a \"Don't show this again\" checkbox,\n'dismissal' opens the splash on every visit, and\n'confirmation' requires the confirmation checkbox to be checked for the splash to be dismissible.", "docsTags": [], "default": "\"permanent-dismissal\"", "values": [ { "value": "confirmation", "type": "string" }, { "value": "dismissal", "type": "string" }, { "value": "permanent-dismissal", "type": "string" } ], "optional": true, "required": false }, { "name": "closeButtonDisabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "close-button-disabled", "reflectToAttr": false, "docs": "When `true`, disables the component's close button.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "confirmationText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "confirmation-text", "reflectToAttr": false, "docs": "Confirmation text for checkbox.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "content", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "content", "reflectToAttr": false, "docs": "Content of splash screen.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "isConfirmed", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "reflectToAttr": false, "docs": "If the dismiss type is 'confirmation', this read-only property determines whether the splash component is dismissible.", "docsTags": [ { "name": "readonly", "text": "" } ], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "localStorageKey", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "local-storage-key", "reflectToAttr": false, "docs": "Local storage key used to determine whether or not user has opted into \"Don't show this again\" checkbox.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "open", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "open", "reflectToAttr": false, "docs": "Controls the 'open' state of the modal element.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "outsideCloseDisabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "outside-close-disabled", "reflectToAttr": false, "docs": "When `true`, disables the closing of the component when clicked outside.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "primaryButtonText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "primary-button-text", "reflectToAttr": false, "docs": "Primary button text.", "docsTags": [], "default": "\"\"", "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "secondaryButton", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "secondary-button", "reflectToAttr": false, "docs": "When `true`, enables a secondary button at the component's footer.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "secondaryButtonCallback", "type": "((() => Promise))", "complexType": { "original": "((() => Promise))", "resolved": "((() => Promise))", "references": { "Promise": { "location": "import", "path": "typescript/lib/lib.es5.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "Callback function when secondary button is clicked.", "docsTags": [], "values": [], "optional": true, "required": false }, { "name": "secondaryButtonIcon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "secondary-button-icon", "reflectToAttr": false, "docs": "Secondary button icon.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "secondaryButtonText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "secondary-button-text", "reflectToAttr": false, "docs": "Secondary button text.", "docsTags": [], "values": [ { "type": "string" } ], "optional": true, "required": false }, { "name": "titleText", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": true, "attr": "title-text", "reflectToAttr": false, "docs": "Title of splash screen.", "docsTags": [], "default": "\"\"", "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": "```js\nconst instantAppsSplash = document.querySelector(\"instant-apps-splash\");\ndocument.body.append(instantAppsSplash);\nawait instantAppsSplash.componentOnReady();\nconsole.log(\"instant-apps-splash is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [ { "event": "splashClose", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emits when the splash modal is closed.", "docsTags": [] } ], "styles": [ { "name": "--instant-apps-splash-content-max-height", "annotation": "prop", "docs": "Set the max height of the content area ." }, { "name": "--instant-apps-splash-back-content-display", "annotation": "prop", "docs": "Controls the display property of the back content area." } ], "slots": [], "parts": [], "listeners": [] }, { "filePath": "src/components/instant-apps-time-filter/instant-apps-time-filter.tsx", "tag": "instant-apps-time-filter", "overview": "", "readme": "", "usage": {}, "docs": "", "docsTags": [ { "name": "superclass", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ], "encapsulation": "none", "dependents": [], "dependencies": [], "dependencyGraph": {}, "props": [ { "name": "autoPlay", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": true, "attr": "auto-play", "reflectToAttr": false, "docs": "", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": true, "required": false }, { "name": "filterMode", "type": "FilterMode", "complexType": { "original": "FilterMode", "resolved": "FilterMode", "references": { "FilterMode": { "location": "local", "path": "dist/interfaces/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "timeInfoConfigItems", "type": "Array<{\n type?: string | undefined;\n id?: string | undefined;\n increments: string;\n max: string;\n min: string;\n rangeEnd: Date;\n rangeStart: Date;\n timeIntervalValue?: number | undefined;\n}>", "complexType": { "original": "Array<{\n type?: string | undefined;\n id?: string | undefined;\n increments: string;\n max: string;\n min: string;\n rangeEnd: Date;\n rangeStart: Date;\n timeIntervalValue?: number | undefined;\n}>", "resolved": "Array<{\n type?: string | undefined;\n id?: string | undefined;\n increments: string;\n max: string;\n min: string;\n rangeEnd: Date;\n rangeStart: Date;\n timeIntervalValue?: number | undefined;\n}>", "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": "timeSliderConfig", "type": "widgetsTimeSliderProperties", "complexType": { "original": "widgetsTimeSliderProperties", "resolved": "widgetsTimeSliderProperties", "references": { "widgetsTimeSliderProperties": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [], "optional": false, "required": true }, { "name": "view", "type": "MapView | SceneView", "complexType": { "original": "MapView | SceneView", "resolved": "MapView | SceneView", "references": { "MapView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" }, "SceneView": { "location": "import", "path": "@arcgis/core/interfaces.d.ts", "id": "notImplemented" } } }, "mutable": true, "reflectToAttr": false, "docs": "", "docsTags": [ { "name": "required" } ], "values": [ { "type": "MapView" }, { "type": "SceneView" } ], "optional": false, "required": true } ], "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": "```js\nconst instantAppsTimeFilter = document.querySelector(\"instant-apps-time-filter\");\ndocument.body.append(instantAppsTimeFilter);\nawait instantAppsTimeFilter.componentOnReady();\nconsole.log(\"instant-apps-time-filter is ready to go!\");\n```" }, { "name": "inheritedFrom", "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}" } ] } ], "events": [], "styles": [], "slots": [], "parts": [], "listeners": [] } ], "typeLibrary": {} }