@arcgis/coding-components 5.1.0-next.11 → 5.1.0-next.13

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.
@@ -1 +1 @@
1
- {"timestamp":"2026-02-10T04:41:01","compiler":{"name":"@arcgis/lumina-compiler","version":"5.1.0-next.11","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","docsTags":[{"name":"internal"}],"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":"Creates a promise that resolves once the 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":"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":"Creates a promise that resolves once the 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":"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":[]}],"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":"Creates a promise that resolves once the 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":"Creates a promise that resolves once the 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":"Creates a promise that resolves once the 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":{}}
1
+ {"timestamp":"2026-02-12T04:42:14","compiler":{"name":"@arcgis/lumina-compiler","version":"5.1.0-next.13","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","docsTags":[{"name":"internal"}],"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/docs.html#interfaces/editor_editor_api.editor.IEditorOptions.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":"string","complexType":{"original":"string","resolved":"string","references":{}},"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":[{"type":"string"}],"optional":true,"required":false},{"name":"profile","type":"IEditorProfileDefinition | IPredefinedProfile | undefined","complexType":{"original":"IEditorProfileDefinition | IPredefinedProfile | undefined","resolved":"IEditorProfileDefinition | IPredefinedProfile | undefined","references":{"IEditorProfileDefinition":{"location":"local","path":"components/types","id":"notImplemented"},"IPredefinedProfile":{"location":"local","path":"components/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":"components/types","id":"notImplemented"},"IEditorCodeSuggestionGroup":{"location":"local","path":"components/types","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":"components/types","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":"Creates a promise that resolves once the 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":"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":"internal"}]},{"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":"Creates a promise that resolves once the 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":"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":[]}],"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":"Creates a promise that resolves once the 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":"Creates a promise that resolves once the 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":"components/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":"Creates a promise that resolves once the 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":{}}
@@ -1 +1 @@
1
- {"$schema":"https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json","name":"@arcgis/coding-components","version":"5.1.0-next.11","description-markup":"markdown","contributions":{"html":{"elements":[{"name":"arcgis-arcade-editor","description":"[**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/)\n--\n\n### Events\n- **arcgisDiagnosticsChange** - Emitted when the diagnostics collection has changed.\n- **arcgisScriptChange** - Emitted when the script string has changed.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `getTestResult(): Promise<ArcadeResult>` - Returns the Arcade result for the script for the provided test data.\n- `setFocus(): Promise<void>` - Set the focus on the element.","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-arcade-editor/","attributes":[{"name":"hide-documentation-actions","description":"If true, it will hide the documentation action in the side panel","default":"false","value":{"type":"boolean"}},{"name":"hide-side-bar","description":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","default":"false","value":{"type":"boolean"}},{"name":"opened-side-panel","description":"The name of the opened side panel. 'none' means 'no panel opened'.","default":"\"none\"","value":{}},{"name":"script","description":"The arcade script. Use this property to define or update the script.","default":"\"\"","value":{"type":"string"}},{"name":"side-action-bar-expanded","description":"If true, the side action bar will be expanded","default":"false","value":{"type":"boolean"}}],"events":[{"name":"arcgisDiagnosticsChange","type":"Diagnostic[]","description":"Emitted when the diagnostics collection has changed."},{"name":"arcgisScriptChange","type":"string","description":"Emitted when the script string has changed."}],"js":{"properties":[{"name":"arcadeAssistant","description":"enables and configures the arcade assistant","type":"ArcadeAssistantConfig | undefined"},{"name":"customPanels","description":"Custom panels to be displayed in the side panel.\nWill be placed below the default panels but above the help panel.","type":"ICustomPanel[] | undefined"},{"name":"editorOptions","description":"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.","type":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined"},{"name":"hideDocumentationActions","description":"If true, it will hide the documentation action in the side panel","type":"boolean"},{"name":"hideSideBar","description":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","type":"boolean"},{"name":"openedSidePanel","description":"The name of the opened side panel. 'none' means 'no panel opened'.","type":"T extends Required<WithCustomPanels> ? SidePanelName : string"},{"name":"profile","description":"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```","type":"IEditorProfileDefinition | IPredefinedProfile | undefined"},{"name":"script","description":"The arcade script. Use this property to define or update the script.","type":"string"},{"name":"sideActionBarExpanded","description":"If true, the side action bar will be expanded","type":"boolean"},{"name":"snippets","description":"Collection of snippets","type":"ApiSnippet[] | undefined"},{"name":"suggestions","description":"Collection of suggestions","type":"IEditorCodeSuggestion[] | IEditorCodeSuggestionGroup[] | undefined"},{"name":"testData","description":"Test data used to execute the script in the editor. If undefined the execute script UX will be hidden.","type":"IEditorTestContext | undefined"}],"events":[{"name":"arcgisDiagnosticsChange","type":"Diagnostic[]","description":"Emitted when the diagnostics collection has changed."},{"name":"arcgisScriptChange","type":"string","description":"Emitted when the script string has changed."}]}},{"name":"arcgis-code-editor","description":"### Events\n- **arcgisSelectionChange** - Emitted when the selection has changed.\n- **arcgisValueChange** - Emitted when the value has changed (script, code, css, json, etc.)\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `insertSnippet(text: string | null | undefined): Promise<void>` - Inserts a snippet at the current position in the editor.\n- `insertText(text: string | null | undefined): Promise<void>` - Inserts a text at the current position in the editor.\n- `setFocus(): Promise<void>` - Sets the focus on the editor.","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-code-editor/","attributes":[{"name":"language","description":"The language for the editor.\nCurrently supported language: arcade, arcgis-sql-expression, json, css, html, javascript, typescript, and text.","value":{"type":"string"}},{"name":"model-id","description":"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.","value":{"type":"string"}},{"name":"value","description":"The initial value for the editor.\nThe value is the script, code, css, json, etc.","default":"\"\"","value":{"type":"string"}}],"events":[{"name":"arcgisSelectionChange","type":"{\n selection: Selection;\n model: Editor.ITextModel | null | undefined;\n}","description":"Emitted when the selection has changed."},{"name":"arcgisValueChange","type":"string","description":"Emitted when the value has changed (script, code, css, json, etc.)"}],"js":{"properties":[{"name":"editorInstance","description":"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.","type":"Editor.IStandaloneCodeEditor | undefined"},{"name":"editorOptions","description":"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.","type":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined"},{"name":"language","description":"The language for the editor.\nCurrently supported language: arcade, arcgis-sql-expression, json, css, html, javascript, typescript, and text.","type":"string | undefined"},{"name":"modelId","description":"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.","type":"`${string}-${string}-${string}-${string}-${string}`"},{"name":"value","description":"The initial value for the editor.\nThe value is the script, code, css, json, etc.","type":"string"}],"events":[{"name":"arcgisSelectionChange","type":"{\n selection: Selection;\n model: Editor.ITextModel | null | undefined;\n}","description":"Emitted when the selection has changed."},{"name":"arcgisValueChange","type":"string","description":"Emitted when the value has changed (script, code, css, json, etc.)"}]}},{"name":"arcgis-code-editor-shell","description":"A layout component for code editors that provides slots for an editor, results panel, side panel, and action bars.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- **top-action-bar** - A slot for placing a top action bar above the editor area.\n- **editor** - A slot for placing the main code editor component.\n- **results-panel** - A slot for placing a results panel below the code editor.\n- **side-panel** - A slot for placing a side panel next to the code editor area.\n- **side-action-bar** - A slot for placing a side action bar next to the side panel.\n\n### CSS Properties\n- **--arcgis-coding-components-border** - The border style for the editor shell * \n- **--arcgis-coding-components-background-color** - The background color for the editor shell * \n- **--arcgis-coding-components-side-action-bar-max-w** - The max width for the side action bar * \n- **--arcgis-coding-components-code-editor-side-panel-w** - The width for the code editor side panel * \n- **--arcgis-coding-components-code-editor-side-panel-max-w** - The max width for the code editor side panel * \n- **--arcgis-coding-components-code-editor-results-panel-max-h** - The max height for the code editor results panel * \n- **--arcgis-coding-components-code-editor-results-panel-h** - The default height for the code editor results panel (preferred over min-h). * ","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-code-editor-shell/","attributes":[],"slots":[{"name":"top-action-bar","description":"A slot for placing a top action bar above the editor area."},{"name":"editor","description":"A slot for placing the main code editor component."},{"name":"results-panel","description":"A slot for placing a results panel below the code editor."},{"name":"side-panel","description":"A slot for placing a side panel next to the code editor area."},{"name":"side-action-bar","description":"A slot for placing a side action bar next to the side panel."}],"events":[],"js":{"properties":[],"events":[]}},{"name":"arcgis-code-viewer","description":"A code viewer component for displaying code snippets.\nSupports syntax highlighting for various programming languages, include arcade and arcgis-sql-expression.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-code-viewer/","attributes":[{"name":"language","description":"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.","default":"\"arcade\"","value":{"type":"string"}},{"name":"round","description":"When `true`, adds a round style to the component.","default":"false","value":{"type":"boolean"}}],"events":[],"js":{"properties":[{"name":"language","description":"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.","type":"string"},{"name":"round","description":"When `true`, adds a round style to the component.","type":"boolean"}],"events":[]}},{"name":"arcgis-sql-expression-editor","description":"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.\n--\n\n### Events\n- **arcgisDiagnosticsChange** - Emitted when the diagnostics collection has changed.\n- **arcgisScriptChange** - Emitted when the script string has changed.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `setFocus(): Promise<void>` - Set the focus on the element.","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-sql-expression-editor/","attributes":[{"name":"hide-side-bar","description":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","default":"false","value":{"type":"boolean"}},{"name":"script","description":"The sql expression script. Use this property to define or update the script.","default":"\"\"","value":{"type":"string"}}],"events":[{"name":"arcgisDiagnosticsChange","type":"editor.IMarkerData[]","description":"Emitted when the diagnostics collection has changed."},{"name":"arcgisScriptChange","type":"string","description":"Emitted when the script string has changed."}],"js":{"properties":[{"name":"hideSideBar","description":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","type":"boolean"},{"name":"profile","description":"The profile to use for the editor. The profile defines the variables and functions that are available to the editor.","type":"IPredefinedProfile | undefined"},{"name":"script","description":"The sql expression script. Use this property to define or update the script.","type":"string"}],"events":[{"name":"arcgisDiagnosticsChange","type":"editor.IMarkerData[]","description":"Emitted when the diagnostics collection has changed."},{"name":"arcgisScriptChange","type":"string","description":"Emitted when the script string has changed."}]}}]},"css":{"properties":[{"name":"--arcgis-coding-components-border","description":"The border style for the editor shell *"},{"name":"--arcgis-coding-components-background-color","description":"The background color for the editor shell *"},{"name":"--arcgis-coding-components-side-action-bar-max-w","description":"The max width for the side action bar *"},{"name":"--arcgis-coding-components-code-editor-side-panel-w","description":"The width for the code editor side panel *"},{"name":"--arcgis-coding-components-code-editor-side-panel-max-w","description":"The max width for the code editor side panel *"},{"name":"--arcgis-coding-components-code-editor-results-panel-max-h","description":"The max height for the code editor results panel *"},{"name":"--arcgis-coding-components-code-editor-results-panel-h","description":"The default height for the code editor results panel (preferred over min-h). *"}],"pseudo-elements":[]}}}
1
+ {"$schema":"https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json","name":"@arcgis/coding-components","version":"5.1.0-next.13","description-markup":"markdown","contributions":{"html":{"elements":[{"name":"arcgis-arcade-editor","description":"[**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/)\n--\n\n### Events\n- **arcgisDiagnosticsChange** - Emitted when the diagnostics collection has changed.\n- **arcgisScriptChange** - Emitted when the script string has changed.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `getTestResult(): Promise<ArcadeResult>` - Returns the Arcade result for the script for the provided test data.\n- `setFocus(): Promise<void>` - Set the focus on the element.","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-arcade-editor/","attributes":[{"name":"hide-documentation-actions","description":"If true, it will hide the documentation action in the side panel","default":"false","value":{"type":"boolean"}},{"name":"hide-side-bar","description":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","default":"false","value":{"type":"boolean"}},{"name":"opened-side-panel","description":"The name of the opened side panel. 'none' means 'no panel opened'.","default":"\"none\"","value":{"type":"string"}},{"name":"script","description":"The arcade script. Use this property to define or update the script.","default":"\"\"","value":{"type":"string"}},{"name":"side-action-bar-expanded","description":"If true, the side action bar will be expanded","default":"false","value":{"type":"boolean"}}],"events":[{"name":"arcgisDiagnosticsChange","type":"Diagnostic[]","description":"Emitted when the diagnostics collection has changed."},{"name":"arcgisScriptChange","type":"string","description":"Emitted when the script string has changed."}],"js":{"properties":[{"name":"arcadeAssistant","description":"enables and configures the arcade assistant","type":"ArcadeAssistantConfig | undefined"},{"name":"customPanels","description":"Custom panels to be displayed in the side panel.\nWill be placed below the default panels but above the help panel.","type":"ICustomPanel[] | undefined"},{"name":"editorOptions","description":"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/docs.html#interfaces/editor_editor_api.editor.IEditorOptions.html) for more details.","type":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined"},{"name":"hideDocumentationActions","description":"If true, it will hide the documentation action in the side panel","type":"boolean"},{"name":"hideSideBar","description":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","type":"boolean"},{"name":"openedSidePanel","description":"The name of the opened side panel. 'none' means 'no panel opened'.","type":"string"},{"name":"profile","description":"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```","type":"IEditorProfileDefinition | IPredefinedProfile | undefined"},{"name":"script","description":"The arcade script. Use this property to define or update the script.","type":"string"},{"name":"sideActionBarExpanded","description":"If true, the side action bar will be expanded","type":"boolean"},{"name":"snippets","description":"Collection of snippets","type":"ApiSnippet[] | undefined"},{"name":"suggestions","description":"Collection of suggestions","type":"IEditorCodeSuggestion[] | IEditorCodeSuggestionGroup[] | undefined"},{"name":"testData","description":"Test data used to execute the script in the editor. If undefined the execute script UX will be hidden.","type":"IEditorTestContext | undefined"}],"events":[{"name":"arcgisDiagnosticsChange","type":"Diagnostic[]","description":"Emitted when the diagnostics collection has changed."},{"name":"arcgisScriptChange","type":"string","description":"Emitted when the script string has changed."}]}},{"name":"arcgis-code-editor","description":"### Events\n- **arcgisSelectionChange** - Emitted when the selection has changed.\n- **arcgisValueChange** - Emitted when the value has changed (script, code, css, json, etc.)\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `insertSnippet(text: string | null | undefined): Promise<void>` - Inserts a snippet at the current position in the editor.\n- `insertText(text: string | null | undefined): Promise<void>` - Inserts a text at the current position in the editor.\n- `setFocus(): Promise<void>` - Sets the focus on the editor.","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-code-editor/","attributes":[{"name":"language","description":"The language for the editor.\nCurrently supported language: arcade, arcgis-sql-expression, json, css, html, javascript, typescript, and text.","value":{"type":"string"}},{"name":"model-id","description":"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.","value":{"type":"string"}},{"name":"value","description":"The initial value for the editor.\nThe value is the script, code, css, json, etc.","default":"\"\"","value":{"type":"string"}}],"events":[{"name":"arcgisSelectionChange","type":"{\n selection: Selection;\n model: Editor.ITextModel | null | undefined;\n}","description":"Emitted when the selection has changed."},{"name":"arcgisValueChange","type":"string","description":"Emitted when the value has changed (script, code, css, json, etc.)"}],"js":{"properties":[{"name":"editorInstance","description":"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.","type":"Editor.IStandaloneCodeEditor | undefined"},{"name":"editorOptions","description":"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.","type":"Editor.IEditorOptions & Editor.IGlobalEditorOptions | undefined"},{"name":"language","description":"The language for the editor.\nCurrently supported language: arcade, arcgis-sql-expression, json, css, html, javascript, typescript, and text.","type":"string | undefined"},{"name":"modelId","description":"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.","type":"`${string}-${string}-${string}-${string}-${string}`"},{"name":"value","description":"The initial value for the editor.\nThe value is the script, code, css, json, etc.","type":"string"}],"events":[{"name":"arcgisSelectionChange","type":"{\n selection: Selection;\n model: Editor.ITextModel | null | undefined;\n}","description":"Emitted when the selection has changed."},{"name":"arcgisValueChange","type":"string","description":"Emitted when the value has changed (script, code, css, json, etc.)"}]}},{"name":"arcgis-code-editor-shell","description":"A layout component for code editors that provides slots for an editor, results panel, side panel, and action bars.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- **top-action-bar** - A slot for placing a top action bar above the editor area.\n- **editor** - A slot for placing the main code editor component.\n- **results-panel** - A slot for placing a results panel below the code editor.\n- **side-panel** - A slot for placing a side panel next to the code editor area.\n- **side-action-bar** - A slot for placing a side action bar next to the side panel.\n\n### CSS Properties\n- **--arcgis-coding-components-border** - The border style for the editor shell * \n- **--arcgis-coding-components-background-color** - The background color for the editor shell * \n- **--arcgis-coding-components-side-action-bar-max-w** - The max width for the side action bar * \n- **--arcgis-coding-components-code-editor-side-panel-w** - The width for the code editor side panel * \n- **--arcgis-coding-components-code-editor-side-panel-max-w** - The max width for the code editor side panel * \n- **--arcgis-coding-components-code-editor-results-panel-max-h** - The max height for the code editor results panel * \n- **--arcgis-coding-components-code-editor-results-panel-h** - The default height for the code editor results panel (preferred over min-h). * ","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-code-editor-shell/","attributes":[],"slots":[{"name":"top-action-bar","description":"A slot for placing a top action bar above the editor area."},{"name":"editor","description":"A slot for placing the main code editor component."},{"name":"results-panel","description":"A slot for placing a results panel below the code editor."},{"name":"side-panel","description":"A slot for placing a side panel next to the code editor area."},{"name":"side-action-bar","description":"A slot for placing a side action bar next to the side panel."}],"events":[],"js":{"properties":[],"events":[]}},{"name":"arcgis-code-viewer","description":"A code viewer component for displaying code snippets.\nSupports syntax highlighting for various programming languages, include arcade and arcgis-sql-expression.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-code-viewer/","attributes":[{"name":"language","description":"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.","default":"\"arcade\"","value":{"type":"string"}},{"name":"round","description":"When `true`, adds a round style to the component.","default":"false","value":{"type":"boolean"}}],"events":[],"js":{"properties":[{"name":"language","description":"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.","type":"string"},{"name":"round","description":"When `true`, adds a round style to the component.","type":"boolean"}],"events":[]}},{"name":"arcgis-sql-expression-editor","description":"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.\n--\n\n### Events\n- **arcgisDiagnosticsChange** - Emitted when the diagnostics collection has changed.\n- **arcgisScriptChange** - Emitted when the script string has changed.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `setFocus(): Promise<void>` - Set the focus on the element.","doc-url":"https://developers.arcgis.com/javascript/latest/references/coding-components/components/arcgis-sql-expression-editor/","attributes":[{"name":"hide-side-bar","description":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","default":"false","value":{"type":"boolean"}},{"name":"script","description":"The sql expression script. Use this property to define or update the script.","default":"\"\"","value":{"type":"string"}}],"events":[{"name":"arcgisDiagnosticsChange","type":"editor.IMarkerData[]","description":"Emitted when the diagnostics collection has changed."},{"name":"arcgisScriptChange","type":"string","description":"Emitted when the script string has changed."}],"js":{"properties":[{"name":"hideSideBar","description":"If true, it will hide the side actions bar. The editor will be in a minimalistic UX.","type":"boolean"},{"name":"profile","description":"The profile to use for the editor. The profile defines the variables and functions that are available to the editor.","type":"IPredefinedProfile | undefined"},{"name":"script","description":"The sql expression script. Use this property to define or update the script.","type":"string"}],"events":[{"name":"arcgisDiagnosticsChange","type":"editor.IMarkerData[]","description":"Emitted when the diagnostics collection has changed."},{"name":"arcgisScriptChange","type":"string","description":"Emitted when the script string has changed."}]}}]},"css":{"properties":[{"name":"--arcgis-coding-components-border","description":"The border style for the editor shell *"},{"name":"--arcgis-coding-components-background-color","description":"The background color for the editor shell *"},{"name":"--arcgis-coding-components-side-action-bar-max-w","description":"The max width for the side action bar *"},{"name":"--arcgis-coding-components-code-editor-side-panel-w","description":"The width for the code editor side panel *"},{"name":"--arcgis-coding-components-code-editor-side-panel-max-w","description":"The max width for the code editor side panel *"},{"name":"--arcgis-coding-components-code-editor-results-panel-max-h","description":"The max height for the code editor results panel *"},{"name":"--arcgis-coding-components-code-editor-results-panel-h","description":"The default height for the code editor results panel (preferred over min-h). *"}],"pseudo-elements":[]}}}
package/dist/index.d.ts CHANGED
@@ -1,8 +1,6 @@
1
1
  export { arcade } from "./utils/arcade-monaco/arcade-defaults";
2
2
  export { sqlExpression } from "./utils/sql-expr-monaco/sql-expr-defaults";
3
- export { type Diagnostic } from "@arcgis/arcade-languageservice";
4
- export type * from "./utils/index";
5
- export type * from "./utils/profile/types";
3
+ export type * from "./components/types";
6
4
 
7
5
  /**
8
6
  * Get a resolved path from where an asset can be loaded.
@@ -1,4 +1,8 @@
1
- /** Public configuration options for the arcade assistant */
1
+ /**
2
+ * Public configuration options for the arcade assistant
3
+ *
4
+ * @internal
5
+ */
2
6
  export type ArcadeAssistantConfig = {
3
7
  /** The URL of the portal the arcade editor is loaded for. Typically accessed via `portal.url` */
4
8
  portalUrl: string;
@@ -1,23 +1,8 @@
1
- import type Field from "@arcgis/core/layers/support/Field";
2
- import type KnowledgeGraph from "@arcgis/core/rest/knowledgeGraph/KnowledgeGraph";
3
- import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
4
- import type { IEditorProfileDefinition } from "./profile/types.js";
5
- import type { ProfileVariableInstances, ArcadeServices } from "@arcgis/core/arcade";
6
- import type { GeometryUnion } from "@arcgis/core/unionTypes";
7
-
8
- /**
9
- * If a profile doesn't contain a map, the spatial reference of geometries will be defaulted to
10
- * wkid: 3857.
11
- * The test context objects allows to set the execution spatial reference for such scenario.
12
- */
13
- export interface IEditorTestContext extends IContextReferences {
14
- /**
15
- * An object of key/value pairs where the key is the name of a profile variable.
16
- * The key's value must be of type ArcGIS core ProfileVariableInstance.
17
- */
18
- profileVariableInstances: ProfileVariableInstances;
19
- }
1
+ import type Field from "@arcgis/core/layers/support/Field.js";
2
+ import type KnowledgeGraph from "@arcgis/core/rest/knowledgeGraph/KnowledgeGraph.js";
3
+ import type { GeometryUnion } from "@arcgis/core/unionTypes.js";
20
4
 
5
+ /** @internal */
21
6
  export interface IArcadeRuntimeDictionary {
22
7
  declaredClass?: string;
23
8
  arcadeDeclaredClass?: string;
@@ -27,86 +12,154 @@ export interface IArcadeRuntimeDictionary {
27
12
  castAsJson: () => Record<string, unknown>;
28
13
  }
29
14
 
15
+ /** @internal */
30
16
  export interface IAbortSignal {
31
17
  aborted: boolean;
32
18
  }
33
19
 
20
+ /** @internal */
21
+ export interface IArcadeRuntimeFeatureSet {
22
+ declaredRootClass: string;
23
+ fields: Field[] | null;
24
+ load: () => Promise<IArcadeRuntimeFeatureSet>;
25
+ iterator: (abortSignal: IAbortSignal) => IArcadeRuntimeFeatureSetIterator;
26
+ }
27
+
28
+ /** @internal */
29
+ export interface IArcadeRuntimeFeatureSetIterator {
30
+ nextBatchAsArcadeFeatures: (bsize: number, timeZone: string) => Promise<IArcadeRuntimeDictionary[] | null>;
31
+ }
32
+
33
+ /** @internal */
34
+ export interface IArcadeRuntimeImmutableArray {
35
+ length: () => number;
36
+ get: (index: number) => unknown;
37
+ toArray: () => unknown[];
38
+ _elements: unknown[];
39
+ }
40
+
41
+ /** @internal */
42
+ export interface IArcadeRuntimeDate {
43
+ declaredRootClass: string;
44
+ toDateTime: () => { setLocale: (locale: string) => { toFormat: (format: string) => string; }; };
45
+ isUnknownTimeZone: boolean;
46
+ }
47
+
48
+ /** @internal */
49
+ export interface IArcadeRuntimeDateOnly {
50
+ declaredRootClass: string;
51
+ /** To ISO Date format */
52
+ toString: () => string;
53
+ }
54
+
55
+ /** @internal */
56
+ export interface IArcadeRuntimeTimeOnly {
57
+ declaredRootClass: string;
58
+ /** To ISO Time format */
59
+ toString: () => string;
60
+ }
61
+
62
+ /** @internal */
34
63
  export type ResultType = "array" | "attachment" | "boolean" | "date" | "dateOnly" | "dictionary" | "error" | "feature" | "featureSet" | "geometry" | "knowledgeGraph" | "null" | "number" | "pixel" | "portal" | "text" | "time" | "unknown";
35
64
 
65
+ /** @internal */
66
+ export interface IArcadeResultBase {
67
+ type: ResultType;
68
+ timeStamp?: Date;
69
+ compilationTime?: number;
70
+ executionTime?: number;
71
+ }
72
+
73
+ /** @internal */
36
74
  export interface IArcadeResultUnknown extends IArcadeResultBase {
37
75
  type: "unknown";
38
76
  }
39
77
 
78
+ /** @internal */
40
79
  export interface IArcadeResultNull extends IArcadeResultBase {
41
80
  type: "null";
42
81
  }
43
82
 
83
+ /** @internal */
44
84
  export interface IArcadeResultError extends IArcadeResultBase {
45
85
  type: "error";
46
86
  value: string;
47
87
  error: unknown;
48
88
  }
49
89
 
90
+ /** @internal */
50
91
  export interface IArcadeResultArray extends IArcadeResultBase {
51
92
  type: "array";
52
93
  value: unknown[];
53
94
  }
54
95
 
96
+ /** @internal */
55
97
  export interface IArcadeResultDate extends IArcadeResultBase {
56
98
  type: "date";
57
99
  value: Date | IArcadeRuntimeDate;
58
100
  }
59
101
 
102
+ /** @internal */
60
103
  export interface IArcadeResultDateOnly extends IArcadeResultBase {
61
104
  type: "dateOnly";
62
105
  value: IArcadeRuntimeDateOnly;
63
106
  }
64
107
 
108
+ /** @internal */
65
109
  export interface IArcadeResultTimeOnly extends IArcadeResultBase {
66
110
  type: "time";
67
111
  value: IArcadeRuntimeTimeOnly;
68
112
  }
69
113
 
114
+ /** @internal */
70
115
  export interface IArcadeResultString extends IArcadeResultBase {
71
116
  type: "text";
72
117
  value: string;
73
118
  }
74
119
 
120
+ /** @internal */
75
121
  export interface IArcadeResultNumber extends IArcadeResultBase {
76
122
  type: "number";
77
123
  value: number;
78
124
  }
79
125
 
126
+ /** @internal */
80
127
  export interface IArcadeResultBoolean extends IArcadeResultBase {
81
128
  type: "boolean";
82
129
  value: boolean;
83
130
  }
84
131
 
132
+ /** @internal */
85
133
  export interface IArcadeResultDictionary extends IArcadeResultBase {
86
134
  type: "dictionary";
87
135
  value: IArcadeRuntimeDictionary;
88
136
  }
89
137
 
138
+ /** @internal */
90
139
  export interface IArcadeResultGeometry extends IArcadeResultBase {
91
140
  type: "geometry";
92
141
  value: GeometryUnion;
93
142
  }
94
143
 
144
+ /** @internal */
95
145
  export interface IArcadeResultKnowledgeGraph extends IArcadeResultBase {
96
146
  type: "knowledgeGraph";
97
147
  value: KnowledgeGraph;
98
148
  }
99
149
 
150
+ /** @internal */
100
151
  export interface IArcadeResultFeature extends IArcadeResultBase {
101
152
  type: "feature";
102
153
  value: IArcadeRuntimeDictionary;
103
154
  }
104
155
 
156
+ /** @internal */
105
157
  export interface IArcadeResultPixel extends IArcadeResultBase {
106
158
  type: "pixel";
107
159
  value: IArcadeRuntimeDictionary;
108
160
  }
109
161
 
162
+ /** @internal */
110
163
  export interface IArcadeResultFeatureSet extends IArcadeResultBase {
111
164
  type: "featureSet";
112
165
  value: IArcadeRuntimeFeatureSet;
@@ -114,90 +167,17 @@ export interface IArcadeResultFeatureSet extends IArcadeResultBase {
114
167
  features: IArcadeRuntimeDictionary[];
115
168
  }
116
169
 
170
+ /** @internal */
117
171
  export interface IArcadeResultPortal extends IArcadeResultBase {
118
172
  type: "portal";
119
173
  value: IArcadeRuntimeDictionary;
120
174
  }
121
175
 
176
+ /** @internal */
122
177
  export interface IArcadeResultAttachment extends IArcadeResultBase {
123
178
  type: "attachment";
124
179
  value: IArcadeRuntimeDictionary;
125
180
  }
126
181
 
127
- export type ArcadeResult = IArcadeResultArray | IArcadeResultAttachment | IArcadeResultBoolean | IArcadeResultDate | IArcadeResultDateOnly | IArcadeResultDictionary | IArcadeResultError | IArcadeResultFeature | IArcadeResultFeatureSet | IArcadeResultGeometry | IArcadeResultKnowledgeGraph | IArcadeResultNull | IArcadeResultNumber | IArcadeResultPixel | IArcadeResultPortal | IArcadeResultString | IArcadeResultTimeOnly | IArcadeResultUnknown;
128
-
129
- /** @param value */
130
- export function valueToArcadeResult(value: unknown): ArcadeResult;
131
-
132
- /**
133
- * @param dateObject
134
- * @param lang
135
- */
136
- export function formatArcadeResultDate(dateObject: IArcadeResultDate, lang?: string): string;
137
-
138
- /** @param dateObject */
139
- export function formatArcadeResultDateOnly(dateObject: IArcadeResultDateOnly): string;
140
-
141
- /** @param dateObject */
142
- export function formatArcadeResultTimeOnly(dateObject: IArcadeResultTimeOnly): string;
143
-
144
- /**
145
- * @param editorProfile
146
- * @param script
147
- * @param testContext
148
- * @param console
149
- */
150
- export function executeScript(editorProfile: IEditorProfileDefinition | undefined, script: string | undefined, testContext: IEditorTestContext, console?: (log: string) => void): Promise<ArcadeResult>;
151
-
152
- export const exportsForTests: { convertScriptOutputToArcadeResult: (scriptOutput: unknown, timeZone?: string) => Promise<ArcadeResult>; };
153
-
154
- export interface IContextReferences {
155
- /**
156
- * Spatial reference object used to define the spatial reference for the arcade runtime.
157
- * By defaults, the spatial reference is set to Web Mercator (wkid: 3857).
158
- */
159
- spatialReference?: SpatialReference | { wkid: number; } | null;
160
- /**
161
- * Defines the default time zone in which to create and display Arcade date types.
162
- * By default, the time zone is set to "system".
163
- */
164
- timeZone?: string;
165
- /** Defines the "services" passed to the arcade executor. */
166
- services?: ArcadeServices;
167
- }
168
-
169
- export interface IArcadeRuntimeFeatureSet {
170
- declaredRootClass: string;
171
- fields: Field[] | null;
172
- load: () => Promise<IArcadeRuntimeFeatureSet>;
173
- iterator: (abortSignal: IAbortSignal) => IArcadeRuntimeFeatureSetIterator;
174
- }
175
-
176
- export interface IArcadeRuntimeFeatureSetIterator {
177
- nextBatchAsArcadeFeatures: (bsize: number, timeZone: string) => Promise<IArcadeRuntimeDictionary[] | null>;
178
- }
179
-
180
- export interface IArcadeRuntimeDate {
181
- declaredRootClass: string;
182
- toDateTime: () => { setLocale: (locale: string) => { toFormat: (format: string) => string; }; };
183
- isUnknownTimeZone: boolean;
184
- }
185
-
186
- export interface IArcadeRuntimeDateOnly {
187
- declaredRootClass: string;
188
- /** To ISO Date format */
189
- toString: () => string;
190
- }
191
-
192
- export interface IArcadeRuntimeTimeOnly {
193
- declaredRootClass: string;
194
- /** To ISO Time format */
195
- toString: () => string;
196
- }
197
-
198
- export interface IArcadeResultBase {
199
- type: ResultType;
200
- timeStamp?: Date;
201
- compilationTime?: number;
202
- executionTime?: number;
203
- }
182
+ /** @internal */
183
+ export type ArcadeResult = IArcadeResultArray | IArcadeResultAttachment | IArcadeResultBoolean | IArcadeResultDate | IArcadeResultDateOnly | IArcadeResultDictionary | IArcadeResultError | IArcadeResultFeature | IArcadeResultFeatureSet | IArcadeResultGeometry | IArcadeResultKnowledgeGraph | IArcadeResultNull | IArcadeResultNumber | IArcadeResultPixel | IArcadeResultPortal | IArcadeResultString | IArcadeResultTimeOnly | IArcadeResultUnknown;
@@ -1,7 +1,8 @@
1
- import type { IEditorProfileDefinition, IPredefinedProfile } from "../profile/types.js";
1
+ import type { IEditorProfileDefinition, IPredefinedProfile } from "../../components/types.js";
2
2
  import type { Uri as Uri2 } from "monaco-editor/esm/vs/editor/editor.api.js";
3
3
  import type { ApiSnippet as ApiSnippet2, ApiCategory } from "@arcgis/languages-api-utils/dist/types.js";
4
4
 
5
+ /** @internal */
5
6
  export const arcade: {
6
7
  setProfileForModel: (modelId: string | Uri2, definition: IEditorProfileDefinition | IPredefinedProfile | undefined, apiContext?: {
7
8
  locale: string;