-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
v8.json
8375 lines (8374 loc) · 244 KB
/
v8.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
{
"$version": 8,
"$root": {
"version": {
"required": true,
"type": "enum",
"values": [
8
],
"doc": "Style specification version number. Must be 8.",
"example": 8
},
"fragment": {
"type": "boolean",
"doc": "Indicates that a style is a fragment style.",
"example": true
},
"name": {
"type": "string",
"doc": "A human-readable name for the style.",
"example": "Bright"
},
"metadata": {
"type": "*",
"doc": "Arbitrary properties useful to track with the stylesheet, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'mapbox:'."
},
"center": {
"type": "array",
"value": "number",
"doc": "Default map center in longitude and latitude. The style center will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
"example": [
-73.9749,
40.7736
]
},
"zoom": {
"type": "number",
"doc": "Default zoom level. The style zoom will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
"example": 12.5
},
"bearing": {
"type": "number",
"default": 0,
"period": 360,
"units": "degrees",
"doc": "Default bearing, in degrees. The bearing is the compass direction that is \"up\"; for example, a bearing of 90° orients the map so that east is up. This value will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
"example": 29
},
"pitch": {
"type": "number",
"default": 0,
"units": "degrees",
"doc": "Default pitch, in degrees. Zero is perpendicular to the surface, for a look straight down at the map, while a greater value like 60 looks ahead towards the horizon. The style pitch will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
"example": 50
},
"light": {
"type": "light",
"doc": "The global light source. Note: This API is deprecated. Prefer using `flat` light type instead in the `lights` API.",
"example": {
"anchor": "viewport",
"color": "white",
"intensity": 0.4
}
},
"lights": {
"required": false,
"type": "array",
"value": "light-3d",
"doc": "Array of light sources affecting the whole map and the default for 3D style, mutually exclusive with the light property",
"example": [
{
"id": "environment",
"type": "ambient",
"properties": {
"color": "rgba(255.0, 0.0, 0.0, 1.0)",
"intensity": 0.4
}
},
{
"id": "sun_light",
"type": "directional",
"properties": {
"color": "rgba(255.0, 0.0, 0.0, 1.0)",
"intensity": 0.4,
"direction": [200.0, 40.0],
"cast-shadows": true,
"shadow-intensity": 0.2
}
}
]
},
"terrain": {
"type": "terrain",
"doc": "A global modifier that elevates layers and markers based on a DEM data source."
},
"fog": {
"type": "fog",
"doc": "A global effect that fades layers and markers based on their distance to the camera. The fog can be used to approximate the effect of atmosphere on distant objects and enhance the depth perception of the map when used with terrain or 3D features. Note: fog is renamed to atmosphere in the Android and iOS SDKs and planned to be changed in GL-JS v.3.0.0."
},
"camera": {
"type": "camera",
"doc": "Global setting to control additional camera intrinsics parameters, e.g. projection type (perspective / orthographic)."
},
"imports": {
"type": "array",
"value": "import",
"doc": "Imports other styles into this style.",
"sdk-support": {
"basic functionality": {
"js": "3.0.0",
"android": "11.0.0",
"ios": "11.0.0",
"macos": "11.0.0"
}
}
},
"schema": {
"type": "schema",
"doc": "Definition of the schema for configuration options.",
"sdk-support": {
"basic functionality": {
"js": "3.0.0",
"android": "11.0.0",
"ios": "11.0.0",
"macos": "11.0.0"
}
}
},
"sources": {
"required": true,
"type": "sources",
"doc": "Data source specifications.",
"example": {
"mapbox-streets": {
"type": "vector",
"url": "mapbox://mapbox.mapbox-streets-v6"
}
}
},
"sprite": {
"type": "string",
"doc": "A base URL for retrieving the sprite image and metadata. The extensions `.png`, `.json` and scale factor `@2x.png` will be automatically appended. This property is required if any layer uses the `background-pattern`, `fill-pattern`, `line-pattern`, `fill-extrusion-pattern`, or `icon-image` properties. The URL must be absolute, containing the [scheme, authority and path components](https://en.wikipedia.org/wiki/URL#Syntax).",
"example": "mapbox://sprites/mapbox/bright-v8"
},
"glyphs": {
"type": "string",
"doc": "A URL template for loading signed-distance-field glyph sets in PBF format. The URL must include `{fontstack}` and `{range}` tokens. This property is required if any layer uses the `text-field` layout property. The URL must be absolute, containing the [scheme, authority and path components](https://en.wikipedia.org/wiki/URL#Syntax).",
"default": "mapbox://fonts/mapbox/{fontstack}/{range}.pbf",
"example": "mapbox://fonts/mapbox/{fontstack}/{range}.pbf"
},
"transition": {
"type": "transition",
"doc": "A global transition definition to use as a default across properties, to be used for timing transitions between one value and the next when no property-specific transition is set. Collision-based symbol fading is controlled independently of the style's `transition` property.",
"example": {
"duration": 300,
"delay": 0
}
},
"projection": {
"type": "projection",
"doc": "The projection the map should be rendered in. Supported projections are Mercator, Globe, Albers, Equal Earth, Equirectangular (WGS84), Lambert conformal conic, Natural Earth, and Winkel Tripel. Terrain, sky and fog are supported by only Mercator and globe. CustomLayerInterface is not supported outside of Mercator.",
"example": {
"name": "albers",
"center": [-154, 50],
"parallels": [55, 65]
}
},
"layers": {
"required": true,
"type": "array",
"value": "layer",
"doc": "Layers will be drawn in the order of this array.",
"example": [
{
"id": "water",
"source": "mapbox-streets",
"source-layer": "water",
"type": "fill",
"paint": {
"fill-color": "#00ffff"
}
}
]
},
"models": {
"type": "models",
"doc": "Specification of models used in the style.",
"example": {
"spruce1-lod0": "asset://spruce1-lod0.glb",
"spruce1-lod1": "asset://spruce1-lod1.glb",
"spruce1-lod2": "asset://spruce1-lod2.glb"
}
}
},
"model": {
"type": "string",
"doc": "A URL to a model resource. Supported protocols are `http:`, `https:`, and `mapbox://<Model ID>`.",
"required": true
},
"import": {
"id": {
"type": "string",
"doc": "Unique import name.",
"required": true
},
"url": {
"type": "string",
"doc": "The URL of the style.",
"required": true
},
"config": {
"type": "config",
"doc": "Configuration values for the imported style's options."
},
"data": {
"type": "$root",
"doc": "The inlined style that must correspond to the contents of the specified URL."
}
},
"config": {
"*": {
"type": "*",
"doc": "Value of the imported style's configuration option."
}
},
"schema": {
"*": {
"type": "option",
"doc": "Specification of a configuration option."
}
},
"option": {
"default": {
"type": "*",
"doc": "Default configuration value for this option.",
"required": true
},
"type": {
"type": "enum",
"doc": "The type this value is coerced to after evaluating the expression. If unspecified, the result is returned as is and is not validated.",
"values": {
"string": {
"doc": "The result will be coerced to a string."
},
"number": {
"doc": "The result will be coerced to a number."
},
"boolean": {
"doc": "The result will be coerced to a boolean."
},
"color": {
"doc": "The result will be coerced to a color."
}
}
},
"array": {
"type": "boolean",
"doc": "If true, this option is returned as an array"
},
"minValue": {
"type": "number",
"doc": "If this option is a number, this specifies the minimum allowed value. Values lower than this will be clamped to the minimum value."
},
"maxValue": {
"type": "number",
"doc": "If this option is a number, this specifies the maximum allowed value. Values higher than this will be clamped to the maximum value."
},
"stepValue": {
"type": "number",
"doc": "If this option is a number, this specifies the increment between allowed values. Values will be rounded towards the nearest allowed value."
},
"values": {
"type": "array",
"value": "*",
"doc": "If this option is specified, the result must be one of the given values. Otherwise, the default value is used instead."
},
"metadata": {
"type": "*",
"doc": "Arbitrary properties useful to track with the layer, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'mapbox:'."
}
},
"models" : {
"*": {
"type": "model",
"doc": "A URL to a model resource. Supported protocols are `http:`, `https:`, and `mapbox://<Model ID>`."
}
},
"light-3d": {
"id": {
"type": "string",
"doc": "Unique light name.",
"required": true
},
"properties": {
"type": "properties",
"doc": "Properties of the light."
},
"type": {
"type": "enum",
"doc": "Type of the light to be added",
"values": {
"ambient": {
"doc": "An indirect light affecting all objects in the map adding a constant amount of light on them. It has no explicit direction and cannot cast shadows.",
"sdk-support": {
"basic functionality": {
"js": "3.0.0",
"android": "11.0.0",
"ios": "11.0.0"
}
}
},
"directional": {
"doc": "A light that has a direction and is located at infinite, so its rays are parallel. Simulates the sun light and it can cast shadows",
"sdk-support": {
"basic functionality": {
"js": "3.0.0",
"android": "11.0.0",
"ios": "11.0.0"
}
}
},
"flat": {
"doc": "A global directional light source which is only applied on 3D layers and hillshade layers. Using this type disables other light sources.",
"sdk-support": {
"basic functionality": {
"js": "3.0.0",
"android": "11.0.0",
"ios": "11.0.0"
}
}
}
}
}
},
"properties": [
"properties_light_directional",
"properties_light_ambient",
"properties_light_flat"
],
"properties_light_directional": {
"direction": {
"type": "array",
"default": [210, 30],
"minimum": [0, 0],
"maximum": [360, 90],
"length": 2,
"value": "number",
"property-type": "data-constant",
"transition": true,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"doc": "Direction of the light source specified as [a azimuthal angle, p polar angle] where a indicates the azimuthal angle of the light relative to north (in degrees and proceeding clockwise), and p indicates polar angle of the light (from 0°, directly above, to 180°, directly below).",
"example": [90, 40]
},
"color": {
"type": "color",
"property-type": "data-constant",
"default": "#ffffff",
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "Color of the directional light."
},
"intensity": {
"type": "number",
"property-type": "data-constant",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "A multiplier for the color of the directional light."
},
"cast-shadows": {
"type": "boolean",
"default": false,
"doc": "Enable/Disable shadow casting for this light",
"transition": false,
"expression": {
"interpolated": false
},
"property-type": "data-constant"
},
"shadow-intensity": {
"type": "number",
"property-type": "data-constant",
"default": 1.0,
"minimum": 0,
"maximum": 1,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"doc": "Determines the shadow strength, affecting the shadow receiver surfaces final color. Values near 0.0 reduce the shadow contribution to the final color. Values near to 1.0 make occluded surfaces receive almost no directional light. Designed to be used mostly for transitioning between values 0 and 1.",
"transition": true
}
},
"properties_light_ambient": {
"color": {
"type": "color",
"property-type": "data-constant",
"default": "#ffffff",
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "Color of the ambient light."
},
"intensity": {
"type": "number",
"property-type": "data-constant",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "A multiplier for the color of the ambient light."
}
},
"properties_light_flat": {
"anchor": {
"type": "enum",
"default": "viewport",
"values": {
"map": {
"doc": "The position of the light source is aligned to the rotation of the map."
},
"viewport": {
"doc": "The position of the light source is aligned to the rotation of the viewport."
}
},
"property-type": "data-constant",
"transition": false,
"expression": {
"interpolated": false,
"parameters": [
"zoom"
]
},
"doc": "Whether extruded geometries are lit relative to the map or viewport.",
"example": "map",
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0",
"macos": "0.5.0"
}
}
},
"position": {
"type": "array",
"default": [
1.15,
210,
30
],
"length": 3,
"value": "number",
"property-type": "data-constant",
"transition": true,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"doc": "Position of the light source relative to lit (extruded) geometries, in [r radial coordinate, a azimuthal angle, p polar angle] where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0° (0° when `light.anchor` is set to `viewport` corresponds to the top of the viewport, or 0° when `light.anchor` is set to `map` corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0°, directly above, to 180°, directly below).",
"example": [
1.5,
90,
80
],
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0",
"macos": "0.5.0"
}
}
},
"color": {
"type": "color",
"property-type": "data-constant",
"default": "#ffffff",
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "Color tint for lighting extruded geometries.",
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0",
"macos": "0.5.0"
}
}
},
"intensity": {
"type": "number",
"property-type": "data-constant",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"expression": {
"interpolated": true,
"parameters": [
"zoom"
]
},
"transition": true,
"doc": "Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.",
"sdk-support": {
"basic functionality": {
"js": "0.27.0",
"android": "5.1.0",
"ios": "3.6.0",
"macos": "0.5.0"
}
}
}
},
"sources": {
"*": {
"type": "source",
"doc": "Specification of a data source. For vector and raster sources, either TileJSON or a URL to a TileJSON must be provided. For image and video sources, a URL must be provided. For GeoJSON sources, a URL or inline GeoJSON must be provided."
}
},
"source": [
"source_vector",
"source_raster",
"source_raster_dem",
"source_geojson",
"source_video",
"source_image",
"source_model"
],
"source_vector": {
"type": {
"required": true,
"type": "enum",
"values": {
"vector": {
"doc": "A vector tile source."
}
},
"doc": "The type of the source."
},
"url": {
"type": "string",
"doc": "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`."
},
"tiles": {
"type": "array",
"value": "string",
"doc": "An array of one or more tile source URLs, as in the TileJSON spec."
},
"bounds": {
"type": "array",
"value": "number",
"length": 4,
"default": [
-180,
-85.051129,
180,
85.051129
],
"doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
},
"scheme": {
"type": "enum",
"values": {
"xyz": {
"doc": "Slippy map tilenames scheme."
},
"tms": {
"doc": "OSGeo spec scheme."
}
},
"default": "xyz",
"doc": "Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed."
},
"minzoom": {
"type": "number",
"default": 0,
"doc": "Minimum zoom level for which tiles are available, as in the TileJSON spec."
},
"maxzoom": {
"type": "number",
"default": 22,
"doc": "Maximum zoom level for which tiles are available, as in the TileJSON spec. Data from tiles at the maxzoom are used when displaying the map at higher zoom levels."
},
"attribution": {
"type": "string",
"doc": "Contains an attribution to be displayed when the map is shown to a user."
},
"promoteId": {
"type": "promoteId",
"doc": "A property to use as a feature id (for feature state). Either a property name, or an object of the form `{<sourceLayer>: <propertyName>}`. If specified as a string for a vector tile source, the same property is used across all its source layers. If specified as an object only specified source layers will have id overriden, others will fallback to original feature id"
},
"volatile": {
"type": "boolean",
"default": false,
"doc": "A setting to determine whether a source's tiles are cached locally.",
"sdk-support": {
"basic functionality": {
"android": "9.3.0",
"ios": "5.10.0"
}
}
},
"*": {
"type": "*",
"doc": "Other keys to configure the data source."
}
},
"source_raster": {
"type": {
"required": true,
"type": "enum",
"values": {
"raster": {
"doc": "A raster tile source."
}
},
"doc": "The type of the source."
},
"url": {
"type": "string",
"doc": "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`."
},
"tiles": {
"type": "array",
"value": "string",
"doc": "An array of one or more tile source URLs, as in the TileJSON spec."
},
"bounds": {
"type": "array",
"value": "number",
"length": 4,
"default": [
-180,
-85.051129,
180,
85.051129
],
"doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
},
"minzoom": {
"type": "number",
"default": 0,
"doc": "Minimum zoom level for which tiles are available, as in the TileJSON spec."
},
"maxzoom": {
"type": "number",
"default": 22,
"doc": "Maximum zoom level for which tiles are available, as in the TileJSON spec. Data from tiles at the maxzoom are used when displaying the map at higher zoom levels."
},
"tileSize": {
"type": "number",
"default": 512,
"units": "pixels",
"doc": "The minimum visual size to display tiles for this layer. Only configurable for raster layers."
},
"scheme": {
"type": "enum",
"values": {
"xyz": {
"doc": "Slippy map tilenames scheme."
},
"tms": {
"doc": "OSGeo spec scheme."
}
},
"default": "xyz",
"doc": "Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed."
},
"attribution": {
"type": "string",
"doc": "Contains an attribution to be displayed when the map is shown to a user."
},
"volatile": {
"type": "boolean",
"default": false,
"doc": "A setting to determine whether a source's tiles are cached locally.",
"sdk-support": {
"basic functionality": {
"android": "9.3.0",
"ios": "5.10.0"
}
}
},
"*": {
"type": "*",
"doc": "Other keys to configure the data source."
}
},
"source_raster_dem": {
"type": {
"required": true,
"type": "enum",
"values": {
"raster-dem": {
"doc": "A RGB-encoded raster DEM source"
}
},
"doc": "The type of the source."
},
"url": {
"type": "string",
"doc": "A URL to a TileJSON resource. Supported protocols are `http:`, `https:`, and `mapbox://<Tileset ID>`."
},
"tiles": {
"type": "array",
"value": "string",
"doc": "An array of one or more tile source URLs, as in the TileJSON spec."
},
"bounds": {
"type": "array",
"value": "number",
"length": 4,
"default": [
-180,
-85.051129,
180,
85.051129
],
"doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
},
"minzoom": {
"type": "number",
"default": 0,
"doc": "Minimum zoom level for which tiles are available, as in the TileJSON spec."
},
"maxzoom": {
"type": "number",
"default": 22,
"doc": "Maximum zoom level for which tiles are available, as in the TileJSON spec. Data from tiles at the maxzoom are used when displaying the map at higher zoom levels."
},
"tileSize": {
"type": "number",
"default": 512,
"units": "pixels",
"doc": "The minimum visual size to display tiles for this layer. Only configurable for raster layers."
},
"attribution": {
"type": "string",
"doc": "Contains an attribution to be displayed when the map is shown to a user."
},
"encoding": {
"type": "enum",
"values": {
"terrarium": {
"doc": "Terrarium format PNG tiles. See https://aws.amazon.com/es/public-datasets/terrain/ for more info."
},
"mapbox": {
"doc": "Mapbox Terrain RGB tiles. See https://www.mapbox.com/help/access-elevation-data/#mapbox-terrain-rgb for more info."
}
},
"default": "mapbox",
"doc": "The encoding used by this source. Mapbox Terrain RGB is used by default"
},
"volatile": {
"type": "boolean",
"default": false,
"doc": "A setting to determine whether a source's tiles are cached locally.",
"sdk-support": {
"basic functionality": {
"android": "9.3.0",
"ios": "5.10.0"
}
}
},
"*": {
"type": "*",
"doc": "Other keys to configure the data source."
}
},
"source_geojson": {
"type": {
"required": true,
"type": "enum",
"values": {
"geojson": {
"doc": "A GeoJSON data source."
}
},
"doc": "The data type of the GeoJSON source."
},
"data": {
"type": "*",
"doc": "A URL to a GeoJSON file, or inline GeoJSON."
},
"maxzoom": {
"type": "number",
"default": 18,
"doc": "Maximum zoom level at which to create vector tiles (higher means greater detail at high zoom levels)."
},
"attribution": {
"type": "string",
"doc": "Contains an attribution to be displayed when the map is shown to a user."
},
"buffer": {
"type": "number",
"default": 128,
"maximum": 512,
"minimum": 0,
"doc": "Size of the tile buffer on each side. A value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself. Larger values produce fewer rendering artifacts near tile edges and slower performance."
},
"filter": {
"type": "*",
"doc": "An expression for filtering features prior to processing them for rendering."
},
"tolerance": {
"type": "number",
"default": 0.375,
"doc": "Douglas-Peucker simplification tolerance (higher means simpler geometries and faster performance)."
},
"cluster": {
"type": "boolean",
"default": false,
"doc": "If the data is a collection of point features, setting this to true clusters the points by radius into groups. Cluster groups become new `Point` features in the source with additional properties:\n * `cluster` Is `true` if the point is a cluster \n * `cluster_id` A unqiue id for the cluster to be used in conjunction with the [cluster inspection methods](https://www.mapbox.com/mapbox-gl-js/api/#geojsonsource#getclusterexpansionzoom)\n * `point_count` Number of original points grouped into this cluster\n * `point_count_abbreviated` An abbreviated point count"
},
"clusterRadius": {
"type": "number",
"default": 50,
"minimum": 0,
"doc": "Radius of each cluster if clustering is enabled. A value of 512 indicates a radius equal to the width of a tile."
},
"clusterMaxZoom": {
"type": "number",
"doc": "Max zoom on which to cluster points if clustering is enabled. Defaults to one zoom less than maxzoom (so that last zoom features are not clustered). Clusters are re-evaluated at integer zoom levels so setting clusterMaxZoom to 14 means the clusters will be displayed until z15."
},
"clusterMinPoints": {
"type": "number",
"doc": "Minimum number of points necessary to form a cluster if clustering is enabled. Defaults to `2`."
},
"clusterProperties": {
"type": "*",
"doc": "An object defining custom properties on the generated clusters if clustering is enabled, aggregating values from clustered points. Has the form `{\"property_name\": [operator, map_expression]}`. `operator` is any expression function that accepts at least 2 operands (e.g. `\"+\"` or `\"max\"`) — it accumulates the property value from clusters/points the cluster contains; `map_expression` produces the value of a single point.\n\nExample: `{\"sum\": [\"+\", [\"get\", \"scalerank\"]]}`.\n\nFor more advanced use cases, in place of `operator`, you can use a custom reduce expression that references a special `[\"accumulated\"]` value, e.g.:\n`{\"sum\": [[\"+\", [\"accumulated\"], [\"get\", \"sum\"]], [\"get\", \"scalerank\"]]}`"
},
"lineMetrics": {
"type": "boolean",
"default": false,
"doc": "Whether to calculate line distance metrics. This is required for line layers that specify `line-gradient` values."
},
"generateId": {
"type": "boolean",
"default": false,
"doc": "Whether to generate ids for the geojson features. When enabled, the `feature.id` property will be auto assigned based on its index in the `features` array, over-writing any previous values."
},
"promoteId": {
"type": "promoteId",
"doc": "A property to use as a feature id (for feature state). Either a property name, or an object of the form `{<sourceLayer>: <propertyName>}`."
}
},
"source_video": {
"type": {
"required": true,
"type": "enum",
"values": {
"video": {
"doc": "A video data source."
}
},
"doc": "The data type of the video source."
},
"urls": {
"required": true,
"type": "array",
"value": "string",
"doc": "URLs to video content in order of preferred format."
},
"coordinates": {
"required": true,
"doc": "Corners of video specified in longitude, latitude pairs.",
"type": "array",
"length": 4,
"value": {
"type": "array",
"length": 2,
"value": "number",
"doc": "A single longitude, latitude pair."
}
}
},
"source_image": {
"type": {
"required": true,
"type": "enum",
"values": {
"image": {
"doc": "An image data source."
}
},
"doc": "The data type of the image source."
},
"url": {
"required": true,
"type": "string",
"doc": "URL that points to an image."
},
"coordinates": {
"required": true,
"doc": "Corners of image specified in longitude, latitude pairs.",
"type": "array",
"length": 4,
"value": {
"type": "array",
"length": 2,
"value": "number",
"doc": "A single longitude, latitude pair."
}
}
},
"source_model" : {
"type": {
"required": true,
"type": "enum",
"values": {
"model": {
"doc": "A collection of 3D models"
},
"batched-model": {
"doc": "A collection of 3D models with anchor data"
}
},
"doc": "Type of model source to be added. From single models to represent 2D layers to 3D tiled models covering a wide area."
},
"maxzoom": {
"type": "number",
"default": 18,
"doc": "Maximum zoom level at which to create batched model tiles. Data from tiles at the maxzoom are used when displaying the map at higher zoom levels."
},
"minzoom": {
"type": "number",
"default": 0,
"doc": "Minimum zoom level for which batched-model tiles are available"
},
"tiles": {
"type": "array",
"value": "string",
"doc": "An array of one or more tile source URLs, as in the TileJSON spec."
}
},
"layer": {
"id": {
"type": "string",
"doc": "Unique layer name.",
"required": true
},
"type": {
"type": "enum",
"values": {
"fill": {
"doc": "A filled polygon with an optional stroked border.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0",
"macos": "0.1.0"
}
}
},
"line": {
"doc": "A stroked line.",
"sdk-support": {
"basic functionality": {
"js": "0.10.0",
"android": "2.0.1",
"ios": "2.0.0",