@vertigis/arcgis-extensions 54.14.6 → 54.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/data/Feature.js +1 -1
  2. package/declarations/arcgis-js-api-extensions/index.d.ts +0 -29
  3. package/docs/html/assets/hierarchy.js +1 -1
  4. package/docs/html/assets/navigation.js +1 -1
  5. package/docs/html/assets/search.js +1 -1
  6. package/docs/html/classes/utilities_format_date.DateFormatter.html +1 -1
  7. package/docs/html/classes/utilities_format_number.NumberFormatter.html +1 -1
  8. package/docs/html/classes/utilities_format_time.TimeFormatter.html +1 -1
  9. package/docs/html/classes/utilities_log.ConsoleLogger.html +1 -1
  10. package/docs/html/classes/utilities_log.LoggerBase.html +1 -1
  11. package/docs/html/functions/utilities_arcade.constructProfile.html +43 -0
  12. package/docs/html/functions/utilities_arcade.createExecutorForExpression.html +53 -0
  13. package/docs/html/functions/utilities_arcade.isArcadeScriptAsync.html +7 -2
  14. package/docs/html/functions/utilities_arcade.isExpressionAsyncOnly.html +43 -0
  15. package/docs/html/functions/utilities_arcade.runArcadeExpression.html +9 -3
  16. package/docs/html/functions/utilities_arcade.runAsyncArcadeExpression.html +7 -2
  17. package/docs/html/functions/utilities_arcade.runAsyncExpression.html +47 -0
  18. package/docs/html/functions/utilities_arcade.runSyncExpression.html +52 -0
  19. package/docs/html/functions/utilities_arcade.toArcadeVariable.html +57 -0
  20. package/docs/html/hierarchy.html +19 -19
  21. package/docs/html/interfaces/utilities_arcade.RunArcadeExpressionParams.html +15 -6
  22. package/docs/html/interfaces/utilities_collection.AfterItemChangeEvent.html +1 -1
  23. package/docs/html/interfaces/utilities_format_FormatSettings.FormatSettings.html +1 -1
  24. package/docs/html/interfaces/utilities_format_date.DateFormatterProperties.html +1 -1
  25. package/docs/html/interfaces/utilities_format_date.DateSettings.html +1 -1
  26. package/docs/html/interfaces/utilities_format_number.NumberFormatterProperties.html +1 -1
  27. package/docs/html/interfaces/utilities_format_number.NumberSettings.html +1 -1
  28. package/docs/html/interfaces/utilities_format_string.FormatOptions.html +1 -1
  29. package/docs/html/interfaces/utilities_format_time.TimeFormatterProperties.html +1 -1
  30. package/docs/html/interfaces/utilities_format_time.TimeSettings.html +1 -1
  31. package/docs/html/interfaces/utilities_log.LogMessageOptions.html +1 -1
  32. package/docs/html/interfaces/utilities_log.LogMessageResourceOptions.html +1 -1
  33. package/docs/html/modules/utilities_arcade.html +6 -2
  34. package/docs/html/types/utilities_arcade.ArcadeVariable.html +39 -0
  35. package/docs/html/variables/version.version.html +1 -1
  36. package/package.json +1 -1
  37. package/utilities/arcade.d.ts +98 -4
  38. package/utilities/arcade.js +1 -1
  39. package/version.d.ts +1 -1
  40. package/version.js +1 -1
@@ -14,7 +14,7 @@
14
14
  <section class="tsd-panel tsd-comment">
15
15
  <div class="tsd-comment tsd-typography"><p>A helper class for formatting and parsing dates.</p>
16
16
  </div></section>
17
- <section class="tsd-panel tsd-hierarchy" data-refl="34231">
17
+ <section class="tsd-panel tsd-hierarchy" data-refl="34250">
18
18
  <h4>Hierarchy (<a href="../hierarchy.html#utilities/format/date.DateFormatter">View Summary</a>)</h4>
19
19
  <ul class="tsd-hierarchy">
20
20
  <li class="tsd-hierarchy-item"><a href="support_Serializable.SerializableBase.html" class="tsd-signature-type tsd-kind-class">SerializableBase</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/utilities_format_date.DateFormatterProperties.html" class="tsd-signature-type tsd-kind-interface">DateFormatterProperties</a><span class="tsd-signature-symbol">&gt;</span>
@@ -14,7 +14,7 @@
14
14
  <section class="tsd-panel tsd-comment">
15
15
  <div class="tsd-comment tsd-typography"><p>A helper class for formatting and parsing numbers.</p>
16
16
  </div></section>
17
- <section class="tsd-panel tsd-hierarchy" data-refl="34375">
17
+ <section class="tsd-panel tsd-hierarchy" data-refl="34394">
18
18
  <h4>Hierarchy (<a href="../hierarchy.html#utilities/format/number.NumberFormatter">View Summary</a>)</h4>
19
19
  <ul class="tsd-hierarchy">
20
20
  <li class="tsd-hierarchy-item"><a href="support_Serializable.SerializableBase.html" class="tsd-signature-type tsd-kind-class">SerializableBase</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/utilities_format_number.NumberFormatterProperties.html" class="tsd-signature-type tsd-kind-interface">NumberFormatterProperties</a><span class="tsd-signature-symbol">&gt;</span>
@@ -14,7 +14,7 @@
14
14
  <section class="tsd-panel tsd-comment">
15
15
  <div class="tsd-comment tsd-typography"><p>A helper class for formatting and parsing times.</p>
16
16
  </div></section>
17
- <section class="tsd-panel tsd-hierarchy" data-refl="34544">
17
+ <section class="tsd-panel tsd-hierarchy" data-refl="34563">
18
18
  <h4>Hierarchy (<a href="../hierarchy.html#utilities/format/time.TimeFormatter">View Summary</a>)</h4>
19
19
  <ul class="tsd-hierarchy">
20
20
  <li class="tsd-hierarchy-item"><a href="support_Serializable.SerializableBase.html" class="tsd-signature-type tsd-kind-class">SerializableBase</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/utilities_format_time.TimeFormatterProperties.html" class="tsd-signature-type tsd-kind-interface">TimeFormatterProperties</a><span class="tsd-signature-symbol">&gt;</span>
@@ -14,7 +14,7 @@
14
14
  <section class="tsd-panel tsd-comment">
15
15
  <div class="tsd-comment tsd-typography"><p>A class implementing a logger that outputs to the console.</p>
16
16
  </div></section>
17
- <section class="tsd-panel tsd-hierarchy" data-refl="34919">
17
+ <section class="tsd-panel tsd-hierarchy" data-refl="34938">
18
18
  <h4>Hierarchy (<a href="../hierarchy.html#utilities/log.ConsoleLogger">View Summary</a>)</h4>
19
19
  <ul class="tsd-hierarchy">
20
20
  <li class="tsd-hierarchy-item"><a href="utilities_log.LoggerBase.html" class="tsd-signature-type tsd-kind-class">LoggerBase</a>
@@ -14,7 +14,7 @@
14
14
  <section class="tsd-panel tsd-comment">
15
15
  <div class="tsd-comment tsd-typography"><p>Base class for loggers.</p>
16
16
  </div></section>
17
- <section class="tsd-panel tsd-hierarchy" data-refl="34873">
17
+ <section class="tsd-panel tsd-hierarchy" data-refl="34892">
18
18
  <h4>Hierarchy (<a href="../hierarchy.html#utilities/log.LoggerBase">View Summary</a>)</h4>
19
19
  <ul class="tsd-hierarchy">
20
20
  <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">LoggerBase</span>
@@ -0,0 +1,43 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>constructProfile | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@vertigis/arcgis-extensions</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/utilities_arcade.html">utilities/arcade</a></li>
12
+ <li><a href="" aria-current="page">constructProfile</a></li></ul>
13
+ <h1>Function constructProfile</h1></div>
14
+ <section class="tsd-panel">
15
+ <ul class="tsd-signatures">
16
+ <li class="">
17
+ <div class="tsd-signature tsd-anchor-link" id="constructprofile"><span class="tsd-kind-call-signature">constructProfile</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/utilities_arcade.RunArcadeExpressionParams.html" class="tsd-signature-type tsd-kind-interface">RunArcadeExpressionParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Profile</span><a href="#constructprofile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
18
+ <div class="tsd-description">
19
+ <div class="tsd-comment tsd-typography"><p>Constructs an Arcade profile based on the provided parameters.</p>
20
+ </div>
21
+ <div class="tsd-parameters">
22
+ <h4 class="tsd-parameters-title">Parameters</h4>
23
+ <ul class="tsd-parameter-list">
24
+ <li><span><span class="tsd-kind-parameter">params</span>: <a href="../interfaces/utilities_arcade.RunArcadeExpressionParams.html" class="tsd-signature-type tsd-kind-interface">RunArcadeExpressionParams</a></span>
25
+ <div class="tsd-comment tsd-typography"><p>The parameters.</p>
26
+ </div></li></ul></div>
27
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Profile</span></h4></div></li></ul></section></div>
28
+ <div class="col-sidebar">
29
+ <div class="page-menu">
30
+ <div class="tsd-navigation settings">
31
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
32
+ <h3>Settings</h3></summary>
33
+ <div class="tsd-accordion-details">
34
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
35
+ <ul id="tsd-filter-options">
36
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
37
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div>
38
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
39
+ <div class="site-menu">
40
+ <nav class="tsd-navigation"><a href="../modules.html">@vertigis/arcgis-extensions</a>
41
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
42
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
43
+ <div class="overlay"></div></body></html>
@@ -0,0 +1,53 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createExecutorForExpression | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@vertigis/arcgis-extensions</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/utilities_arcade.html">utilities/arcade</a></li>
12
+ <li><a href="" aria-current="page">createExecutorForExpression</a></li></ul>
13
+ <h1>Function createExecutorForExpression</h1></div>
14
+ <section class="tsd-panel">
15
+ <ul class="tsd-signatures">
16
+ <li class="">
17
+ <div class="tsd-signature tsd-anchor-link" id="createexecutorforexpression"><span class="tsd-kind-call-signature">createExecutorForExpression</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">expression</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">profile</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Profile</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArcadeExecutor</span><span class="tsd-signature-symbol">&gt;</span><a href="#createexecutorforexpression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
18
+ <div class="tsd-description">
19
+ <div class="tsd-comment tsd-typography"><p>Creates and returns an ArcadeExecutor object for the given expression. This
20
+ should primarily be used for executing Arcade expressions in a sync context
21
+ with <a href="utilities_arcade.runSyncExpression.html" class="tsd-kind-function">runSyncExpression</a>. If you are executing an expression in an async
22
+ context, you should use the <a href="utilities_arcade.runAsyncExpression.html" class="tsd-kind-function">runAsyncExpression</a> function instead. Sync
23
+ Arcade expressions cannot be run without first creating an executor
24
+ asynchronously.</p>
25
+ </div>
26
+ <div class="tsd-parameters">
27
+ <h4 class="tsd-parameters-title">Parameters</h4>
28
+ <ul class="tsd-parameter-list">
29
+ <li><span><span class="tsd-kind-parameter">expression</span>: <span class="tsd-signature-type">string</span></span>
30
+ <div class="tsd-comment tsd-typography"><p>The Arcade expression string.</p>
31
+ </div></li>
32
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">profile</span>: <span class="tsd-signature-type">Profile</span></span>
33
+ <div class="tsd-comment tsd-typography"><p>The profile definition used to execute the given expression.
34
+ If not provided, a generic profile with all primary variable types will be
35
+ used.</p>
36
+ </div></li></ul></div>
37
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArcadeExecutor</span><span class="tsd-signature-symbol">&gt;</span></h4></div></li></ul></section></div>
38
+ <div class="col-sidebar">
39
+ <div class="page-menu">
40
+ <div class="tsd-navigation settings">
41
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
42
+ <h3>Settings</h3></summary>
43
+ <div class="tsd-accordion-details">
44
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
45
+ <ul id="tsd-filter-options">
46
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
47
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div>
48
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
49
+ <div class="site-menu">
50
+ <nav class="tsd-navigation"><a href="../modules.html">@vertigis/arcgis-extensions</a>
51
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
52
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
53
+ <div class="overlay"></div></body></html>
@@ -10,7 +10,7 @@
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="../modules/utilities_arcade.html">utilities/arcade</a></li>
12
12
  <li><a href="" aria-current="page">isArcadeScriptAsync</a></li></ul>
13
- <h1>Function isArcadeScriptAsync</h1></div>
13
+ <h1 class="deprecated">Function isArcadeScriptAsync</h1></div>
14
14
  <section class="tsd-panel">
15
15
  <ul class="tsd-signatures">
16
16
  <li class="">
@@ -27,7 +27,12 @@
27
27
  <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">spatialReference</span>: <span class="tsd-signature-type">SpatialReference</span></span>
28
28
  <div class="tsd-comment tsd-typography"><p>Optionally the spatial reference for the expressions.</p>
29
29
  </div></li></ul></div>
30
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></div></li></ul></section></div>
30
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
31
+ <div class="tsd-comment tsd-typography">
32
+ <div class="tsd-tag-deprecated">
33
+ <h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use <a href="utilities_arcade.isExpressionAsyncOnly.html" class="tsd-kind-function">isExpressionAsyncOnly</a> instead. This function will be
34
+ removed in a future release.</p>
35
+ </div></div></div></li></ul></section></div>
31
36
  <div class="col-sidebar">
32
37
  <div class="page-menu">
33
38
  <div class="tsd-navigation settings">
@@ -0,0 +1,43 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isExpressionAsyncOnly | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@vertigis/arcgis-extensions</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/utilities_arcade.html">utilities/arcade</a></li>
12
+ <li><a href="" aria-current="page">isExpressionAsyncOnly</a></li></ul>
13
+ <h1>Function isExpressionAsyncOnly</h1></div>
14
+ <section class="tsd-panel">
15
+ <ul class="tsd-signatures">
16
+ <li class="">
17
+ <div class="tsd-signature tsd-anchor-link" id="isexpressionasynconly"><span class="tsd-kind-call-signature">isExpressionAsyncOnly</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">expression</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#isexpressionasynconly" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
18
+ <div class="tsd-description">
19
+ <div class="tsd-comment tsd-typography"><p>Detect if the arcade expression requires an async evaluation.</p>
20
+ </div>
21
+ <div class="tsd-parameters">
22
+ <h4 class="tsd-parameters-title">Parameters</h4>
23
+ <ul class="tsd-parameter-list">
24
+ <li><span><span class="tsd-kind-parameter">expression</span>: <span class="tsd-signature-type">string</span></span>
25
+ <div class="tsd-comment tsd-typography"><p>The Arcade expression string.</p>
26
+ </div></li></ul></div>
27
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></div></li></ul></section></div>
28
+ <div class="col-sidebar">
29
+ <div class="page-menu">
30
+ <div class="tsd-navigation settings">
31
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
32
+ <h3>Settings</h3></summary>
33
+ <div class="tsd-accordion-details">
34
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
35
+ <ul id="tsd-filter-options">
36
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
37
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div>
38
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
39
+ <div class="site-menu">
40
+ <nav class="tsd-navigation"><a href="../modules.html">@vertigis/arcgis-extensions</a>
41
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
42
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
43
+ <div class="overlay"></div></body></html>
@@ -10,13 +10,13 @@
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="../modules/utilities_arcade.html">utilities/arcade</a></li>
12
12
  <li><a href="" aria-current="page">runArcadeExpression</a></li></ul>
13
- <h1>Function runArcadeExpression</h1></div>
13
+ <h1 class="deprecated">Function runArcadeExpression</h1></div>
14
14
  <section class="tsd-panel">
15
15
  <ul class="tsd-signatures">
16
16
  <li class="">
17
17
  <div class="tsd-signature tsd-anchor-link" id="runarcadeexpression"><span class="tsd-kind-call-signature">runArcadeExpression</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">expression</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/utilities_arcade.RunArcadeExpressionParams.html" class="tsd-signature-type tsd-kind-interface">RunArcadeExpressionParams</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><a href="#runarcadeexpression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
18
18
  <div class="tsd-description">
19
- <div class="tsd-comment tsd-typography"><p>Execute an synchronous arcade expression string, and return the unformatted
19
+ <div class="tsd-comment tsd-typography"><p>Execute a synchronous arcade expression string, and return the unformatted
20
20
  result. You must call 'enableGeometrySupport' prior to evaluating any
21
21
  expressions that might require the geometry engine.</p>
22
22
  </div>
@@ -29,7 +29,13 @@ expressions that might require the geometry engine.</p>
29
29
  <li><span><span class="tsd-kind-parameter">params</span>: <a href="../interfaces/utilities_arcade.RunArcadeExpressionParams.html" class="tsd-signature-type tsd-kind-interface">RunArcadeExpressionParams</a></span>
30
30
  <div class="tsd-comment tsd-typography"><p>The parameters.</p>
31
31
  </div></li></ul></div>
32
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></div></li></ul></section></div>
32
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4>
33
+ <div class="tsd-comment tsd-typography">
34
+ <div class="tsd-tag-deprecated">
35
+ <h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Create an executor using <a href="utilities_arcade.createExecutorForExpression.html" class="tsd-kind-function">createExecutorForExpression</a> and
36
+ then call <a href="utilities_arcade.runSyncExpression.html" class="tsd-kind-function">runSyncExpression</a> instead. This function will be removed
37
+ in a future release.</p>
38
+ </div></div></div></li></ul></section></div>
33
39
  <div class="col-sidebar">
34
40
  <div class="page-menu">
35
41
  <div class="tsd-navigation settings">
@@ -10,7 +10,7 @@
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="../modules/utilities_arcade.html">utilities/arcade</a></li>
12
12
  <li><a href="" aria-current="page">runAsyncArcadeExpression</a></li></ul>
13
- <h1>Function runAsyncArcadeExpression</h1></div>
13
+ <h1 class="deprecated">Function runAsyncArcadeExpression</h1></div>
14
14
  <section class="tsd-panel">
15
15
  <ul class="tsd-signatures">
16
16
  <li class="">
@@ -28,7 +28,12 @@ result.</p>
28
28
  <li><span><span class="tsd-kind-parameter">params</span>: <a href="../interfaces/utilities_arcade.RunArcadeExpressionParams.html" class="tsd-signature-type tsd-kind-interface">RunArcadeExpressionParams</a></span>
29
29
  <div class="tsd-comment tsd-typography"><p>The parameters.</p>
30
30
  </div></li></ul></div>
31
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></div></li></ul></section></div>
31
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
32
+ <div class="tsd-comment tsd-typography">
33
+ <div class="tsd-tag-deprecated">
34
+ <h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use runAsyncExpression instead. This function will be removed in
35
+ a future release.</p>
36
+ </div></div></div></li></ul></section></div>
32
37
  <div class="col-sidebar">
33
38
  <div class="page-menu">
34
39
  <div class="tsd-navigation settings">
@@ -0,0 +1,47 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>runAsyncExpression | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@vertigis/arcgis-extensions</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/utilities_arcade.html">utilities/arcade</a></li>
12
+ <li><a href="" aria-current="page">runAsyncExpression</a></li></ul>
13
+ <h1>Function runAsyncExpression</h1></div>
14
+ <section class="tsd-panel">
15
+ <ul class="tsd-signatures">
16
+ <li class="">
17
+ <div class="tsd-signature tsd-anchor-link" id="runasyncexpression"><span class="tsd-kind-call-signature">runAsyncExpression</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">expression</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/utilities_arcade.RunArcadeExpressionParams.html" class="tsd-signature-type tsd-kind-interface">RunArcadeExpressionParams</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><a href="#runasyncexpression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
18
+ <div class="tsd-description">
19
+ <div class="tsd-comment tsd-typography"><p>Execute an asynchronous arcade expression string, and return the unformatted
20
+ result.</p>
21
+ </div>
22
+ <div class="tsd-parameters">
23
+ <h4 class="tsd-parameters-title">Parameters</h4>
24
+ <ul class="tsd-parameter-list">
25
+ <li><span><span class="tsd-kind-parameter">expression</span>: <span class="tsd-signature-type">string</span></span>
26
+ <div class="tsd-comment tsd-typography"><p>The arcade expression string.</p>
27
+ </div></li>
28
+ <li><span><span class="tsd-kind-parameter">params</span>: <a href="../interfaces/utilities_arcade.RunArcadeExpressionParams.html" class="tsd-signature-type tsd-kind-interface">RunArcadeExpressionParams</a></span>
29
+ <div class="tsd-comment tsd-typography"><p>The parameters.</p>
30
+ </div></li></ul></div>
31
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></div></li></ul></section></div>
32
+ <div class="col-sidebar">
33
+ <div class="page-menu">
34
+ <div class="tsd-navigation settings">
35
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
36
+ <h3>Settings</h3></summary>
37
+ <div class="tsd-accordion-details">
38
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
39
+ <ul id="tsd-filter-options">
40
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
41
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div>
42
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
43
+ <div class="site-menu">
44
+ <nav class="tsd-navigation"><a href="../modules.html">@vertigis/arcgis-extensions</a>
45
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
46
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
47
+ <div class="overlay"></div></body></html>
@@ -0,0 +1,52 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>runSyncExpression | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@vertigis/arcgis-extensions</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/utilities_arcade.html">utilities/arcade</a></li>
12
+ <li><a href="" aria-current="page">runSyncExpression</a></li></ul>
13
+ <h1>Function runSyncExpression</h1></div>
14
+ <section class="tsd-panel">
15
+ <ul class="tsd-signatures">
16
+ <li class="">
17
+ <div class="tsd-signature tsd-anchor-link" id="runsyncexpression"><span class="tsd-kind-call-signature">runSyncExpression</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">expression</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/utilities_arcade.RunArcadeExpressionParams.html" class="tsd-signature-type tsd-kind-interface">RunArcadeExpressionParams</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">executor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArcadeExecutor</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><a href="#runsyncexpression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
18
+ <div class="tsd-description">
19
+ <div class="tsd-comment tsd-typography"><p>Execute a synchronous arcade expression string, and return the unformatted
20
+ result.</p>
21
+ </div>
22
+ <div class="tsd-parameters">
23
+ <h4 class="tsd-parameters-title">Parameters</h4>
24
+ <ul class="tsd-parameter-list">
25
+ <li><span><span class="tsd-kind-parameter">expression</span>: <span class="tsd-signature-type">string</span></span>
26
+ <div class="tsd-comment tsd-typography"><p>The arcade expression string.</p>
27
+ </div></li>
28
+ <li><span><span class="tsd-kind-parameter">params</span>: <a href="../interfaces/utilities_arcade.RunArcadeExpressionParams.html" class="tsd-signature-type tsd-kind-interface">RunArcadeExpressionParams</a></span>
29
+ <div class="tsd-comment tsd-typography"><p>The parameters.</p>
30
+ </div></li>
31
+ <li><span><span class="tsd-kind-parameter">executor</span>: <span class="tsd-signature-type">ArcadeExecutor</span></span>
32
+ <div class="tsd-comment tsd-typography"><p>The ArcadeExecutor to use for executing the expression. The
33
+ executor should be created using the <a href="utilities_arcade.createExecutorForExpression.html" class="tsd-kind-function">createExecutorForExpression</a>
34
+ function.</p>
35
+ </div></li></ul></div>
36
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></div></li></ul></section></div>
37
+ <div class="col-sidebar">
38
+ <div class="page-menu">
39
+ <div class="tsd-navigation settings">
40
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
41
+ <h3>Settings</h3></summary>
42
+ <div class="tsd-accordion-details">
43
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
44
+ <ul id="tsd-filter-options">
45
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
46
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div>
47
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
48
+ <div class="site-menu">
49
+ <nav class="tsd-navigation"><a href="../modules.html">@vertigis/arcgis-extensions</a>
50
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
51
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
52
+ <div class="overlay"></div></body></html>
@@ -0,0 +1,57 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>toArcadeVariable | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@vertigis/arcgis-extensions</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="../modules/utilities_arcade.html">utilities/arcade</a></li>
12
+ <li><a href="" aria-current="page">toArcadeVariable</a></li></ul>
13
+ <h1>Function toArcadeVariable</h1></div>
14
+ <section class="tsd-panel">
15
+ <ul class="tsd-signatures">
16
+ <li class="">
17
+ <div class="tsd-signature tsd-anchor-link" id="toarcadevariable"><span class="tsd-kind-call-signature">toArcadeVariable</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">definition</span><span class="tsd-signature-symbol">:</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SimpleVariable</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">DictionaryVariable</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayVariable</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/utilities_arcade.ArcadeVariable.html" class="tsd-signature-type tsd-kind-type-alias">ArcadeVariable</a><a href="#toarcadevariable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
18
+ <div class="tsd-description">
19
+ <div class="tsd-comment tsd-typography"><p>Tags a value with an explicit Arcade Variable type definition so it can be
20
+ passed through the <code>vars</code> parameter of <a href="utilities_arcade.runAsyncExpression.html" class="tsd-kind-function">runAsyncExpression</a> and
21
+ <a href="utilities_arcade.runSyncExpression.html" class="tsd-kind-function">runSyncExpression</a> without being assumed to be a plain JSON-compatible
22
+ value.</p>
23
+ </div>
24
+ <div class="tsd-parameters">
25
+ <h4 class="tsd-parameters-title">Parameters</h4>
26
+ <ul class="tsd-parameter-list">
27
+ <li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">unknown</span></span>
28
+ <div class="tsd-comment tsd-typography"><p>The value of the variable.</p>
29
+ </div></li>
30
+ <li><span><span class="tsd-kind-parameter">definition</span>: <br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SimpleVariable</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">DictionaryVariable</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ArrayVariable</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;name&quot;</span><span class="tsd-signature-symbol">&gt;</span></span>
31
+ <div class="tsd-comment tsd-typography"><p>The Arcade variable type definition (excluding <code>name</code>) to
32
+ declare the value as (e.g. <code>{ type: &quot;featureSet&quot; }</code> for a FeatureSet
33
+ object).</p>
34
+ </div></li></ul></div>
35
+ <h4 class="tsd-returns-title">Returns <a href="../types/utilities_arcade.ArcadeVariable.html" class="tsd-signature-type tsd-kind-type-alias">ArcadeVariable</a></h4>
36
+ <div class="tsd-comment tsd-typography">
37
+ <div class="tsd-tag-example">
38
+ <h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-2"> </span><span class="hl-9">await</span><span class="hl-2"> </span><span class="hl-3">runAsyncExpression</span><span class="hl-2">(</span><span class="hl-4">&quot;Count($features)&quot;</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-1">vars:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-1">$features:</span><span class="hl-2"> </span><span class="hl-3">toArcadeVariable</span><span class="hl-2">(</span><span class="hl-1">featureSet</span><span class="hl-2">, { </span><span class="hl-1">type:</span><span class="hl-2"> </span><span class="hl-4">&quot;featureSet&quot;</span><span class="hl-2"> }),</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> });</span><br/><span class="hl-2"> </span>
39
+ </code><button>Copy</button></pre>
40
+
41
+ </div></div></div></li></ul></section></div>
42
+ <div class="col-sidebar">
43
+ <div class="page-menu">
44
+ <div class="tsd-navigation settings">
45
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
46
+ <h3>Settings</h3></summary>
47
+ <div class="tsd-accordion-details">
48
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
49
+ <ul id="tsd-filter-options">
50
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
51
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div>
52
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
53
+ <div class="site-menu">
54
+ <nav class="tsd-navigation"><a href="../modules.html">@vertigis/arcgis-extensions</a>
55
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
56
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
57
+ <div class="overlay"></div></body></html>