@vertigis/viewer-spec 47.6.0 → 47.6.1

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 (65) hide show
  1. package/app-config/AppConfig.d.ts +3 -6
  2. package/app-config/common/BrandingThemeProperties.d.ts +2 -4
  3. package/app-config/common/HighlightModelProperties.d.ts +2 -4
  4. package/app-config/common/LayerPresetsModelProperties.d.ts +1 -2
  5. package/app-config/common/LayoutProperties.d.ts +3 -3
  6. package/app-config/common/RegionModelProperties.d.ts +1 -2
  7. package/app-config/common/SearchModelProperties.d.ts +2 -2
  8. package/app-config/common/WorkflowModelProperties.d.ts +2 -4
  9. package/app-config/mobile/FeatureDetailsModelProperties.d.ts +2 -1
  10. package/app-config/mobile/SearchModelProperties.d.ts +3 -1
  11. package/app-config/mobile/VertigisMobileModelProperties.d.ts +1 -2
  12. package/app-config/schema/common-app-config.schema.json +1 -1
  13. package/app-config/schema/mobile-app-config.schema.json +1 -1
  14. package/app-config/schema/web-app-config.schema.json +1 -1
  15. package/app-config/web/DrawModelProperties.d.ts +1 -2
  16. package/app-config/web/FeatureDetailsModelProperties.d.ts +2 -2
  17. package/app-config/web/HasVisibilityFilters.d.ts +4 -4
  18. package/app-config/web/KpiCardModelProperties.d.ts +10 -10
  19. package/app-config/web/MapCoordinatesModelProperties.d.ts +1 -2
  20. package/app-config/web/MapModelProperties.d.ts +2 -4
  21. package/app-config/web/MeasurementModelProperties.d.ts +1 -2
  22. package/app-config/web/ResultsModelProperties.d.ts +2 -2
  23. package/app-config/web/SearchModelProperties.d.ts +1 -2
  24. package/app-config/web/VertigisWebModelProperties.d.ts +4 -6
  25. package/layout/schema/layout-common.xsd +843 -830
  26. package/layout/schema/layout-mobile.xsd +241 -234
  27. package/layout/schema/layout-web.xsd +281 -277
  28. package/layout/schema/schema-reference-example.xml +11 -10
  29. package/messaging/Command.d.ts +1 -2
  30. package/messaging/Event.d.ts +2 -4
  31. package/messaging/MessageBus.d.ts +2 -2
  32. package/messaging/Operation.d.ts +1 -2
  33. package/messaging/common.d.ts +9 -14
  34. package/messaging/registry/app.d.ts +6 -10
  35. package/messaging/registry/arcade.d.ts +3 -7
  36. package/messaging/registry/auth.d.ts +6 -10
  37. package/messaging/registry/basemap.d.ts +8 -8
  38. package/messaging/registry/charts.d.ts +2 -2
  39. package/messaging/registry/debugConsole.d.ts +3 -4
  40. package/messaging/registry/drawing.d.ts +3 -6
  41. package/messaging/registry/edit.d.ts +9 -14
  42. package/messaging/registry/geolocation.d.ts +13 -20
  43. package/messaging/registry/geometry.d.ts +26 -31
  44. package/messaging/registry/kpi.d.ts +2 -4
  45. package/messaging/registry/layer-comparison.d.ts +2 -2
  46. package/messaging/registry/layout.d.ts +1 -2
  47. package/messaging/registry/location-marker.d.ts +5 -10
  48. package/messaging/registry/map.d.ts +21 -22
  49. package/messaging/registry/measurement.d.ts +6 -8
  50. package/messaging/registry/messaging.d.ts +3 -3
  51. package/messaging/registry/offline.d.ts +19 -24
  52. package/messaging/registry/panel.d.ts +1 -2
  53. package/messaging/registry/portal.d.ts +1 -2
  54. package/messaging/registry/printing.d.ts +3 -4
  55. package/messaging/registry/results.d.ts +8 -16
  56. package/messaging/registry/sketching.d.ts +27 -40
  57. package/messaging/registry/system.d.ts +6 -6
  58. package/messaging/registry/tasks.d.ts +4 -6
  59. package/messaging/registry/ui.d.ts +12 -18
  60. package/messaging/registry/viewer.d.ts +1 -2
  61. package/messaging/registry/workflow.d.ts +2 -4
  62. package/messaging/schema/web-action.schema.json +1 -1
  63. package/package.json +17 -17
  64. package/version.d.ts +1 -1
  65. package/version.js +1 -1
@@ -1,879 +1,892 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <schema xmlns="http://www.w3.org/2001/XMLSchema"
3
- xmlns:tns="https://geocortex.com/layout/v1" targetNamespace="https://geocortex.com/layout/v1" elementFormDefault="qualified"
4
- xmlns:xs="http://www.w3.org/2001/XMLSchema">
5
- <element name="layout">
6
- <complexType>
7
- <sequence>
8
- <element ref="tns:component" minOccurs="0" maxOccurs="unbounded"/>
9
- <element ref="tns:rootComponent" minOccurs="0" maxOccurs="unbounded"/>
10
- </sequence>
11
- <attribute name="orientations">
1
+ <?xml version="1.0" encoding="UTF-8" ?>
2
+ <schema
3
+ xmlns="http://www.w3.org/2001/XMLSchema"
4
+ xmlns:tns="https://geocortex.com/layout/v1"
5
+ targetNamespace="https://geocortex.com/layout/v1"
6
+ elementFormDefault="qualified"
7
+ xmlns:xs="http://www.w3.org/2001/XMLSchema"
8
+ >
9
+ <element name="layout">
10
+ <complexType>
11
+ <sequence>
12
+ <element ref="tns:component" minOccurs="0" maxOccurs="unbounded" />
13
+ <element ref="tns:rootComponent" minOccurs="0" maxOccurs="unbounded" />
14
+ </sequence>
15
+ <attribute name="orientations">
16
+ <annotation>
17
+ <documentation xml:lang="en">
18
+ Indicates the allowable orientations - landscape or portrait, or both. When
19
+ set to "landscape" or "portrait", the orientation of
20
+ the device will be locked to the specified value. Defaults to both if value
21
+ not specified. Applies to iOS and Android Mobile only.
22
+ </documentation>
23
+ </annotation>
24
+ <simpleType>
25
+ <restriction base="string">
26
+ <enumeration value="landscape" />
27
+ <enumeration value="portrait" />
28
+ <enumeration value="portrait,landscape" />
29
+ </restriction>
30
+ </simpleType>
31
+ </attribute>
32
+ </complexType>
33
+ </element>
34
+
35
+ <complexType name="ComponentWithChildren" abstract="true">
36
+ <complexContent mixed="true">
37
+ <extension base="tns:Component">
38
+ <choice>
39
+ <element ref="tns:component" minOccurs="0" maxOccurs="unbounded" />
40
+ </choice>
41
+ </extension>
42
+ </complexContent>
43
+ </complexType>
44
+
45
+ <element name="rootComponent" type="tns:RootComponent" abstract="true" />
46
+
47
+ <complexType name="RootComponent" abstract="true">
48
+ <complexContent mixed="true">
49
+ <extension base="tns:Component">
50
+ <choice>
51
+ <element ref="tns:component" minOccurs="1" maxOccurs="unbounded" />
52
+ </choice>
53
+ </extension>
54
+ </complexContent>
55
+ </complexType>
56
+
57
+ <element name="component" type="tns:Component" abstract="true" />
58
+
59
+ <complexType name="Component" abstract="true">
12
60
  <annotation>
13
- <documentation xml:lang="en">
14
- Indicates the allowable orientations - landscape or portrait, or both. When set to "landscape" or "portrait", the orientation of
15
- the device will be locked to the specified value. Defaults to both if value not specified. Applies to iOS and Android Mobile only.
16
- </documentation>
61
+ <documentation xml:lang="en">
62
+ A visual element of an application's UI, e.g. a button, a map, a
63
+ a dialog box, a panel, etc.
64
+ </documentation>
17
65
  </annotation>
18
- <simpleType>
19
- <restriction base="string">
20
- <enumeration value="landscape"/>
21
- <enumeration value="portrait"/>
22
- <enumeration value="portrait,landscape"/>
23
- </restriction>
24
- </simpleType>
25
- </attribute>
26
- </complexType>
27
- </element>
28
-
29
- <complexType name="ComponentWithChildren" abstract="true">
30
- <complexContent mixed="true">
31
- <extension base="tns:Component">
32
- <choice>
33
- <element ref="tns:component" minOccurs="0" maxOccurs="unbounded"/>
34
- </choice>
35
- </extension>
36
- </complexContent>
37
- </complexType>
38
-
39
- <element name="rootComponent" type="tns:RootComponent" abstract="true"/>
40
-
41
- <complexType name="RootComponent" abstract="true">
42
- <complexContent mixed="true">
43
- <extension base="tns:Component">
44
- <choice>
45
- <element ref="tns:component" minOccurs="1" maxOccurs="unbounded"/>
46
- </choice>
47
- </extension>
48
- </complexContent>
49
- </complexType>
50
-
51
- <element name="component" type="tns:Component" abstract="true"/>
52
-
53
- <complexType name="Component" abstract="true">
54
- <annotation>
55
- <documentation xml:lang="en">
56
- A visual element of an application's UI, e.g. a button, a map, a
57
- a dialog box, a panel, etc.
58
- </documentation>
59
- </annotation>
60
- <sequence/>
61
- <attribute name="id" type="ID">
62
- <annotation>
63
- <documentation xml:lang="en">
64
- A unique ID for the component.
65
- </documentation>
66
- </annotation>
67
- </attribute>
68
- <attribute name="title" type="string">
69
- <annotation>
70
- <documentation xml:lang="en">
71
- A human-readable title for the component. Where the title
72
- appears (or whether it appears at all) varies with each type
73
- of component.
74
- </documentation>
75
- </annotation>
76
- </attribute>
77
- <attribute name="icon" type="string">
78
- <annotation>
79
- <documentation xml:lang="en">
80
- A resource key that can be mapped to an image for the icon.
81
- Where the icon appears (or whether it appears at all) varies
82
- with each type of component.
83
- </documentation>
84
- </annotation>
85
- </attribute>
86
- <attribute name="config" type="string">
87
- <annotation>
88
- <documentation xml:lang="en">
89
- The ID of a corresponding item in a Geocortex App that
90
- contains this component's configuration and state.
91
- </documentation>
92
- </annotation>
93
- </attribute>
94
- <attribute name="width">
95
- <annotation>
96
- <documentation xml:lang="en">
97
- The width of the component, in em units.
98
- </documentation>
99
- </annotation>
100
- <simpleType>
101
- <restriction base="double">
102
- <minInclusive value="0" />
103
- </restriction>
104
- </simpleType>
105
- </attribute>
106
- <attribute name="height">
107
- <annotation>
108
- <documentation xml:lang="en">
109
- The height of the component, in em units.
110
- </documentation>
111
- </annotation>
112
- <simpleType>
113
- <restriction base="double">
114
- <minInclusive value="0" />
115
- </restriction>
116
- </simpleType>
117
- </attribute>
118
- <attribute name="margin" type="double">
119
- <annotation>
120
- <documentation xml:lang="en">
121
- The margin around the component, in em units.
122
- </documentation>
123
- </annotation>
124
- </attribute>
125
- <attribute name="padding" type="double">
126
- <annotation>
127
- <documentation xml:lang="en">
128
- The padding within the component, in em units.
129
- </documentation>
130
- </annotation>
131
- </attribute>
132
- <attribute name="halign" default="start">
133
- <annotation>
134
- <documentation xml:lang="en">
135
- Describes how the content of a component is horizontally
136
- aligned. For stacks and splits, the content is the child
137
- components. For a component like text, the content is the
138
- text itself.
139
- </documentation>
140
- </annotation>
141
- <simpleType>
142
- <restriction base="string">
143
- <enumeration value="start"/>
144
- <enumeration value="center"/>
145
- <enumeration value="end"/>
146
- </restriction>
147
- </simpleType>
148
- </attribute>
149
- <attribute name="valign" default="start">
150
- <annotation>
151
- <documentation xml:lang="en">
152
- Describes how the content of a component is vertically
153
- aligned. For stacks and splits, the content is the child
154
- components. For a component like text, the content is the
155
- text itself.
156
- </documentation>
157
- </annotation>
158
- <simpleType>
159
- <restriction base="string">
160
- <enumeration value="start"/>
161
- <enumeration value="center"/>
162
- <enumeration value="end"/>
163
- </restriction>
164
- </simpleType>
165
- </attribute>
166
- <attribute name="grow" default="0">
167
- <annotation>
168
- <documentation xml:lang="en">
169
- Sets whether or not a component's width or height will grow
170
- over its parents primary axis. Components with a grow of 0
171
- will fill to their natural or requested width/height.
172
- Components with a specified grow will fill up a percentage
173
- of the remaining space equal to their grow value divided by
174
- the total grow of all sibling components (including the
175
- component in question).
176
- </documentation>
177
- </annotation>
178
- <simpleType>
179
- <restriction base="double">
180
- <minInclusive value="0" />
181
- </restriction>
182
- </simpleType>
183
- </attribute>
184
- <attribute name="slot" type="string">
185
- <annotation>
186
- <documentation xml:lang="en">
187
- When a component is nested inside of another component, it
188
- may explicitly reference a named "slot" in the parent
189
- component to indicate where the child should appear.
190
- </documentation>
191
- </annotation>
192
- </attribute>
193
- <attribute name="active" type="boolean">
194
- <annotation>
195
- <documentation xml:lang="en">
196
- Specifies whether a component is active by default or not. When this
197
- attribute is not defined, the parent component decides the child's
198
- behavior. In Web, an inactive component means that the component is
199
- initially not visible. An active component means the component is
200
- initially visible. In Mobile, inactive and active components are up to
201
- the interpretation of the parent to decide on how to render.
202
- </documentation>
203
- </annotation>
204
- </attribute>
205
- <attribute name="models" type="string">
206
- <annotation>
207
- <documentation xml:lang="en">
208
- Some components import the models of other components (for
209
- example, a scalebar component might need access to a map
210
- component's model). When these relationships cannot be
211
- determined implicitly from the layout, then the layout
212
- author can explicitly specify these dependencies via this
213
- attribute. The value is a comma-separated list of CSS-style
214
- selectors indiciating which components to import models
215
- from. For example, "map,#primary-scene" would specify all
216
- map components and a component with ID "primary-scene".
217
- </documentation>
218
- </annotation>
219
- </attribute>
220
- </complexType>
221
-
222
- <!-- Basic Components -->
223
-
224
- <element name="button" substitutionGroup="tns:component">
225
- <annotation>
226
- <documentation xml:lang="en">
227
- A button that executes a command when clicked. The caption will be
228
- the contained text, e.g. "Click Me!" in the case of
229
- <![CDATA[<button>Click Me!</button>]]>.
230
- </documentation>
231
- </annotation>
232
- <complexType>
233
- <complexContent mixed="true">
234
- <extension base="tns:Component">
235
- <attribute name="command" type="string">
66
+ <sequence />
67
+ <attribute name="id" type="ID">
236
68
  <annotation>
237
- <documentation xml:lang="en">
238
- The name of the command to execute.
239
- </documentation>
69
+ <documentation xml:lang="en">A unique ID for the component.</documentation>
240
70
  </annotation>
241
- </attribute>
242
- <attribute name="arguments" type="string">
71
+ </attribute>
72
+ <attribute name="title" type="string">
243
73
  <annotation>
244
- <documentation xml:lang="en">
245
- The arguments for the command (optional).
246
- </documentation>
74
+ <documentation xml:lang="en">
75
+ A human-readable title for the component. Where the title
76
+ appears (or whether it appears at all) varies with each type
77
+ of component.
78
+ </documentation>
247
79
  </annotation>
248
- </attribute>
249
- <attribute name="style">
80
+ </attribute>
81
+ <attribute name="icon" type="string">
250
82
  <annotation>
251
- <documentation xml:lang="en">
252
- The desired visual style for the button.
253
- </documentation>
83
+ <documentation xml:lang="en">
84
+ A resource key that can be mapped to an image for the icon.
85
+ Where the icon appears (or whether it appears at all) varies
86
+ with each type of component.
87
+ </documentation>
254
88
  </annotation>
255
- <simpleType>
256
- <restriction base="string">
257
- <enumeration value="round"/>
258
- <enumeration value="square"/>
259
- </restriction>
260
- </simpleType>
261
- </attribute>
262
- <attribute name="show-title" type="boolean" default="true">
89
+ </attribute>
90
+ <attribute name="config" type="string">
263
91
  <annotation>
264
- <documentation xml:lang="en">
265
- Whether to show the button's title.
266
- </documentation>
92
+ <documentation xml:lang="en">
93
+ The ID of a corresponding item in a Geocortex App that
94
+ contains this component's configuration and state.
95
+ </documentation>
267
96
  </annotation>
268
- </attribute>
269
- </extension>
270
- </complexContent>
271
- </complexType>
272
- </element>
273
-
274
- <element name="bookmarks" substitutionGroup="tns:component">
275
- <annotation>
276
- <documentation xml:lang="en">
277
- A component that shows the bookmarks associated with a map,
278
- and allows users to create their own bookmarks.
279
- </documentation>
280
- </annotation>
281
- <complexType>
282
- <complexContent>
283
- <extension base="tns:Component">
284
- <attribute name="style">
97
+ </attribute>
98
+ <attribute name="width">
285
99
  <annotation>
286
- <documentation xml:lang="en">
287
- The desired visual style for the button.
288
- </documentation>
100
+ <documentation xml:lang="en">
101
+ The width of the component, in em units.
102
+ </documentation>
289
103
  </annotation>
290
104
  <simpleType>
291
- <restriction base="string">
292
- <enumeration value="round"/>
293
- <enumeration value="square"/>
294
- </restriction>
105
+ <restriction base="double">
106
+ <minInclusive value="0" />
107
+ </restriction>
295
108
  </simpleType>
296
- </attribute>
297
- </extension>
298
- </complexContent>
299
- </complexType>
300
- </element>
301
-
302
- <element name="dialog" substitutionGroup="tns:rootComponent">
303
- <annotation>
304
- <documentation xml:lang="en">
305
- Displays a single child component in a dialog. Initially hidden. Displayed when
306
- the dialog component is activated. Not supported in Web.
307
- </documentation>
308
- </annotation>
309
- <complexType>
310
- <complexContent>
311
- <extension base="tns:RootComponent" />
312
- </complexContent>
313
- </complexType>
314
- </element>
315
-
316
- <element name="expand" substitutionGroup="tns:component">
317
- <annotation>
318
- <documentation xml:lang="en">
319
- A container whose content is hidden by default and only becomes visible
320
- when the small "expand" button is clicked. When the button is clicked,
321
- the container "pops up" and appears beside the expand button. Clicking
322
- the expand button while the container is open closes the container. This
323
- component is useful for hiding widget-like components that become
324
- visible at the click of a button.
325
- </documentation>
326
- </annotation>
327
- <complexType>
328
- <complexContent mixed="true">
329
- <extension base="tns:ComponentWithChildren">
330
- <attribute name="visual-state">
109
+ </attribute>
110
+ <attribute name="height">
331
111
  <annotation>
332
- <documentation xml:lang="en">
333
- The initial state of the Expand. Not supported in Mobile.
334
- </documentation>
112
+ <documentation xml:lang="en">
113
+ The height of the component, in em units.
114
+ </documentation>
335
115
  </annotation>
336
116
  <simpleType>
337
- <restriction base="string">
338
- <enumeration value="open"/>
339
- <enumeration value="closed"/>
340
- </restriction>
117
+ <restriction base="double">
118
+ <minInclusive value="0" />
119
+ </restriction>
341
120
  </simpleType>
342
- </attribute>
343
- <attribute name="modal" type="boolean" default="true">
121
+ </attribute>
122
+ <attribute name="margin" type="double">
344
123
  <annotation>
345
- <documentation xml:lang="en">
346
- Whether or not the expand container behaves as a modal window.
347
- </documentation>
124
+ <documentation xml:lang="en">
125
+ The margin around the component, in em units.
126
+ </documentation>
348
127
  </annotation>
349
- </attribute>
350
- <attribute name="showIcon" type="boolean" default="true">
128
+ </attribute>
129
+ <attribute name="padding" type="double">
351
130
  <annotation>
352
- <documentation xml:lang="en">
353
- Whether or not the icon should be displayed.
354
- </documentation>
131
+ <documentation xml:lang="en">
132
+ The padding within the component, in em units.
133
+ </documentation>
355
134
  </annotation>
356
- </attribute>
357
- <attribute name="showTitle" type="boolean" default="false">
135
+ </attribute>
136
+ <attribute name="halign" default="start">
358
137
  <annotation>
359
- <documentation xml:lang="en">
360
- Whether or not the title should be displayed.
361
- </documentation>
362
- </annotation>
363
- </attribute>
364
- <attribute name="style">
365
- <annotation>
366
- <documentation xml:lang="en">
367
- The desired visual style for the button.
368
- </documentation>
138
+ <documentation xml:lang="en">
139
+ Describes how the content of a component is horizontally
140
+ aligned. For stacks and splits, the content is the child
141
+ components. For a component like text, the content is the
142
+ text itself.
143
+ </documentation>
369
144
  </annotation>
370
145
  <simpleType>
371
- <restriction base="string">
372
- <enumeration value="round"/>
373
- <enumeration value="square"/>
374
- </restriction>
146
+ <restriction base="string">
147
+ <enumeration value="start" />
148
+ <enumeration value="center" />
149
+ <enumeration value="end" />
150
+ </restriction>
375
151
  </simpleType>
376
- </attribute>
377
- </extension>
378
- </complexContent>
379
- </complexType>
380
- </element>
381
-
382
- <element name="image" substitutionGroup="tns:component">
383
- <annotation>
384
- <documentation xml:lang="en">
385
- An image. Not supported in Mobile.
386
- </documentation>
387
- </annotation>
388
- <complexType>
389
- <complexContent>
390
- <extension base="tns:Component" />
391
- </complexContent>
392
- </complexType>
393
- </element>
394
-
395
- <element name="iwtm" substitutionGroup="tns:component">
396
- <annotation>
397
- <documentation xml:lang="en">
398
- An "I Want To..." menu (the actual title can be specified via the
399
- "title" attribute). Has a single slot in Web, at the top. Supports
400
- both "top" and "bottom" named slots in Mobile.
401
- </documentation>
402
- </annotation>
403
- <complexType>
404
- <complexContent>
405
- <extension base="tns:ComponentWithChildren" />
406
- </complexContent>
407
- </complexType>
408
- </element>
409
-
410
- <element name="panel" substitutionGroup="tns:component">
411
- <annotation>
412
- <documentation xml:lang="en">
413
- A container that enables hierarchical navigation between its
414
- child components. The user can navigate backwards to
415
- components that were activated prior to the currently active
416
- component and are ordered above the current component in
417
- configuration. The last component that is marked as active
418
- will be initially displayed, with all other components
419
- configured above that last component as active being
420
- accessible via navigating backwards.
421
- For example, if a panel has child components A, B, and C
422
- (configured in that order), and initially A is active, then
423
- activating C would display the C component but allow the user
424
- to navigate back to A. If the user then activated B while C
425
- is active, then C would be popped, and B would be shown,
426
- again with a back button to navigate to A but with no way of
427
- navigating to C because the configured order is maintained.
428
- </documentation>
429
- </annotation>
430
- <complexType>
431
- <complexContent mixed="true">
432
- <extension base="tns:ComponentWithChildren">
433
- <attribute name="show-close-button" type="boolean" default="true">
152
+ </attribute>
153
+ <attribute name="valign" default="start">
434
154
  <annotation>
435
- <documentation xml:lang="en">
436
- Whether to show a button that closes the Panel. Not supported in
437
- Mobile.
438
- </documentation>
439
- </annotation>
440
- </attribute>
441
- <attribute name="show-back-button" type="boolean" default="true">
442
- <annotation>
443
- <documentation xml:lang="en">
444
- Whether to show a button that allows the user to go "back". If a
445
- Panel has child components A, B, and C, and C is currently
446
- active, clicking the back button will hide C and B will be
447
- shown. Not supported in Mobile.
448
- </documentation>
449
- </annotation>
450
- </attribute>
451
- <attribute name="show-maximize-button" type="boolean" default="true">
452
- <annotation>
453
- <documentation xml:lang="en">
454
- Whether to show a button that allows the user to maximize the
455
- panel. A maximized panel will grow and fill the size of its
456
- parent container. Not supported in Mobile.
457
- </documentation>
458
- </annotation>
459
- </attribute>
460
- <attribute name="show-minimize-button" type="boolean" default="true">
461
- <annotation>
462
- <documentation xml:lang="en">
463
- Whether to show a button that allows the user to minimize the
464
- panel. A minimized panel will shrink to a small bar that only
465
- contains a "restore size" button. In a split, this is a vertical
466
- bar; in a stack (and other containers the arrange children
467
- vertically), this is a horizontal bar. Not supported in Mobile.
468
- </documentation>
469
- </annotation>
470
- </attribute>
471
- <attribute name="visual-state">
472
- <annotation>
473
- <documentation xml:lang="en">
474
- The initial state of the panel. Not supported in Mobile.
475
- </documentation>
155
+ <documentation xml:lang="en">
156
+ Describes how the content of a component is vertically
157
+ aligned. For stacks and splits, the content is the child
158
+ components. For a component like text, the content is the
159
+ text itself.
160
+ </documentation>
476
161
  </annotation>
477
162
  <simpleType>
478
- <restriction base="string">
479
- <enumeration value="normal"/>
480
- <enumeration value="minimized"/>
481
- <enumeration value="maximized"/>
482
- </restriction>
163
+ <restriction base="string">
164
+ <enumeration value="start" />
165
+ <enumeration value="center" />
166
+ <enumeration value="end" />
167
+ </restriction>
483
168
  </simpleType>
484
- </attribute>
485
- </extension>
486
- </complexContent>
487
- </complexType>
488
- </element>
489
-
490
- <element name="split" substitutionGroup="tns:component">
491
- <annotation>
492
- <documentation xml:lang="en">
493
- A container for other components that organizes its children
494
- horizontally.
495
- </documentation>
496
- </annotation>
497
- <complexType>
498
- <complexContent mixed="true">
499
- <extension base="tns:Component">
500
- <choice>
501
- <element ref="tns:component" minOccurs="0" maxOccurs="unbounded"/>
502
- </choice>
503
- <attribute name="resizable" type="boolean" default="false">
504
- <annotation>
505
- <documentation xml:lang="en">
506
- Whether the user can interactively resize the
507
- contained components. Not supported on all
508
- platforms.
509
- </documentation>
510
- </annotation>
511
- </attribute>
512
- </extension>
513
- </complexContent>
514
- </complexType>
515
- </element>
516
-
517
- <element name="stack" substitutionGroup="tns:component">
518
- <annotation>
519
- <documentation xml:lang="en">
520
- A container for other components that organizes its children
521
- vertically.
522
- </documentation>
523
- </annotation>
524
- <complexType>
525
- <complexContent mixed="true">
526
- <extension base="tns:Component">
527
- <choice>
528
- <element ref="tns:component" minOccurs="0" maxOccurs="unbounded"/>
529
- </choice>
530
- <attribute name="resizable" type="boolean" default="false">
531
- <annotation>
532
- <documentation xml:lang="en">
533
- Whether the user can interactively resize the
534
- contained components. Not supported on all
535
- platforms.
536
- </documentation>
537
- </annotation>
538
- </attribute>
539
- </extension>
540
- </complexContent>
541
- </complexType>
542
- </element>
543
-
544
- <element name="text" substitutionGroup="tns:component">
545
- <annotation>
546
- <documentation xml:lang="en">
547
- A component that displays text.
548
- </documentation>
549
- </annotation>
550
- <complexType>
551
- <complexContent mixed="true">
552
- <extension base="tns:Component" />
553
- </complexContent>
554
- </complexType>
555
- </element>
556
-
557
- <!-- NOTE: GXW-only, despite being in the common namespace. -->
558
- <element name="toolbar" substitutionGroup="tns:component">
559
- <annotation>
560
- <documentation xml:lang="en">
561
- A toolbar menu. The toolbar supports up to one level of nesting (a set of
562
- tools can be grouped together in one 'parent' that is displayed on the
563
- root toolbar menu.). Not supported in Mobile.
564
- </documentation>
565
- </annotation>
566
- <complexType>
567
- <complexContent>
568
- <extension base="tns:Component">
569
- <attribute name="orientation">
169
+ </attribute>
170
+ <attribute name="grow" default="0">
570
171
  <annotation>
571
- <documentation xml:lang="en">
572
- Determines the orientation of the toolbar menu items.
573
- </documentation>
172
+ <documentation xml:lang="en">
173
+ Sets whether or not a component's width or height will grow
174
+ over its parents primary axis. Components with a grow of 0
175
+ will fill to their natural or requested width/height.
176
+ Components with a specified grow will fill up a percentage
177
+ of the remaining space equal to their grow value divided by
178
+ the total grow of all sibling components (including the
179
+ component in question).
180
+ </documentation>
574
181
  </annotation>
575
182
  <simpleType>
576
- <restriction base="string">
577
- <enumeration value="vertical"/>
578
- <enumeration value="horizontal"/>
579
- </restriction>
183
+ <restriction base="double">
184
+ <minInclusive value="0" />
185
+ </restriction>
580
186
  </simpleType>
581
- </attribute>
582
- <attribute name="showTitles" type="boolean" default="true">
187
+ </attribute>
188
+ <attribute name="slot" type="string">
583
189
  <annotation>
584
- <documentation xml:lang="en">
585
- Whether to display the titles on buttons. You may wish to hide
586
- the titles in order to show just icons.
587
- </documentation>
190
+ <documentation xml:lang="en">
191
+ When a component is nested inside of another component, it
192
+ may explicitly reference a named "slot" in the parent
193
+ component to indicate where the child should appear.
194
+ </documentation>
588
195
  </annotation>
589
- </attribute>
590
- <attribute name="showDescriptions" type="boolean" default="true">
196
+ </attribute>
197
+ <attribute name="active" type="boolean">
591
198
  <annotation>
592
- <documentation xml:lang="en">
593
- Whether to display the descriptions inline in buttons. If turned
594
- off, the description will be in the tooltip instead for desktop
595
- users. No effect unless the orientation is "vertical" and titles
596
- are also shown.
597
- </documentation>
199
+ <documentation xml:lang="en">
200
+ Specifies whether a component is active by default or not.
201
+ When this attribute is not defined, the parent component
202
+ decides the child's behavior. In Web, an inactive component
203
+ means that the component is initially not visible. An active
204
+ component means the component is initially visible. In
205
+ Mobile, inactive and active components are up to the
206
+ interpretation of the parent to decide on how to render.
207
+ </documentation>
598
208
  </annotation>
599
- </attribute>
600
- </extension>
601
- </complexContent>
602
- </complexType>
603
- </element>
604
-
605
- <element name="user" substitutionGroup="tns:component">
606
- <annotation>
607
- <documentation xml:lang="en">
608
- Shows information about the current user (if there is one), and allows
609
- the user to sign in or out as appropriate. The user component does not
610
- support child components in Mobile.
611
- </documentation>
612
- </annotation>
613
- <complexType>
614
- <complexContent>
615
- <extension base="tns:ComponentWithChildren" />
616
- </complexContent>
617
- </complexType>
618
- </element>
619
-
620
- <element name="workflow" substitutionGroup="tns:component">
621
- <annotation>
622
- <documentation xml:lang="en">
623
- A component that hosts workflow forms. When a workflow item config is
624
- specified, the workflow will be run when the component is activated. Any
625
- command to run a workflow can use the component by adding
626
- '#{componentId}' to its target. If the component is activated outside
627
- the context of running a workflow, and does not have a workflow item
628
- config, it will appear empty. Only one workflow can use the component at
629
- a time. If a second workflow attempts to use the component, the user
630
- will be asked to cancel one of the workflows in Mobile. In Web, the
631
- first workflow is canceled automatically.
632
- </documentation>
633
- </annotation>
634
- <complexType>
635
- <complexContent mixed="true">
636
- <extension base="tns:Component" />
637
- </complexContent>
209
+ </attribute>
210
+ <attribute name="models" type="string">
211
+ <annotation>
212
+ <documentation xml:lang="en">
213
+ Some components import the models of other components (for
214
+ example, a scalebar component might need access to a map
215
+ component's model). When these relationships cannot be
216
+ determined implicitly from the layout, then the layout
217
+ author can explicitly specify these dependencies via this
218
+ attribute. The value is a comma-separated list of CSS-style
219
+ selectors indiciating which components to import models
220
+ from. For example, "map,#primary-scene" would specify all
221
+ map components and a component with ID "primary-scene".
222
+ </documentation>
223
+ </annotation>
224
+ </attribute>
638
225
  </complexType>
639
- </element>
640
226
 
641
- <!-- GIS Components -->
227
+ <!-- Basic Components -->
642
228
 
643
- <element name="basemap-picker" substitutionGroup="tns:component">
644
- <annotation>
645
- <documentation xml:lang="en">
646
- Allows users to choose between available basemaps for the webmap or
647
- webscene. Requiers an associated map component (see the "models"
648
- attribute).
229
+ <element name="button" substitutionGroup="tns:component">
230
+ <annotation>
231
+ <documentation xml:lang="en">
232
+ A button that executes a command when clicked. The caption will
233
+ be the contained text, e.g. "Click Me!" in the case of
234
+ <![CDATA[<button>Click Me!</button>]]>.
649
235
  </documentation>
650
- </annotation>
651
- <complexType>
652
- <complexContent>
653
- <extension base="tns:Component" />
654
- </complexContent>
655
- </complexType>
656
- </element>
236
+ </annotation>
237
+ <complexType>
238
+ <complexContent mixed="true">
239
+ <extension base="tns:Component">
240
+ <attribute name="command" type="string">
241
+ <annotation>
242
+ <documentation xml:lang="en">
243
+ The name of the command to execute.
244
+ </documentation>
245
+ </annotation>
246
+ </attribute>
247
+ <attribute name="arguments" type="string">
248
+ <annotation>
249
+ <documentation xml:lang="en">
250
+ The arguments for the command (optional).
251
+ </documentation>
252
+ </annotation>
253
+ </attribute>
254
+ <attribute name="style">
255
+ <annotation>
256
+ <documentation xml:lang="en">
257
+ The desired visual style for the button.
258
+ </documentation>
259
+ </annotation>
260
+ <simpleType>
261
+ <restriction base="string">
262
+ <enumeration value="round" />
263
+ <enumeration value="square" />
264
+ </restriction>
265
+ </simpleType>
266
+ </attribute>
267
+ <attribute name="show-title" type="boolean" default="true">
268
+ <annotation>
269
+ <documentation xml:lang="en">
270
+ Whether to show the button's title.
271
+ </documentation>
272
+ </annotation>
273
+ </attribute>
274
+ </extension>
275
+ </complexContent>
276
+ </complexType>
277
+ </element>
657
278
 
658
- <element name="compass" substitutionGroup="tns:component">
659
- <annotation>
660
- <documentation xml:lang="en">
661
- Displays a North-pointing compass that rotates with the rotation of the map to which it is associated.
662
- </documentation>
663
- </annotation>
664
- <complexType>
665
- <complexContent>
666
- <extension base="tns:Component" />
667
- </complexContent>
668
- </complexType>
669
- </element>
279
+ <element name="bookmarks" substitutionGroup="tns:component">
280
+ <annotation>
281
+ <documentation xml:lang="en">
282
+ A component that shows the bookmarks associated with a map, and
283
+ allows users to create their own bookmarks.
284
+ </documentation>
285
+ </annotation>
286
+ <complexType>
287
+ <complexContent>
288
+ <extension base="tns:Component">
289
+ <attribute name="style">
290
+ <annotation>
291
+ <documentation xml:lang="en">
292
+ The desired visual style for the button.
293
+ </documentation>
294
+ </annotation>
295
+ <simpleType>
296
+ <restriction base="string">
297
+ <enumeration value="round" />
298
+ <enumeration value="square" />
299
+ </restriction>
300
+ </simpleType>
301
+ </attribute>
302
+ </extension>
303
+ </complexContent>
304
+ </complexType>
305
+ </element>
306
+
307
+ <element name="dialog" substitutionGroup="tns:rootComponent">
308
+ <annotation>
309
+ <documentation xml:lang="en">
310
+ Displays a single child component in a dialog. Initially hidden.
311
+ Displayed when the dialog component is activated. Not supported
312
+ in Web.
313
+ </documentation>
314
+ </annotation>
315
+ <complexType>
316
+ <complexContent>
317
+ <extension base="tns:RootComponent" />
318
+ </complexContent>
319
+ </complexType>
320
+ </element>
321
+
322
+ <element name="expand" substitutionGroup="tns:component">
323
+ <annotation>
324
+ <documentation xml:lang="en">
325
+ A container whose content is hidden by default and only becomes
326
+ visible when the small "expand" button is clicked. When the
327
+ button is clicked, the container "pops up" and appears beside
328
+ the expand button. Clicking the expand button while the
329
+ container is open closes the container. This component is useful
330
+ for hiding widget-like components that become visible at the
331
+ click of a button.
332
+ </documentation>
333
+ </annotation>
334
+ <complexType>
335
+ <complexContent mixed="true">
336
+ <extension base="tns:ComponentWithChildren">
337
+ <attribute name="visual-state">
338
+ <annotation>
339
+ <documentation xml:lang="en">
340
+ The initial state of the Expand. Not supported in Mobile.
341
+ </documentation>
342
+ </annotation>
343
+ <simpleType>
344
+ <restriction base="string">
345
+ <enumeration value="open" />
346
+ <enumeration value="closed" />
347
+ </restriction>
348
+ </simpleType>
349
+ </attribute>
350
+ <attribute name="modal" type="boolean" default="true">
351
+ <annotation>
352
+ <documentation xml:lang="en">
353
+ Whether or not the expand container behaves as a modal window.
354
+ </documentation>
355
+ </annotation>
356
+ </attribute>
357
+ <attribute name="showIcon" type="boolean" default="true">
358
+ <annotation>
359
+ <documentation xml:lang="en">
360
+ Whether or not the icon should be displayed.
361
+ </documentation>
362
+ </annotation>
363
+ </attribute>
364
+ <attribute name="showTitle" type="boolean" default="false">
365
+ <annotation>
366
+ <documentation xml:lang="en">
367
+ Whether or not the title should be displayed.
368
+ </documentation>
369
+ </annotation>
370
+ </attribute>
371
+ <attribute name="style">
372
+ <annotation>
373
+ <documentation xml:lang="en">
374
+ The desired visual style for the button.
375
+ </documentation>
376
+ </annotation>
377
+ <simpleType>
378
+ <restriction base="string">
379
+ <enumeration value="round" />
380
+ <enumeration value="square" />
381
+ </restriction>
382
+ </simpleType>
383
+ </attribute>
384
+ </extension>
385
+ </complexContent>
386
+ </complexType>
387
+ </element>
388
+
389
+ <element name="image" substitutionGroup="tns:component">
390
+ <annotation>
391
+ <documentation xml:lang="en">An image. Not supported in Mobile.</documentation>
392
+ </annotation>
393
+ <complexType>
394
+ <complexContent>
395
+ <extension base="tns:Component" />
396
+ </complexContent>
397
+ </complexType>
398
+ </element>
399
+
400
+ <element name="iwtm" substitutionGroup="tns:component">
401
+ <annotation>
402
+ <documentation xml:lang="en">
403
+ An "I Want To..." menu (the actual title can be specified via
404
+ the "title" attribute). Has a single slot in Web, at the top.
405
+ Supports both "top" and "bottom" named slots in Mobile.
406
+ </documentation>
407
+ </annotation>
408
+ <complexType>
409
+ <complexContent>
410
+ <extension base="tns:ComponentWithChildren" />
411
+ </complexContent>
412
+ </complexType>
413
+ </element>
414
+
415
+ <element name="panel" substitutionGroup="tns:component">
416
+ <annotation>
417
+ <documentation xml:lang="en">
418
+ A container that enables hierarchical navigation between its
419
+ child components. The user can navigate backwards to components
420
+ that were activated prior to the currently active component and
421
+ are ordered above the current component in configuration. The
422
+ last component that is marked as active will be initially
423
+ displayed, with all other components configured above that last
424
+ component as active being accessible via navigating backwards.
425
+ For example, if a panel has child components A, B, and C
426
+ (configured in that order), and initially A is active, then
427
+ activating C would display the C component but allow the user to
428
+ navigate back to A. If the user then activated B while C is
429
+ active, then C would be popped, and B would be shown, again with
430
+ a back button to navigate to A but with no way of navigating to
431
+ C because the configured order is maintained.
432
+ </documentation>
433
+ </annotation>
434
+ <complexType>
435
+ <complexContent mixed="true">
436
+ <extension base="tns:ComponentWithChildren">
437
+ <attribute name="show-close-button" type="boolean" default="true">
438
+ <annotation>
439
+ <documentation xml:lang="en">
440
+ Whether to show a button that closes the Panel. Not supported in
441
+ Mobile.
442
+ </documentation>
443
+ </annotation>
444
+ </attribute>
445
+ <attribute name="show-back-button" type="boolean" default="true">
446
+ <annotation>
447
+ <documentation xml:lang="en">
448
+ Whether to show a button that allows the user to
449
+ go "back". If a Panel has child components A, B,
450
+ and C, and C is currently active, clicking the
451
+ back button will hide C and B will be shown. Not
452
+ supported in Mobile.
453
+ </documentation>
454
+ </annotation>
455
+ </attribute>
456
+ <attribute name="show-maximize-button" type="boolean" default="true">
457
+ <annotation>
458
+ <documentation xml:lang="en">
459
+ Whether to show a button that allows the user to
460
+ maximize the panel. A maximized panel will grow
461
+ and fill the size of its parent container. Not
462
+ supported in Mobile.
463
+ </documentation>
464
+ </annotation>
465
+ </attribute>
466
+ <attribute name="show-minimize-button" type="boolean" default="true">
467
+ <annotation>
468
+ <documentation xml:lang="en">
469
+ Whether to show a button that allows the user to
470
+ minimize the panel. A minimized panel will
471
+ shrink to a small bar that only contains a
472
+ "restore size" button. In a split, this is a
473
+ vertical bar; in a stack (and other containers
474
+ the arrange children vertically), this is a
475
+ horizontal bar. Not supported in Mobile.
476
+ </documentation>
477
+ </annotation>
478
+ </attribute>
479
+ <attribute name="visual-state">
480
+ <annotation>
481
+ <documentation xml:lang="en">
482
+ The initial state of the panel. Not supported in Mobile.
483
+ </documentation>
484
+ </annotation>
485
+ <simpleType>
486
+ <restriction base="string">
487
+ <enumeration value="normal" />
488
+ <enumeration value="minimized" />
489
+ <enumeration value="maximized" />
490
+ </restriction>
491
+ </simpleType>
492
+ </attribute>
493
+ </extension>
494
+ </complexContent>
495
+ </complexType>
496
+ </element>
497
+
498
+ <element name="split" substitutionGroup="tns:component">
499
+ <annotation>
500
+ <documentation xml:lang="en">
501
+ A container for other components that organizes its children
502
+ horizontally.
503
+ </documentation>
504
+ </annotation>
505
+ <complexType>
506
+ <complexContent mixed="true">
507
+ <extension base="tns:Component">
508
+ <choice>
509
+ <element ref="tns:component" minOccurs="0" maxOccurs="unbounded" />
510
+ </choice>
511
+ <attribute name="resizable" type="boolean" default="false">
512
+ <annotation>
513
+ <documentation xml:lang="en">
514
+ Whether the user can interactively resize the
515
+ contained components. Not supported on all
516
+ platforms.
517
+ </documentation>
518
+ </annotation>
519
+ </attribute>
520
+ </extension>
521
+ </complexContent>
522
+ </complexType>
523
+ </element>
524
+
525
+ <element name="stack" substitutionGroup="tns:component">
526
+ <annotation>
527
+ <documentation xml:lang="en">
528
+ A container for other components that organizes its children
529
+ vertically.
530
+ </documentation>
531
+ </annotation>
532
+ <complexType>
533
+ <complexContent mixed="true">
534
+ <extension base="tns:Component">
535
+ <choice>
536
+ <element ref="tns:component" minOccurs="0" maxOccurs="unbounded" />
537
+ </choice>
538
+ <attribute name="resizable" type="boolean" default="false">
539
+ <annotation>
540
+ <documentation xml:lang="en">
541
+ Whether the user can interactively resize the
542
+ contained components. Not supported on all
543
+ platforms.
544
+ </documentation>
545
+ </annotation>
546
+ </attribute>
547
+ </extension>
548
+ </complexContent>
549
+ </complexType>
550
+ </element>
551
+
552
+ <element name="text" substitutionGroup="tns:component">
553
+ <annotation>
554
+ <documentation xml:lang="en">A component that displays text.</documentation>
555
+ </annotation>
556
+ <complexType>
557
+ <complexContent mixed="true">
558
+ <extension base="tns:Component" />
559
+ </complexContent>
560
+ </complexType>
561
+ </element>
562
+
563
+ <!-- NOTE: GXW-only, despite being in the common namespace. -->
564
+ <element name="toolbar" substitutionGroup="tns:component">
565
+ <annotation>
566
+ <documentation xml:lang="en">
567
+ A toolbar menu. The toolbar supports up to one level of nesting
568
+ (a set of tools can be grouped together in one 'parent' that is
569
+ displayed on the root toolbar menu.). Not supported in Mobile.
570
+ </documentation>
571
+ </annotation>
572
+ <complexType>
573
+ <complexContent>
574
+ <extension base="tns:Component">
575
+ <attribute name="orientation">
576
+ <annotation>
577
+ <documentation xml:lang="en">
578
+ Determines the orientation of the toolbar menu items.
579
+ </documentation>
580
+ </annotation>
581
+ <simpleType>
582
+ <restriction base="string">
583
+ <enumeration value="vertical" />
584
+ <enumeration value="horizontal" />
585
+ </restriction>
586
+ </simpleType>
587
+ </attribute>
588
+ <attribute name="showTitles" type="boolean" default="true">
589
+ <annotation>
590
+ <documentation xml:lang="en">
591
+ Whether to display the titles on buttons. You
592
+ may wish to hide the titles in order to show
593
+ just icons.
594
+ </documentation>
595
+ </annotation>
596
+ </attribute>
597
+ <attribute name="showDescriptions" type="boolean" default="true">
598
+ <annotation>
599
+ <documentation xml:lang="en">
600
+ Whether to display the descriptions inline in
601
+ buttons. If turned off, the description will be
602
+ in the tooltip instead for desktop users. No
603
+ effect unless the orientation is "vertical" and
604
+ titles are also shown.
605
+ </documentation>
606
+ </annotation>
607
+ </attribute>
608
+ </extension>
609
+ </complexContent>
610
+ </complexType>
611
+ </element>
612
+
613
+ <element name="user" substitutionGroup="tns:component">
614
+ <annotation>
615
+ <documentation xml:lang="en">
616
+ Shows information about the current user (if there is one), and
617
+ allows the user to sign in or out as appropriate. The user
618
+ component does not support child components in Mobile.
619
+ </documentation>
620
+ </annotation>
621
+ <complexType>
622
+ <complexContent>
623
+ <extension base="tns:ComponentWithChildren" />
624
+ </complexContent>
625
+ </complexType>
626
+ </element>
627
+
628
+ <element name="workflow" substitutionGroup="tns:component">
629
+ <annotation>
630
+ <documentation xml:lang="en">
631
+ A component that hosts workflow forms. When a workflow item
632
+ config is specified, the workflow will be run when the component
633
+ is activated. Any command to run a workflow can use the
634
+ component by adding '#{componentId}' to its target. If the
635
+ component is activated outside the context of running a
636
+ workflow, and does not have a workflow item config, it will
637
+ appear empty. Only one workflow can use the component at a time.
638
+ If a second workflow attempts to use the component, the user
639
+ will be asked to cancel one of the workflows in Mobile. In Web,
640
+ the first workflow is canceled automatically.
641
+ </documentation>
642
+ </annotation>
643
+ <complexType>
644
+ <complexContent mixed="true">
645
+ <extension base="tns:Component" />
646
+ </complexContent>
647
+ </complexType>
648
+ </element>
670
649
 
671
- <element name="feature-details" substitutionGroup="tns:component">
672
- <annotation>
673
- <documentation xml:lang="en">
674
- A component that allows the user to view feature details.
675
- </documentation>
676
- </annotation>
677
- <complexType>
678
- <complexContent>
679
- <extension base="tns:Component" />
680
- </complexContent>
681
- </complexType>
682
- </element>
650
+ <!-- GIS Components -->
683
651
 
684
- <element name="geolocate" substitutionGroup="tns:component">
685
- <annotation>
686
- <documentation xml:lang="en">
687
- Displays a clickable/tappable indicator that toggles GPS geolocation behavior. In Mobile,
688
- the accuracy is also shown, and can be displayed in either metric or imperial units.
689
- </documentation>
690
- </annotation>
691
- <complexType>
692
- <complexContent>
693
- <extension base="tns:Component" />
694
- </complexContent>
695
- </complexType>
696
- </element>
697
-
698
- <element name="layer-list" substitutionGroup="tns:component">
699
- <annotation>
700
- <documentation xml:lang="en">
701
- Allows users to see the structure of layers on the map and change their
702
- visibility. Requires an associated map component (see the "models"
703
- attribute).
704
- </documentation>
705
- </annotation>
706
- <complexType>
707
- <complexContent>
708
- <extension base="tns:Component" />
709
- </complexContent>
710
- </complexType>
711
- </element>
652
+ <element name="basemap-picker" substitutionGroup="tns:component">
653
+ <annotation>
654
+ <documentation xml:lang="en">
655
+ Allows users to choose between available basemaps for the webmap
656
+ or webscene. Requiers an associated map component (see the
657
+ "models" attribute).
658
+ </documentation>
659
+ </annotation>
660
+ <complexType>
661
+ <complexContent>
662
+ <extension base="tns:Component" />
663
+ </complexContent>
664
+ </complexType>
665
+ </element>
666
+
667
+ <element name="compass" substitutionGroup="tns:component">
668
+ <annotation>
669
+ <documentation xml:lang="en">
670
+ Displays a North-pointing compass that rotates with the rotation of the map to which
671
+ it is associated.
672
+ </documentation>
673
+ </annotation>
674
+ <complexType>
675
+ <complexContent>
676
+ <extension base="tns:Component" />
677
+ </complexContent>
678
+ </complexType>
679
+ </element>
680
+
681
+ <element name="feature-details" substitutionGroup="tns:component">
682
+ <annotation>
683
+ <documentation xml:lang="en">
684
+ A component that allows the user to view feature details.
685
+ </documentation>
686
+ </annotation>
687
+ <complexType>
688
+ <complexContent>
689
+ <extension base="tns:Component" />
690
+ </complexContent>
691
+ </complexType>
692
+ </element>
693
+
694
+ <element name="geolocate" substitutionGroup="tns:component">
695
+ <annotation>
696
+ <documentation xml:lang="en">
697
+ Displays a clickable/tappable indicator that toggles GPS
698
+ geolocation behavior. In Mobile, the accuracy is also shown, and
699
+ can be displayed in either metric or imperial units.
700
+ </documentation>
701
+ </annotation>
702
+ <complexType>
703
+ <complexContent>
704
+ <extension base="tns:Component" />
705
+ </complexContent>
706
+ </complexType>
707
+ </element>
708
+
709
+ <element name="layer-list" substitutionGroup="tns:component">
710
+ <annotation>
711
+ <documentation xml:lang="en">
712
+ Allows users to see the structure of layers on the map and
713
+ change their visibility. Requires an associated map component
714
+ (see the "models" attribute).
715
+ </documentation>
716
+ </annotation>
717
+ <complexType>
718
+ <complexContent>
719
+ <extension base="tns:Component" />
720
+ </complexContent>
721
+ </complexType>
722
+ </element>
712
723
 
713
724
  <element name="layer-presets" substitutionGroup="tns:component">
714
- <annotation>
715
- <documentation xml:lang="en">
716
- A component that shows a list of layer presets and allows users to apply
717
- them.
718
- </documentation>
719
- </annotation>
720
- <complexType>
721
- <complexContent>
722
- <extension base="tns:Component">
723
- <attribute name="filter-by">
724
- <annotation>
725
- <documentation xml:lang="en">
726
- Indicates how the filter box will behave; if the value is
727
- 'none', no filter box will be displayed. Web only.
728
- </documentation>
729
- </annotation>
730
- <simpleType>
731
- <restriction base="string">
732
- <enumeration value="none"/>
733
- <enumeration value="title"/>
734
- <enumeration value="title-and-description"/>
735
- </restriction>
736
- </simpleType>
737
- </attribute>
738
- <attribute name="show-title" type="boolean" default="true">
739
- <annotation>
740
- <documentation xml:lang="en">
741
- Indicates if the title should be displayed. Web only.
742
- </documentation>
743
- </annotation>
744
- </attribute>
745
- <attribute name="show-icon" type="boolean" default="true">
746
- <annotation>
747
- <documentation xml:lang="en">
748
- Indicates if the icon should be displayed. Web only.
749
- </documentation>
750
- </annotation>
751
- </attribute>
752
- </extension>
753
- </complexContent>
754
- </complexType>
755
- </element>
756
-
757
- <element name="legend" substitutionGroup="tns:component">
758
- <annotation>
759
- <documentation xml:lang="en">
760
- Allows the user to see the symbology of the layers on the map. Requires
761
- an associated map component (see the "models" attribute").
762
- </documentation>
763
- </annotation>
764
- <complexType>
765
- <complexContent>
766
- <extension base="tns:Component" />
767
- </complexContent>
768
- </complexType>
769
- </element>
770
-
771
- <element name="map" substitutionGroup="tns:component">
772
- <annotation>
773
- <documentation xml:lang="en">
774
- A 2D map (and/or a 3D scene in Web). A map can host child components and
775
- has the following slots in Mobile: "top-left", "top-right",
776
- "bottom-left", "bottom-right", "top", "top-center-visible", "bottom" and
777
- "bottom-center-visible". A child component in the "center-visible" slot
778
- will be centered in the visible area of the map, factoring in other
779
- components that are overlapping the map.
725
+ <annotation>
726
+ <documentation xml:lang="en">
727
+ A component that shows a list of layer presets and allows users
728
+ to apply them.
729
+ </documentation>
730
+ </annotation>
731
+ <complexType>
732
+ <complexContent>
733
+ <extension base="tns:Component">
734
+ <attribute name="filter-by">
735
+ <annotation>
736
+ <documentation xml:lang="en">
737
+ Indicates how the filter box will behave; if the
738
+ value is 'none', no filter box will be
739
+ displayed. Web only.
740
+ </documentation>
741
+ </annotation>
742
+ <simpleType>
743
+ <restriction base="string">
744
+ <enumeration value="none" />
745
+ <enumeration value="title" />
746
+ <enumeration value="title-and-description" />
747
+ </restriction>
748
+ </simpleType>
749
+ </attribute>
750
+ <attribute name="show-title" type="boolean" default="true">
751
+ <annotation>
752
+ <documentation xml:lang="en">
753
+ Indicates if the title should be displayed. Web only.
754
+ </documentation>
755
+ </annotation>
756
+ </attribute>
757
+ <attribute name="show-icon" type="boolean" default="true">
758
+ <annotation>
759
+ <documentation xml:lang="en">
760
+ Indicates if the icon should be displayed. Web only.
761
+ </documentation>
762
+ </annotation>
763
+ </attribute>
764
+ </extension>
765
+ </complexContent>
766
+ </complexType>
767
+ </element>
768
+
769
+ <element name="legend" substitutionGroup="tns:component">
770
+ <annotation>
771
+ <documentation xml:lang="en">
772
+ Allows the user to see the symbology of the layers on the map.
773
+ Requires an associated map component (see the "models"
774
+ attribute").
775
+ </documentation>
776
+ </annotation>
777
+ <complexType>
778
+ <complexContent>
779
+ <extension base="tns:Component" />
780
+ </complexContent>
781
+ </complexType>
782
+ </element>
783
+
784
+ <element name="map" substitutionGroup="tns:component">
785
+ <annotation>
786
+ <documentation xml:lang="en">
787
+ A 2D map (and/or a 3D scene in Web). A map can host child
788
+ components and has the following slots in Mobile: "top-left",
789
+ "top-right", "bottom-left", "bottom-right", "top",
790
+ "top-center-visible", "bottom" and "bottom-center-visible". A
791
+ child component in the "center-visible" slot will be centered in
792
+ the visible area of the map, factoring in other components that
793
+ are overlapping the map.
780
794
 
781
- A map in Web has the following slots: "top-start", "top-center",
782
- "top-end", "bottom-start", "bottom-center", "bottom-end",
783
- "context-menu", and "popup". In left-to-right locales, "start" will be
784
- on the left, and "end" will be on the right. In right-to-left locales,
785
- these will be reversed.
786
- </documentation>
787
- </annotation>
788
- <complexType>
789
- <complexContent mixed="true">
790
- <extension base="tns:ComponentWithChildren" />
791
- </complexContent>
792
- </complexType>
793
- </element>
794
-
795
- <!-- NOTE: GXW-only, despite being in the common namespace. -->
796
- <element name="map-coordinates" substitutionGroup="tns:component">
797
- <annotation>
798
- <documentation xml:lang="en">
799
- Allows the user to see the coordinates under the current mouse position.
800
- Requires an associated map component (see the "models" attribute"). Not
801
- supported in Mobile.
802
- </documentation>
803
- </annotation>
804
- <complexType>
805
- <complexContent>
806
- <extension base="tns:Component" />
807
- </complexContent>
808
- </complexType>
809
- </element>
810
-
811
- <element name="results-list" substitutionGroup="tns:component">
812
- <annotation>
813
- <documentation xml:lang="en">
814
- A component that allows the user to view results from a search,
815
- identify, query, or any other activity that produces features in a list
816
- view.
817
- </documentation>
818
- </annotation>
819
- <complexType>
820
- <complexContent>
821
- <extension base="tns:Component" />
822
- </complexContent>
823
- </complexType>
824
- </element>
825
-
826
- <element name="scalebar" substitutionGroup="tns:component">
827
- <annotation>
828
- <documentation xml:lang="en">
829
- A component that shows the scale of a map.
830
- </documentation>
831
- </annotation>
832
- <complexType>
833
- <complexContent>
834
- <extension base="tns:Component" />
835
- </complexContent>
836
- </complexType>
837
- </element>
838
-
839
- <element name="search" substitutionGroup="tns:component">
840
- <annotation>
841
- <documentation xml:lang="en">
842
- A component that allows the user to search one ore more sources
843
- (maps, scenes, tables, geocoders, etc.).
844
- </documentation>
845
- </annotation>
846
- <complexType>
847
- <complexContent>
848
- <extension base="tns:Component" />
849
- </complexContent>
850
- </complexType>
851
- </element>
852
-
853
- <element name="search-new-extent" substitutionGroup="tns:component">
854
- <annotation>
855
- <documentation xml:lang="en">
856
- A component that provides a single button that allows the user to "search this area"
857
- when the extent of the map changes to be different than the extent that was originally searched.
858
- </documentation>
859
- </annotation>
860
- <complexType>
861
- <complexContent>
862
- <extension base="tns:Component" />
863
- </complexContent>
864
- </complexType>
865
- </element>
866
-
867
- <element name="zoom" substitutionGroup="tns:component">
868
- <annotation>
869
- <documentation xml:lang="en">
870
- Displays a pair of buttons that allow the user to zoom the map in or out.
871
- </documentation>
872
- </annotation>
873
- <complexType>
874
- <complexContent>
875
- <extension base="tns:Component" />
876
- </complexContent>
877
- </complexType>
878
- </element>
795
+ A map in Web has the following slots: "top-start", "top-center",
796
+ "top-end", "bottom-start", "bottom-center", "bottom-end",
797
+ "context-menu", and "popup". In left-to-right locales, "start"
798
+ will be on the left, and "end" will be on the right. In
799
+ right-to-left locales, these will be reversed.
800
+ </documentation>
801
+ </annotation>
802
+ <complexType>
803
+ <complexContent mixed="true">
804
+ <extension base="tns:ComponentWithChildren" />
805
+ </complexContent>
806
+ </complexType>
807
+ </element>
808
+
809
+ <!-- NOTE: GXW-only, despite being in the common namespace. -->
810
+ <element name="map-coordinates" substitutionGroup="tns:component">
811
+ <annotation>
812
+ <documentation xml:lang="en">
813
+ Allows the user to see the coordinates under the current mouse
814
+ position. Requires an associated map component (see the "models"
815
+ attribute"). Not supported in Mobile.
816
+ </documentation>
817
+ </annotation>
818
+ <complexType>
819
+ <complexContent>
820
+ <extension base="tns:Component" />
821
+ </complexContent>
822
+ </complexType>
823
+ </element>
824
+
825
+ <element name="results-list" substitutionGroup="tns:component">
826
+ <annotation>
827
+ <documentation xml:lang="en">
828
+ A component that allows the user to view results from a search,
829
+ identify, query, or any other activity that produces features in
830
+ a list view.
831
+ </documentation>
832
+ </annotation>
833
+ <complexType>
834
+ <complexContent>
835
+ <extension base="tns:Component" />
836
+ </complexContent>
837
+ </complexType>
838
+ </element>
839
+
840
+ <element name="scalebar" substitutionGroup="tns:component">
841
+ <annotation>
842
+ <documentation xml:lang="en">A component that shows the scale of a map.</documentation>
843
+ </annotation>
844
+ <complexType>
845
+ <complexContent>
846
+ <extension base="tns:Component" />
847
+ </complexContent>
848
+ </complexType>
849
+ </element>
850
+
851
+ <element name="search" substitutionGroup="tns:component">
852
+ <annotation>
853
+ <documentation xml:lang="en">
854
+ A component that allows the user to search one ore more sources
855
+ (maps, scenes, tables, geocoders, etc.).
856
+ </documentation>
857
+ </annotation>
858
+ <complexType>
859
+ <complexContent>
860
+ <extension base="tns:Component" />
861
+ </complexContent>
862
+ </complexType>
863
+ </element>
864
+
865
+ <element name="search-new-extent" substitutionGroup="tns:component">
866
+ <annotation>
867
+ <documentation xml:lang="en">
868
+ A component that provides a single button that allows the user
869
+ to "search this area" when the extent of the map changes to be
870
+ different than the extent that was originally searched.
871
+ </documentation>
872
+ </annotation>
873
+ <complexType>
874
+ <complexContent>
875
+ <extension base="tns:Component" />
876
+ </complexContent>
877
+ </complexType>
878
+ </element>
879
+
880
+ <element name="zoom" substitutionGroup="tns:component">
881
+ <annotation>
882
+ <documentation xml:lang="en">
883
+ Displays a pair of buttons that allow the user to zoom the map in or out.
884
+ </documentation>
885
+ </annotation>
886
+ <complexType>
887
+ <complexContent>
888
+ <extension base="tns:Component" />
889
+ </complexContent>
890
+ </complexType>
891
+ </element>
879
892
  </schema>