-
-
Notifications
You must be signed in to change notification settings - Fork 9
/
MapboxStyleParser.ts
1601 lines (1471 loc) · 52.2 KB
/
MapboxStyleParser.ts
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
/* eslint-disable id-blacklist */
import {
PointSymbolizer,
Rule,
Style,
StyleParser,
Symbolizer,
FillSymbolizer,
LineSymbolizer,
IconSymbolizer,
TextSymbolizer,
Filter,
Operator,
SymbolizerKind,
MarkSymbolizer,
ScaleDenominator,
UnsupportedProperties,
ReadStyleResult,
isGeoStylerFunction,
GeoStylerBooleanFunction,
GeoStylerStringFunction,
WriteStyleResult,
isFillSymbolizer,
isLineSymbolizer,
CapType,
JoinType,
isFilter,
isScaleDenominator,
isGeoStylerBooleanFunction
} from 'geostyler-style';
import MapboxStyleUtil from './Util/MapboxStyleUtil';
import _isEqual from 'lodash/isEqual';
import {
AnyLayer,
AnyLayout,
AnyPaint,
CircleLayout,
CirclePaint,
CustomLayerInterface,
FillLayer,
FillLayout,
FillPaint,
LineLayer,
LineLayout,
LinePaint,
SymbolLayout,
SymbolPaint,
Style as MapboxStyle,
Sources,
Expression
} from 'mapbox-gl';
import { gs2mbExpression, mb2gsExpression } from './Expressions';
import { isBoolean, isString, isUndefined, omitBy, set } from 'lodash';
/**
* The style representation of mapbox-gl but with optional sources, as these are
* not required for reading the style and get stripped when writing.
*/
export type MbStyle = Omit<MapboxStyle, 'sources'> & { sources?: Sources };
type NoneCustomLayer = Exclude<AnyLayer, CustomLayerInterface>;
/**
* Generated ids contain information about the position of a layer inside the
* geostyler-style:
* r* -> rule index
* sy* -> symbolizer index
* st* -> mapboxlayer index
*/
type LayerId = AnyLayer['id'];
type GeoStylerRef = {
rules: {
name?: string;
symbolizers?: LayerId[][];
}[];
};
type MapboxRef = {
splitSymbolizers?: {
rule: number;
symbolizers: number[];
}[];
};
type SymbolType = {
textSymbolizer?: TextSymbolizer;
iconSymbolizer?: IconSymbolizer;
};
type OptionsType = {
ignoreConversionErrors?: boolean;
pretty?: boolean;
};
export class MapboxStyleParser implements StyleParser<Omit<MbStyle, 'sources'>> {
// looks like there's no way to access static properties from an instance
// without a reference to the constructor function, so we have to duplicate
// the title here
public static title = 'Mapbox';
private static readonly fillSymbolizerStrokeProperties: (keyof FillSymbolizer)[] = [
'outlineOpacity',
'outlineWidth',
'outlineCap',
'outlineJoin',
'outlineDasharray'
];
public title = 'Mapbox';
/**
* Object of unsupported properties.
*/
unsupportedProperties = {
Symbolizer: {
FillSymbolizer: {
fillOpacity: {
support: 'none',
info: 'Use opacity instead.'
},
outlineWidthUnit: 'none'
},
LineSymbolizer: {
dashOffset: 'none',
graphicStroke: 'none',
gapWidthUnit: 'none',
spacing: 'none',
spacingUnit: 'none',
widthUnit: 'none'
},
MarkSymbolizer: {
support: 'partial',
wellKnownName: {
support: 'partial',
info: 'Only circle symbolizers are supported for the moment.'
},
opacity: {
support: 'none',
info: 'General opacity is not supported. Use fillOpacity and strokeOpacity instead.'
},
},
IconSymbolizer: {
haloOpacity: 'none',
haloWidthUnit: 'none',
sizeUnit: 'none'
},
RasterSymbolizer: 'none',
TextSymbolizer: {
fontStyle: 'none',
fontWeight: 'none',
haloOpacity: 'none',
haloWidthUnit: 'none',
letterSpacingUnit: 'none',
lineHeightUnit: 'none'
}
},
Function: {
numberFormat: 'none',
strAbbreviate: 'none',
strCapitalize: 'none',
strDefaultIfBlank: 'none',
strEndsWith: 'none',
strEqualsIgnoreCase: 'none',
strIndexOf: 'none',
strLastIndexOf: 'none',
strMatches: 'none',
strReplace: 'none',
strStartsWith: 'none',
strStripAccents: 'none',
strSubstringStart: 'none',
strSubstring: {
support: 'partial',
info: 'end index is mandatory'
},
strTrim: 'none',
exp: {
support: 'partial',
info: 'only for x = 1'
},
atan2: 'none',
random: 'none',
rint: 'none',
toDegrees: 'none',
toRadians: 'none',
double2bool: 'none',
}
} satisfies UnsupportedProperties;
public ignoreConversionErrors: boolean = false;
public pretty: boolean = false;
private mbMetadata: {
'geostyler:ref': GeoStylerRef;
};
private spriteBaseUrl: string;
constructor(options?: OptionsType) {
if (options && options.ignoreConversionErrors) {
this.ignoreConversionErrors = options.ignoreConversionErrors;
}
if (options?.pretty !== undefined) {
this.pretty = options?.pretty;
}
}
public isSymbolType(s: Symbolizer|SymbolType): s is SymbolType {
return (<SymbolType> s).iconSymbolizer ? true : (<SymbolType> s).textSymbolizer ? true : false;
}
/**
* Parses the GeoStylerStyle-SymbolizerKind from a Mapbox Style Layer
*
* @param type A Mapbox Style Layer
* @return A GeoStylerStyle SymbolizerKind 'Symbol' or 'Circle'
*/
getSymbolizerKindFromMapboxLayerType(type: AnyLayer['type']): SymbolizerKind | 'Symbol' | 'Circle' {
switch (type) {
case 'fill':
return 'Fill';
case 'line':
return 'Line';
case 'symbol':
return 'Symbol';
case 'circle':
return 'Circle';
default:
if (this.ignoreConversionErrors) {
return 'Circle';
}
throw new Error(`Could not parse mapbox style. Unsupported layer type.
We support types 'fill', 'line', 'circle' and 'symbol' only.`);
}
}
/**
* Creates a GeoStylerStyle-TextSymbolizer label from a Mapbox Layer Paint Symbol text-field
*
* @param label A Mapbox Layer Paint Symbol text-field
* @return A GeoStylerStyle-TextSymbolizer label
*/
getLabelFromTextField(label: string | Expression): (string | GeoStylerStringFunction | undefined) {
if (typeof label === 'undefined') {
return;
}
if (typeof label === 'string') {
return MapboxStyleUtil.resolveMbTextPlaceholder(label);
}
if (label[0] !== 'format') {
return mb2gsExpression(label);
}
let gsLabel = '';
// ignore all even indexes since we cannot handle them
for (let i = 1; i < label.length; i = i + 2) {
if (typeof label[i] === 'string') {
gsLabel += label[i];
} else {
if (label[i][0] !== 'get' && !this.ignoreConversionErrors) {
throw new Error('Cannot parse mapbox style. Unsupported lookup type.');
}
gsLabel += '{{' + label[i][1] + '}}';
}
}
return gsLabel;
}
/**
* Creates an image url based on the sprite baseurl and the sprite name.
*
* @param spriteName Name of the sprite
* @return the url that returns the single image
*/
getIconImage(spriteName: string): (string|undefined) {
if (!spriteName) {
return;
}
if (!this.spriteBaseUrl) {
return;
}
// TODO update endpoint as soon as api specification was made
let url: string = '/sprites/?';
url += 'name=' + spriteName;
url += '&baseurl=' + encodeURIComponent(this.spriteBaseUrl);
return url;
}
/**
* Creates a GeoStylerStyle-MarkSymbolizer with wellKnownName 'circle'
* from a Mapbox Style Layer. This one will be handled explicitly
* because mapbox has a dedicated layer type for circles. Other shapes are covered
* in layer type 'symbol' using fonts.
*
* @param paint A Mapbox paint
* @param layout A Mapbox layout
* @return A GeoStylerStyle-MarkSymbolizer
*/
getMarkSymbolizerFromMapboxCircleLayer(paint: CirclePaint, layout: CircleLayout): MarkSymbolizer | undefined {
const symbolizer: MarkSymbolizer = {
kind: 'Mark',
blur: mb2gsExpression<number>(paint?.['circle-blur']),
color: mb2gsExpression<string>(paint?.['circle-color']),
// TODO: handle array values
offset: paint?.['circle-translate'] as MarkSymbolizer['offset'],
offsetAnchor: paint?.['circle-translate-anchor'],
fillOpacity: mb2gsExpression<number>(paint?.['circle-opacity']),
pitchAlignment: paint?.['circle-pitch-alignment'],
pitchScale: paint?.['circle-pitch-scale'],
radius: mb2gsExpression<number>(paint?.['circle-radius']),
strokeColor: mb2gsExpression<string>(paint?.['circle-stroke-color']),
strokeOpacity: mb2gsExpression<number>(paint?.['circle-stroke-opacity']),
strokeWidth: mb2gsExpression<number>(paint?.['circle-stroke-width']),
visibility: layout?.visibility && layout?.visibility !== 'none',
wellKnownName: 'circle'
};
if (MapboxStyleUtil.symbolizerAllUndefined(symbolizer)) {
return undefined;
}
return omitBy(symbolizer, isUndefined) as MarkSymbolizer;
}
/**
* Creates a GeoStylerStyle-IconSymbolizer from a Mapbox Style Layer
*
* @param paint A Mapbox paint
* @param layout A Mapbox layout
* @return A GeoStylerStyle-IconSymbolizer
*/
getIconSymbolizerFromMapboxSymbolLayer(paint: SymbolPaint, layout: SymbolLayout): IconSymbolizer | undefined {
const symbolizer: IconSymbolizer = {
kind: 'Icon',
allowOverlap: mb2gsExpression<boolean>(layout?.['icon-allow-overlap']),
anchor: layout?.['icon-anchor'] as IconSymbolizer['anchor'],
avoidEdges: layout?.['symbol-avoid-edges'],
color: mb2gsExpression<string>(paint?.['icon-color']),
haloBlur: mb2gsExpression<number>(paint?.['icon-halo-blur']),
haloColor: mb2gsExpression<string>(paint?.['icon-halo-color']),
haloWidth: mb2gsExpression<number>(paint?.['icon-halo-width']),
image: this.getIconImage(layout?.['icon-image'] as string),
keepUpright: mb2gsExpression<boolean>(layout?.['icon-keep-upright']),
// TODO: handle array values
offset: layout?.['icon-offset'] as IconSymbolizer['offset'],
offsetAnchor: paint?.['icon-translate-anchor'],
opacity: mb2gsExpression<number>(paint?.['icon-opacity']),
optional: mb2gsExpression<boolean>(layout?.['icon-optional']),
padding: mb2gsExpression<number>(layout?.['icon-padding']),
pitchAlignment: layout?.['icon-pitch-alignment'],
rotate: mb2gsExpression<number>(layout?.['icon-rotate']),
rotationAlignment: layout?.['icon-rotation-alignment'],
size: mb2gsExpression<number>(layout?.['icon-size']),
textFit: layout?.['icon-text-fit'], // TODO: handle enum values
// TODO: handle array values
textFitPadding: layout?.['icon-text-fit-padding'] as IconSymbolizer['textFitPadding'],
visibility: layout?.visibility && layout?.visibility !== 'none'
};
if (MapboxStyleUtil.symbolizerAllUndefined(symbolizer)) {
return undefined;
}
return symbolizer;
}
/**
* Creates a GeoStylerStyle-TextSymbolizer from a Mapbox Style Layer
*
* @param paint A Mapbox paint
* @param layout A Mapbox layout
* @return A GeoStylerStyle-TextSymbolizer
*/
getTextSymbolizerFromMapboxLayer(paint: SymbolPaint, layout: SymbolLayout): TextSymbolizer | undefined {
const symbolizer: TextSymbolizer = {
kind: 'Text',
allowOverlap: mb2gsExpression<boolean>(layout?.['text-allow-overlap']),
// TODO: handle enum values
anchor: layout?.['text-anchor'] as TextSymbolizer['anchor'],
avoidEdges: mb2gsExpression<boolean>(layout?.['symbol-avoid-edges']),
color: mb2gsExpression<string>(paint?.['text-color']),
// TODO: handle array values
font: layout?.['text-font'],
haloBlur: mb2gsExpression<number>(paint?.['text-halo-blur']),
haloColor: mb2gsExpression<string>(paint?.['text-halo-color']),
haloWidth: mb2gsExpression<number>(paint?.['text-halo-width']),
// TODO: handle enum values
justify: layout?.['text-justify'] as TextSymbolizer['justify'],
keepUpright: mb2gsExpression<boolean>(layout?.['text-keep-upright']),
label: this.getLabelFromTextField(layout?.['text-field'] as string),
letterSpacing: mb2gsExpression<number>(layout?.['text-letter-spacing']),
lineHeight: mb2gsExpression<number>(layout?.['text-line-height']),
maxAngle: mb2gsExpression<number>(layout?.['text-max-angle']),
maxWidth: mb2gsExpression<number>(layout?.['text-max-width']),
// TODO: handle array values
offset: layout?.['text-offset'] as TextSymbolizer['offset'],
// TODO: handle enum values
offsetAnchor: paint?.['text-translate-anchor'],
opacity: mb2gsExpression<number>(paint?.['text-opacity']),
optional: mb2gsExpression<boolean>(layout?.['text-optional']),
padding: mb2gsExpression<number>(layout?.['text-padding']),
// TODO: handle enum values
pitchAlignment: layout?.['text-pitch-alignment'],
rotate: mb2gsExpression<number>(layout?.['text-rotate']),
// TODO: handle enum values
rotationAlignment: layout?.['text-rotation-alignment'],
size: mb2gsExpression<number>(layout?.['text-size']),
// TODO: handle enum values
transform: layout?.['text-transform'] as TextSymbolizer['transform'],
visibility: layout?.visibility && layout?.visibility !== 'none'
};
if (MapboxStyleUtil.symbolizerAllUndefined(symbolizer)) {
return undefined;
}
return omitBy(symbolizer, isUndefined) as TextSymbolizer;
}
/**
* Creates a GeoStylerStyle-FillSymbolizer from a Mapbox Style Layer.
*
* @param paint A Mapbox paint
* @param layout A Mapbox layout
* @return A GeoStylerStyle-FillSymbolizer
*/
getFillSymbolizerFromMapboxFillLayer(paint: FillPaint, layout: FillLayout): FillSymbolizer {
const fillSymbolizer: FillSymbolizer = {
kind: 'Fill',
visibility: layout?.visibility && layout?.visibility !== 'none',
antialias: mb2gsExpression<boolean>(paint?.['fill-antialias']),
opacity: mb2gsExpression<number>(paint?.['fill-opacity']),
color: mb2gsExpression<string>(paint?.['fill-color']),
outlineColor: mb2gsExpression<string>(paint?.['fill-outline-color']),
graphicFill: this.getPatternOrGradientFromMapboxLayer(paint?.['fill-pattern'])
};
return omitBy(fillSymbolizer, isUndefined) as FillSymbolizer;
}
getPatternOrGradientFromMapboxLayer(icon: any): IconSymbolizer|undefined {
if (Array.isArray(icon) && !this.ignoreConversionErrors) {
throw new Error('Cannot parse pattern or gradient. No Mapbox expressions allowed');
}
if (!icon) {
return;
}
return this.getIconSymbolizerFromMapboxSymbolLayer({}, {'icon-image': icon});
}
/**
* Creates a GeoStylerStyle-LineSymbolizer from a Mapbox Style Layer
*
* @param paint A Mapbox paint
* @param layout A Mapbox layout
* @return A GeoStylerStyle-LineSymbolizer
*/
getLineSymbolizerFromMapboxLineLayer(paint: LinePaint, layout: LineLayout): LineSymbolizer {
const lineSymbolizer: LineSymbolizer = {
kind: 'Line',
visibility: layout?.visibility && layout?.visibility !== 'none',
// TODO: handle enum values
cap: layout?.['line-cap'] as CapType,
// TODO: handle enum values
join: layout?.['line-join'] as JoinType,
miterLimit: mb2gsExpression<number>(layout?.['line-miter-limit']),
roundLimit: mb2gsExpression<number>(layout?.['line-round-limit']),
opacity: mb2gsExpression<number>(paint?.['line-opacity']),
color: mb2gsExpression<string>(paint?.['line-color']),
width: mb2gsExpression<number>(paint?.['line-width']),
gapWidth: mb2gsExpression<number>(paint?.['line-gap-width']),
perpendicularOffset: mb2gsExpression<number>(paint?.['line-offset']),
blur: mb2gsExpression<number>(paint?.['line-blur']),
// TODO: handle array values
dasharray: paint?.['line-dasharray'],
// TODO: handle enum values
gradient: paint?.['line-gradient'],
graphicFill: this.getPatternOrGradientFromMapboxLayer(paint?.['line-pattern'])
};
return omitBy(lineSymbolizer, isUndefined) as LineSymbolizer;
}
/**
* Creates GeoStyler-Style TextSymbolizer and IconSymbolizer from
* a mapbox layer paint object.
*
* @param paint A Mapbox paint
* @param layout A Mapbox layout
*/
getIconTextSymbolizersFromMapboxSymbolLayer(paint: SymbolPaint, layout: SymbolLayout): Symbolizer[] {
const symbolizers = [
this.getTextSymbolizerFromMapboxLayer(paint, layout),
this.getIconSymbolizerFromMapboxSymbolLayer(paint, layout)
];
return symbolizers.filter(symbolizer => !!symbolizer) as Symbolizer[];
}
/**
* Creates a GeoStylerStyle-Symbolizer from a Mapbox Style Layer
*
* @param paint A Mapbox paint
* @param layout A Mapbox layout
* @param type A Mapbox LayerType
* @return A GeoStylerStyle-Symbolizer
*/
getSymbolizersFromMapboxLayer(
{paint, layout, type}: {paint?: AnyPaint; layout?: AnyLayout; type: AnyLayer['type']}
): Symbolizer[] {
let symbolizer: Symbolizer = {} as Symbolizer;
const kind: SymbolizerKind | 'Symbol' | 'Circle' = this.getSymbolizerKindFromMapboxLayerType(type);
switch (kind) {
case 'Fill':
symbolizer = this.getFillSymbolizerFromMapboxFillLayer(
paint as FillPaint,
layout as FillLayout
);
break;
case 'Line':
symbolizer = this.getLineSymbolizerFromMapboxLineLayer(
paint as LinePaint,
layout as LineLayout
);
break;
case 'Symbol':
return this.getIconTextSymbolizersFromMapboxSymbolLayer(
paint as SymbolPaint,
layout as SymbolLayout
);
case 'Circle':
const sym = this.getMarkSymbolizerFromMapboxCircleLayer(
paint as CirclePaint,
layout as CircleLayout
);
return sym ? [sym]: [];
default:
if (this.ignoreConversionErrors) {
return [];
}
throw new Error('Cannot parse mapbox style. Unsupported Symbolizer kind.');
}
return [omitBy(symbolizer, isUndefined) as Symbolizer];
}
/**
* Creates a GeoStylerStyle-Filter from a Mapbox Style Layer Filter
*
* @param filter A Mapbox Style Layer Filter
* @return A GeoStylerStyle-Filter
*/
getFilterFromMapboxFilter(filter?: any[]): Filter | undefined {
if (!filter) {
return;
}
const operatorMapping = {
all: true,
any: true,
'!': true
};
const operator: Operator = filter[0];
let isNestedFilter: boolean = false;
if (operator in operatorMapping) {
isNestedFilter = true;
}
if (isNestedFilter) {
switch (filter[0]) {
case 'all':
filter[0] = '&&';
break;
case 'any':
filter[0] = '||';
break;
default:
break;
}
let restFilter = filter.slice(1);
restFilter.forEach((f: any[]) => {
this.getFilterFromMapboxFilter(f);
});
}
return filter as Filter;
}
/**
* Creates a GeoStylerStyle-ScaleDenominator from a Mapvox Style Layer Min/Max Zoom
*
* @param minZoom A Mapbox Style Layer minZoom property
* @param maxZoom A Mapbox Style Layer maxZoom property
* @return A GeoStylerStyle-ScaleDenominator
*/
getScaleDenominatorFromMapboxZoom(minZoom?: number, maxZoom?: number): ScaleDenominator|undefined {
let scaleDenominator: ScaleDenominator = {};
if (typeof minZoom !== 'undefined') {
scaleDenominator.max = MapboxStyleUtil.zoomToScale(minZoom);
}
if (typeof maxZoom !== 'undefined') {
scaleDenominator.min = MapboxStyleUtil.zoomToScale(maxZoom);
}
if (typeof scaleDenominator.min === 'undefined' && typeof scaleDenominator.max === 'undefined') {
return undefined;
}
return scaleDenominator;
}
/**
* This merges all the passed symbolizers into one if possbile.
*
* @param symbolizers The array of geostyler-style Symbolizers
* @returns
*/
mergeSymbolizers(symbolizers: Symbolizer[]): Symbolizer {
if (symbolizers.length === 1) {
return symbolizers[0];
}
return symbolizers.reduce((s1, s2, index) => {
if (index === 0) {
return s1;
}
let merged = Object.assign({}, s1,s2);
if (s1.kind !== s2.kind) {
const s1IsFill = isFillSymbolizer(s1);
const s2IsFill = isFillSymbolizer(s2);
if (s1IsFill || s2IsFill) {
const s1IsLine = isLineSymbolizer(s1);
const fillSymbolizer: FillSymbolizer = s1IsFill ? s1 : s2 as FillSymbolizer;
const lineSymbolizer: LineSymbolizer = s1IsLine ? s1 : s2 as LineSymbolizer;
merged = fillSymbolizer;
merged.outlineColor = lineSymbolizer.color;
merged.outlineOpacity = lineSymbolizer.opacity;
merged.outlineCap = lineSymbolizer.cap;
merged.outlineJoin = lineSymbolizer.join;
merged.outlineWidth = lineSymbolizer.width;
} else {
throw new Error(`Trying to merge two symbolizers of different kinds: ${s1.kind}, ${s2.kind}`);
}
}
return merged;
}, symbolizers[0]);
};
/**
* Creates a GeoStyler-Style Rule from a mapbox layer.
*
* @param layer The mapbox Layer
* @return A GeoStyler-Style Rule Array
*/
mapboxLayersToGeoStylerRules(layers: NoneCustomLayer[], mapboxRef: MapboxRef): Rule[] {
const geoStylerRef: GeoStylerRef = this.mbMetadata?.['geostyler:ref'];
const gsRules: Rule[] = [];
const splitSymbolizers: MapboxRef['splitSymbolizers'] = [];
if (geoStylerRef) {
geoStylerRef.rules.forEach((rule, ruleIndex) => {
const name = rule?.name || '';
let symbolizers: Symbolizer[] = [];
let filter: Filter | undefined;
let scaleDenominator: ScaleDenominator | undefined;
rule.symbolizers?.forEach((layerIds, symbolizerIndex) => {
const matchingLayers = layers.filter(layer => layerIds.includes(layer.id));
const flattenedSymbolizers = matchingLayers
.map(layer => {
const symbs = this.getSymbolizersFromMapboxLayer(layer);
if (symbs.length > 1) {
splitSymbolizers.push({
rule: ruleIndex,
symbolizers: symbs.map((s, sIdx) => sIdx)
});
}
return symbs;
})
.flat();
symbolizers[symbolizerIndex] = this.mergeSymbolizers(flattenedSymbolizers);
// TODO: check if there are multiple layers with different filters
// and scaledenominators and throw a warning that we only use the first
// one
if (matchingLayers?.[0]) {
filter = this.getFilterFromMapboxFilter(matchingLayers[0].filter);
scaleDenominator = this.getScaleDenominatorFromMapboxZoom(
matchingLayers[0].minzoom,
matchingLayers[0].maxzoom,
);
}
// TODO: care about layers not configured in the metadata
// const noneMatchingLayes = layers.filter(layer => !layerIds.includes(layer.id));
});
const gsRule = {
filter,
name,
scaleDenominator,
symbolizers
} satisfies Rule;
gsRules[ruleIndex] = omitBy(gsRule, isUndefined) as Rule;
});
} else {
// returns array of rules where one rule contains one symbolizer
layers.forEach((layer, layerIdx) => {
const symbolizers = this.getSymbolizersFromMapboxLayer(layer);
if (symbolizers.length < 1) {
return;
}
const filter = this.getFilterFromMapboxFilter(layer.filter);
const scaleDenominator = this.getScaleDenominatorFromMapboxZoom(
layer.minzoom,
layer.maxzoom,
);
const rule = {
filter,
name: layer.id,
scaleDenominator,
symbolizers
};
gsRules.push(rule);
if (symbolizers.length > 1) {
splitSymbolizers.push({
rule: gsRules.length - 1,
symbolizers: symbolizers.map((s, sIdx) => sIdx)
});
}
});
}
if (splitSymbolizers.length) {
mapboxRef.splitSymbolizers = splitSymbolizers;
}
return gsRules;
}
/**
* Creates a GeoStylerStyle-Style from a Mapbox Style
*
* @param mapboxStyle The Mapbox Style object
* @return A GeoStylerStyle-Style
*/
mapboxStyleToGeoStylerStyle(mapboxStyle: MbStyle): Style {
let style: Style = {} as Style;
style.name = mapboxStyle.name || '';
style.rules = [];
const mapboxRef = {};
this.mbMetadata = mapboxStyle.metadata;
if (mapboxStyle.sprite) {
this.spriteBaseUrl = MapboxStyleUtil.getUrlForMbPlaceholder(mapboxStyle.sprite);
}
if (mapboxStyle.layers) {
const layers = mapboxStyle.layers.filter(
layer => !(layer.type === 'custom')
) as NoneCustomLayer[];
const rules = this.mapboxLayersToGeoStylerRules(layers, mapboxRef);
style.rules = style.rules.concat(rules);
}
if (Object.keys(mapboxRef).length) {
style.metadata = {
'mapbox:ref': mapboxRef
};
}
return style;
}
/**
* The readStyle implementation of the GeoStyler-Style StylerParser interface.
* It reads a Mapbox Style and returns a Promise resolving with a GeoStylerStyle-ReadStyleResult.
*
* @param mapboxStyle The Mapbox Style object
* @return The Promise resolving with a GeoStylerStyle-ReadStyleResult
*/
readStyle(mapboxStyle: MbStyle): Promise<ReadStyleResult> {
return new Promise<ReadStyleResult>(resolve => {
try {
const mbStyle = structuredClone(mapboxStyle);
const geoStylerStyle: Style = this.mapboxStyleToGeoStylerStyle(mbStyle);
resolve({
output: geoStylerStyle
});
} catch (e) {
resolve({
errors: [e]
});
}
});
}
/**
* The writeStyle implementation of the GeoStyler-Style StyleParser interface.
* It reads a GeoStyler-Style Style and returns a Promise.
*
* @param geoStylerStyle A GeoStylerStyle-Style
* @return The Promise resolving with a GeoStylerStyle-WriteStyleResult
*/
writeStyle(geoStylerStyle: Style): Promise<WriteStyleResult<Omit<MbStyle, 'sources'>>> {
return new Promise<WriteStyleResult<Omit<MbStyle, 'sources'>>>(resolve => {
const unsupportedProperties = this.checkForUnsupportedProperties(geoStylerStyle);
try {
const gsStyle = structuredClone(geoStylerStyle);
const output: Omit<MbStyle, 'sources'> = this.geoStylerStyleToMapboxObject(gsStyle);
resolve({
output,
unsupportedProperties,
warnings: unsupportedProperties && ['Your style contains unsupportedProperties!']
});
} catch (e) {
resolve({
errors: [e]
});
}
});
}
/**
* Write a Mapbox Style Object based on a GeoStylerStyle.
*
* @param geoStylerStyle A GeoStylerStyle-Style
* @return A Mapbox Style object
*/
geoStylerStyleToMapboxObject(geoStylerStyle: Style): Omit<MbStyle, 'sources'> {
// Mapbox Style version
const version = 8;
const name = geoStylerStyle.name;
const metadata = geoStylerStyle.metadata?.['mapbox:ref'];
const {layers, geoStylerRef} = this.getMapboxLayersFromRules(geoStylerStyle.rules, metadata);
const sprite = MapboxStyleUtil.getMbPlaceholderForUrl(this.spriteBaseUrl);
let mapboxObject = omitBy({
version,
name,
layers,
sprite,
}, isUndefined) as Omit<MbStyle, 'sources'>;
if (geoStylerRef){
mapboxObject = {
...mapboxObject,
metadata: {
'geostyler:ref': geoStylerRef
}
};
}
return mapboxObject;
}
/**
* Creates a layer for each Rule and each Symbolizer.
*
* @param rules An array of GeoStylerStyle-Rules
* @return An array of Mapbox Layers
*/
getMapboxLayersFromRules(rules: Rule[], mapboxRef: MapboxRef): {layers: NoneCustomLayer[]; geoStylerRef: GeoStylerRef}
{
// one layer corresponds to a single symbolizer within a rule
// so filters and scaleDenominators have to be set for each symbolizer explicitly
const layers: NoneCustomLayer[] = [];
const geoStylerRef: GeoStylerRef = {
rules: []
};
rules.forEach((rule: Rule, ruleIndex: number) => {
// create new layer object
let layer: Partial<NoneCustomLayer> = {};
// set filters and scaleDenominator
if (isFilter(rule.filter)) {
const filterClone = structuredClone(rule.filter);
layer.filter = this.getMapboxFilterFromFilter(filterClone);
}
if (isScaleDenominator(rule.scaleDenominator)) {
// calculate zoomLevel from scaleDenominator
if (typeof rule.scaleDenominator.min !== 'undefined') {
if (!isGeoStylerFunction(rule.scaleDenominator.min)) {
layer.maxzoom = this.getMapboxZoomFromScaleDenominator(rule.scaleDenominator.min);
}
}
if (typeof rule.scaleDenominator.max !== 'undefined') {
if (!isGeoStylerFunction(rule.scaleDenominator.max)) {
layer.minzoom = this.getMapboxZoomFromScaleDenominator(rule.scaleDenominator.max);
}
}
}
geoStylerRef.rules[ruleIndex] = {
name: rule.name,
symbolizers: []
};
rule.symbolizers.forEach((symbolizer: Symbolizer, symbolizerIndex: number) => {
// use existing layer properties
let lyr: any = {};
lyr.filter = layer.filter;
lyr.minzoom = layer.minzoom;
lyr.maxzoom = layer.maxzoom;
// get symbolizer type and paint
const styles = this.getStyleFromSymbolizer(symbolizer);
const shouldMergeIntoPrev = mapboxRef?.splitSymbolizers?.some(
s => s.rule === ruleIndex && s.symbolizers.length > 1 && s.symbolizers.slice(1).includes(symbolizerIndex)
);
styles.forEach((style: any, styleIndex: number) => {
const {
type, paint, layout
} = style;
let lyrClone = structuredClone(lyr);
if (shouldMergeIntoPrev) {
lyrClone = layers.at(-1);
lyrClone.paint = {...lyrClone.paint, ...paint};
lyrClone.layout = {...lyrClone.layout, ...layout};
return;
}
lyrClone.type = type;
if (!MapboxStyleUtil.allUndefined(paint)) {
lyrClone.paint = paint;
}
if (!MapboxStyleUtil.allUndefined(layout)) {
lyrClone.layout = layout;
}
lyrClone.id = `r${ruleIndex}_sy${symbolizerIndex}_st${styleIndex}`;
layers.push(omitBy(lyrClone, isUndefined) as NoneCustomLayer);
let symbs = geoStylerRef.rules[ruleIndex].symbolizers;
if (!symbs) {
symbs = [];
}
if (!symbs[symbolizerIndex]) {
symbs[symbolizerIndex] = [];
}
symbs[symbolizerIndex].push(lyrClone.id);
geoStylerRef.rules[ruleIndex].symbolizers = symbs;
});
});
});
return {layers, geoStylerRef};
}
/**
* Get the mapbox zoomlevel from a scaleDenominator.
* Interpolates the zoomlevel if calculated resolutions do not match.
*
* @param scaleDenominator The scaleDenominator of the GeoStyler-Style Rule
* @return number The corresponding zoom level
*/
getMapboxZoomFromScaleDenominator(scaleDenominator: number): number {
// transform scaledenom to resolution
const resolution: number = MapboxStyleUtil.getResolutionForScale(scaleDenominator);
let pre: number|undefined = undefined;
let post: number|undefined = undefined;
let zoom: number;
const resolutions = MapboxStyleUtil.getResolutions();
zoom = resolutions.indexOf(resolution);
if (zoom === -1) {
zoom = MapboxStyleUtil.getZoomForResolution(resolution);
}
if (typeof pre !== 'undefined' && typeof post !== 'undefined') {
// interpolate between zoomlevels
const preVal = resolutions[pre];
const postVal = resolutions[post];
const range = preVal - postVal;
const diff = resolution - postVal;
const percentage = 1 - (diff / range);
if (percentage === 0) {
return pre;
}
zoom = pre + percentage;
}
return zoom;
}
/**
* Writes a Mapbox-filter from a GeoStylerStyle-Filter
*
* @param filter A GeoStylerStyle-Filter
* @return A Mapbox filter array
*/
// TODO: Move to Expression evaluation as mapbox Filter are deprecated
// (replaced by Expressions)
getMapboxFilterFromFilter(filter: Filter): Expression {
if (isGeoStylerBooleanFunction(filter) || isBoolean(filter)) {
return gs2mbExpression<any>(filter);
}
let mbFilter = [...filter];
const nestingOperators = ['&&', '||', '!'];
const operator: Operator = mbFilter[0] as Operator;