-
-
Notifications
You must be signed in to change notification settings - Fork 116
/
planetiler.schema.json
708 lines (708 loc) · 20.4 KB
/
planetiler.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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/onthegomap/planetiler/main/planetiler-custommap/planetiler.schema.json",
"title": "Planetiler",
"description": "Planetiler schema definition",
"type": "object",
"properties": {
"schema_name": {
"description": "A descriptive name for the schema",
"type": "string"
},
"schema_description": {
"description": "A longer description of the schema",
"type": "string"
},
"attribution": {
"description": "An attribution statement, which may include HTML such as links",
"type": "string"
},
"definitions": {
"description": "An unparsed spot where you can define anchors and aliases to be used in other parts of the schema",
"type": "object",
"properties": {
"attributes": {
"description": "An unparsed array of attribute fragments to be used below.",
"type": "array",
"items": {
"$ref": "#/$defs/attribute"
}
}
}
},
"sources": {
"description": "An object where key is the source ID and value is the definition of where the features should be extracted from",
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"description": "File format of the data source",
"enum": [
"osm",
"shapefile",
"geopackage"
]
},
"url": {
"description": "Location to download the file from. For geofabrik named areas, use `geofabrik:` prefixes, for example `geofabrik:rhode-island`.",
"$ref": "#/$defs/expression"
},
"local_path": {
"description": "Local path to the file to use, inferred from `url` if missing",
"$ref": "#/$defs/expression"
}
},
"anyOf": [
{
"required": [
"url"
]
},
{
"required": [
"local_path"
]
}
]
}
},
"tag_mappings": {
"description": "Specifies that certain tag key should have their values treated as being a certain data type",
"type": "object",
"additionalProperties": {
"anyOf": [
{
"$ref": "#/$defs/datatype"
},
{
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/datatype"
},
"input": {
"description": "The name of the key that this attribute is parsed from",
"type": "string"
}
}
}
]
}
},
"layers": {
"description": "A list of vector tile layers and their definitions",
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"description": "Unique layer name",
"type": "string"
},
"features": {
"description": "A list of features contained in this layer",
"type": "array",
"items": {
"$ref": "#/$defs/feature"
}
},
"tile_post_process": {
"description": "Optional processing operations to merge features with the same attributes in a rendered tile",
"$ref": "#/$defs/tile_post_process"
}
}
}
},
"args": {
"description": "Set default values for built-in command-line arguments or expose new command-line arguments.",
"type": "object",
"properties": {
"threads": {
"description": "Default number of threads to use."
},
"write_threads": {
"description": "Default number of threads to use when writing temp features"
},
"process_threads": {
"description": "Default number of threads to use when processing input features"
},
"feature_read_threads": {
"description": "Default number of threads to use when reading features at tile write time"
},
"minzoom": {
"description": "Minimum tile zoom level to emit"
},
"maxzoom": {
"description": "Maximum tile zoom level to emit"
},
"render_maxzoom": {
"description": "Maximum rendering zoom level up to"
},
"force": {
"description": "Overwriting output file and ignore warnings",
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"gzip_temp": {
"description": "Gzip temporary feature storage (uses more CPU, but less disk space)",
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"mmap_temp": {
"description": "Use memory-mapped IO for temp feature files",
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"sort_max_readers": {
"description": "Maximum number of concurrent read threads to use when sorting chunks"
},
"sort_max_writers": {
"description": "Maximum number of concurrent write threads to use when sorting chunks"
},
"nodemap_type": {
"description": "Type of node location map",
"anyOf": [
{
"type": "string"
},
{
"enum": [
"array",
"sparsearray",
"sortedtable",
"noop"
]
}
]
},
"nodemap_storage": {
"description": "Storage for node location map",
"anyOf": [
{
"type": "string"
},
{
"enum": [
"ram",
"mmap",
"direct"
]
}
]
},
"nodemap_madvise": {
"description": "Use linux madvise(random) for node locations",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"multipolygon_geometry_storage": {
"description": "Storage for multipolygon geometries",
"anyOf": [
{
"type": "string"
},
{
"enum": [
"ram",
"mmap",
"direct"
]
}
]
},
"multipolygon_geometry_madvise": {
"description": "Use linux madvise(random) for multiplygon geometries",
"anyOf": [
{
"type": "boolean"
},
{
"type": "string"
}
]
},
"http_user_agent": {
"description": "User-Agent header to set when downloading files over HTTP"
},
"http_retries": {
"description": "Retries to use when downloading files over HTTP"
},
"download_chunk_size_mb": {
"description": "Size of file chunks to download in parallel in megabytes"
},
"download_threads": {
"description": "Number of parallel threads to use when downloading each file"
},
"download_max_bandwidth": {
"description": "Maximum bandwidth to consume when downloading files in units mb/s, mbps, kbps, etc."
},
"min_feature_size_at_max_zoom": {
"description": "Default value for the minimum size in tile pixels of features to emit at the maximum zoom level to allow for overzooming"
},
"min_feature_size": {
"description": "Default value for the minimum size in tile pixels of features to emit below the maximum zoom level"
},
"simplify_tolerance_at_max_zoom": {
"description": "Default value for the tile pixel tolerance to use when simplifying features at the maximum zoom level to allow for overzooming"
},
"simplify_tolerance": {
"description": "Default value for the tile pixel tolerance to use when simplifying features below the maximum zoom level"
},
"skip_filled_tiles": {
"description": "Skip writing tiles containing only polygon fills to the output",
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"tile_warning_size_mb": {
"description": "Maximum size in megabytes of a tile to emit a warning about"
}
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"default": {
"description": "Default value for this argument (can be an expression).",
"$ref": "#/$defs/expression"
},
"type": {
"description": "Data type of this argument.",
"$ref": "#/$defs/datatype"
},
"description": {
"description": "Description for this argument.",
"type": "string"
}
}
}
]
}
},
"examples": {
"description": "Example input features and the vector tile features they map to, or a relative path to a file with those examples in it.",
"oneOf": [
{
"$ref": "#/$defs/include"
},
{
"$ref": "planetilerspec.schema.json#/properties/examples"
}
]
}
},
"$defs": {
"datatype": {
"type": "string",
"enum": [
"boolean",
"string",
"direction",
"long",
"integer",
"double"
]
},
"feature": {
"type": "object",
"required": [
"geometry"
],
"properties": {
"geometry": {
"description": "Include objects of a certain geometry type",
"type": "string",
"enum": [
"point",
"line",
"polygon",
"polygon_centroid",
"polygon_centroid_if_convex",
"polygon_point_on_surface"
]
},
"source": {
"description": "A source ID or list of source IDs from which features should be extracted",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"min_tile_cover_size": {
"description": "include objects of a certain geometry size, where 1.0 means \"is the same size as a tile at this zoom\"",
"type": "number",
"minimum": 0,
"maximum": 1
},
"include_when": {
"description": "A tag specification which determines the features to include. If unspecified, all features from the specified sources are included",
"$ref": "#/$defs/boolean_expression"
},
"exclude_when": {
"description": "A tag specification which determines the features to exclude. This rule is applied after `includeWhen`. If unspecified, no exclusion filter is applied.",
"$ref": "#/$defs/boolean_expression"
},
"min_zoom": {
"description": "An expression that returns the minimum zoom to render this feature at.",
"$ref": "#/$defs/expression"
},
"attributes": {
"description": "Specifies the attributes that should be rendered into the tiles for this feature, and how they are constructed",
"type": "array",
"items": {
"$ref": "#/$defs/attribute"
}
},
"min_size": {
"description": "Minimum length of line features or square root of the minimum area of polygon features to emit below the maximum zoom-level of the map",
"$ref": "#/$defs/expression"
}
}
},
"tile_post_process": {
"type": "object",
"properties": {
"merge_line_strings": {
"description": "Combines linestrings with the same set of attributes into a multilinestring where segments with touching endpoints are merged",
"type": "object",
"properties": {
"min_length": {
"description": "Minimum tile pixel length of features to emit, or 0 to emit all merged linestrings",
"type": "number"
},
"tolerance": {
"description": "After merging, simplify linestrings using this pixel tolerance, or -1 to skip simplification step",
"type": "number"
},
"buffer": {
"description": "Number of pixels outside the visible tile area to include detail for, or -1 to skip clipping step",
"type": "number"
}
}
},
"merge_polygons": {
"description": "Combines polygons with the same set of attributes into a multipolygon where overlapping/touching polygons are combined into fewer polygons covering the same area",
"type": "object",
"properties": {
"min_area": {
"description": "Minimum area in square tile pixels of polygons to emit",
"type": "number"
}
}
}
}
},
"zoom_level": {
"type": "integer",
"minimum": 0,
"maximum": 15
},
"attribute": {
"type": "object",
"anyOf": [
{
"$ref": "#/$defs/expression_coalesce"
},
{
"$ref": "#/$defs/expression_tag_value"
},
{
"$ref": "#/$defs/expression_arg_value"
},
{
"$ref": "#/$defs/expression_value"
},
{
"$ref": "#/$defs/expression_with_type_or_match_key_value"
},
{
"type": "object",
"properties": {
"key": {
"description": "ID of this attribute in the tile",
"type": "string"
},
"include_when": {
"description": "A filter specification which determines whether to include this attribute. If unspecified, the attribute will be included unless excluded by `excludeWhen`",
"$ref": "#/$defs/boolean_expression"
},
"exclude_when": {
"description": "A filter specification which determines whether to exclude this attribute. This rule is applied after `includeWhen`. If unspecified, no exclusion filter is applied.",
"$ref": "#/$defs/boolean_expression"
},
"min_zoom": {
"description": "The minimum zoom at which to render this attribute",
"$ref": "#/$defs/zoom_level"
},
"min_zoom_by_value": {
"description": "Minimum zoom to render this attribute depending on the value. Contains a map of `value: zoom` entries that indicate the minimum zoom for each possible value",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/zoom_level"
}
}
}
}
]
},
"boolean_expression": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/single_boolean_expression"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/single_boolean_expression"
}
}
]
},
"single_boolean_expression": {
"type": "object",
"properties": {
"__all__": {
"$ref": "#/$defs/boolean_expression"
},
"__any__": {
"$ref": "#/$defs/boolean_expression"
},
"__not__": {
"$ref": "#/$defs/boolean_expression"
}
},
"additionalProperties": {
"anyOf": [
{
"description": "Matches any value for this key",
"const": "__any__"
},
{
"description": "Matches when this key is missing or empty",
"const": ""
},
{
"type": "array",
"description": "A list of possible values for the key",
"items": {
"description": "One of the possible values for the key"
}
},
{
"description": "A single value for the key"
}
]
}
},
"expression": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"$ref": "#/$defs/expression_default_overrides"
},
{
"$ref": "#/$defs/expression_match"
},
{
"$ref": "#/$defs/expression_coalesce"
},
{
"$ref": "#/$defs/expression_tag_value"
},
{
"$ref": "#/$defs/expression_arg_value"
},
{
"$ref": "#/$defs/expression_value"
},
{
"$ref": "#/$defs/expression_with_type"
},
{
"$ref": "#/$defs/multiexpression"
}
]
},
"expression_with_type_or_match_key_value": {
"type": "object",
"properties": {
"type": {
"description": "Type of the attribute to map to",
"oneOf": [
{
"type": "string",
"enum": [
"match_key",
"match_value"
]
},
{
"$ref": "#/$defs/datatype"
}
]
}
}
},
"expression_with_type": {
"type": "object",
"properties": {
"type": {
"description": "Type of the attribute to map to",
"$ref": "#/$defs/datatype"
}
}
},
"expression_tag_value": {
"type": "object",
"properties": {
"tag_value": {
"description": "Value of the attribute in the tile, as copied from the value of the specified tag key. If neither constantValue nor tagValue are specified, the default behavior is to set the tag value equal to the input value (pass-through)",
"$ref": "#/$defs/expression"
}
}
},
"expression_arg_value": {
"type": "object",
"properties": {
"arg_value": {
"description": "Returns the value associated with an argument",
"$ref": "#/$defs/expression"
}
}
},
"expression_value": {
"type": "object",
"properties": {
"value": {
"description": "An expression that computes the value for this key for each input element",
"$ref": "#/$defs/expression"
}
}
},
"expression_coalesce": {
"type": "object",
"properties": {
"coalesce": {
"type": "array",
"items": {
"$ref": "#/$defs/expression"
}
}
}
},
"expression_match": {
"type": "object",
"properties": {
"match": {
"$ref": "#/$defs/multiexpression"
}
}
},
"expression_default_overrides": {
"type": "object",
"properties": {
"default_value": {
"$ref": "#/$defs/expression"
},
"overrides": {
"$ref": "#/$defs/multiexpression"
}
}
},
"multiexpression": {
"oneOf": [
{
"$ref": "#/$defs/multiexpression_object"
},
{
"$ref": "#/$defs/multiexpression_array"
}
]
},
"multiexpression_object": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"$ref": "#/$defs/boolean_expression"
},
{
"const": "otherwise"
}
]
}
},
"multiexpression_array": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"$ref": "#/$defs/expression"
},
"if": {
"$ref": "#/$defs/boolean_expression"
},
"else": {
"$ref": "#/$defs/expression"
}
}
}
},
"include": {
"type": "string"
}
}
}