@vertigis/arcgis-extensions 32.8.5 → 32.10.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 (123) hide show
  1. package/AppConfig.schema.json +43 -11
  2. package/docs/html/assets/js/search.js +1 -1
  3. package/docs/html/classes/mapping_grouplayerextension.grouplayerextensioncollection.html +13 -13
  4. package/docs/html/classes/mapping_mapextension.mapextension.html +7 -7
  5. package/docs/html/classes/mapping_support__layerextensioncollection.layerextensioncollectionbase.html +19 -19
  6. package/docs/html/enums/portal_featurelayer.featurelayermode.html +4 -4
  7. package/docs/html/index.html +9 -0
  8. package/docs/html/interfaces/data__tableextension.tableproperties.html +51 -9
  9. package/docs/html/interfaces/mapping_featurelayerextension.featurelayerproperties.html +76 -13
  10. package/docs/html/interfaces/mapping_featurelayerextensionbase.featurelayerbaseproperties.html +76 -13
  11. package/docs/html/interfaces/mapping_support__layerextensioncollection.layerextensioncollection.html +3 -3
  12. package/docs/html/interfaces/portal_applicationproperties.applicationproperties.html +32 -2
  13. package/docs/html/interfaces/portal_bookmark.bookmark.html +18 -3
  14. package/docs/html/interfaces/portal_csvlayer.csvlayer-1.html +27 -7
  15. package/docs/html/interfaces/portal_drawinginfo.drawinginfo-1.html +29 -8
  16. package/docs/html/interfaces/portal_featurelayer.featurelayer-1.html +73 -13
  17. package/docs/html/interfaces/portal_forminfo.formattachmentelement.html +351 -0
  18. package/docs/html/interfaces/portal_forminfo.formbarcodescannerinput.html +257 -0
  19. package/docs/html/interfaces/portal_forminfo.formcomboboxinput.html +254 -0
  20. package/docs/html/interfaces/portal_forminfo.formdatetimepickerinput.html +274 -0
  21. package/docs/html/interfaces/portal_forminfo.formexpressioninfo.html +273 -0
  22. package/docs/html/interfaces/portal_forminfo.formfieldelement.html +386 -0
  23. package/docs/html/interfaces/portal_forminfo.formgroupelement.html +315 -0
  24. package/docs/html/interfaces/portal_forminfo.forminfo.html +271 -0
  25. package/docs/html/interfaces/portal_forminfo.formradiobuttonsinput.html +253 -0
  26. package/docs/html/interfaces/portal_forminfo.formrelationshipelement.html +334 -0
  27. package/docs/html/interfaces/portal_forminfo.formswitchinput.html +252 -0
  28. package/docs/html/interfaces/portal_forminfo.formtextareainput.html +254 -0
  29. package/docs/html/interfaces/portal_forminfo.formtextboxinput.html +255 -0
  30. package/docs/html/interfaces/portal_grouplayer.grouplayer-1.html +7 -4
  31. package/docs/html/interfaces/portal_grouplayer.subtypegrouplayer.html +501 -0
  32. package/docs/html/interfaces/portal_imageservicelayer.imageservicelayer-1.html +33 -13
  33. package/docs/html/interfaces/portal_imageservicevectorlayer.imageservicevectorlayer.html +28 -8
  34. package/docs/html/interfaces/portal_item.item-1.html +158 -41
  35. package/docs/html/interfaces/portal_labelinginfo.labelinginfo-1.html +19 -10
  36. package/docs/html/interfaces/portal_layerdefinition.fieldoverride.html +241 -0
  37. package/docs/html/interfaces/portal_layerdefinition.layerdefinition-1.html +116 -31
  38. package/docs/html/interfaces/portal_layerdefinition.layerdefinitiondefaults.html +12 -0
  39. package/docs/html/interfaces/portal_layerdefinition.layertimeinfo.html +381 -0
  40. package/docs/html/interfaces/portal_layerdefinition.timeinfoexportoptions.html +262 -0
  41. package/docs/html/interfaces/portal_mapfloorinfo.facilitylayerinfo.html +254 -0
  42. package/docs/html/interfaces/portal_mapfloorinfo.levellayerinfo.html +315 -0
  43. package/docs/html/interfaces/portal_mapfloorinfo.mapfloorinfo-1.html +233 -0
  44. package/docs/html/interfaces/portal_mapfloorinfo.sitelayerinfo.html +231 -0
  45. package/docs/html/interfaces/portal_mapservicelayer.mapservicelayer-1.html +26 -6
  46. package/docs/html/interfaces/portal_renderer.authoringinfo.html +28 -5
  47. package/docs/html/interfaces/portal_renderer.colorramp.html +291 -0
  48. package/docs/html/interfaces/portal_renderer.rendererbase.html +3 -0
  49. package/docs/html/interfaces/portal_streamlayer.streamlayer-1.html +75 -12
  50. package/docs/html/interfaces/portal_symbol.font.html +4 -4
  51. package/docs/html/interfaces/portal_table.table.html +49 -9
  52. package/docs/html/interfaces/portal_tiledimageservicelayer.tiledimageservicelayer-1.html +23 -3
  53. package/docs/html/interfaces/portal_tiledmapservicelayer.tiledmapservicelayer-1.html +27 -7
  54. package/docs/html/interfaces/portal_utilitynetwork.traceconfiguration.html +201 -0
  55. package/docs/html/interfaces/portal_utilitynetwork.utilitynetwork.html +243 -0
  56. package/docs/html/interfaces/portal_vectortilelayer.vectortilelayer-1.html +24 -4
  57. package/docs/html/interfaces/portal_webmap.webmap-1.html +71 -13
  58. package/docs/html/interfaces/portal_webscene.webscene-1.html +34 -15
  59. package/docs/html/interfaces/portal_webtilelayer.webtilelayer-1.html +8 -8
  60. package/docs/html/interfaces/portal_widgets.floorfilter.html +310 -0
  61. package/docs/html/interfaces/portal_widgets.range.html +6 -3
  62. package/docs/html/interfaces/portal_widgets.timeslider.html +4 -1
  63. package/docs/html/interfaces/portal_widgets.widgets.html +22 -0
  64. package/docs/html/modules/mapping_mapextension.html +1 -1
  65. package/docs/html/modules/portal_applicationproperties.html +2 -2
  66. package/docs/html/modules/portal_featurelayer.featurelayer.html +8 -8
  67. package/docs/html/modules/portal_featurelayer.html +1 -1
  68. package/docs/html/modules/portal_forminfo.html +178 -0
  69. package/docs/html/modules/portal_grouplayer.grouplayer.html +3 -3
  70. package/docs/html/modules/portal_grouplayer.html +5 -1
  71. package/docs/html/modules/portal_labelinginfo.html +1 -1
  72. package/docs/html/modules/portal_labelinginfo.labelplacement.html +2 -2
  73. package/docs/html/modules/portal_layerdefinition.html +32 -1
  74. package/docs/html/modules/portal_layerdefinition.layerdefinitioncapabilities.html +6 -6
  75. package/docs/html/modules/portal_mapfloorinfo.html +153 -0
  76. package/docs/html/modules/portal_mapfloorinfo.mapfloorinfo.html +209 -0
  77. package/docs/html/modules/portal_renderer.html +10 -6
  78. package/docs/html/modules/portal_table.html +5 -5
  79. package/docs/html/modules/portal_tiledmapservicelayer.tiledmapservicelayer.html +1 -1
  80. package/docs/html/modules/portal_utilitynetwork.html +134 -0
  81. package/docs/html/modules/portal_webmap.webmap.html +3 -3
  82. package/docs/html/modules/portal_webscene.webscene.html +3 -3
  83. package/docs/html/modules/portal_webtilelayer.webtilelayer.html +1 -1
  84. package/docs/html/modules/portal_widgets.html +5 -1
  85. package/docs/html/modules/version.html +1 -1
  86. package/docs/html/modules.html +12 -0
  87. package/mapping/MapExtension.js +1 -1
  88. package/mapping/support/_LayerExtensionCollection.js +1 -1
  89. package/package.json +1 -1
  90. package/portal/ApplicationProperties.d.ts +25 -0
  91. package/portal/Bookmark.d.ts +8 -2
  92. package/portal/CSVLayer.d.ts +5 -0
  93. package/portal/DrawingInfo.d.ts +9 -3
  94. package/portal/FeatureLayer.d.ts +16 -0
  95. package/portal/FormInfo.d.ts +391 -0
  96. package/portal/FormInfo.js +1 -0
  97. package/portal/GroupLayer.d.ts +25 -0
  98. package/portal/ImageServiceLayer.d.ts +5 -0
  99. package/portal/ImageServiceVectorLayer.d.ts +5 -0
  100. package/portal/Item.d.ts +37 -10
  101. package/portal/LabelingInfo.d.ts +7 -2
  102. package/portal/LayerDefinition.d.ts +121 -0
  103. package/portal/MapFloorInfo.d.ts +130 -0
  104. package/portal/MapFloorInfo.js +1 -0
  105. package/portal/MapServiceLayer.d.ts +5 -0
  106. package/portal/MapServiceLayer.js +1 -1
  107. package/portal/Renderer.d.ts +32 -0
  108. package/portal/Symbol.d.ts +4 -4
  109. package/portal/Table.d.ts +11 -0
  110. package/portal/TiledImageServiceLayer.d.ts +5 -0
  111. package/portal/TiledMapServiceLayer.d.ts +5 -0
  112. package/portal/TiledMapServiceLayer.js +1 -1
  113. package/portal/UtilityNetwork.d.ts +42 -0
  114. package/portal/UtilityNetwork.js +1 -0
  115. package/portal/VectorTileLayer.d.ts +5 -0
  116. package/portal/WebMap.d.ts +16 -0
  117. package/portal/WebMap.js +1 -1
  118. package/portal/WebScene.d.ts +5 -0
  119. package/portal/WebScene.js +1 -1
  120. package/portal/WebTileLayer.js +1 -1
  121. package/portal/Widgets.d.ts +45 -0
  122. package/version.d.ts +1 -1
  123. package/version.js +1 -1
package/docs/html/interfaces/portal_forminfo.formradiobuttonsinput.html ADDED
@@ -0,0 +1,253 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>FormRadioButtonsInput | @vertigis/arcgis-extensions</title>
7
+ <meta name="description" content="Documentation for @vertigis/arcgis-extensions">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@vertigis/arcgis-extensions</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ </div>
43
+ </div>
44
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
45
+ </div>
46
+ </div>
47
+ </div>
48
+ </div>
49
+ <div class="tsd-page-title">
50
+ <div class="container">
51
+ <ul class="tsd-breadcrumb">
52
+ <li>
53
+ <a href="../modules.html">@vertigis/arcgis-extensions</a>
54
+ </li>
55
+ <li>
56
+ <a href="../modules/portal_forminfo.html">portal/FormInfo</a>
57
+ </li>
58
+ <li>
59
+ <a href="portal_forminfo.formradiobuttonsinput.html">FormRadioButtonsInput</a>
60
+ </li>
61
+ </ul>
62
+ <h1>Interface FormRadioButtonsInput</h1>
63
+ </div>
64
+ </div>
65
+ </header>
66
+ <div class="container container-main">
67
+ <div class="row">
68
+ <div class="col-8 col-content">
69
+ <section class="tsd-panel tsd-comment">
70
+ <div class="tsd-comment tsd-typography">
71
+ <div class="lead">
72
+ <p>Defines the desired user interface is a radio button group.
73
+ <a href="https://developers.arcgis.com/web-map-specification/objects/formRadioButtonsInput/" class="external">https://developers.arcgis.com/web-map-specification/objects/formRadioButtonsInput/</a>.</p>
74
+ </div>
75
+ </div>
76
+ </section>
77
+ <section class="tsd-panel tsd-hierarchy">
78
+ <h3>Hierarchy</h3>
79
+ <ul class="tsd-hierarchy">
80
+ <li>
81
+ <span class="target">FormRadioButtonsInput</span>
82
+ </li>
83
+ </ul>
84
+ </section>
85
+ <section class="tsd-panel-group tsd-index-group">
86
+ <h2>Index</h2>
87
+ <section class="tsd-panel tsd-index-panel">
88
+ <div class="tsd-index-content">
89
+ <section class="tsd-index-section ">
90
+ <h3>Properties</h3>
91
+ <ul class="tsd-index-list">
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formradiobuttonsinput.html#novalueoptionlabel" class="tsd-kind-icon">no<wbr>Value<wbr>Option<wbr>Label</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formradiobuttonsinput.html#shownovalueoption" class="tsd-kind-icon">show<wbr>NoValue<wbr>Option</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formradiobuttonsinput.html#type" class="tsd-kind-icon">type</a></li>
95
+ </ul>
96
+ </section>
97
+ </div>
98
+ </section>
99
+ </section>
100
+ <section class="tsd-panel-group tsd-member-group ">
101
+ <h2>Properties</h2>
102
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
103
+ <a name="novalueoptionlabel" class="tsd-anchor"></a>
104
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> no<wbr>Value<wbr>Option<wbr>Label</h3>
105
+ <div class="tsd-signature tsd-kind-icon">no<wbr>Value<wbr>Option<wbr>Label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
106
+ <aside class="tsd-sources">
107
+ <ul>
108
+ <li>Defined in src/portal/FormInfo.ts:378</li>
109
+ </ul>
110
+ </aside>
111
+ <div class="tsd-comment tsd-typography">
112
+ <div class="lead">
113
+ <p>The text used to represent a null value.</p>
114
+ </div>
115
+ </div>
116
+ </section>
117
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
118
+ <a name="shownovalueoption" class="tsd-anchor"></a>
119
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> show<wbr>NoValue<wbr>Option</h3>
120
+ <div class="tsd-signature tsd-kind-icon">show<wbr>NoValue<wbr>Option<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
121
+ <aside class="tsd-sources">
122
+ <ul>
123
+ <li>Defined in src/portal/FormInfo.ts:385</li>
124
+ </ul>
125
+ </aside>
126
+ <div class="tsd-comment tsd-typography">
127
+ <div class="lead">
128
+ <p>Determines whether null value option is displayed. This only applies to
129
+ fields that support null values. If not provided, the default value is
130
+ false.</p>
131
+ </div>
132
+ </div>
133
+ </section>
134
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
135
+ <a name="type" class="tsd-anchor"></a>
136
+ <h3>type</h3>
137
+ <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;radio-buttons&quot;</span></div>
138
+ <aside class="tsd-sources">
139
+ <ul>
140
+ <li>Defined in src/portal/FormInfo.ts:390</li>
141
+ </ul>
142
+ </aside>
143
+ <div class="tsd-comment tsd-typography">
144
+ <div class="lead">
145
+ <p>The input type identifier.</p>
146
+ </div>
147
+ </div>
148
+ </section>
149
+ </section>
150
+ </div>
151
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
152
+ <nav class="tsd-navigation primary">
153
+ <ul>
154
+ <li class=" ">
155
+ <a href="../modules.html">Exports</a>
156
+ </li>
157
+ <li class="current tsd-kind-module">
158
+ <a href="../modules/portal_forminfo.html">portal/<wbr>Form<wbr>Info</a>
159
+ </li>
160
+ </ul>
161
+ </nav>
162
+ <nav class="tsd-navigation secondary menu-sticky">
163
+ <ul class="before-current">
164
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="portal_forminfo.formattachmentelement.html" class="tsd-kind-icon">Form<wbr>Attachment<wbr>Element</a>
166
+ </li>
167
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
168
+ <a href="portal_forminfo.formbarcodescannerinput.html" class="tsd-kind-icon">Form<wbr>Barcode<wbr>Scanner<wbr>Input</a>
169
+ </li>
170
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
171
+ <a href="portal_forminfo.formcomboboxinput.html" class="tsd-kind-icon">Form<wbr>Combo<wbr>Box<wbr>Input</a>
172
+ </li>
173
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
174
+ <a href="portal_forminfo.formdatetimepickerinput.html" class="tsd-kind-icon">Form<wbr>Date<wbr>Time<wbr>Picker<wbr>Input</a>
175
+ </li>
176
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
177
+ <a href="portal_forminfo.formexpressioninfo.html" class="tsd-kind-icon">Form<wbr>Expression<wbr>Info</a>
178
+ </li>
179
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
180
+ <a href="portal_forminfo.formfieldelement.html" class="tsd-kind-icon">Form<wbr>Field<wbr>Element</a>
181
+ </li>
182
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
183
+ <a href="portal_forminfo.formgroupelement.html" class="tsd-kind-icon">Form<wbr>Group<wbr>Element</a>
184
+ </li>
185
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
186
+ <a href="portal_forminfo.forminfo.html" class="tsd-kind-icon">Form<wbr>Info</a>
187
+ </li>
188
+ </ul>
189
+ <ul class="current">
190
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
191
+ <a href="portal_forminfo.formradiobuttonsinput.html" class="tsd-kind-icon">Form<wbr>Radio<wbr>Buttons<wbr>Input</a>
192
+ <ul>
193
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
194
+ <a href="portal_forminfo.formradiobuttonsinput.html#novalueoptionlabel" class="tsd-kind-icon">no<wbr>Value<wbr>Option<wbr>Label</a>
195
+ </li>
196
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
197
+ <a href="portal_forminfo.formradiobuttonsinput.html#shownovalueoption" class="tsd-kind-icon">show<wbr>NoValue<wbr>Option</a>
198
+ </li>
199
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
200
+ <a href="portal_forminfo.formradiobuttonsinput.html#type" class="tsd-kind-icon">type</a>
201
+ </li>
202
+ </ul>
203
+ </li>
204
+ </ul>
205
+ <ul class="after-current">
206
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
207
+ <a href="portal_forminfo.formrelationshipelement.html" class="tsd-kind-icon">Form<wbr>Relationship<wbr>Element</a>
208
+ </li>
209
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
210
+ <a href="portal_forminfo.formswitchinput.html" class="tsd-kind-icon">Form<wbr>Switch<wbr>Input</a>
211
+ </li>
212
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
213
+ <a href="portal_forminfo.formtextareainput.html" class="tsd-kind-icon">Form<wbr>Text<wbr>Area<wbr>Input</a>
214
+ </li>
215
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
216
+ <a href="portal_forminfo.formtextboxinput.html" class="tsd-kind-icon">Form<wbr>Text<wbr>Box<wbr>Input</a>
217
+ </li>
218
+ </ul>
219
+ </nav>
220
+ </div>
221
+ </div>
222
+ </div>
223
+ <footer>
224
+ <div class="container">
225
+ <h2>Legend</h2>
226
+ <div class="tsd-legend-group">
227
+ <ul class="tsd-legend">
228
+ <li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
229
+ <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
230
+ <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
231
+ <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
232
+ <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
233
+ <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
234
+ </ul>
235
+ <ul class="tsd-legend">
236
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
237
+ <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
238
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
239
+ </ul>
240
+ <ul class="tsd-legend">
241
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
242
+ <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
243
+ </ul>
244
+ <ul class="tsd-legend">
245
+ <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
246
+ </ul>
247
+ </div>
248
+ </div>
249
+ </footer>
250
+ <div class="overlay"></div>
251
+ <script src="../assets/js/main.js"></script>
252
+ </body>
253
+ </html>
package/docs/html/interfaces/portal_forminfo.formrelationshipelement.html ADDED
@@ -0,0 +1,334 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>FormRelationshipElement | @vertigis/arcgis-extensions</title>
7
+ <meta name="description" content="Documentation for @vertigis/arcgis-extensions">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@vertigis/arcgis-extensions</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ </div>
43
+ </div>
44
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
45
+ </div>
46
+ </div>
47
+ </div>
48
+ </div>
49
+ <div class="tsd-page-title">
50
+ <div class="container">
51
+ <ul class="tsd-breadcrumb">
52
+ <li>
53
+ <a href="../modules.html">@vertigis/arcgis-extensions</a>
54
+ </li>
55
+ <li>
56
+ <a href="../modules/portal_forminfo.html">portal/FormInfo</a>
57
+ </li>
58
+ <li>
59
+ <a href="portal_forminfo.formrelationshipelement.html">FormRelationshipElement</a>
60
+ </li>
61
+ </ul>
62
+ <h1>Interface FormRelationshipElement</h1>
63
+ </div>
64
+ </div>
65
+ </header>
66
+ <div class="container container-main">
67
+ <div class="row">
68
+ <div class="col-8 col-content">
69
+ <section class="tsd-panel tsd-comment">
70
+ <div class="tsd-comment tsd-typography">
71
+ <div class="lead">
72
+ <p>Defines how a relationship between feature layers and tables can participate
73
+ in the form. When present in the form, the user may have the option to add or
74
+ edit related records.
75
+ <a href="https://developers.arcgis.com/web-map-specification/objects/formRelationshipElement/" class="external">https://developers.arcgis.com/web-map-specification/objects/formRelationshipElement/</a>.</p>
76
+ </div>
77
+ </div>
78
+ </section>
79
+ <section class="tsd-panel tsd-hierarchy">
80
+ <h3>Hierarchy</h3>
81
+ <ul class="tsd-hierarchy">
82
+ <li>
83
+ <span class="target">FormRelationshipElement</span>
84
+ </li>
85
+ </ul>
86
+ </section>
87
+ <section class="tsd-panel-group tsd-index-group">
88
+ <h2>Index</h2>
89
+ <section class="tsd-panel tsd-index-panel">
90
+ <div class="tsd-index-content">
91
+ <section class="tsd-index-section ">
92
+ <h3>Properties</h3>
93
+ <ul class="tsd-index-list">
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formrelationshipelement.html#description" class="tsd-kind-icon">description</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formrelationshipelement.html#displaycount" class="tsd-kind-icon">display<wbr>Count</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formrelationshipelement.html#displaytype" class="tsd-kind-icon">display<wbr>Type</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formrelationshipelement.html#editable" class="tsd-kind-icon">editable</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formrelationshipelement.html#label" class="tsd-kind-icon">label</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formrelationshipelement.html#type" class="tsd-kind-icon">type</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_forminfo.formrelationshipelement.html#visibilityexpression" class="tsd-kind-icon">visibility<wbr>Expression</a></li>
101
+ </ul>
102
+ </section>
103
+ </div>
104
+ </section>
105
+ </section>
106
+ <section class="tsd-panel-group tsd-member-group ">
107
+ <h2>Properties</h2>
108
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
109
+ <a name="description" class="tsd-anchor"></a>
110
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
111
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
+ <aside class="tsd-sources">
113
+ <ul>
114
+ <li>Defined in src/portal/FormInfo.ts:252</li>
115
+ </ul>
116
+ </aside>
117
+ <div class="tsd-comment tsd-typography">
118
+ <div class="lead">
119
+ <p>A string that describes the element in detail.</p>
120
+ </div>
121
+ </div>
122
+ </section>
123
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
124
+ <a name="displaycount" class="tsd-anchor"></a>
125
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> display<wbr>Count</h3>
126
+ <div class="tsd-signature tsd-kind-icon">display<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
127
+ <aside class="tsd-sources">
128
+ <ul>
129
+ <li>Defined in src/portal/FormInfo.ts:257</li>
130
+ </ul>
131
+ </aside>
132
+ <div class="tsd-comment tsd-typography">
133
+ <div class="lead">
134
+ <p>An integer that indicates the maximum number of records to display.</p>
135
+ </div>
136
+ </div>
137
+ </section>
138
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
139
+ <a name="displaytype" class="tsd-anchor"></a>
140
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> display<wbr>Type</h3>
141
+ <div class="tsd-signature tsd-kind-icon">display<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;list&quot;</span></div>
142
+ <aside class="tsd-sources">
143
+ <ul>
144
+ <li>Defined in src/portal/FormInfo.ts:262</li>
145
+ </ul>
146
+ </aside>
147
+ <div class="tsd-comment tsd-typography">
148
+ <div class="lead">
149
+ <p>A string that defines how the related records should be displayed.</p>
150
+ </div>
151
+ </div>
152
+ </section>
153
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
154
+ <a name="editable" class="tsd-anchor"></a>
155
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> editable</h3>
156
+ <div class="tsd-signature tsd-kind-icon">editable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
157
+ <aside class="tsd-sources">
158
+ <ul>
159
+ <li>Defined in src/portal/FormInfo.ts:268</li>
160
+ </ul>
161
+ </aside>
162
+ <div class="tsd-comment tsd-typography">
163
+ <div class="lead">
164
+ <p>A Boolean determining whether users can edit this form element. If not
165
+ supplied the default value is true.</p>
166
+ </div>
167
+ </div>
168
+ </section>
169
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
170
+ <a name="label" class="tsd-anchor"></a>
171
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> label</h3>
172
+ <div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
173
+ <aside class="tsd-sources">
174
+ <ul>
175
+ <li>Defined in src/portal/FormInfo.ts:273</li>
176
+ </ul>
177
+ </aside>
178
+ <div class="tsd-comment tsd-typography">
179
+ <div class="lead">
180
+ <p>A string value indicating what the element represents.</p>
181
+ </div>
182
+ </div>
183
+ </section>
184
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
185
+ <a name="type" class="tsd-anchor"></a>
186
+ <h3>type</h3>
187
+ <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;relationship&quot;</span></div>
188
+ <aside class="tsd-sources">
189
+ <ul>
190
+ <li>Defined in src/portal/FormInfo.ts:278</li>
191
+ </ul>
192
+ </aside>
193
+ <div class="tsd-comment tsd-typography">
194
+ <div class="lead">
195
+ <p>String value indicating which type of element to use.</p>
196
+ </div>
197
+ </div>
198
+ </section>
199
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
200
+ <a name="visibilityexpression" class="tsd-anchor"></a>
201
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> visibility<wbr>Expression</h3>
202
+ <div class="tsd-signature tsd-kind-icon">visibility<wbr>Expression<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
203
+ <aside class="tsd-sources">
204
+ <ul>
205
+ <li>Defined in src/portal/FormInfo.ts:287</li>
206
+ </ul>
207
+ </aside>
208
+ <div class="tsd-comment tsd-typography">
209
+ <div class="lead">
210
+ <p>A reference to an Arcade expression that returns a boolean value. When
211
+ this expression evaluates to true, the element is displayed. When the
212
+ expression evaluates to false the element is not displayed. If no
213
+ expression is provided, the default behavior is that the element is
214
+ displayed.</p>
215
+ </div>
216
+ </div>
217
+ </section>
218
+ </section>
219
+ </div>
220
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
221
+ <nav class="tsd-navigation primary">
222
+ <ul>
223
+ <li class=" ">
224
+ <a href="../modules.html">Exports</a>
225
+ </li>
226
+ <li class="current tsd-kind-module">
227
+ <a href="../modules/portal_forminfo.html">portal/<wbr>Form<wbr>Info</a>
228
+ </li>
229
+ </ul>
230
+ </nav>
231
+ <nav class="tsd-navigation secondary menu-sticky">
232
+ <ul class="before-current">
233
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
234
+ <a href="portal_forminfo.formattachmentelement.html" class="tsd-kind-icon">Form<wbr>Attachment<wbr>Element</a>
235
+ </li>
236
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
237
+ <a href="portal_forminfo.formbarcodescannerinput.html" class="tsd-kind-icon">Form<wbr>Barcode<wbr>Scanner<wbr>Input</a>
238
+ </li>
239
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
240
+ <a href="portal_forminfo.formcomboboxinput.html" class="tsd-kind-icon">Form<wbr>Combo<wbr>Box<wbr>Input</a>
241
+ </li>
242
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
243
+ <a href="portal_forminfo.formdatetimepickerinput.html" class="tsd-kind-icon">Form<wbr>Date<wbr>Time<wbr>Picker<wbr>Input</a>
244
+ </li>
245
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
246
+ <a href="portal_forminfo.formexpressioninfo.html" class="tsd-kind-icon">Form<wbr>Expression<wbr>Info</a>
247
+ </li>
248
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
249
+ <a href="portal_forminfo.formfieldelement.html" class="tsd-kind-icon">Form<wbr>Field<wbr>Element</a>
250
+ </li>
251
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
252
+ <a href="portal_forminfo.formgroupelement.html" class="tsd-kind-icon">Form<wbr>Group<wbr>Element</a>
253
+ </li>
254
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
255
+ <a href="portal_forminfo.forminfo.html" class="tsd-kind-icon">Form<wbr>Info</a>
256
+ </li>
257
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
258
+ <a href="portal_forminfo.formradiobuttonsinput.html" class="tsd-kind-icon">Form<wbr>Radio<wbr>Buttons<wbr>Input</a>
259
+ </li>
260
+ </ul>
261
+ <ul class="current">
262
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
263
+ <a href="portal_forminfo.formrelationshipelement.html" class="tsd-kind-icon">Form<wbr>Relationship<wbr>Element</a>
264
+ <ul>
265
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
266
+ <a href="portal_forminfo.formrelationshipelement.html#description" class="tsd-kind-icon">description</a>
267
+ </li>
268
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
269
+ <a href="portal_forminfo.formrelationshipelement.html#displaycount" class="tsd-kind-icon">display<wbr>Count</a>
270
+ </li>
271
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
272
+ <a href="portal_forminfo.formrelationshipelement.html#displaytype" class="tsd-kind-icon">display<wbr>Type</a>
273
+ </li>
274
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
275
+ <a href="portal_forminfo.formrelationshipelement.html#editable" class="tsd-kind-icon">editable</a>
276
+ </li>
277
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
278
+ <a href="portal_forminfo.formrelationshipelement.html#label" class="tsd-kind-icon">label</a>
279
+ </li>
280
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
281
+ <a href="portal_forminfo.formrelationshipelement.html#type" class="tsd-kind-icon">type</a>
282
+ </li>
283
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
284
+ <a href="portal_forminfo.formrelationshipelement.html#visibilityexpression" class="tsd-kind-icon">visibility<wbr>Expression</a>
285
+ </li>
286
+ </ul>
287
+ </li>
288
+ </ul>
289
+ <ul class="after-current">
290
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
291
+ <a href="portal_forminfo.formswitchinput.html" class="tsd-kind-icon">Form<wbr>Switch<wbr>Input</a>
292
+ </li>
293
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
294
+ <a href="portal_forminfo.formtextareainput.html" class="tsd-kind-icon">Form<wbr>Text<wbr>Area<wbr>Input</a>
295
+ </li>
296
+ <li class=" tsd-kind-interface tsd-parent-kind-module">
297
+ <a href="portal_forminfo.formtextboxinput.html" class="tsd-kind-icon">Form<wbr>Text<wbr>Box<wbr>Input</a>
298
+ </li>
299
+ </ul>
300
+ </nav>
301
+ </div>
302
+ </div>
303
+ </div>
304
+ <footer>
305
+ <div class="container">
306
+ <h2>Legend</h2>
307
+ <div class="tsd-legend-group">
308
+ <ul class="tsd-legend">
309
+ <li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
310
+ <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
311
+ <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
312
+ <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
313
+ <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
314
+ <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
315
+ </ul>
316
+ <ul class="tsd-legend">
317
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
318
+ <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
319
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
320
+ </ul>
321
+ <ul class="tsd-legend">
322
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
323
+ <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
324
+ </ul>
325
+ <ul class="tsd-legend">
326
+ <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
327
+ </ul>
328
+ </div>
329
+ </div>
330
+ </footer>
331
+ <div class="overlay"></div>
332
+ <script src="../assets/js/main.js"></script>
333
+ </body>
334
+ </html>