forked from ramp4-pcar4/ramp4-pcar4
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.json
2832 lines (2832 loc) · 126 KB
/
schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"title": "RAMP4 Config Schema",
"type": "object",
"version": 4.0,
"unevaluatedProperties": false,
"$defs": {
"help": {
"type": "object",
"description": "Specifies details for the Help section.",
"properties": {
"location": {
"type": "string",
"default": "./help/",
"description": "Relative path or URL to the help directory, which contains the help content and images. Markdown files must be named for the language they support, e.g. en.md, fr.md. Images must be placed in a subfolder named images."
},
"panelWidth": {
"type": "number",
"default": 350,
"description": "Help panel width in pixels"
}
},
"required": ["folderName"],
"additionalProperties": false
},
"northarrow": {
"type": "object",
"description": "Provides configuration to the northarrow fixture.",
"properties": {
"arrowIcon": {
"type": "string",
"default": "",
"description": "The graphical icon url/data url of the north arrow."
},
"poleIcon": {
"type": "string",
"default": "",
"description": "The graphical icon url/data url of the north pole that replaces north arrow when it's on north pole"
}
},
"required": ["arrowIcon", "poleIcon"],
"additionalProperties": false
},
"overviewmap": {
"type": "object",
"description": "Provides the configuration to the overviewmap fixture",
"properties": {
"basemaps": {
"type": "object",
"description": "Key-value dictionary where the key is the tile schema id and the value is a basemap. Can provide an overriding basemap for each tile schema in the main map config.",
"additionalProperties": {
"type": "object",
"$ref": "#/$defs/basemap"
}
},
"startMinimized": {
"type": "boolean",
"default": true,
"description": "Initial state of the overviewmap"
},
"expandFactor": {
"type": "number",
"default": 1.5,
"description": "The ratio of the overview map's extent size compared to the main map's extent size"
},
"borderColour": {
"type": "string",
"default": "#FF0000",
"description": "The hex code representing the area rectangle border colour. "
},
"borderWidth": {
"type": "number",
"default": 1,
"description": "The pixel width of the area rectangle border"
},
"areaColour": {
"type": "string",
"default": "#000000",
"description": "The hex code representing the area rectangle colour."
},
"areaOpacity": {
"type": "number",
"default": 0.25,
"description": "The opacity value of the area rectangle. Accepts decimal values between 0 and 1."
}
}
},
"scrollguard": {
"type": "object",
"description": "Provides the configuration to the scrollguard fixture",
"properties": {
"enabled": {
"type": "boolean",
"default": false,
"description": "Indicates if the scrollguard should be active"
}
}
},
"extentguard": {
"type": "object",
"description": "Provides the configuration to the extentguard fixture.",
"properties": {
"alwaysOn": {
"type": "boolean",
"default": false,
"description": "Indicates if the extentguard should be active regardless of the extent set the map is using."
},
"extentSetIds": {
"type": "array",
"description": "Indicates a specific set of extent set ids. The extent guard will only be active if the map is using one of these extent sets. Ignored if alwaysOn is true.",
"default": [],
"items": {
"type": "string",
"description": "An extent set id"
}
}
}
},
"areas-of-interest": {
"type": "object",
"description": "Provides the configuration to the areas of interest fixture",
"properties": {
"panelTeleport": {
"$ref": "#/$defs/panelTeleport"
},
"areas": {
"type": "array",
"description": "The areas to be displayed in the areas of interest fixture",
"items": {
"type": "object",
"description": "The configuration for an area of interest",
"properties": {
"title": {
"type": "string",
"description": "The title for this area of interest"
},
"thumbnail": {
"type": "string",
"description": "The URL or base64 for the image to be used as the thumbnail graphic for this area of interest"
},
"altText": {
"type": "string",
"description": "Optional alt-text for the thumbnail"
},
"description": {
"type": "string",
"description": "Optional description blurb for this area of interest"
},
"extent": {
"$ref": "#/$defs/extentWithReference",
"description": "The map extent for this area of interest"
}
},
"required": ["title", "extent"],
"additionalProperties": false
}
}
}
},
"appbar": {
"type": "object",
"description": "Provides configuration to the appbar fixture. If not supplied, the default appbar controls are displayed.",
"properties": {
"items": {
"type": "array",
"default": ["legend", "geosearch", "basemap"],
"description": "Items that are displayed on the appbar, such as buttons linked to map components, formatters, images, etc.",
"items": {
"oneOf": [
{
"type": "string",
"default": "",
"description": "Specifies a panel ID to create a linked button for."
},
{
"type": "object",
"description": "Specifies an appbar component with possibility of custom options.",
"properties": {
"id": {
"type": "string",
"description": "Id of the appbar component."
},
"options": {
"type": "object",
"description": "Optional additional properties to customize the appbar component.",
"additionalProperties": true
}
}
},
{
"type": "array",
"description": "A sub array of appbar items.",
"items": {
"oneOf": [
{
"type": "string",
"default": "",
"description": "Specifies a panel ID to create a linked button for."
},
{
"type": "object",
"description": "Specifies an appbar component with possibility of custom options.",
"properties": {
"id": {
"type": "string",
"description": "Id of the appbar component."
},
"options": {
"type": "object",
"description": "Optional additional properties to customize the appbar component.",
"additionalProperties": true
}
}
}
]
}
}
]
},
"minItems": 1
}
},
"required": ["items"],
"additionalProperties": false
},
"details": {
"type": "object",
"description": "Provides layer-specific configuration to the details fixture.",
"properties": {
"name": {
"type": "string",
"description": "Display name field of the identified layer. Only applies to layers that support attributes and do not have an overriding template. The field defined by the layer is used if not provided."
},
"priority": {
"type": "number",
"description": "Specifies a priority ranking for the layer result being initially selected. Smaller number has higher priority.",
"default": 50
},
"template": {
"type": "string",
"description": "Custom Vue component to render as details template"
},
"fields": {
"type": "array",
"description": "An array to specify alternate display settings for layer fields. Only applies to layers that support attributes and do not have an overriding template.",
"items": {
"$ref": "#/$defs/detailsField"
}
}
},
"required": ["template"],
"additionalProperties": false
},
"detailsField": {
"type": "object",
"description": "",
"properties": {
"field": {
"type": "string",
"description": "Unique identifier for the field. Aligns with the layer field name."
},
"alias": {
"type": "string",
"description": "Specifies the field title. If missing, attempts to use the service alias, then defaults to the field name."
},
"visible": {
"type": "boolean",
"default": true,
"description": "Specifies if the field is visible by default."
}
},
"required": ["field"]
},
"geosearch": {
"type": "object",
"description": "Provides configuration to the geosearch fixture.",
"properties": {
"panelTeleport": {
"$ref": "#/$defs/panelTeleport"
},
"serviceUrls": {
"type": "object",
"properties": {
"geoNames": {
"type": "string",
"default": "https://geogratis.gc.ca/services/geoname/@{language}/geonames.json",
"description": "Endpoint url for geoNames service."
},
"geoLocation": {
"type": "string",
"default": "https://geogratis.gc.ca/services/geolocation/@{language}/locate",
"description": "Endpoint url for geoLocation service."
},
"geoProvince": {
"type": "string",
"default": "https://geogratis.gc.ca/services/geoname/@{language}/codes/province.json",
"description": "Endpoint url for provinces service."
},
"geoTypes": {
"type": "string",
"default": "https://geogratis.gc.ca/services/geoname/@{language}/codes/concise.json",
"description": "Endpoint url for types service."
}
},
"description": "Set of urls for lookup services. Aligns with GeoGratis APIs."
},
"settings": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Filter the search results based on the type of the geographical names. Allowed values can be found here (if using the Canadian GeoNames Search Service API): http://geogratis.gc.ca/services/geoname/en/codes/concise. Street address type ('ADDR') is also valid."
},
"sortOrder": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "The sort order of the defined 'categories'. Any missing categories are appended to the bottom of the sorted list. The results can still be sorted through this option even if there are no categories being filtered."
},
"disabledSearchTypes": {
"type": "array",
"items": {
"type": "string",
"enum": ["NTS", "FSA", "LAT/LNG"]
},
"uniqueItems": true,
"default": [],
"description": "Disable specific types of searches (NTS, FSA, or LAT/LNG)."
},
"maxResults": {
"type": "number",
"default": 100,
"description": "The maximum number of results to return per request. The Canadian GeoNames Search Service API has a 1000 search limit which will be used as an upper limit of results returned unless another service is being used with a higher limit. The default is 100 results."
},
"officialOnly": {
"type": "boolean",
"default": false,
"description": "Whether to return only official names for the geographic names. Default is false which will return both official names and formerly official names."
}
}
}
},
"unevaluatedProperties": false
},
"legend": {
"type": "object",
"description": "Provides configuration to the legend fixture.",
"properties": {
"headerControls": {
"$ref": "legendHeaderControls",
"default": ["wizard", "layerReorder", "groupToggle", "visibilityToggle"]
},
"panelWidth": {
"$ref": "#/$defs/panelWidth"
},
"panelTeleport": {
"$ref": "#/$defs/panelTeleport"
},
"root": {
"$ref": "#/$defs/sectionItem"
},
"multilineItems": {
"type": "object",
"description": "Determines whether legend items should wrap using multiple lines if necessary. Only applies to layer items.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Determines whether the multilineItems setting is enabled.",
"default": true
},
"maxLines": {
"type": "number",
"description": "Determines the max number of lines a legend item can take up before truncating. Only applies if the legend property multilineItems.enabled is true. Only accepts integers 1-6, inclusive.",
"default": 3
}
}
}
},
"required": ["root"],
"unevaluatedProperties": false
},
"panelWidth": {
"type": ["number", "object"],
"description": "Determines the width of provided panels. If a number, then defaults all panels for the fixture to the number."
},
"panelTeleport": {
"type": "object",
"description": "Determines where to render the panel instead of its usual spot in the panel stack.",
"properties": {
"target": {
"type": ["string", "element"],
"description": "The target container where the panel will be rendered. Can be the element itself or a string query selector."
},
"showHeader": {
"type": "boolean",
"description": "Whether to show the panel header or not.",
"default": false
},
"showAppbarButton": {
"type": "boolean",
"description": "Whether to show the appbar button for the panel or not. Only applies to temporary appbar buttons.",
"default": false
},
"breakpoints": {
"type": "object",
"description": "An object of type { className<string>: minWidth<number>} pairs. The className will be applied as a CSS class when the container width is greater than or equal to the breakpoint minWidth."
}
},
"required": ["target"],
"unevaluatedProperties": false
},
"sectionItem": {
"type": "object",
"description": "A legend item not bound to a layer, used only for grouping legend items or displaying info sections.",
"allOf": [
{
"$ref": "#/$defs/legendItem"
}
],
"properties": {
"infoType": {
"type": "string",
"enum": ["title", "image", "text", "markdown", "template"],
"default": "title",
"description": "Type of info content."
},
"content": {
"type": "string",
"default": "",
"description": "Actual content of the section - description of title/text, URL to image file, or HTML for template."
}
},
"unevaluatedProperties": false
},
"layerItem": {
"type": "object",
"description": "A single legend item bound to a layer.",
"allOf": [
{
"$ref": "#/$defs/legendItem"
}
],
"properties": {
"layerId": {
"type": "string",
"description": "Id a layer defined in the layers section of config."
},
"sublayerIndex": {
"type": "integer",
"default": 0,
"description": "Index of the sublayer in the case of a Map Image Layer."
},
"layerControls": {
"$ref": "#/$defs/layerControls"
},
"layerDisabledControls": {
"$ref": "#/$defs/layerControls"
},
"coverIcon": {
"type": "string",
"default": "",
"description": "An optional icon used to represent the layer."
},
"description": {
"type": "string",
"default": "",
"description": "Optional description displayed above the symbology stack when it is expanded."
},
"symbologyStack": {
"$ref": "#/$defs/symbologyStack"
},
"symbologyRenderStyle": {
"type": "string",
"enum": ["icons", "images"],
"default": "icons",
"description": "An optional style, describes how the symbology stack should be rendered."
},
"symbologyExpanded": {
"type": "boolean",
"default": false,
"description": "Indicates if symbology stack is expand by default"
},
"maxLines": {
"type": "number",
"description": "Determines the max number of lines this legend layer item can take up before truncating. Only applies if the legend-level property multilineItems.enabled is true. Overrides the legend-level property multilineItems.maxLines, and defaults to it if no value is provided here. Only accepts integers 1-6, inclusive."
}
},
"required": ["layerId"],
"unevaluatedProperties": false
},
"legendItem": {
"type": "object",
"description": "Config for common properties present in all legend item types.",
"properties": {
"name": {
"type": "string",
"default": "Layer name for layer items. Undefined for section items.",
"description": "Title of the legend item."
},
"hidden": {
"type": "boolean",
"default": false,
"description": "Indicates that the legend item will be hidden from the UI."
},
"expanded": {
"type": "boolean",
"default": true,
"description": "Specifies if the legend item is expanded by default."
},
"exclusive": {
"type": "boolean",
"default": false,
"description": "Specifies that children of this item form an exclusive set."
},
"controls": {
"$ref": "#/$defs/legendItemControls",
"default": ["visibility", "expand"]
},
"disabledControls": {
"$ref": "#/$defs/legendItemControls",
"default": []
},
"children": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/$defs/layerItem"
},
{
"$ref": "#/$defs/sectionItem"
}
]
}
}
}
},
"legendHeaderControls": {
"type": "array",
"description": "All possible controls to show in the legend header.",
"items": {
"type": "string",
"enum": ["groupToggle", "layerReorder", "visibilityToggle", "wizard"]
},
"uniqueItems": true
},
"legendItemControls": {
"type": "array",
"description": "All possible controls to be enabled/disabled on a legend item.",
"items": {
"type": "string",
"enum": ["visibility", "expand"]
},
"uniqueItems": true
},
"layerControls": {
"type": "array",
"description": "All possible controls to be enabled/disabled on a single legend layer item. Defaults to controls/disabledControls defined in layer config if missing.",
"items": {
"type": "string",
"enum": [
"boundaryZoom",
"datatable",
"identify",
"metadata",
"opacity",
"refresh",
"reload",
"remove",
"settings",
"symbology",
"visibility"
]
},
"uniqueItems": true
},
"symbologyStack": {
"type": "array",
"description": "A collection of image-label pairings making up a layer's symbology stack.",
"items": {
"type": "object",
"properties": {
"image": {
"type": "string",
"default": "",
"description": "Either a data URI or a URL to a source that supports CORS headers."
},
"text": {
"type": "string",
"default": "",
"description": "Description of a layer feature."
},
"sqlQuery": {
"type": "string",
"default": "",
"description": "An SQL where clause by which the map and datatable attributes can be filtered. All the query results for the symbologyStack should cover all attributes for that layer."
}
},
"required": ["image", "text"],
"additionalProperties": false
},
"minItems": 1
},
"mapnav": {
"type": "object",
"description": "Provides configuration to the map navigation bar fixture. If not supplied the default mapnav buttons are shown.",
"properties": {
"zoomOption": {
"type": "string",
"enum": ["all", "buttons", "slider"],
"default": "buttons",
"description": "Specifies between zoom buttons or zoom sliders. Currently not supported."
},
"items": {
"type": "array",
"default": ["fullscreen", "help", "home", "geolocator", "basemap"],
"description": "Map navigation buttons displayed on mapnav. These will be displayed in addition to the zoom buttons, which are always visible.",
"items": {
"type": "string",
"enum": ["geolocator", "home", "basemap", "help", "fullscreen", "geosearch", "legend"]
},
"uniqueItems": true
}
},
"unevaluatedProperties": false
},
"exportComponent": {
"type": "object",
"description": "Provides configuration for an export fixture component. If not supplied the default config used.",
"properties": {
"selected": {
"type": "boolean",
"description": "Indicates if this component is selected.",
"default": true
},
"selectable": {
"type": "boolean",
"description": "Indicates if this component is selectable.",
"default": true
}
}
},
"export": {
"type": "object",
"description": "Provides configuration to the export fixture. If not supplied the default config used.",
"properties": {
"title": {
"type": "object",
"description": "Configuration for the title.",
"allOf": [
{
"$ref": "#/$defs/exportComponent"
}
],
"properties": {
"value": {
"type": "string",
"default": "RAMP-Map / PCAR-Carte",
"description": "The value of the title text."
}
},
"requried": ["value"]
},
"map": {
"type": "object",
"description": "Configuration for map.",
"$ref": "#/$defs/exportComponent"
},
"mapElements": {
"type": "object",
"description": "Configuration for the north arrow and scale bar.",
"$ref": "#/$defs/exportComponent"
},
"legend": {
"type": "object",
"description": "Configuration for the legend.",
"allOf": [
{
"$ref": "#/$defs/exportComponent"
}
],
"properties": {
"columnWidth": {
"type": "number",
"default": "",
"description": "Value in pixels to be used as the column width for the exported legend."
}
}
},
"footnote": {
"type": "object",
"description": "Configuration for the footnote.",
"allOf": [
{
"$ref": "#/$defs/exportComponent"
}
],
"properties": {
"value": {
"type": "string",
"default": "",
"description": "The value of the footnote text."
}
},
"requried": ["value"]
},
"timestamp": {
"type": "object",
"description": "Configuration for the timestamp.",
"$ref": "#/$defs/exportComponent"
},
"fileName": {
"type": "string",
"description": "The filename of the exported image."
},
"panelTeleport": {
"$ref": "#/$defs/panelTeleport"
},
"panelWidth": {
"$ref": "#/$defs/panelWidth"
}
}
},
"layerList": {
"type": "array",
"description": "List of defined layers to be displayed, added to the map in the same order it appears in this list.",
"items": {
"oneOf": [
{
"$ref": "#/$defs/basicLayer"
},
{
"$ref": "#/$defs/mapImageLayer"
},
{
"$ref": "#/$defs/featureLayer"
},
{
"$ref": "#/$defs/fileLayer"
},
{
"$ref": "#/$defs/dataLayer"
},
{
"$ref": "#/$defs/wfsLayer"
},
{
"$ref": "#/$defs/wmsLayer"
},
{
"$ref": "#/$defs/osmLayer"
}
]
},
"minItems": 0
},
"drawOrder": {
"type": "array",
"description": "Specification of the map drawing order for vector features. A value for the field or arcade property must be provided. Note ESRI currently only supports one definition.",
"items": {
"type": "object",
"description": "Draw order for one attribute field.",
"properties": {
"field": {
"type": "string",
"description": "Layer field name contianing the value to order by. Must be numeric or date field."
},
"arcade": {
"type": "string",
"description": "An Arcade function to derive an ordering value. Must return a numeric or date value."
},
"ascending": {
"type": "boolean",
"description": "Direction to order in. True means smaller values are on top of larger values. False is the opposite.",
"default": true
}
},
"additionalProperties": false
}
},
"basicLayer": {
"type": "object",
"description": "Properties describing a generic layer type that can represent an ESRI tile/image layer.",
"properties": {
"id": {
"type": "string",
"description": "Identification of the layer for referencing within the viewer (does not relate directly to any external service)."
},
"name": {
"type": "string",
"default": "",
"description": "Display name of the layer."
},
"url": {
"type": "string",
"default": "",
"description": "Service endpoint of the layer. It should match the type provided in layerType."
},
"refreshInterval": {
"type": "number",
"default": 0,
"description": "The automatic refresh interval of the layer in minutes. Maximum interval is 100 minutes. Currently not supported."
},
"expectedDrawTime": {
"type": "number",
"description": "The time span (in milliseconds) after which a 'slow to draw' notification is shown for any drawing layer. Zero will disable notifications. If missing, will use the map default."
},
"expectedLoadTime": {
"type": "number",
"description": "The time span (in milliseconds) after which a 'slow to load' notification is shown for any loading layer. Zero will disable notifications. If missing, will use the map default."
},
"maxLoadTime": {
"type": "number",
"default": 0,
"description": "The time span (in milliseconds) a layer can load for before entering the 'error' state. Zero will defer to the map default."
},
"metadata": {
"$ref": "#/$defs/layerMetadata"
},
"catalogueUrl": {
"type": "string",
"default": null,
"description": "Catalogue url of the layer service. Currently not supported."
},
"layerType": {
"type": "string",
"enum": ["esri-imagery", "esri-tile"],
"description": "Service type for basic layers."
},
"extent": {
"$ref": "#/$defs/extentWithReference"
},
"controls": {
"$ref": "#/$defs/layerControls",
"default": [
"datatable",
"opacity",
"visibility",
"identify",
"metadata",
"boundaryZoom",
"refresh",
"reload",
"remove",
"settings",
"symbology"
]
},
"disabledControls": {
"$ref": "#/$defs/layerControls",
"default": []
},
"state": {
"$ref": "#/$defs/initialLayerSettings"
},
"cosmetic": {
"type": "boolean",
"default": false,
"description": "Indicates if this layer is a cosmetic supporting layer which will not be considered for general user interaction."
}
},
"required": ["id", "layerType", "url"],
"unevaluatedProperties": false
},
"osmLayer": {
"type": "object",
"description": "Properties describing an OpenStreetMap layer.",
"properties": {
"id": {
"type": "string",
"description": "Identification of the layer for referencing within the viewer (does not relate directly to any external service)."
},
"name": {
"type": "string",
"default": "",
"description": "Display name of the layer."
},
"expectedDrawTime": {
"type": "number",
"description": "The time span (in milliseconds) after which a 'slow to draw' notification is shown for any drawing layer. Zero will disable notifications. If missing, will use the map default."
},
"expectedLoadTime": {
"type": "number",
"description": "The time span (in milliseconds) after which a 'slow to load' notification is shown for any loading layer. Zero will disable notifications. If missing, will use the map default."
},
"maxLoadTime": {
"type": "number",
"default": 0,
"description": "The time span (in milliseconds) a layer can load for before entering the 'error' state. Zero will defer to the map default."
},
"metadata": {
"$ref": "#/$defs/layerMetadata"
},
"layerType": {
"type": "string",
"enum": ["osm-tile"],
"description": "Service type for OpenStreetMap layers."
},
"extent": {
"$ref": "#/$defs/extentWithReference"
},
"controls": {
"$ref": "#/$defs/layerControls",
"default": ["opacity", "visibility", "metadata", "boundaryZoom", "reload", "remove", "settings"]
},
"disabledControls": {
"$ref": "#/$defs/layerControls",
"default": []
},
"state": {
"$ref": "#/$defs/initialLayerSettings"
},
"cosmetic": {
"type": "boolean",
"default": false,
"description": "Indicates if this layer is a cosmetic supporting layer which will not be considered for general user interaction."
}
},
"required": ["id", "layerType"],
"unevaluatedProperties": false
},
"mapImageLayer": {
"type": "object",
"description": "Properties describing a map image Layer which is rendered as a group by default.",
"properties": {
"id": {
"type": "string",
"description": "Identification of the layer for referencing within the viewer (does not relate directly to any external service)."
},
"name": {
"type": "string",
"default": "",
"description": "The display name of the layer. If not present, the viewer will make an attempt to scrape this information."
},
"url": {
"type": "string",
"default": "",
"description": "The service endpoint of the layer. It should match the type provided in layerType."
},
"refreshInterval": {
"type": "number",
"default": 0,
"description": "The automatic refresh interval of the layer in minutes. Maximum interval is 100 minutes. Currently not supported."
},
"expectedDrawTime": {
"type": "number",
"description": "The time span (in milliseconds) after which a 'slow to draw' notification is shown for any drawing layer. Zero will disable notifications. If missing, will use the map default."
},
"expectedLoadTime": {
"type": "number",
"description": "The time span (in milliseconds) after which a 'slow to load' notification is shown for any loading layer. Zero will disable notifications. If missing, will use the map default."
},
"maxLoadTime": {
"type": "number",
"default": 0,
"description": "The time span (in milliseconds) a layer can load for before entering the 'error' state. Zero will defer to the map default."
},
"metadata": {
"$ref": "#/$defs/layerMetadata"
},
"catalogueUrl": {
"type": "string",
"default": null,
"description": "Catalogue url of the layer service. Currently not supported."
},
"layerType": {
"type": "string",
"enum": ["esri-map-image"],
"default": "esri-map-image",
"description": "Service type for map image layers."
},
"singleEntryCollapse": {
"type": "boolean",
"default": false,
"description": "Indicates that the map image layer with a single layer entry should be rendered without the root group. Currently not supported."
},
"sublayers": {
"type": "array",
"description": "Layer entries rendered as part of the map image layer group.",
"items": {
"$ref": "#/$defs/mapImageSublayer"
},
"minItems": 1
},
"mouseTolerance": {
"type": "number",
"default": 5,
"description": "Specifies the tolerance in pixels when determining if a feature was clicked. Should be non-negative integer"
},
"touchTolerance": {
"type": "number",
"default": 15,
"description": "Specifies the tolerance in pixels when determining if a feature was tapped. Should be non-negative integer"
},