@arcgis/coding-components 5.0.0-next.136 → 5.0.0-next.137

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (176) hide show
  1. package/dist/addons/arcade-coding-assistant/useArcadeAssistant.d.ts +7 -17
  2. package/dist/addons/index.d.ts +2 -2
  3. package/dist/addons.js +1 -1
  4. package/dist/cdn/{OZZYHIPM.js → 22N5QBRQ.js} +1 -1
  5. package/dist/cdn/{ZBKMCGR7.js → 2EKDNAHO.js} +2 -2
  6. package/dist/cdn/{A7BGWNLB.js → 2NXZWMO2.js} +2 -2
  7. package/dist/cdn/{RFPCEKOB.js → 2UFRNIIX.js} +2 -2
  8. package/dist/cdn/{H3N4UPAY.js → 2ZQEKE2N.js} +3 -3
  9. package/dist/cdn/{OAJKP3TF.js → 3P2KVVSN.js} +1 -1
  10. package/dist/cdn/{EZGAUSIF.js → 3T5KGXQ7.js} +2 -2
  11. package/dist/cdn/{224QUA5Z.js → 5MGUXXER.js} +2 -2
  12. package/dist/cdn/{MMSAWKPK.js → 5N2Q2P7U.js} +2 -2
  13. package/dist/cdn/{UCG4NPRP.js → 652ZSIU3.js} +2 -2
  14. package/dist/cdn/{YTFTM7FZ.js → 6DBUX6JF.js} +1 -1
  15. package/dist/cdn/{22DCBJ5F.js → APQA7KWN.js} +2 -2
  16. package/dist/cdn/{OCZIBXWV.js → ATM4NOGS.js} +1 -1
  17. package/dist/cdn/{5N7BLQUC.js → B5CXJQR6.js} +1 -1
  18. package/dist/cdn/{MGX5UEEJ.js → BUACEA3I.js} +3 -3
  19. package/dist/cdn/{Q54H2UGW.js → CPWFDMAZ.js} +2 -2
  20. package/dist/cdn/{XLQLW2QL.js → D3RYGBRI.js} +2 -2
  21. package/dist/cdn/{PR666JT5.js → D6TFIJTU.js} +2 -2
  22. package/dist/cdn/{Q6ERATMA.js → FFISKNTL.js} +2 -2
  23. package/dist/cdn/{JYHLAFWX.js → FZU6DHUW.js} +2 -2
  24. package/dist/cdn/{U77BQSD4.js → G6GHNSL7.js} +2 -2
  25. package/dist/cdn/KGEHLX5T.js +4 -0
  26. package/dist/cdn/{ZWJAHBIF.js → KNPWBL2I.js} +2 -2
  27. package/dist/cdn/{FV6JUYSW.js → LKTNXGNX.js} +2 -2
  28. package/dist/cdn/{PP7BAX5L.js → LXFKAS3V.js} +2 -2
  29. package/dist/cdn/{UMHPBSPW.js → LXPYFEGT.js} +1 -1
  30. package/dist/cdn/{DSHANUYF.js → OB5OMUWO.js} +2 -2
  31. package/dist/cdn/{OCXFKC66.js → OPBG2VOB.js} +1 -1
  32. package/dist/cdn/{PWTWO4LQ.js → OS4TOCCI.js} +2 -2
  33. package/dist/cdn/{J2DLUEJO.js → OWLGWZHC.js} +2 -2
  34. package/dist/cdn/{TV544T2R.js → QDQF6MJO.js} +2 -2
  35. package/dist/cdn/{Q4UHUY3T.js → QK2B5NW2.js} +2 -2
  36. package/dist/cdn/{ZB3AQDM2.js → QSPWHJZL.js} +2 -2
  37. package/dist/cdn/{HSBLYEZV.js → QWNYDDUJ.js} +2 -2
  38. package/dist/cdn/{VDMEGRHB.js → R2YG3J22.js} +2 -2
  39. package/dist/cdn/{MEXDPC7D.js → R5MLSRIF.js} +1 -1
  40. package/dist/cdn/{TZYBHRPS.js → RUH6XBH5.js} +2 -2
  41. package/dist/cdn/SA2I6VGH.js +6 -0
  42. package/dist/cdn/{4RJPAWSA.js → TAAR5ZM6.js} +2 -2
  43. package/dist/cdn/TO7MSMOI.js +4 -0
  44. package/dist/cdn/{UI5EVXFU.js → TQNRSDFY.js} +2 -2
  45. package/dist/cdn/{UZMYMIUN.js → U4XM5Q3C.js} +2 -2
  46. package/dist/cdn/{CUWBQ6DE.js → UMCG5VR5.js} +2 -2
  47. package/dist/cdn/{HEOVDTIB.js → UXKT2D32.js} +2 -2
  48. package/dist/cdn/{36Y75YKB.js → VVGAJL4U.js} +2 -2
  49. package/dist/cdn/{RIEACZTY.js → WLIDKUHE.js} +2 -2
  50. package/dist/cdn/{TGBYUAUR.js → XB5O7QZI.js} +2 -2
  51. package/dist/cdn/{ZLUCSP73.js → ZMY3G2UA.js} +2 -2
  52. package/dist/cdn/index.js +2 -2
  53. package/dist/chunks/arcade-defaults.js +2 -2
  54. package/dist/chunks/arcade-executor.js +1 -1
  55. package/dist/chunks/arcade-mode.js +1 -1
  56. package/dist/chunks/arcade-service-accessors.js +1 -1
  57. package/dist/chunks/colorize.js +1 -1
  58. package/dist/chunks/fields.js +1 -1
  59. package/dist/chunks/language-defaults-base.js +3 -3
  60. package/dist/chunks/markdown.js +1 -1
  61. package/dist/chunks/monaco-importer.js +1 -1
  62. package/dist/chunks/monaco-theme.js +1 -1
  63. package/dist/chunks/runtime.js +1 -1
  64. package/dist/chunks/{arcade-contribution.js → setup-monaco-theme.js} +40 -40
  65. package/dist/chunks/sql-expr-defaults.js +2 -2
  66. package/dist/chunks/sql-expr-mode.js +1 -1
  67. package/dist/chunks/sql-expr-service-accessors.js +1 -1
  68. package/dist/chunks/useT9n.js +1 -1
  69. package/dist/chunks/utilities.js +1 -1
  70. package/dist/components/arcgis-arcade-coding-assistant/customElement.js +1 -1
  71. package/dist/components/arcgis-arcade-coding-assistant/types.d.ts +3 -48
  72. package/dist/components/arcgis-arcade-editor/customElement.d.ts +123 -112
  73. package/dist/components/arcgis-arcade-editor/customElement.js +2 -2
  74. package/dist/components/arcgis-arcade-editor/index.d.ts +0 -13
  75. package/dist/components/arcgis-arcade-results/customElement.js +7 -7
  76. package/dist/components/arcgis-arcade-suggestions/customElement.js +1 -1
  77. package/dist/components/arcgis-code-editor/customElement.d.ts +74 -81
  78. package/dist/components/arcgis-code-editor/customElement.js +3 -3
  79. package/dist/components/arcgis-code-editor-shell/customElement.d.ts +9 -5
  80. package/dist/components/arcgis-code-editor-shell/customElement.js +1 -1
  81. package/dist/components/arcgis-code-viewer/customElement.d.ts +23 -37
  82. package/dist/components/arcgis-code-viewer/customElement.js +2 -2
  83. package/dist/components/arcgis-editor-variables/customElement.js +1 -1
  84. package/dist/components/arcgis-language-api-panel/customElement.js +1 -1
  85. package/dist/components/arcgis-sql-expression-editor/customElement.d.ts +53 -49
  86. package/dist/components/arcgis-sql-expression-editor/customElement.js +1 -1
  87. package/dist/components/arcgis-sql-expression-editor/index.d.ts +0 -7
  88. package/dist/components/arcgis-sql-expression-fields/customElement.js +1 -1
  89. package/dist/docs/api.json +1 -1470
  90. package/dist/docs/docs.json +1 -1381
  91. package/dist/docs/vscode.css-custom-data.json +1 -35
  92. package/dist/docs/vscode.html-custom-data.json +1 -119
  93. package/dist/docs/web-types.json +1 -385
  94. package/dist/index.d.ts +34 -21
  95. package/dist/index.js +1 -1
  96. package/dist/loader.js +7 -7
  97. package/dist/types/lumina.d.ts +11 -11
  98. package/dist/types/preact.d.ts +11 -11
  99. package/dist/types/react.d.ts +11 -11
  100. package/dist/types/stencil.d.ts +11 -11
  101. package/dist/utils/arcade-assistant/types.d.ts +8 -72
  102. package/dist/utils/arcade-executor.d.ts +158 -126
  103. package/dist/utils/arcade-monaco/arcade-defaults.d.ts +9 -49
  104. package/dist/utils/custom-panel.d.ts +35 -30
  105. package/dist/utils/editor-suggestions.d.ts +17 -28
  106. package/dist/utils/index.d.ts +4 -6
  107. package/dist/utils/profile/types.d.ts +273 -345
  108. package/dist/utils/sql-expr-monaco/sql-expr-defaults.d.ts +8 -22
  109. package/package.json +6 -6
  110. package/dist/addons/arcade-coding-assistant/chat-helper.d.ts +0 -78
  111. package/dist/addons/arcade-coding-assistant/index.d.ts +0 -2
  112. package/dist/addons/arcade-coding-assistant/temporary-strings.d.ts +0 -47
  113. package/dist/cdn/2WNWZ6AD.js +0 -4
  114. package/dist/cdn/EGURZWSY.js +0 -4
  115. package/dist/cdn/TIR4RXVC.js +0 -6
  116. package/dist/components/arcgis-arcade-coding-assistant/customElement.d.ts +0 -45
  117. package/dist/components/arcgis-arcade-coding-assistant/functional.d.ts +0 -235
  118. package/dist/components/arcgis-arcade-coding-assistant/index.d.ts +0 -27
  119. package/dist/components/arcgis-arcade-results/customElement.d.ts +0 -32
  120. package/dist/components/arcgis-arcade-results/functional.d.ts +0 -73
  121. package/dist/components/arcgis-arcade-results/index.d.ts +0 -10
  122. package/dist/components/arcgis-arcade-suggestions/customElement.d.ts +0 -24
  123. package/dist/components/arcgis-arcade-suggestions/index.d.ts +0 -10
  124. package/dist/components/arcgis-editor-variables/customElement.d.ts +0 -40
  125. package/dist/components/arcgis-editor-variables/index.d.ts +0 -10
  126. package/dist/components/arcgis-language-api-panel/customElement.d.ts +0 -42
  127. package/dist/components/arcgis-language-api-panel/index.d.ts +0 -11
  128. package/dist/components/arcgis-sql-expression-fields/customElement.d.ts +0 -23
  129. package/dist/components/arcgis-sql-expression-fields/index.d.ts +0 -7
  130. package/dist/controllers/useT9n.d.ts +0 -1
  131. package/dist/runtime.d.ts +0 -6
  132. package/dist/utils/arcade-assistant/aiContext.d.ts +0 -6
  133. package/dist/utils/arcade-assistant/constants.d.ts +0 -2
  134. package/dist/utils/arcade-assistant/utils.d.ts +0 -9
  135. package/dist/utils/arcade-monaco/arcade-contribution.d.ts +0 -1
  136. package/dist/utils/arcade-monaco/arcade-language-features.d.ts +0 -35
  137. package/dist/utils/arcade-monaco/arcade-language-syntax.d.ts +0 -3
  138. package/dist/utils/arcade-monaco/arcade-mode.d.ts +0 -29
  139. package/dist/utils/arcade-monaco/arcade-profile-strategy.d.ts +0 -12
  140. package/dist/utils/arcade-monaco/arcade-service-accessors.d.ts +0 -31
  141. package/dist/utils/arcade-monaco/arcade-worker-manager.d.ts +0 -22
  142. package/dist/utils/arcade-monaco/arcade.worker.d.ts +0 -23
  143. package/dist/utils/arcade-monaco/types.d.ts +0 -9
  144. package/dist/utils/colorize.d.ts +0 -5
  145. package/dist/utils/constants.d.ts +0 -3
  146. package/dist/utils/css-vars.d.ts +0 -7
  147. package/dist/utils/fields.d.ts +0 -20
  148. package/dist/utils/internal-monaco-apis.d.ts +0 -67
  149. package/dist/utils/language-defaults-base.d.ts +0 -76
  150. package/dist/utils/markdown.d.ts +0 -6
  151. package/dist/utils/monaco-importer.d.ts +0 -28
  152. package/dist/utils/monaco-languages.d.ts +0 -17
  153. package/dist/utils/monaco-theme.json.d.ts +0 -27
  154. package/dist/utils/monaco-typings.d.ts +0 -8
  155. package/dist/utils/patch-monaco.d.ts +0 -16
  156. package/dist/utils/profile/editor-profile.d.ts +0 -278
  157. package/dist/utils/profile/utils.d.ts +0 -49
  158. package/dist/utils/setup-monaco-theme.d.ts +0 -1
  159. package/dist/utils/setup-monaco.d.ts +0 -31
  160. package/dist/utils/sql-expr-monaco/sql-expr-completion.d.ts +0 -74
  161. package/dist/utils/sql-expr-monaco/sql-expr-constants.d.ts +0 -67
  162. package/dist/utils/sql-expr-monaco/sql-expr-contribution.d.ts +0 -1
  163. package/dist/utils/sql-expr-monaco/sql-expr-language-features.d.ts +0 -23
  164. package/dist/utils/sql-expr-monaco/sql-expr-language-syntax.d.ts +0 -3
  165. package/dist/utils/sql-expr-monaco/sql-expr-mode.d.ts +0 -43
  166. package/dist/utils/sql-expr-monaco/sql-expr-parser-utils.d.ts +0 -36
  167. package/dist/utils/sql-expr-monaco/sql-expr-profile-utils.d.ts +0 -5
  168. package/dist/utils/sql-expr-monaco/sql-expr-service-accessors.d.ts +0 -19
  169. package/dist/utils/sql-expr-monaco/sql-expr-validation-diagnostic-adapter.d.ts +0 -33
  170. package/dist/utils/sql-expr-monaco/sql-expr-validation-utils.d.ts +0 -82
  171. package/dist/utils/sql-expr-monaco/sql-expr-validation.d.ts +0 -41
  172. package/dist/utils/sql-expr-monaco/sql-expr-worker-manager.d.ts +0 -22
  173. package/dist/utils/sql-expr-monaco/sql-expr.worker.d.ts +0 -22
  174. package/dist/utils/sql-expr-monaco/sql-expression-profile-strategy.d.ts +0 -13
  175. package/dist/utils/sql-expr-monaco/types.d.ts +0 -96
  176. package/dist/utils/utilities.d.ts +0 -16
@@ -1,1381 +1 @@
1
- {
2
- "timestamp": "2026-01-19T04:39:48",
3
- "compiler": {
4
- "name": "@arcgis/lumina-compiler",
5
- "version": "5.0.0-next.136",
6
- "typescriptVersion": "5.9.3"
7
- },
8
- "components": [
9
- {
10
- "filePath": "src/components/arcade-editor/arcade-editor.tsx",
11
- "tag": "arcgis-arcade-editor",
12
- "overview": "",
13
- "readme": "",
14
- "usage": {},
15
- "docs": "[**Arcade**](https://developers.arcgis.com/arcade/) is a portable, and lightweight expression language used to create custom content throughout the [ArcGIS system](https://www.esri.com/en-us/arcgis/products/index).\nLike other expression languages, it can perform mathematical calculations, format text, and evaluate logical statements.\nIt also supports multi-statement expressions, variables, and flow control statements. Arcade is unique when compared to other expression and scripting languages due to its inclusion of [feature](https://developers.arcgis.com/arcade/guide/types/#feature) and [geometry](https://developers.arcgis.com/arcade/guide/types/#geometry) data types.\n\nMap Viewer (MV) was the first ArcGIS Online product to incorporate the new Arcade editor after [the editor's introduction in the November 2022 ArcGIS Online release](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/introducing-the-new-arcade-editor-in-arcgis-online/).\nThis was possible thanks to the Arcade editor component, which enabled MV to implement its own Arcade expression builder.\nYou can now also find the editor in ArcGIS Dashboards, ArcGIS Field Maps, and ArcGIS Velocity.\n\nYou can easily get your own dedicated Arcade expression builder with the **Arcade editor** component, which includes:\n\n- An easy to use [layout](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/discover-the-arcade-editors-powerful-new-features/#the-new-layout)\n- An optional minimal layout if you, for example, decide to manually exclude things such as test data, padding, line numbers, and the sidebar\n- A way to execute Arcade expressions in a configurable code editor\n- [Suggestions and code completion](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/discover-the-arcade-editors-powerful-new-features/#suggestions-and-code-completion)\n- [WCAG 2.0 compliant code colorization / syntax highlighting](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/accessibility-and-arcade-working-in-color/)\n- Built-in [keyboard shortcuts](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/discover-the-arcade-editors-powerful-new-features/#keyboard-shortcuts)\n- In-editor help for finding information about profile variables relevant to your profile, documentation for constants and functions, a link to the official Arcade documentation, and, in some case, suggestions.\n- Support for many [languages and directionality](https://developers.arcgis.com/javascript/latest/localization/)",
16
- "docsTags": [
17
- {
18
- "name": "superclass",
19
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
20
- }
21
- ],
22
- "encapsulation": "shadow",
23
- "dependents": [],
24
- "dependencies": [],
25
- "dependencyGraph": {},
26
- "props": [
27
- {
28
- "name": "arcadeAssistant",
29
- "type": "{\n portalUrl: string;\n appVersion?: string | undefined;\n}",
30
- "complexType": {
31
- "original": "{\n portalUrl: string;\n appVersion?: string | undefined;\n}",
32
- "resolved": "{\n portalUrl: string;\n appVersion?: string | undefined;\n}",
33
- "references": {}
34
- },
35
- "mutable": true,
36
- "reflectToAttr": false,
37
- "docs": "enables and configures the arcade assistant",
38
- "docsTags": [
39
- {
40
- "name": "internal"
41
- }
42
- ],
43
- "values": [],
44
- "optional": true,
45
- "required": false
46
- },
47
- {
48
- "name": "customPanels",
49
- "type": "(Array<{\n id: string;\n name: string;\n location: \"sidebar\";\n renderer: ({ closePanel, insertText, closed, editorRef, }: {\n closePanel: (e: Event) => void;\n insertText: (text: string) => void;\n closed: boolean;\n editorRef: ArcgisArcadeEditor<object>;\n }) => JsxNode;\n} & {\n icon: IconName;\n description?: string | undefined;\n useFlows?: boolean | undefined;\n enabled?: boolean | undefined;\n location: \"sidebar\";\n}>)",
50
- "complexType": {
51
- "original": "(Array<{\n id: string;\n name: string;\n location: \"sidebar\";\n renderer: ({ closePanel, insertText, closed, editorRef, }: {\n closePanel: (e: Event) => void;\n insertText: (text: string) => void;\n closed: boolean;\n editorRef: ArcgisArcadeEditor<object>;\n }) => JsxNode;\n} & {\n icon: IconName;\n description?: string | undefined;\n useFlows?: boolean | undefined;\n enabled?: boolean | undefined;\n location: \"sidebar\";\n}>)",
52
- "resolved": "(Array<{\n id: string;\n name: string;\n location: \"sidebar\";\n renderer: ({ closePanel, insertText, closed, editorRef, }: {\n closePanel: (e: Event) => void;\n insertText: (text: string) => void;\n closed: boolean;\n editorRef: ArcgisArcadeEditor<object>;\n }) => JsxNode;\n} & {\n icon: IconName;\n description?: string | undefined;\n useFlows?: boolean | undefined;\n enabled?: boolean | undefined;\n location: \"sidebar\";\n}>)",
53
- "references": {
54
- "Array": {
55
- "location": "import",
56
- "path": "typescript/lib/lib.es5.d.ts",
57
- "id": "notImplemented"
58
- }
59
- }
60
- },
61
- "mutable": true,
62
- "reflectToAttr": false,
63
- "docs": "Custom panels to be displayed in the side panel.\nWill be placed below the default panels but above the help panel.",
64
- "docsTags": [
65
- {
66
- "name": "internal"
67
- }
68
- ],
69
- "values": [],
70
- "optional": true,
71
- "required": false
72
- },
73
- {
74
- "name": "editorOptions",
75
- "type": "(IEditorOptions & IGlobalEditorOptions)",
76
- "complexType": {
77
- "original": "(IEditorOptions & IGlobalEditorOptions)",
78
- "resolved": "(IEditorOptions & IGlobalEditorOptions)",
79
- "references": {
80
- "IEditorOptions": {
81
- "location": "import",
82
- "path": "monaco-editor/esm/vs/editor/editor.api.d.ts",
83
- "id": "notImplemented"
84
- },
85
- "IGlobalEditorOptions": {
86
- "location": "import",
87
- "path": "monaco-editor/esm/vs/editor/editor.api.d.ts",
88
- "id": "notImplemented"
89
- }
90
- }
91
- },
92
- "mutable": true,
93
- "reflectToAttr": false,
94
- "docs": "Options to update on the editor.\nFor example:\n```json\n{\n \"fontSize\": 18\n}\n```\n\nTo get the full list of available options, see the Monaco Editor options [documentation](https://microsoft.github.io/monaco-editor/typedoc/variables/editor.EditorOptions.html) for more details.",
95
- "docsTags": [],
96
- "values": [],
97
- "optional": true,
98
- "required": false
99
- },
100
- {
101
- "name": "hideDocumentationActions",
102
- "type": "boolean",
103
- "complexType": {
104
- "original": "boolean",
105
- "resolved": "boolean",
106
- "references": {}
107
- },
108
- "mutable": true,
109
- "attr": "hide-documentation-actions",
110
- "reflectToAttr": false,
111
- "docs": "If true, it will hide the documentation action in the side panel",
112
- "docsTags": [],
113
- "default": "false",
114
- "values": [
115
- {
116
- "type": "boolean"
117
- }
118
- ],
119
- "optional": true,
120
- "required": false
121
- },
122
- {
123
- "name": "hideSideBar",
124
- "type": "boolean",
125
- "complexType": {
126
- "original": "boolean",
127
- "resolved": "boolean",
128
- "references": {}
129
- },
130
- "mutable": true,
131
- "attr": "hide-side-bar",
132
- "reflectToAttr": false,
133
- "docs": "If true, it will hide the side actions bar. The editor will be in a minimalistic UX.",
134
- "docsTags": [],
135
- "default": "false",
136
- "values": [
137
- {
138
- "type": "boolean"
139
- }
140
- ],
141
- "optional": true,
142
- "required": false
143
- },
144
- {
145
- "name": "openedSidePanel",
146
- "type": "T extends {\n customPanels: Array<ICustomSidePanel>;\n} ? \"none\" | \"variables\" | \"suggestions\" | \"api\" : string",
147
- "complexType": {
148
- "original": "T extends {\n customPanels: Array<ICustomSidePanel>;\n} ? \"none\" | \"variables\" | \"suggestions\" | \"api\" : string",
149
- "resolved": "T extends {\n customPanels: Array<ICustomSidePanel>;\n} ? \"none\" | \"variables\" | \"suggestions\" | \"api\" : string",
150
- "references": {
151
- "T": {
152
- "location": "local",
153
- "path": "dist/components/arcgis-arcade-editor/customElement.d.ts",
154
- "id": "notImplemented"
155
- }
156
- }
157
- },
158
- "mutable": true,
159
- "reflectToAttr": true,
160
- "docs": "The name of the opened side panel. 'none' means 'no panel opened'.",
161
- "docsTags": [],
162
- "default": "\"none\"",
163
- "values": [],
164
- "optional": true,
165
- "required": false
166
- },
167
- {
168
- "name": "profile",
169
- "type": "IEditorProfileDefinition | IPredefinedProfile",
170
- "complexType": {
171
- "original": "IEditorProfileDefinition | IPredefinedProfile",
172
- "resolved": "IEditorProfileDefinition | IPredefinedProfile",
173
- "references": {
174
- "IEditorProfileDefinition": {
175
- "location": "local",
176
- "path": "dist/utils/profile/types.d.ts",
177
- "id": "notImplemented"
178
- },
179
- "IPredefinedProfile": {
180
- "location": "local",
181
- "path": "dist/utils/profile/types.d.ts",
182
- "id": "notImplemented"
183
- }
184
- }
185
- },
186
- "mutable": true,
187
- "reflectToAttr": false,
188
- "docs": "The profile contains metadata used by the editor for editing context and help.\nExample:\n```\n {\n bundles: [\"core\", \"dataAccess\", \"geometry\", \"portal-access\"],\n variables: [\n {\n name: \"$feature\",\n description: \"The feature passed to the script during execution.\",\n definition: aFeatureLayerInstance\n }\n ]\n }\n```",
189
- "docsTags": [],
190
- "values": [
191
- {
192
- "type": "IEditorProfileDefinition"
193
- },
194
- {
195
- "type": "IPredefinedProfile"
196
- }
197
- ],
198
- "optional": true,
199
- "required": false
200
- },
201
- {
202
- "name": "script",
203
- "type": "string",
204
- "complexType": {
205
- "original": "string",
206
- "resolved": "string",
207
- "references": {}
208
- },
209
- "mutable": true,
210
- "attr": "script",
211
- "reflectToAttr": false,
212
- "docs": "The arcade script. Use this property to define or update the script.",
213
- "docsTags": [],
214
- "default": "\"\"",
215
- "values": [
216
- {
217
- "type": "string"
218
- }
219
- ],
220
- "optional": true,
221
- "required": false
222
- },
223
- {
224
- "name": "sideActionBarExpanded",
225
- "type": "boolean",
226
- "complexType": {
227
- "original": "boolean",
228
- "resolved": "boolean",
229
- "references": {}
230
- },
231
- "mutable": true,
232
- "attr": "side-action-bar-expanded",
233
- "reflectToAttr": true,
234
- "docs": "If true, the side action bar will be expanded",
235
- "docsTags": [],
236
- "default": "false",
237
- "values": [
238
- {
239
- "type": "boolean"
240
- }
241
- ],
242
- "optional": true,
243
- "required": false
244
- },
245
- {
246
- "name": "snippets",
247
- "type": "Array<ApiSnippet>",
248
- "complexType": {
249
- "original": "Array<ApiSnippet>",
250
- "resolved": "Array<ApiSnippet>",
251
- "references": {
252
- "Array": {
253
- "location": "import",
254
- "path": "typescript/lib/lib.es5.d.ts",
255
- "id": "notImplemented"
256
- },
257
- "ApiSnippet": {
258
- "location": "import",
259
- "path": "@arcgis/languages-api-utils/types.d.ts",
260
- "id": "notImplemented"
261
- }
262
- }
263
- },
264
- "mutable": true,
265
- "reflectToAttr": false,
266
- "docs": "Collection of snippets",
267
- "docsTags": [],
268
- "values": [],
269
- "optional": true,
270
- "required": false
271
- },
272
- {
273
- "name": "suggestions",
274
- "type": "Array<IEditorCodeSuggestion> | Array<IEditorCodeSuggestionGroup>",
275
- "complexType": {
276
- "original": "Array<IEditorCodeSuggestion> | Array<IEditorCodeSuggestionGroup>",
277
- "resolved": "Array<IEditorCodeSuggestion> | Array<IEditorCodeSuggestionGroup>",
278
- "references": {
279
- "Array": {
280
- "location": "import",
281
- "path": "typescript/lib/lib.es5.d.ts",
282
- "id": "notImplemented"
283
- },
284
- "IEditorCodeSuggestion": {
285
- "location": "local",
286
- "path": "dist/utils/editor-suggestions.d.ts",
287
- "id": "notImplemented"
288
- },
289
- "IEditorCodeSuggestionGroup": {
290
- "location": "local",
291
- "path": "dist/utils/editor-suggestions.d.ts",
292
- "id": "notImplemented"
293
- }
294
- }
295
- },
296
- "mutable": true,
297
- "reflectToAttr": false,
298
- "docs": "Collection of suggestions",
299
- "docsTags": [],
300
- "values": [
301
- {
302
- "type": "Array<IEditorCodeSuggestion>"
303
- },
304
- {
305
- "type": "Array<IEditorCodeSuggestionGroup>"
306
- }
307
- ],
308
- "optional": true,
309
- "required": false
310
- },
311
- {
312
- "name": "testData",
313
- "type": "IEditorTestContext",
314
- "complexType": {
315
- "original": "IEditorTestContext",
316
- "resolved": "IEditorTestContext",
317
- "references": {
318
- "IEditorTestContext": {
319
- "location": "local",
320
- "path": "dist/utils/arcade-executor.d.ts",
321
- "id": "notImplemented"
322
- }
323
- }
324
- },
325
- "mutable": true,
326
- "reflectToAttr": false,
327
- "docs": "Test data used to execute the script in the editor. If undefined the execute script UX will be hidden.",
328
- "docsTags": [],
329
- "values": [],
330
- "optional": true,
331
- "required": false
332
- }
333
- ],
334
- "methods": [
335
- {
336
- "name": "componentOnReady",
337
- "returns": {
338
- "type": "Promise<this>",
339
- "docs": ""
340
- },
341
- "complexType": {
342
- "signature": "(): Promise<this>",
343
- "parameters": [],
344
- "return": "Promise<this>",
345
- "references": {
346
- "Promise": {
347
- "location": "import",
348
- "path": "typescript/lib/lib.es5.d.ts",
349
- "id": "notImplemented"
350
- }
351
- }
352
- },
353
- "signature": "componentOnReady(): Promise<this>",
354
- "parameters": [],
355
- "docs": "Create a promise that resolves once component is fully loaded.",
356
- "docsTags": [
357
- {
358
- "name": "example",
359
- "text": "```js\nconst arcgisArcadeEditor = document.querySelector(\"arcgis-arcade-editor\");\ndocument.body.append(arcgisArcadeEditor);\nawait arcgisArcadeEditor.componentOnReady();\nconsole.log(\"arcgis-arcade-editor is ready to go!\");\n```"
360
- },
361
- {
362
- "name": "inheritedFrom",
363
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
364
- }
365
- ]
366
- },
367
- {
368
- "name": "getScript",
369
- "returns": {
370
- "type": "Promise<string | undefined>",
371
- "docs": ""
372
- },
373
- "complexType": {
374
- "signature": "(): Promise<string | undefined>",
375
- "parameters": [],
376
- "return": "Promise<string | undefined>",
377
- "references": {
378
- "Promise": {
379
- "location": "import",
380
- "path": "typescript/lib/lib.es5.d.ts",
381
- "id": "notImplemented"
382
- }
383
- }
384
- },
385
- "signature": "getScript(): Promise<string | undefined>",
386
- "parameters": [],
387
- "docs": "",
388
- "docsTags": [],
389
- "deprecation": "**Deprecated** since 4.30. Use `script` property instead."
390
- },
391
- {
392
- "name": "getTestResult",
393
- "returns": {
394
- "type": "Promise<IArcadeResultUnknown | IArcadeResultNull | IArcadeResultError | IArcadeResultArray | IArcadeResultDate | IArcadeResultDateOnly | IArcadeResultTimeOnly | IArcadeResultString | IArcadeResultNumber | IArcadeResultBoolean | IArcadeResultDictionary | IArcadeResultGeometry | IArcadeResultKnowledgeGraph | IArcadeResultFeature | IArcadeResultPixel | IArcadeResultFeatureSet | IArcadeResultPortal | IArcadeResultAttachment>",
395
- "docs": ""
396
- },
397
- "complexType": {
398
- "signature": "(): Promise<ArcadeResult>",
399
- "parameters": [],
400
- "return": "Promise<IArcadeResultUnknown | IArcadeResultNull | IArcadeResultError | IArcadeResultArray | IArcadeResultDate | IArcadeResultDateOnly | IArcadeResultTimeOnly | IArcadeResultString | IArcadeResultNumber | IArcadeResultBoolean | IArcadeResultDictionary | IArcadeResultGeometry | IArcadeResultKnowledgeGraph | IArcadeResultFeature | IArcadeResultPixel | IArcadeResultFeatureSet | IArcadeResultPortal | IArcadeResultAttachment>",
401
- "references": {
402
- "Promise": {
403
- "location": "import",
404
- "path": "typescript/lib/lib.es5.d.ts",
405
- "id": "notImplemented"
406
- },
407
- "IArcadeResultUnknown": {
408
- "location": "local",
409
- "path": "dist/utils/arcade-executor.d.ts",
410
- "id": "notImplemented"
411
- },
412
- "IArcadeResultNull": {
413
- "location": "local",
414
- "path": "dist/utils/arcade-executor.d.ts",
415
- "id": "notImplemented"
416
- },
417
- "IArcadeResultError": {
418
- "location": "local",
419
- "path": "dist/utils/arcade-executor.d.ts",
420
- "id": "notImplemented"
421
- },
422
- "IArcadeResultArray": {
423
- "location": "local",
424
- "path": "dist/utils/arcade-executor.d.ts",
425
- "id": "notImplemented"
426
- },
427
- "IArcadeResultDate": {
428
- "location": "local",
429
- "path": "dist/utils/arcade-executor.d.ts",
430
- "id": "notImplemented"
431
- },
432
- "IArcadeResultDateOnly": {
433
- "location": "local",
434
- "path": "dist/utils/arcade-executor.d.ts",
435
- "id": "notImplemented"
436
- },
437
- "IArcadeResultTimeOnly": {
438
- "location": "local",
439
- "path": "dist/utils/arcade-executor.d.ts",
440
- "id": "notImplemented"
441
- },
442
- "IArcadeResultString": {
443
- "location": "local",
444
- "path": "dist/utils/arcade-executor.d.ts",
445
- "id": "notImplemented"
446
- },
447
- "IArcadeResultNumber": {
448
- "location": "local",
449
- "path": "dist/utils/arcade-executor.d.ts",
450
- "id": "notImplemented"
451
- },
452
- "IArcadeResultBoolean": {
453
- "location": "local",
454
- "path": "dist/utils/arcade-executor.d.ts",
455
- "id": "notImplemented"
456
- },
457
- "IArcadeResultDictionary": {
458
- "location": "local",
459
- "path": "dist/utils/arcade-executor.d.ts",
460
- "id": "notImplemented"
461
- },
462
- "IArcadeResultGeometry": {
463
- "location": "local",
464
- "path": "dist/utils/arcade-executor.d.ts",
465
- "id": "notImplemented"
466
- },
467
- "IArcadeResultKnowledgeGraph": {
468
- "location": "local",
469
- "path": "dist/utils/arcade-executor.d.ts",
470
- "id": "notImplemented"
471
- },
472
- "IArcadeResultFeature": {
473
- "location": "local",
474
- "path": "dist/utils/arcade-executor.d.ts",
475
- "id": "notImplemented"
476
- },
477
- "IArcadeResultPixel": {
478
- "location": "local",
479
- "path": "dist/utils/arcade-executor.d.ts",
480
- "id": "notImplemented"
481
- },
482
- "IArcadeResultFeatureSet": {
483
- "location": "local",
484
- "path": "dist/utils/arcade-executor.d.ts",
485
- "id": "notImplemented"
486
- },
487
- "IArcadeResultPortal": {
488
- "location": "local",
489
- "path": "dist/utils/arcade-executor.d.ts",
490
- "id": "notImplemented"
491
- },
492
- "IArcadeResultAttachment": {
493
- "location": "local",
494
- "path": "dist/utils/arcade-executor.d.ts",
495
- "id": "notImplemented"
496
- }
497
- }
498
- },
499
- "signature": "getTestResult(): Promise<ArcadeResult>",
500
- "parameters": [],
501
- "docs": "Returns the Arcade result for the script for the provided test data.",
502
- "docsTags": []
503
- },
504
- {
505
- "name": "setFocus",
506
- "returns": {
507
- "type": "Promise<void>",
508
- "docs": ""
509
- },
510
- "complexType": {
511
- "signature": "(): Promise<void>",
512
- "parameters": [],
513
- "return": "Promise<void>",
514
- "references": {
515
- "Promise": {
516
- "location": "import",
517
- "path": "typescript/lib/lib.es5.d.ts",
518
- "id": "notImplemented"
519
- }
520
- }
521
- },
522
- "signature": "setFocus(): Promise<void>",
523
- "parameters": [],
524
- "docs": "Set the focus on the element.",
525
- "docsTags": []
526
- }
527
- ],
528
- "events": [
529
- {
530
- "event": "arcgisDiagnosticsChange",
531
- "detail": "Array<Diagnostic>",
532
- "bubbles": false,
533
- "complexType": {
534
- "original": "Array<Diagnostic>",
535
- "resolved": "Array<Diagnostic>",
536
- "references": {
537
- "Array": {
538
- "location": "import",
539
- "path": "typescript/lib/lib.es5.d.ts",
540
- "id": "notImplemented"
541
- },
542
- "Diagnostic": {
543
- "location": "import",
544
- "path": "@arcgis/arcade-languageservice/index.d.ts",
545
- "id": "notImplemented"
546
- }
547
- }
548
- },
549
- "cancelable": true,
550
- "composed": true,
551
- "docs": "Emitted when the diagnostics collection has changed.",
552
- "docsTags": []
553
- },
554
- {
555
- "event": "arcgisScriptChange",
556
- "detail": "string",
557
- "bubbles": false,
558
- "complexType": {
559
- "original": "string",
560
- "resolved": "string",
561
- "references": {}
562
- },
563
- "cancelable": true,
564
- "composed": true,
565
- "docs": "Emitted when the script string has changed.",
566
- "docsTags": []
567
- }
568
- ],
569
- "styles": [],
570
- "slots": [],
571
- "parts": [],
572
- "listeners": []
573
- },
574
- {
575
- "filePath": "src/components/code-editor/code-editor.tsx",
576
- "tag": "arcgis-code-editor",
577
- "overview": "",
578
- "readme": "",
579
- "usage": {},
580
- "docs": "",
581
- "docsTags": [
582
- {
583
- "name": "internal"
584
- },
585
- {
586
- "name": "superclass",
587
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
588
- }
589
- ],
590
- "encapsulation": "shadow",
591
- "dependents": [],
592
- "dependencies": [],
593
- "dependencyGraph": {},
594
- "props": [
595
- {
596
- "name": "editorInstance",
597
- "type": "IStandaloneCodeEditor",
598
- "complexType": {
599
- "original": "IStandaloneCodeEditor",
600
- "resolved": "IStandaloneCodeEditor",
601
- "references": {
602
- "IStandaloneCodeEditor": {
603
- "location": "import",
604
- "path": "monaco-editor/esm/vs/editor/editor.api.d.ts",
605
- "id": "notImplemented"
606
- }
607
- }
608
- },
609
- "mutable": true,
610
- "reflectToAttr": false,
611
- "docs": "The instance of the Monaco Editor after the component has been rendered.\nTo determine when a component is rendered, you can use componentOnReady() method.\nThe method returns a Promise that resolves after the component rendered for the first time.",
612
- "docsTags": [
613
- {
614
- "name": "readonly",
615
- "text": ""
616
- }
617
- ],
618
- "values": [],
619
- "optional": true,
620
- "required": false
621
- },
622
- {
623
- "name": "editorOptions",
624
- "type": "(IEditorOptions & IGlobalEditorOptions)",
625
- "complexType": {
626
- "original": "(IEditorOptions & IGlobalEditorOptions)",
627
- "resolved": "(IEditorOptions & IGlobalEditorOptions)",
628
- "references": {
629
- "IEditorOptions": {
630
- "location": "import",
631
- "path": "monaco-editor/esm/vs/editor/editor.api.d.ts",
632
- "id": "notImplemented"
633
- },
634
- "IGlobalEditorOptions": {
635
- "location": "import",
636
- "path": "monaco-editor/esm/vs/editor/editor.api.d.ts",
637
- "id": "notImplemented"
638
- }
639
- }
640
- },
641
- "mutable": true,
642
- "reflectToAttr": false,
643
- "docs": "Options to update on the editor.\nFor example:\n```json\n{\n \"fontSize\": 18\n}\n```\n\nTo get the full list of options set on the editor, use the editorInstance property and see Monaco Editor options documentation for more details.",
644
- "docsTags": [],
645
- "values": [],
646
- "optional": true,
647
- "required": false
648
- },
649
- {
650
- "name": "language",
651
- "type": "string",
652
- "complexType": {
653
- "original": "string",
654
- "resolved": "string",
655
- "references": {}
656
- },
657
- "mutable": true,
658
- "attr": "language",
659
- "reflectToAttr": false,
660
- "docs": "The language for the editor.\nCurrently supported language: arcade, arcgis-sql-expression, json, css, html, javascript, typescript, and text.",
661
- "docsTags": [],
662
- "values": [
663
- {
664
- "type": "string"
665
- }
666
- ],
667
- "optional": true,
668
- "required": false
669
- },
670
- {
671
- "name": "modelId",
672
- "type": "`${string}-${string}-${string}-${string}-${string}`",
673
- "complexType": {
674
- "original": "`${string}-${string}-${string}-${string}-${string}`",
675
- "resolved": "`${string}-${string}-${string}-${string}-${string}`",
676
- "references": {}
677
- },
678
- "mutable": true,
679
- "reflectToAttr": false,
680
- "docs": "A unique identifier for the model.\nThe unique identifier is sometimes used by language defaults to store model metadata.\nFor example, with arcade, the model id is used to store the arcade profile and other metadata.\nThe unique identifier is especially useful when there are multiple editors on the same page.",
681
- "docsTags": [],
682
- "values": [],
683
- "optional": true,
684
- "required": false
685
- },
686
- {
687
- "name": "value",
688
- "type": "string",
689
- "complexType": {
690
- "original": "string",
691
- "resolved": "string",
692
- "references": {}
693
- },
694
- "mutable": true,
695
- "attr": "value",
696
- "reflectToAttr": false,
697
- "docs": "The initial value for the editor.\nThe value is the script, code, css, json, etc.",
698
- "docsTags": [],
699
- "default": "\"\"",
700
- "values": [
701
- {
702
- "type": "string"
703
- }
704
- ],
705
- "optional": true,
706
- "required": false
707
- }
708
- ],
709
- "methods": [
710
- {
711
- "name": "componentOnReady",
712
- "returns": {
713
- "type": "Promise<this>",
714
- "docs": ""
715
- },
716
- "complexType": {
717
- "signature": "(): Promise<this>",
718
- "parameters": [],
719
- "return": "Promise<this>",
720
- "references": {
721
- "Promise": {
722
- "location": "import",
723
- "path": "typescript/lib/lib.es5.d.ts",
724
- "id": "notImplemented"
725
- }
726
- }
727
- },
728
- "signature": "componentOnReady(): Promise<this>",
729
- "parameters": [],
730
- "docs": "Create a promise that resolves once component is fully loaded.",
731
- "docsTags": [
732
- {
733
- "name": "example",
734
- "text": "```js\nconst arcgisCodeEditor = document.querySelector(\"arcgis-code-editor\");\ndocument.body.append(arcgisCodeEditor);\nawait arcgisCodeEditor.componentOnReady();\nconsole.log(\"arcgis-code-editor is ready to go!\");\n```"
735
- },
736
- {
737
- "name": "inheritedFrom",
738
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
739
- }
740
- ]
741
- },
742
- {
743
- "name": "getValue",
744
- "returns": {
745
- "type": "Promise<string>",
746
- "docs": ""
747
- },
748
- "complexType": {
749
- "signature": "(): Promise<string>",
750
- "parameters": [],
751
- "return": "Promise<string>",
752
- "references": {
753
- "Promise": {
754
- "location": "import",
755
- "path": "typescript/lib/lib.es5.d.ts",
756
- "id": "notImplemented"
757
- }
758
- }
759
- },
760
- "signature": "getValue(): Promise<string>",
761
- "parameters": [],
762
- "docs": "",
763
- "docsTags": [],
764
- "deprecation": "**Deprecated** since 4.30. Use `value` property instead."
765
- },
766
- {
767
- "name": "insertSnippet",
768
- "returns": {
769
- "type": "Promise<void>",
770
- "docs": ""
771
- },
772
- "complexType": {
773
- "signature": "(text: string | null | undefined): Promise<void>",
774
- "parameters": [
775
- {
776
- "name": "text",
777
- "type": "null | string | undefined",
778
- "docs": ""
779
- }
780
- ],
781
- "return": "Promise<void>",
782
- "references": {
783
- "Promise": {
784
- "location": "import",
785
- "path": "typescript/lib/lib.es5.d.ts",
786
- "id": "notImplemented"
787
- }
788
- }
789
- },
790
- "signature": "insertSnippet(text: string | null | undefined): Promise<void>",
791
- "parameters": [
792
- {
793
- "name": "text",
794
- "type": "null | string | undefined",
795
- "docs": ""
796
- }
797
- ],
798
- "docs": "Inserts a snippet at the current position in the editor.",
799
- "docsTags": [
800
- {
801
- "name": "param",
802
- "text": "text - The string snippet to insert"
803
- }
804
- ]
805
- },
806
- {
807
- "name": "insertText",
808
- "returns": {
809
- "type": "Promise<void>",
810
- "docs": ""
811
- },
812
- "complexType": {
813
- "signature": "(text: string | null | undefined): Promise<void>",
814
- "parameters": [
815
- {
816
- "name": "text",
817
- "type": "null | string | undefined",
818
- "docs": ""
819
- }
820
- ],
821
- "return": "Promise<void>",
822
- "references": {
823
- "Promise": {
824
- "location": "import",
825
- "path": "typescript/lib/lib.es5.d.ts",
826
- "id": "notImplemented"
827
- }
828
- }
829
- },
830
- "signature": "insertText(text: string | null | undefined): Promise<void>",
831
- "parameters": [
832
- {
833
- "name": "text",
834
- "type": "null | string | undefined",
835
- "docs": ""
836
- }
837
- ],
838
- "docs": "Inserts a text at the current position in the editor.",
839
- "docsTags": [
840
- {
841
- "name": "param",
842
- "text": "text - The string to insert"
843
- }
844
- ]
845
- },
846
- {
847
- "name": "setFocus",
848
- "returns": {
849
- "type": "Promise<void>",
850
- "docs": ""
851
- },
852
- "complexType": {
853
- "signature": "(): Promise<void>",
854
- "parameters": [],
855
- "return": "Promise<void>",
856
- "references": {
857
- "Promise": {
858
- "location": "import",
859
- "path": "typescript/lib/lib.es5.d.ts",
860
- "id": "notImplemented"
861
- }
862
- }
863
- },
864
- "signature": "setFocus(): Promise<void>",
865
- "parameters": [],
866
- "docs": "Sets the focus on the editor.",
867
- "docsTags": []
868
- },
869
- {
870
- "name": "setValue",
871
- "returns": {
872
- "type": "Promise<void>",
873
- "docs": ""
874
- },
875
- "complexType": {
876
- "signature": "(text: string | null | undefined): Promise<void>",
877
- "parameters": [
878
- {
879
- "name": "text",
880
- "type": "null | string | undefined",
881
- "docs": ""
882
- }
883
- ],
884
- "return": "Promise<void>",
885
- "references": {
886
- "Promise": {
887
- "location": "import",
888
- "path": "typescript/lib/lib.es5.d.ts",
889
- "id": "notImplemented"
890
- }
891
- }
892
- },
893
- "signature": "setValue(text: string | null | undefined): Promise<void>",
894
- "parameters": [
895
- {
896
- "name": "text",
897
- "type": "null | string | undefined",
898
- "docs": ""
899
- }
900
- ],
901
- "docs": "",
902
- "docsTags": [],
903
- "deprecation": "**Deprecated** since 4.30. Use `value` property instead."
904
- }
905
- ],
906
- "events": [
907
- {
908
- "event": "arcgisSelectionChange",
909
- "detail": "{\n selection: Selection;\n model: ITextModel | null | undefined;\n}",
910
- "bubbles": false,
911
- "complexType": {
912
- "original": "{\n selection: Selection;\n model: ITextModel | null | undefined;\n}",
913
- "resolved": "{\n selection: Selection;\n model: ITextModel | null | undefined;\n}",
914
- "references": {}
915
- },
916
- "cancelable": true,
917
- "composed": true,
918
- "docs": "Emitted when the selection has changed.",
919
- "docsTags": []
920
- },
921
- {
922
- "event": "arcgisValueChange",
923
- "detail": "string",
924
- "bubbles": false,
925
- "complexType": {
926
- "original": "string",
927
- "resolved": "string",
928
- "references": {}
929
- },
930
- "cancelable": true,
931
- "composed": true,
932
- "docs": "Emitted when the value has changed (script, code, css, json, etc.)",
933
- "docsTags": []
934
- }
935
- ],
936
- "styles": [],
937
- "slots": [],
938
- "parts": [],
939
- "listeners": []
940
- },
941
- {
942
- "filePath": "src/components/code-editor-shell/code-editor-shell.tsx",
943
- "tag": "arcgis-code-editor-shell",
944
- "overview": "",
945
- "readme": "",
946
- "usage": {},
947
- "docs": "A layout component for code editors that provides slots for an editor, results panel, side panel, and action bars.",
948
- "docsTags": [
949
- {
950
- "name": "internal"
951
- },
952
- {
953
- "name": "superclass",
954
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
955
- }
956
- ],
957
- "encapsulation": "shadow",
958
- "dependents": [],
959
- "dependencies": [],
960
- "dependencyGraph": {},
961
- "props": [],
962
- "methods": [
963
- {
964
- "name": "componentOnReady",
965
- "returns": {
966
- "type": "Promise<this>",
967
- "docs": ""
968
- },
969
- "complexType": {
970
- "signature": "(): Promise<this>",
971
- "parameters": [],
972
- "return": "Promise<this>",
973
- "references": {
974
- "Promise": {
975
- "location": "import",
976
- "path": "typescript/lib/lib.es5.d.ts",
977
- "id": "notImplemented"
978
- }
979
- }
980
- },
981
- "signature": "componentOnReady(): Promise<this>",
982
- "parameters": [],
983
- "docs": "Create a promise that resolves once component is fully loaded.",
984
- "docsTags": [
985
- {
986
- "name": "example",
987
- "text": "```js\nconst codeEditorShell = document.querySelector(\"arcgis-code-editor-shell\");\ndocument.body.append(codeEditorShell);\nawait codeEditorShell.componentOnReady();\nconsole.log(\"arcgis-code-editor-shell is ready to go!\");\n```"
988
- },
989
- {
990
- "name": "inheritedFrom",
991
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
992
- }
993
- ]
994
- }
995
- ],
996
- "events": [],
997
- "styles": [
998
- {
999
- "name": "--arcgis-coding-components-border",
1000
- "annotation": "prop",
1001
- "docs": "The border style for the editor shell *"
1002
- },
1003
- {
1004
- "name": "--arcgis-coding-components-background-color",
1005
- "annotation": "prop",
1006
- "docs": "The background color for the editor shell *"
1007
- },
1008
- {
1009
- "name": "--arcgis-coding-components-side-action-bar-max-w",
1010
- "annotation": "prop",
1011
- "docs": "The max width for the side action bar *"
1012
- },
1013
- {
1014
- "name": "--arcgis-coding-components-code-editor-side-panel-w",
1015
- "annotation": "prop",
1016
- "docs": "The width for the code editor side panel *"
1017
- },
1018
- {
1019
- "name": "--arcgis-coding-components-code-editor-side-panel-max-w",
1020
- "annotation": "prop",
1021
- "docs": "The max width for the code editor side panel *"
1022
- },
1023
- {
1024
- "name": "--arcgis-coding-components-code-editor-results-panel-max-h",
1025
- "annotation": "prop",
1026
- "docs": "The max height for the code editor results panel *"
1027
- },
1028
- {
1029
- "name": "--arcgis-coding-components-code-editor-results-panel-h",
1030
- "annotation": "prop",
1031
- "docs": "The default height for the code editor results panel (preferred over min-h). *"
1032
- }
1033
- ],
1034
- "slots": [
1035
- {
1036
- "name": "top-action-bar",
1037
- "docs": "A slot for placing a top action bar above the editor area."
1038
- },
1039
- {
1040
- "name": "editor",
1041
- "docs": "A slot for placing the main code editor component."
1042
- },
1043
- {
1044
- "name": "results-panel",
1045
- "docs": "A slot for placing a results panel below the code editor."
1046
- },
1047
- {
1048
- "name": "side-panel",
1049
- "docs": "A slot for placing a side panel next to the code editor area."
1050
- },
1051
- {
1052
- "name": "side-action-bar",
1053
- "docs": "A slot for placing a side action bar next to the side panel."
1054
- }
1055
- ],
1056
- "parts": [],
1057
- "listeners": []
1058
- },
1059
- {
1060
- "filePath": "src/components/code-viewer/code-viewer.tsx",
1061
- "tag": "arcgis-code-viewer",
1062
- "overview": "",
1063
- "readme": "",
1064
- "usage": {},
1065
- "docs": "A code viewer component for displaying code snippets.\nSupports syntax highlighting for various programming languages, include arcade and arcgis-sql-expression.",
1066
- "docsTags": [
1067
- {
1068
- "name": "example",
1069
- "text": "```tsx\n<arcgis-code-viewer language=\"javascript\">\nfunction greet() {\n console.log(\"Hello, World!\");\n}\n</arcgis-code-viewer>\n```"
1070
- },
1071
- {
1072
- "name": "example",
1073
- "text": "HTML snippets (preserve markup)\n```tsx\n<arcgis-code-viewer language=\"html\">\n<template>\n<div class=\"greeting\"><span>Hello</span> World!</div>\n</template>\n</arcgis-code-viewer>\n```\nWhen `language=\"html\"`, the component will attempt to preserve your original markup instead of reducing it\nto plain text. For safety and to prevent the markup from rendering in-page, wrap the snippet in a `<template>`.\nIf no `<template>` is provided, the component falls back to concatenating the `outerHTML` of element nodes and the\nraw text of text nodes. Script contents are treated as inert string data; they are never executed."
1074
- },
1075
- {
1076
- "name": "internal"
1077
- },
1078
- {
1079
- "name": "superclass",
1080
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
1081
- }
1082
- ],
1083
- "encapsulation": "shadow",
1084
- "dependents": [],
1085
- "dependencies": [],
1086
- "dependencyGraph": {},
1087
- "props": [
1088
- {
1089
- "name": "language",
1090
- "type": "string",
1091
- "complexType": {
1092
- "original": "string",
1093
- "resolved": "string",
1094
- "references": {}
1095
- },
1096
- "mutable": true,
1097
- "attr": "language",
1098
- "reflectToAttr": false,
1099
- "docs": "The language for the component.\nCurrently supported language: arcade, arcgis-sql-expression, plus all the following languages found in monaco-editor's repo:\nhttps://github.com/microsoft/monaco-editor/tree/main/src/basic-languages.\n\nNote: The number of supported languages is limited in cdn builds to reduce package size. In cdn builds,\nonly the following languages are supported: css, html, javascript, typescript, and arcade, arcgis-sql-expression.",
1100
- "docsTags": [],
1101
- "default": "\"arcade\"",
1102
- "values": [
1103
- {
1104
- "type": "string"
1105
- }
1106
- ],
1107
- "optional": true,
1108
- "required": false
1109
- },
1110
- {
1111
- "name": "round",
1112
- "type": "boolean",
1113
- "complexType": {
1114
- "original": "boolean",
1115
- "resolved": "boolean",
1116
- "references": {}
1117
- },
1118
- "mutable": true,
1119
- "attr": "round",
1120
- "reflectToAttr": true,
1121
- "docs": "When `true`, adds a round style to the component.",
1122
- "docsTags": [],
1123
- "default": "false",
1124
- "values": [
1125
- {
1126
- "type": "boolean"
1127
- }
1128
- ],
1129
- "optional": true,
1130
- "required": false
1131
- }
1132
- ],
1133
- "methods": [
1134
- {
1135
- "name": "componentOnReady",
1136
- "returns": {
1137
- "type": "Promise<this>",
1138
- "docs": ""
1139
- },
1140
- "complexType": {
1141
- "signature": "(): Promise<this>",
1142
- "parameters": [],
1143
- "return": "Promise<this>",
1144
- "references": {
1145
- "Promise": {
1146
- "location": "import",
1147
- "path": "typescript/lib/lib.es5.d.ts",
1148
- "id": "notImplemented"
1149
- }
1150
- }
1151
- },
1152
- "signature": "componentOnReady(): Promise<this>",
1153
- "parameters": [],
1154
- "docs": "Create a promise that resolves once component is fully loaded.",
1155
- "docsTags": [
1156
- {
1157
- "name": "example",
1158
- "text": "```js\nconst arcgisCodeViewer = document.querySelector(\"arcgis-code-viewer\");\ndocument.body.append(arcgisCodeViewer);\nawait arcgisCodeViewer.componentOnReady();\nconsole.log(\"arcgis-code-viewer is ready to go!\");\n```"
1159
- },
1160
- {
1161
- "name": "inheritedFrom",
1162
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
1163
- }
1164
- ]
1165
- }
1166
- ],
1167
- "events": [],
1168
- "styles": [],
1169
- "slots": [],
1170
- "parts": [],
1171
- "listeners": []
1172
- },
1173
- {
1174
- "filePath": "src/components/sql-expression-editor/sql-expression-editor.tsx",
1175
- "tag": "arcgis-sql-expression-editor",
1176
- "overview": "",
1177
- "readme": "",
1178
- "usage": {},
1179
- "docs": "The SQL Expression Editor provides a familiar code editor experience for writing your own SQL expressions.\nIt supports syntax highlighting, code completion, and validation, allowing users to write SQL expressions using the\n[standardized SQL functions](https://doc.arcgis.com/en/arcgis-online/reference/sql-agol.htm) supported by ArcGIS.",
1180
- "docsTags": [
1181
- {
1182
- "name": "internal"
1183
- },
1184
- {
1185
- "name": "superclass",
1186
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
1187
- }
1188
- ],
1189
- "encapsulation": "shadow",
1190
- "dependents": [],
1191
- "dependencies": [],
1192
- "dependencyGraph": {},
1193
- "props": [
1194
- {
1195
- "name": "hideSideBar",
1196
- "type": "boolean",
1197
- "complexType": {
1198
- "original": "boolean",
1199
- "resolved": "boolean",
1200
- "references": {}
1201
- },
1202
- "mutable": true,
1203
- "attr": "hide-side-bar",
1204
- "reflectToAttr": false,
1205
- "docs": "If true, it will hide the side actions bar. The editor will be in a minimalistic UX.",
1206
- "docsTags": [
1207
- {
1208
- "name": "example",
1209
- "text": "```html\n <arcgis-sql-expression-editor hideSideBar></arcgis-sql-expression-editor>\n```"
1210
- }
1211
- ],
1212
- "default": "false",
1213
- "values": [
1214
- {
1215
- "type": "boolean"
1216
- }
1217
- ],
1218
- "optional": true,
1219
- "required": false
1220
- },
1221
- {
1222
- "name": "profile",
1223
- "type": "IPredefinedProfile",
1224
- "complexType": {
1225
- "original": "IPredefinedProfile",
1226
- "resolved": "IPredefinedProfile",
1227
- "references": {
1228
- "IPredefinedProfile": {
1229
- "location": "local",
1230
- "path": "dist/utils/profile/types.d.ts",
1231
- "id": "notImplemented"
1232
- }
1233
- }
1234
- },
1235
- "mutable": true,
1236
- "reflectToAttr": false,
1237
- "docs": "The profile to use for the editor. The profile defines the variables and functions that are available to the editor.",
1238
- "docsTags": [
1239
- {
1240
- "name": "example",
1241
- "text": "```jsx\n<arcgis-sql-expression-editor profile={id: \"field-calculation\", definitions: { $layer: layer }}></arcgis-sql-expression-editor>\n```"
1242
- }
1243
- ],
1244
- "values": [],
1245
- "optional": true,
1246
- "required": false
1247
- },
1248
- {
1249
- "name": "script",
1250
- "type": "string",
1251
- "complexType": {
1252
- "original": "string",
1253
- "resolved": "string",
1254
- "references": {}
1255
- },
1256
- "mutable": true,
1257
- "attr": "script",
1258
- "reflectToAttr": false,
1259
- "docs": "The sql expression script. Use this property to define or update the script.",
1260
- "docsTags": [
1261
- {
1262
- "name": "example",
1263
- "text": "```html\n<arcgis-sql-expression-editor script=\"CAST(2.45 AS INTEGER)\"></arcgis-sql-expression-editor>\n```"
1264
- }
1265
- ],
1266
- "default": "\"\"",
1267
- "values": [
1268
- {
1269
- "type": "string"
1270
- }
1271
- ],
1272
- "optional": true,
1273
- "required": false
1274
- }
1275
- ],
1276
- "methods": [
1277
- {
1278
- "name": "componentOnReady",
1279
- "returns": {
1280
- "type": "Promise<this>",
1281
- "docs": ""
1282
- },
1283
- "complexType": {
1284
- "signature": "(): Promise<this>",
1285
- "parameters": [],
1286
- "return": "Promise<this>",
1287
- "references": {
1288
- "Promise": {
1289
- "location": "import",
1290
- "path": "typescript/lib/lib.es5.d.ts",
1291
- "id": "notImplemented"
1292
- }
1293
- }
1294
- },
1295
- "signature": "componentOnReady(): Promise<this>",
1296
- "parameters": [],
1297
- "docs": "Create a promise that resolves once component is fully loaded.",
1298
- "docsTags": [
1299
- {
1300
- "name": "example",
1301
- "text": "```js\nconst arcgisSqlExpressionEditor = document.querySelector(\"arcgis-sql-expression-editor\");\ndocument.body.append(arcgisSqlExpressionEditor);\nawait arcgisSqlExpressionEditor.componentOnReady();\nconsole.log(\"arcgis-sql-expression-editor is ready to go!\");\n```"
1302
- },
1303
- {
1304
- "name": "inheritedFrom",
1305
- "text": "{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"
1306
- }
1307
- ]
1308
- },
1309
- {
1310
- "name": "setFocus",
1311
- "returns": {
1312
- "type": "Promise<void>",
1313
- "docs": ""
1314
- },
1315
- "complexType": {
1316
- "signature": "(): Promise<void>",
1317
- "parameters": [],
1318
- "return": "Promise<void>",
1319
- "references": {
1320
- "Promise": {
1321
- "location": "import",
1322
- "path": "typescript/lib/lib.es5.d.ts",
1323
- "id": "notImplemented"
1324
- }
1325
- }
1326
- },
1327
- "signature": "setFocus(): Promise<void>",
1328
- "parameters": [],
1329
- "docs": "Set the focus on the element.",
1330
- "docsTags": []
1331
- }
1332
- ],
1333
- "events": [
1334
- {
1335
- "event": "arcgisDiagnosticsChange",
1336
- "detail": "Array<IMarkerData>",
1337
- "bubbles": false,
1338
- "complexType": {
1339
- "original": "Array<IMarkerData>",
1340
- "resolved": "Array<IMarkerData>",
1341
- "references": {
1342
- "Array": {
1343
- "location": "import",
1344
- "path": "typescript/lib/lib.es5.d.ts",
1345
- "id": "notImplemented"
1346
- },
1347
- "IMarkerData": {
1348
- "location": "import",
1349
- "path": "monaco-editor/esm/vs/editor/editor.api.d.ts",
1350
- "id": "notImplemented"
1351
- }
1352
- }
1353
- },
1354
- "cancelable": true,
1355
- "composed": true,
1356
- "docs": "Emitted when the diagnostics collection has changed.",
1357
- "docsTags": []
1358
- },
1359
- {
1360
- "event": "arcgisScriptChange",
1361
- "detail": "string",
1362
- "bubbles": false,
1363
- "complexType": {
1364
- "original": "string",
1365
- "resolved": "string",
1366
- "references": {}
1367
- },
1368
- "cancelable": true,
1369
- "composed": true,
1370
- "docs": "Emitted when the script string has changed.",
1371
- "docsTags": []
1372
- }
1373
- ],
1374
- "styles": [],
1375
- "slots": [],
1376
- "parts": [],
1377
- "listeners": []
1378
- }
1379
- ],
1380
- "typeLibrary": {}
1381
- }
1
+ {"timestamp":"2026-01-20T01:20:50","compiler":{"name":"@arcgis/lumina-compiler","version":"5.0.0-next.137","typescriptVersion":"5.9.3"},"components":[{"filePath":"src/components/arcade-editor/arcade-editor.tsx","tag":"arcgis-arcade-editor","overview":"","readme":"","usage":{},"docs":"[**Arcade**](https://developers.arcgis.com/arcade/) is a portable, and lightweight expression language used to create custom content throughout the [ArcGIS system](https://www.esri.com/en-us/arcgis/products/index).\nLike other expression languages, it can perform mathematical calculations, format text, and evaluate logical statements.\nIt also supports multi-statement expressions, variables, and flow control statements. Arcade is unique when compared to other expression and scripting languages due to its inclusion of [feature](https://developers.arcgis.com/arcade/guide/types/#feature) and [geometry](https://developers.arcgis.com/arcade/guide/types/#geometry) data types.\n\nMap Viewer (MV) was the first ArcGIS Online product to incorporate the new Arcade editor after [the editor's introduction in the November 2022 ArcGIS Online release](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/introducing-the-new-arcade-editor-in-arcgis-online/).\nThis was possible thanks to the Arcade editor component, which enabled MV to implement its own Arcade expression builder.\nYou can now also find the editor in ArcGIS Dashboards, ArcGIS Field Maps, and ArcGIS Velocity.\n\nYou can easily get your own dedicated Arcade expression builder with the **Arcade editor** component, which includes:\n\n- An easy to use [layout](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/discover-the-arcade-editors-powerful-new-features/#the-new-layout)\n- An optional minimal layout if you, for example, decide to manually exclude things such as test data, padding, line numbers, and the sidebar\n- A way to execute Arcade expressions in a configurable code editor\n- [Suggestions and code completion](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/discover-the-arcade-editors-powerful-new-features/#suggestions-and-code-completion)\n- [WCAG 2.0 compliant code colorization / syntax highlighting](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/accessibility-and-arcade-working-in-color/)\n- Built-in [keyboard shortcuts](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/discover-the-arcade-editors-powerful-new-features/#keyboard-shortcuts)\n- In-editor help for finding information about profile variables relevant to your profile, documentation for constants and functions, a link to the official Arcade documentation, and, in some case, suggestions.\n- Support for many [languages and directionality](https://developers.arcgis.com/javascript/latest/localization/)","docsTags":[{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"arcadeAssistant","type":"ArcadeAssistantConfig | undefined","complexType":{"original":"ArcadeAssistantConfig | undefined","resolved":"ArcadeAssistantConfig | undefined","references":{"ArcadeAssistantConfig":{"location":"local","path":"utils/arcade-assistant/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"enables and configures the arcade assistant @internal","docsTags":[],"values":[],"optional":true,"required":false},{"name":"customPanels","type":"ICustomPanel[] | undefined","complexType":{"original":"ICustomPanel[] | undefined","resolved":"ICustomPanel[] | undefined","references":{"ICustomPanel":{"location":"local","path":"utils/custom-panel","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Custom panels to be displayed in the side panel.\nWill be placed below the default panels but above the help panel.","docsTags":[{"name":"internal"}],"values":[],"optional":true,"required":false},{"name":"editorOptions","type":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined","complexType":{"original":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined","resolved":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined","references":{"editor":{"location":"import","path":"monaco-editor","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Options to update on the editor.\nFor example:\n```json\n{\n \"fontSize\": 18\n}\n```\n\nTo get the full list of available options, see the Monaco Editor options [documentation](https://microsoft.github.io/monaco-editor/typedoc/variables/editor.EditorOptions.html) for more details.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"hideDocumentationActions","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-documentation-actions","reflectToAttr":false,"docs":"If true, it will hide the documentation action in the side panel","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"hideSideBar","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-side-bar","reflectToAttr":false,"docs":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"openedSidePanel","type":"T extends Required<WithCustomPanels> ? SidePanelName : string","complexType":{"original":"T extends Required<WithCustomPanels> ? SidePanelName : string","resolved":"T extends Required<WithCustomPanels> ? SidePanelName : string","references":{"T":{"location":"local","id":"notImplemented"},"Required":{"location":"global","path":"global:","id":"notImplemented"},"WithCustomPanels":{"location":"local","id":"notImplemented"},"SidePanelName":{"location":"local","id":"notImplemented"}}},"mutable":true,"attr":"opened-side-panel","reflectToAttr":true,"docs":"The name of the opened side panel. 'none' means 'no panel opened'.","docsTags":[],"default":"\"none\"","values":[],"optional":true,"required":false},{"name":"profile","type":"IEditorProfileDefinition | IPredefinedProfile | undefined","complexType":{"original":"IEditorProfileDefinition | IPredefinedProfile | undefined","resolved":"IEditorProfileDefinition | IPredefinedProfile | undefined","references":{"IEditorProfileDefinition":{"location":"local","path":"utils/profile/types","id":"notImplemented"},"IPredefinedProfile":{"location":"local","path":"utils/profile/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The profile contains metadata used by the editor for editing context and help.\nExample:\n```\n {\n bundles: [\"core\", \"dataAccess\", \"geometry\", \"portal-access\"],\n variables: [\n {\n name: \"$feature\",\n description: \"The feature passed to the script during execution.\",\n definition: aFeatureLayerInstance\n }\n ]\n }\n```","docsTags":[],"values":[],"optional":true,"required":false},{"name":"script","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"script","reflectToAttr":false,"docs":"The arcade script. Use this property to define or update the script.","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"sideActionBarExpanded","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"side-action-bar-expanded","reflectToAttr":true,"docs":"If true, the side action bar will be expanded","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"snippets","type":"ApiSnippet[] | undefined","complexType":{"original":"ApiSnippet[] | undefined","resolved":"ApiSnippet[] | undefined","references":{"ApiSnippet":{"location":"import","path":"@arcgis/languages-api-utils","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Collection of snippets","docsTags":[],"values":[],"optional":true,"required":false},{"name":"suggestions","type":"IEditorCodeSuggestion[] | IEditorCodeSuggestionGroup[] | undefined","complexType":{"original":"IEditorCodeSuggestion[] | IEditorCodeSuggestionGroup[] | undefined","resolved":"IEditorCodeSuggestion[] | IEditorCodeSuggestionGroup[] | undefined","references":{"IEditorCodeSuggestion":{"location":"local","path":"utils/editor-suggestions","id":"notImplemented"},"IEditorCodeSuggestionGroup":{"location":"local","path":"utils/editor-suggestions","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Collection of suggestions","docsTags":[],"values":[],"optional":true,"required":false},{"name":"testData","type":"IEditorTestContext | undefined","complexType":{"original":"IEditorTestContext | undefined","resolved":"IEditorTestContext | undefined","references":{"IEditorTestContext":{"location":"local","path":"utils/arcade-executor","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Test data used to execute the script in the editor. If undefined the execute script UX will be hidden.","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Create a promise that resolves once component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisArcadeEditor = document.querySelector(\"arcgis-arcade-editor\");\ndocument.body.append(arcgisArcadeEditor);\nawait arcgisArcadeEditor.componentOnReady();\nconsole.log(\"arcgis-arcade-editor is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]},{"name":"getScript","returns":{"type":"Promise<string | undefined>","docs":""},"complexType":{"signature":"(): Promise<string | undefined>","parameters":[],"return":"Promise<string | undefined>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"getScript(): Promise<string | undefined>","parameters":[],"docs":"","docsTags":[],"deprecation":"**Deprecated** since 4.30. Use `script` property instead."},{"name":"getTestResult","returns":{"type":"Promise<ArcadeResult>","docs":""},"complexType":{"signature":"(): Promise<ArcadeResult>","parameters":[],"return":"Promise<ArcadeResult>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"},"ArcadeResult":{"location":"local","path":"utils/arcade-executor","id":"notImplemented"}}},"signature":"getTestResult(): Promise<ArcadeResult>","parameters":[],"docs":"Returns the Arcade result for the script for the provided test data.","docsTags":[]},{"name":"setFocus","returns":{"type":"Promise<void>","docs":""},"complexType":{"signature":"(): Promise<void>","parameters":[],"return":"Promise<void>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setFocus(): Promise<void>","parameters":[],"docs":"Set the focus on the element.","docsTags":[]}],"events":[{"event":"arcgisDiagnosticsChange","detail":"Diagnostic[]","bubbles":false,"complexType":{"original":"Diagnostic[]","resolved":"Diagnostic[]","references":{"Diagnostic":{"location":"import","path":"@arcgis/arcade-languageservice","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when the diagnostics collection has changed.","docsTags":[]},{"event":"arcgisScriptChange","detail":"string","bubbles":false,"complexType":{"original":"string","resolved":"string","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the script string has changed.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/code-editor/code-editor.tsx","tag":"arcgis-code-editor","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"editorInstance","type":"Editor.IStandaloneCodeEditor | undefined","complexType":{"original":"Editor.IStandaloneCodeEditor | undefined","resolved":"Editor.IStandaloneCodeEditor | undefined","references":{"editor":{"location":"import","path":"monaco-editor","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The instance of the Monaco Editor after the component has been rendered.\nTo determine when a component is rendered, you can use componentOnReady() method.\nThe method returns a Promise that resolves after the component rendered for the first time.","docsTags":[{"name":"readonly","text":""}],"values":[],"optional":true,"required":false},{"name":"editorOptions","type":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined","complexType":{"original":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined","resolved":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined","references":{"editor":{"location":"import","path":"monaco-editor","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"Options to update on the editor.\nFor example:\n```json\n{\n \"fontSize\": 18\n}\n```\n\nTo get the full list of options set on the editor, use the editorInstance property and see Monaco Editor options documentation for more details.","docsTags":[],"values":[],"optional":true,"required":false},{"name":"language","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"language","reflectToAttr":false,"docs":"The language for the editor.\nCurrently supported language: arcade, arcgis-sql-expression, json, css, html, javascript, typescript, and text.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"modelId","type":"`${string}-${string}-${string}-${string}-${string}`","complexType":{"original":"`${string}-${string}-${string}-${string}-${string}`","resolved":"`${string}-${string}-${string}-${string}-${string}`","references":{}},"mutable":true,"attr":"model-id","reflectToAttr":false,"docs":"A unique identifier for the model.\nThe unique identifier is sometimes used by language defaults to store model metadata.\nFor example, with arcade, the model id is used to store the arcade profile and other metadata.\nThe unique identifier is especially useful when there are multiple editors on the same page.","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"value","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"value","reflectToAttr":false,"docs":"The initial value for the editor.\nThe value is the script, code, css, json, etc.","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Create a promise that resolves once component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisCodeEditor = document.querySelector(\"arcgis-code-editor\");\ndocument.body.append(arcgisCodeEditor);\nawait arcgisCodeEditor.componentOnReady();\nconsole.log(\"arcgis-code-editor is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]},{"name":"getValue","returns":{"type":"Promise<string>","docs":""},"complexType":{"signature":"(): Promise<string>","parameters":[],"return":"Promise<string>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"getValue(): Promise<string>","parameters":[],"docs":"","docsTags":[],"deprecation":"**Deprecated** since 4.30. Use `value` property instead."},{"name":"insertSnippet","returns":{"type":"Promise<void>","docs":""},"complexType":{"signature":"(text: string | null | undefined): Promise<void>","parameters":[{"name":"text","type":"string | null | undefined","docs":"The string snippet to insert"}],"return":"Promise<void>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"insertSnippet(text: string | null | undefined): Promise<void>","parameters":[{"name":"text","type":"string | null | undefined","docs":"The string snippet to insert"}],"docs":"Inserts a snippet at the current position in the editor.","docsTags":[]},{"name":"insertText","returns":{"type":"Promise<void>","docs":""},"complexType":{"signature":"(text: string | null | undefined): Promise<void>","parameters":[{"name":"text","type":"string | null | undefined","docs":"The string to insert"}],"return":"Promise<void>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"insertText(text: string | null | undefined): Promise<void>","parameters":[{"name":"text","type":"string | null | undefined","docs":"The string to insert"}],"docs":"Inserts a text at the current position in the editor.","docsTags":[]},{"name":"setFocus","returns":{"type":"Promise<void>","docs":""},"complexType":{"signature":"(): Promise<void>","parameters":[],"return":"Promise<void>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setFocus(): Promise<void>","parameters":[],"docs":"Sets the focus on the editor.","docsTags":[]},{"name":"setValue","returns":{"type":"Promise<void>","docs":""},"complexType":{"signature":"(text: string | null | undefined): Promise<void>","parameters":[{"name":"text","type":"string | null | undefined","docs":""}],"return":"Promise<void>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setValue(text: string | null | undefined): Promise<void>","parameters":[{"name":"text","type":"string | null | undefined","docs":""}],"docs":"","docsTags":[],"deprecation":"**Deprecated** since 4.30. Use `value` property instead."}],"events":[{"event":"arcgisSelectionChange","detail":"{\n selection: Selection;\n model: Editor.ITextModel | null | undefined;\n}","bubbles":false,"complexType":{"original":"{\n selection: Selection;\n model: Editor.ITextModel | null | undefined;\n}","resolved":"{\n selection: Selection;\n model: Editor.ITextModel | null | undefined;\n}","references":{"Selection":{"location":"import","path":"monaco-editor","id":"notImplemented"},"editor":{"location":"import","path":"monaco-editor","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when the selection has changed.","docsTags":[]},{"event":"arcgisValueChange","detail":"string","bubbles":false,"complexType":{"original":"string","resolved":"string","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the value has changed (script, code, css, json, etc.)","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/code-editor-shell/code-editor-shell.tsx","tag":"arcgis-code-editor-shell","overview":"","readme":"","usage":{},"docs":"A layout component for code editors that provides slots for an editor, results panel, side panel, and action bars.","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Create a promise that resolves once component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst codeEditorShell = document.querySelector(\"arcgis-code-editor-shell\");\ndocument.body.append(codeEditorShell);\nawait codeEditorShell.componentOnReady();\nconsole.log(\"arcgis-code-editor-shell is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[{"name":"--arcgis-coding-components-border","annotation":"prop","docs":"The border style for the editor shell *"},{"name":"--arcgis-coding-components-background-color","annotation":"prop","docs":"The background color for the editor shell *"},{"name":"--arcgis-coding-components-side-action-bar-max-w","annotation":"prop","docs":"The max width for the side action bar *"},{"name":"--arcgis-coding-components-code-editor-side-panel-w","annotation":"prop","docs":"The width for the code editor side panel *"},{"name":"--arcgis-coding-components-code-editor-side-panel-max-w","annotation":"prop","docs":"The max width for the code editor side panel *"},{"name":"--arcgis-coding-components-code-editor-results-panel-max-h","annotation":"prop","docs":"The max height for the code editor results panel *"},{"name":"--arcgis-coding-components-code-editor-results-panel-h","annotation":"prop","docs":"The default height for the code editor results panel (preferred over min-h). *"}],"slots":[{"name":"top-action-bar","docs":"A slot for placing a top action bar above the editor area."},{"name":"editor","docs":"A slot for placing the main code editor component."},{"name":"results-panel","docs":"A slot for placing a results panel below the code editor."},{"name":"side-panel","docs":"A slot for placing a side panel next to the code editor area."},{"name":"side-action-bar","docs":"A slot for placing a side action bar next to the side panel."}],"parts":[],"listeners":[]},{"filePath":"src/components/code-viewer/code-viewer.tsx","tag":"arcgis-code-viewer","overview":"","readme":"","usage":{},"docs":"A code viewer component for displaying code snippets.\nSupports syntax highlighting for various programming languages, include arcade and arcgis-sql-expression.","docsTags":[{"name":"example","text":"```tsx\n<arcgis-code-viewer language=\"javascript\">\nfunction greet() {\n console.log(\"Hello, World!\");\n}\n</arcgis-code-viewer>\n```"},{"name":"example","text":"HTML snippets (preserve markup)\n```tsx\n<arcgis-code-viewer language=\"html\">\n <template>\n <div class=\"greeting\"><span>Hello</span> World!</div>\n </template>\n</arcgis-code-viewer>\n```\nWhen `language=\"html\"`, the component will attempt to preserve your original markup instead of reducing it\nto plain text. For safety and to prevent the markup from rendering in-page, wrap the snippet in a `<template>`.\nIf no `<template>` is provided, the component falls back to concatenating the `outerHTML` of element nodes and the\nraw text of text nodes. Script contents are treated as inert string data; they are never executed."},{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"language","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"language","reflectToAttr":false,"docs":"The language for the component.\nCurrently supported language: arcade, arcgis-sql-expression, plus all the following languages found in monaco-editor's repo:\nhttps://github.com/microsoft/monaco-editor/tree/main/src/basic-languages.\n\nNote: The number of supported languages is limited in cdn builds to reduce package size. In cdn builds,\nonly the following languages are supported: css, html, javascript, typescript, and arcade, arcgis-sql-expression.","docsTags":[],"default":"\"arcade\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"round","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"round","reflectToAttr":true,"docs":"When `true`, adds a round style to the component.","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Create a promise that resolves once component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisCodeViewer = document.querySelector(\"arcgis-code-viewer\");\ndocument.body.append(arcgisCodeViewer);\nawait arcgisCodeViewer.componentOnReady();\nconsole.log(\"arcgis-code-viewer is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/sql-expression-editor/sql-expression-editor.tsx","tag":"arcgis-sql-expression-editor","overview":"","readme":"","usage":{},"docs":"The SQL Expression Editor provides a familiar code editor experience for writing your own SQL expressions.\nIt supports syntax highlighting, code completion, and validation, allowing users to write SQL expressions using the\n[standardized SQL functions](https://doc.arcgis.com/en/arcgis-online/reference/sql-agol.htm) supported by ArcGIS.","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"hideSideBar","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"hide-side-bar","reflectToAttr":false,"docs":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","docsTags":[{"name":"example","text":"```html\n <arcgis-sql-expression-editor hideSideBar></arcgis-sql-expression-editor>\n```"}],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"profile","type":"IPredefinedProfile | undefined","complexType":{"original":"IPredefinedProfile | undefined","resolved":"IPredefinedProfile | undefined","references":{"IPredefinedProfile":{"location":"local","path":"utils/profile/types","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The profile to use for the editor. The profile defines the variables and functions that are available to the editor.","docsTags":[{"name":"example","text":"```jsx\n<arcgis-sql-expression-editor profile={id: \"field-calculation\", definitions: { $layer: layer }}></arcgis-sql-expression-editor>\n```"}],"values":[],"optional":true,"required":false},{"name":"script","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"script","reflectToAttr":false,"docs":"The sql expression script. Use this property to define or update the script.","docsTags":[{"name":"example","text":"```html\n<arcgis-sql-expression-editor script=\"CAST(2.45 AS INTEGER)\"></arcgis-sql-expression-editor>\n```"}],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Create a promise that resolves once component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisSqlExpressionEditor = document.querySelector(\"arcgis-sql-expression-editor\");\ndocument.body.append(arcgisSqlExpressionEditor);\nawait arcgisSqlExpressionEditor.componentOnReady();\nconsole.log(\"arcgis-sql-expression-editor is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]},{"name":"setFocus","returns":{"type":"Promise<void>","docs":""},"complexType":{"signature":"(): Promise<void>","parameters":[],"return":"Promise<void>","references":{"Promise":{"location":"global","path":"global:","id":"notImplemented"}}},"signature":"setFocus(): Promise<void>","parameters":[],"docs":"Set the focus on the element.","docsTags":[]}],"events":[{"event":"arcgisDiagnosticsChange","detail":"editor.IMarkerData[]","bubbles":false,"complexType":{"original":"editor.IMarkerData[]","resolved":"editor.IMarkerData[]","references":{"editor":{"location":"import","path":"monaco-editor","id":"notImplemented"}}},"cancelable":true,"composed":true,"docs":"Emitted when the diagnostics collection has changed.","docsTags":[]},{"event":"arcgisScriptChange","detail":"string","bubbles":false,"complexType":{"original":"string","resolved":"string","references":{}},"cancelable":true,"composed":true,"docs":"Emitted when the script string has changed.","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]}],"typeLibrary":{}}