@vertigis/viewer-spec 56.26.0 → 56.27.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.
@@ -1,6 +1,20 @@
1
1
  {
2
2
  "$ref": "#/definitions/viewer-spec.Event",
3
3
  "definitions": {
4
+ "ArcGISPortalIdentity": {
5
+ "additionalProperties": false,
6
+ "type": "object"
7
+ },
8
+ "AuthenticationType": {
9
+ "description": "A type of authentication.",
10
+ "enum": [
11
+ "Network",
12
+ "OAuth2",
13
+ "Token",
14
+ "Unknown"
15
+ ],
16
+ "type": "string"
17
+ },
4
18
  "EffectFunctionJson": {
5
19
  "anyOf": [
6
20
  {
@@ -39,6 +53,165 @@
39
53
  ],
40
54
  "description": "Effect functions that can be combined to build a layer effect."
41
55
  },
56
+ "Error": {
57
+ "additionalProperties": false,
58
+ "properties": {
59
+ "cause": {},
60
+ "message": {
61
+ "type": "string"
62
+ },
63
+ "name": {
64
+ "type": "string"
65
+ },
66
+ "stack": {
67
+ "type": "string"
68
+ }
69
+ },
70
+ "required": [
71
+ "message",
72
+ "name"
73
+ ],
74
+ "type": "object"
75
+ },
76
+ "GeolocateAccuracyChangedEventArgs": {
77
+ "additionalProperties": false,
78
+ "description": "Arguments for the \"geolocation.accuracy-changed\" event.",
79
+ "properties": {
80
+ "accuracy": {
81
+ "description": "The current geolocation accuracy, in meters.",
82
+ "type": "number"
83
+ }
84
+ },
85
+ "required": [
86
+ "accuracy"
87
+ ],
88
+ "type": "object"
89
+ },
90
+ "GeolocationEvent": {
91
+ "additionalProperties": false,
92
+ "description": "Arguments for geolocation events such as \"geolocation.position-acquired\" and \"geolocation.position-lost\".",
93
+ "properties": {
94
+ "gnssDeviceConnectionInfo": {
95
+ "$ref": "#/definitions/GnssDeviceConnectionInfo",
96
+ "description": "The GNSS source associated with the raised geolocation event. Mobile only."
97
+ }
98
+ },
99
+ "type": "object"
100
+ },
101
+ "GeolocationStatusChangedEventArgs": {
102
+ "additionalProperties": false,
103
+ "description": "Arguments for the \"geolocation.status-changed\" event.",
104
+ "properties": {
105
+ "isEnabled": {
106
+ "description": "Indicates whether the geolocation is now enabled.",
107
+ "type": "boolean"
108
+ }
109
+ },
110
+ "required": [
111
+ "isEnabled"
112
+ ],
113
+ "type": "object"
114
+ },
115
+ "GnssDeviceConnectionInfo": {
116
+ "additionalProperties": false,
117
+ "description": "A geolocation source.",
118
+ "properties": {
119
+ "deviceFullName": {
120
+ "description": "Full name of the GNSS device.",
121
+ "type": "string"
122
+ },
123
+ "deviceName": {
124
+ "description": "Name of the GNSS device.",
125
+ "type": "string"
126
+ },
127
+ "deviceType": {
128
+ "$ref": "#/definitions/GnssDeviceType",
129
+ "description": "The type of the device. Options are Integrated, Bluetooth, USB, and Emulator."
130
+ },
131
+ "settings": {
132
+ "$ref": "GnssDeviceSettings",
133
+ "description": "The device settings, including the correction service's spatial reference, the desired datum transformation, and the device's antenna height."
134
+ }
135
+ },
136
+ "required": [
137
+ "deviceFullName",
138
+ "deviceName",
139
+ "deviceType",
140
+ "settings"
141
+ ],
142
+ "type": "object"
143
+ },
144
+ "GnssDeviceType": {
145
+ "enum": [
146
+ "bluetooth",
147
+ "emulator",
148
+ "integrated",
149
+ "usb"
150
+ ],
151
+ "type": "string"
152
+ },
153
+ "HasMaps": {
154
+ "additionalProperties": false,
155
+ "description": "Defines an object that has a `maps` property.",
156
+ "properties": {
157
+ "maps": {
158
+ "$ref": "#/definitions/MapsLike",
159
+ "description": "Map(s) to use for the command/operation."
160
+ }
161
+ },
162
+ "type": "object"
163
+ },
164
+ "MapEvent": {
165
+ "additionalProperties": false,
166
+ "description": "Arguments for the various map events.",
167
+ "properties": {
168
+ "mapExtension": {
169
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
170
+ "description": "The map extension for which the event was generated. This property is required in VertiGIS Studio Mobile. Mobile only."
171
+ },
172
+ "maps": {
173
+ "$ref": "#/definitions/MapsLike",
174
+ "description": "The map from which the event was generated. Web only."
175
+ }
176
+ },
177
+ "type": "object"
178
+ },
179
+ "MapInitializedEvent": {
180
+ "additionalProperties": false,
181
+ "description": "Event args for the map.initialized event.",
182
+ "properties": {
183
+ "loadTime": {
184
+ "$ref": "#/definitions/TimeSpan",
185
+ "description": "The amount of time that the map took to load. Mobile only."
186
+ },
187
+ "mapExtension": {
188
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
189
+ "description": "The map extension for which the event was generated. This property is required in VertiGIS Studio Mobile. Mobile only."
190
+ },
191
+ "maps": {
192
+ "$ref": "#/definitions/MapsLike",
193
+ "description": "The map from which the event was generated. Web only."
194
+ }
195
+ },
196
+ "required": [
197
+ "loadTime"
198
+ ],
199
+ "type": "object"
200
+ },
201
+ "MapsLike": {
202
+ "anyOf": [
203
+ {
204
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension"
205
+ },
206
+ {
207
+ "items": {
208
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension"
209
+ },
210
+ "type": "array"
211
+ }
212
+ ],
213
+ "description": "One or map extensions."
214
+ },
42
215
  "OperationalLayerJson": {
43
216
  "anyOf": [
44
217
  {
@@ -121,24 +294,256 @@
121
294
  ],
122
295
  "description": "Filters applied to the pointCloud which will hide a point. See {@link https://developers.arcgis.com/web-scene-specification/objects/pointCloudFilter/}."
123
296
  },
297
+ "PortalType": {
298
+ "description": "The type of Portal.",
299
+ "enum": [
300
+ "AGOL",
301
+ "ArcGISEnterprise"
302
+ ],
303
+ "type": "string"
304
+ },
305
+ "PrintErrorEventArgs": {
306
+ "additionalProperties": false,
307
+ "description": "Arguments for the printing.print-error event.",
308
+ "properties": {
309
+ "errorCode": {
310
+ "description": "The HTTP status code associated with the error, if it's a HTTP error.",
311
+ "type": "number"
312
+ },
313
+ "instanceId": {
314
+ "description": "A unique ID to track the running of this print.",
315
+ "type": "string"
316
+ },
317
+ "message": {
318
+ "description": "The error message.",
319
+ "type": "string"
320
+ },
321
+ "printTemplateId": {
322
+ "description": "The ID of the print template being used.",
323
+ "type": "string"
324
+ }
325
+ },
326
+ "required": [
327
+ "instanceId",
328
+ "message",
329
+ "printTemplateId"
330
+ ],
331
+ "type": "object"
332
+ },
333
+ "PrintFinishedEventArgs": {
334
+ "additionalProperties": false,
335
+ "description": "Arguments for the printing.print-finished event.",
336
+ "properties": {
337
+ "downloadUrl": {
338
+ "description": "The URL from which to download the print.",
339
+ "type": "string"
340
+ },
341
+ "instanceId": {
342
+ "description": "A unique ID to track the running of this print.",
343
+ "type": "string"
344
+ },
345
+ "printTemplateId": {
346
+ "description": "The ID of the print template being used.",
347
+ "type": "string"
348
+ }
349
+ },
350
+ "required": [
351
+ "downloadUrl",
352
+ "instanceId",
353
+ "printTemplateId"
354
+ ],
355
+ "type": "object"
356
+ },
357
+ "PrintProgressEventArgs": {
358
+ "additionalProperties": false,
359
+ "description": "Arguments for the printing.print-progress event.",
360
+ "properties": {
361
+ "instanceId": {
362
+ "description": "A unique ID to track the running of this print.",
363
+ "type": "string"
364
+ },
365
+ "printTemplateId": {
366
+ "description": "The ID of the print template being used.",
367
+ "type": "string"
368
+ }
369
+ },
370
+ "required": [
371
+ "instanceId",
372
+ "printTemplateId"
373
+ ],
374
+ "type": "object"
375
+ },
376
+ "PrintStartedEventArgs": {
377
+ "additionalProperties": false,
378
+ "description": "Arguments for the printing.print-started event.",
379
+ "properties": {
380
+ "instanceId": {
381
+ "description": "A unique ID to track the running of this print.",
382
+ "type": "string"
383
+ },
384
+ "printTemplateId": {
385
+ "description": "The ID of the print template being used.",
386
+ "type": "string"
387
+ }
388
+ },
389
+ "required": [
390
+ "instanceId",
391
+ "printTemplateId"
392
+ ],
393
+ "type": "object"
394
+ },
395
+ "SignInCompletedEventArgs": {
396
+ "additionalProperties": false,
397
+ "description": "Arguments for the auth.sign-in-completed and auth.portal-sign-in-completed events. Only available in VertiGIS Studio Mobile.",
398
+ "properties": {
399
+ "identity": {
400
+ "$ref": "#/definitions/ArcGISPortalIdentity",
401
+ "description": "The identity that was obtained from the sign in."
402
+ }
403
+ },
404
+ "required": [
405
+ "identity"
406
+ ],
407
+ "type": "object"
408
+ },
409
+ "SignInEventArgs": {
410
+ "additionalProperties": false,
411
+ "description": "Arguments for the auth.sign-in events. Only available in VertiGIS Studio Mobile.",
412
+ "properties": {
413
+ "authenticationType": {
414
+ "$ref": "#/definitions/AuthenticationType",
415
+ "description": "The authentication method used for the sign in process. Not available in VertiGIS Studio Web."
416
+ },
417
+ "portalType": {
418
+ "$ref": "#/definitions/PortalType",
419
+ "description": "The type of Portal: AGOL or Enterprise."
420
+ },
421
+ "requestInfo": {
422
+ "description": "Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile."
423
+ }
424
+ },
425
+ "required": [
426
+ "authenticationType",
427
+ "portalType",
428
+ "requestInfo"
429
+ ],
430
+ "type": "object"
431
+ },
432
+ "SignInFailedEventArgs": {
433
+ "additionalProperties": false,
434
+ "description": "Arguments for the auth.sign-in-failed event. Only available in the VertiGIS Studio Mobile Viewer.",
435
+ "properties": {
436
+ "authenticationType": {
437
+ "$ref": "#/definitions/AuthenticationType",
438
+ "description": "The authentication method used for the sign in process. Not available in VertiGIS Studio Web."
439
+ },
440
+ "exception": {
441
+ "description": "The exception that occurred during the sign in. Not available in VertiGIS Studio Web."
442
+ },
443
+ "portalType": {
444
+ "$ref": "#/definitions/PortalType",
445
+ "description": "The type of Portal: AGOL or Enterprise."
446
+ },
447
+ "requestInfo": {
448
+ "description": "Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile."
449
+ }
450
+ },
451
+ "required": [
452
+ "authenticationType",
453
+ "exception",
454
+ "portalType",
455
+ "requestInfo"
456
+ ],
457
+ "type": "object"
458
+ },
459
+ "TimeSpan": {
460
+ "additionalProperties": false,
461
+ "type": "object"
462
+ },
463
+ "WorkflowErrorEventArgs": {
464
+ "additionalProperties": false,
465
+ "description": "Arguments for the \"workflow.workflow-error\" event.",
466
+ "properties": {
467
+ "errorMessage": {
468
+ "description": "The human readable error message.",
469
+ "type": "string"
470
+ },
471
+ "exception": {
472
+ "$ref": "#/definitions/Error",
473
+ "description": "The Error object containing detailed information about the error."
474
+ },
475
+ "workflow": {
476
+ "$ref": "WorkflowModel",
477
+ "description": "The workflow pertaining to the event."
478
+ }
479
+ },
480
+ "required": [
481
+ "workflow"
482
+ ],
483
+ "type": "object"
484
+ },
485
+ "WorkflowFinishedEventArgs": {
486
+ "additionalProperties": false,
487
+ "description": "Arguments for the \"workflow.workflow-finished\" event.",
488
+ "properties": {
489
+ "workflow": {
490
+ "$ref": "WorkflowModel",
491
+ "description": "The workflow pertaining to the event."
492
+ }
493
+ },
494
+ "required": [
495
+ "workflow"
496
+ ],
497
+ "type": "object"
498
+ },
124
499
  "auth.sign-in-completed": {
125
500
  "description": "Raised when successfully signed in. Principal event type used in Web, SignInCompletedEventArgs used in Mobile.",
126
501
  "enum": [
127
502
  "auth.sign-in-completed"
128
503
  ]
129
504
  },
505
+ "auth.sign-in-completed:input": {
506
+ "anyOf": [
507
+ {
508
+ "$ref": "Principal"
509
+ },
510
+ {
511
+ "$ref": "#/definitions/SignInCompletedEventArgs"
512
+ }
513
+ ]
514
+ },
130
515
  "auth.sign-in-failed": {
131
516
  "description": "Raised when a sign-in attempt fails.",
132
517
  "enum": [
133
518
  "auth.sign-in-failed"
134
519
  ]
135
520
  },
521
+ "auth.sign-in-failed:input": {
522
+ "anyOf": [
523
+ {
524
+ "$ref": "#/definitions/SignInFailedEventArgs"
525
+ },
526
+ {
527
+ "type": "null"
528
+ }
529
+ ]
530
+ },
136
531
  "auth.sign-in-requested": {
137
532
  "description": "Raised when the user requests a sign-in.",
138
533
  "enum": [
139
534
  "auth.sign-in-requested"
140
535
  ]
141
536
  },
537
+ "auth.sign-in-requested:input": {
538
+ "anyOf": [
539
+ {
540
+ "$ref": "#/definitions/SignInEventArgs"
541
+ },
542
+ {
543
+ "type": "null"
544
+ }
545
+ ]
546
+ },
142
547
  "auth.sign-out-completed": {
143
548
  "description": "Raised when the user is signed out.",
144
549
  "enum": [
@@ -166,18 +571,30 @@
166
571
  "edit.feature-added"
167
572
  ]
168
573
  },
574
+ "edit.feature-added:input": {
575
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
576
+ },
169
577
  "edit.feature-deleted": {
170
578
  "description": "Raised when a feature is deleted from a feature source.",
171
579
  "enum": [
172
580
  "edit.feature-deleted"
173
581
  ]
174
582
  },
583
+ "edit.feature-deleted:input": {
584
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
585
+ },
175
586
  "edit.feature-updated": {
176
587
  "description": "Raised when the attributes or geometry of a feature from a feature source are updated.",
177
588
  "enum": [
178
589
  "edit.feature-updated"
179
590
  ]
180
591
  },
592
+ "edit.feature-updated:input": {
593
+ "$ref": "@vertigis.arcgis-extensions.data.Feature.Feature"
594
+ },
595
+ "esri.Point": {
596
+ "$ref": "esri/geometry/Point"
597
+ },
181
598
  "esri.rest-api.AnnotationLayerJson.AnnotationLayerJson": {
182
599
  "additionalProperties": false,
183
600
  "description": "Annotation layers can be created by referencing a layer from a feature service. Annotation layers honor any feature templates configured in the source document.",
@@ -9070,78 +9487,138 @@
9070
9487
  "geolocation.accuracy-changed"
9071
9488
  ]
9072
9489
  },
9490
+ "geolocation.accuracy-changed:input": {
9491
+ "$ref": "#/definitions/GeolocateAccuracyChangedEventArgs"
9492
+ },
9073
9493
  "geolocation.auto-recenter-started": {
9074
9494
  "description": "Raised when geolocation enters auto recenter mode. For VertiGIS Studio Web Viewer, the event will have no parameter (all maps are always affected).",
9075
9495
  "enum": [
9076
9496
  "geolocation.auto-recenter-started"
9077
9497
  ]
9078
9498
  },
9499
+ "geolocation.auto-recenter-started:input": {
9500
+ "anyOf": [
9501
+ {
9502
+ "$ref": "#/definitions/HasMaps"
9503
+ },
9504
+ {
9505
+ "type": "null"
9506
+ }
9507
+ ]
9508
+ },
9079
9509
  "geolocation.auto-recenter-stopped": {
9080
9510
  "description": "Raised when geolocation leaves auto recenter mode. For VertiGIS Studio Web Viewer, the event will have no parameter (all maps are always affected).",
9081
9511
  "enum": [
9082
9512
  "geolocation.auto-recenter-stopped"
9083
9513
  ]
9084
9514
  },
9515
+ "geolocation.auto-recenter-stopped:input": {
9516
+ "anyOf": [
9517
+ {
9518
+ "$ref": "#/definitions/HasMaps"
9519
+ },
9520
+ {
9521
+ "type": "null"
9522
+ }
9523
+ ]
9524
+ },
9085
9525
  "geolocation.position-acquired": {
9086
9526
  "description": "Raised when geolocation is activated and a user position has been received.",
9087
9527
  "enum": [
9088
9528
  "geolocation.position-acquired"
9089
9529
  ]
9090
9530
  },
9531
+ "geolocation.position-acquired:input": {
9532
+ "$ref": "#/definitions/GeolocationEvent"
9533
+ },
9091
9534
  "geolocation.position-changed": {
9092
9535
  "description": "Raised when geolocation is activated and the user's position changes.",
9093
9536
  "enum": [
9094
9537
  "geolocation.position-changed"
9095
9538
  ]
9096
9539
  },
9540
+ "geolocation.position-changed:input": {
9541
+ "$ref": "#/definitions/esri.Point"
9542
+ },
9097
9543
  "geolocation.position-lost": {
9098
9544
  "description": "Raised when geolocation is disabled, either through signal loss or being turned off, and a user position is not available.",
9099
9545
  "enum": [
9100
9546
  "geolocation.position-lost"
9101
9547
  ]
9102
9548
  },
9549
+ "geolocation.position-lost:input": {
9550
+ "$ref": "#/definitions/GeolocationEvent"
9551
+ },
9103
9552
  "geolocation.status-changed": {
9104
9553
  "description": "Raised when geolocation status (enabled or disabled via app permissions) changes.",
9105
9554
  "enum": [
9106
9555
  "geolocation.status-changed"
9107
9556
  ]
9108
9557
  },
9558
+ "geolocation.status-changed:input": {
9559
+ "$ref": "#/definitions/GeolocationStatusChangedEventArgs"
9560
+ },
9109
9561
  "map.initialized": {
9110
9562
  "description": "Raised when a map has completed initialization. MapEvent used in Web, MapInitializedEvent used in Mobile.",
9111
9563
  "enum": [
9112
9564
  "map.initialized"
9113
9565
  ]
9114
9566
  },
9567
+ "map.initialized:input": {
9568
+ "anyOf": [
9569
+ {
9570
+ "$ref": "#/definitions/MapEvent"
9571
+ },
9572
+ {
9573
+ "$ref": "#/definitions/MapInitializedEvent"
9574
+ }
9575
+ ]
9576
+ },
9115
9577
  "map.viewpoint-changed": {
9116
9578
  "description": "Raised when the a map extent is changed. This event is raised in extremely high frequency - for example, every few pixels the map is repositioned during a pan.",
9117
9579
  "enum": [
9118
9580
  "map.viewpoint-changed"
9119
9581
  ]
9120
9582
  },
9583
+ "map.viewpoint-changed:input": {
9584
+ "$ref": "#/definitions/MapEvent"
9585
+ },
9121
9586
  "printing.print-error": {
9122
9587
  "description": "Raised when an error occurs with running a print.",
9123
9588
  "enum": [
9124
9589
  "printing.print-error"
9125
9590
  ]
9126
9591
  },
9592
+ "printing.print-error:input": {
9593
+ "$ref": "#/definitions/PrintErrorEventArgs"
9594
+ },
9127
9595
  "printing.print-finished": {
9128
9596
  "description": "Raised when a print has finished running. Event arguments include the print download URL.",
9129
9597
  "enum": [
9130
9598
  "printing.print-finished"
9131
9599
  ]
9132
9600
  },
9601
+ "printing.print-finished:input": {
9602
+ "$ref": "#/definitions/PrintFinishedEventArgs"
9603
+ },
9133
9604
  "printing.print-progress": {
9134
9605
  "description": "Raised while a print is running to provide updates on its status.",
9135
9606
  "enum": [
9136
9607
  "printing.print-progress"
9137
9608
  ]
9138
9609
  },
9610
+ "printing.print-progress:input": {
9611
+ "$ref": "#/definitions/PrintProgressEventArgs"
9612
+ },
9139
9613
  "printing.print-started": {
9140
9614
  "description": "Raised when a print has started running.",
9141
9615
  "enum": [
9142
9616
  "printing.print-started"
9143
9617
  ]
9144
9618
  },
9619
+ "printing.print-started:input": {
9620
+ "$ref": "#/definitions/PrintStartedEventArgs"
9621
+ },
9145
9622
  "ui.activated": {
9146
9623
  "description": "Raised when a component is activated. The argument is the component ID.",
9147
9624
  "enum": [
@@ -9260,11 +9737,17 @@
9260
9737
  "workflow.workflow-error"
9261
9738
  ]
9262
9739
  },
9740
+ "workflow.workflow-error:input": {
9741
+ "$ref": "#/definitions/WorkflowErrorEventArgs"
9742
+ },
9263
9743
  "workflow.workflow-finished": {
9264
9744
  "description": "Raised when a workflow finishes running.",
9265
9745
  "enum": [
9266
9746
  "workflow.workflow-finished"
9267
9747
  ]
9748
+ },
9749
+ "workflow.workflow-finished:input": {
9750
+ "$ref": "#/definitions/WorkflowFinishedEventArgs"
9268
9751
  }
9269
9752
  }
9270
9753
  }