This repository was archived by the owner on Jun 10, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmaplibre-gl.d.ts
More file actions
11085 lines (11080 loc) · 399 KB
/
maplibre-gl.d.ts
File metadata and controls
11085 lines (11080 loc) · 399 KB
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
// Generated by dts-bundle-generator v8.0.1
import Point from '@mapbox/point-geometry';
import TinySDF from '@mapbox/tiny-sdf';
import { VectorTileFeature, VectorTileLayer } from '@mapbox/vector-tile';
import { Color, CompositeExpression, Feature, FeatureFilter, FeatureState, FilterSpecification, Formatted, FormattedSection, GeoJSONSourceSpecification, GlobalProperties, ICanonicalTileID, IMercatorCoordinate, ImageSourceSpecification, InterpolationType, LayerSpecification, LightSpecification, Padding, PromoteIdSpecification, PropertyValueSpecification, RasterDEMSourceSpecification, RasterSourceSpecification, ResolvedImage, SourceExpression, SourceSpecification, SpriteSpecification, StylePropertyExpression, StylePropertySpecification, StyleSpecification, TerrainSpecification, TransitionSpecification, VectorSourceSpecification, VideoSourceSpecification } from '@maplibre/maplibre-gl-style-spec';
import { mat2, mat4, vec4 } from 'gl-matrix';
import KDBush from 'kdbush';
import { PotpackBox } from 'potpack';
export type Cancelable = {
cancel: () => void;
};
export type Callback<T> = (error?: Error | null, result?: T | null) => void;
/**
* A `RequestParameters` object to be returned from Map.options.transformRequest callbacks.
* @typedef {Object} RequestParameters
* @property {string} url The URL to be requested.
* @property {Object} headers The headers to be sent with the request.
* @property {string} method Request method `'GET' | 'POST' | 'PUT'`.
* @property {string} body Request body.
* @property {string} type Response body type to be returned `'string' | 'json' | 'arrayBuffer'`.
* @property {string} credentials `'same-origin'|'include'` Use 'include' to send cookies with cross-origin requests.
* @property {boolean} collectResourceTiming If true, Resource Timing API information will be collected for these transformed requests and returned in a resourceTiming property of relevant data events.
* @example
* // use transformRequest to modify requests that begin with `http://myHost`
* transformRequest: function(url, resourceType) {
* if (resourceType === 'Source' && url.indexOf('http://myHost') > -1) {
* return {
* url: url.replace('http', 'https'),
* headers: { 'my-custom-header': true },
* credentials: 'include' // Include cookies for cross-origin requests
* }
* }
* }
*
*/
export type RequestParameters = {
url: string;
headers?: any;
method?: "GET" | "POST" | "PUT";
body?: string;
type?: "string" | "json" | "arrayBuffer" | "image";
credentials?: "same-origin" | "include";
collectResourceTiming?: boolean;
};
export type ResponseCallback<T> = (error?: Error | null, data?: T | null, cacheControl?: string | null, expires?: string | null) => void;
export declare class AJAXError extends Error {
/**
* The response's HTTP status code.
*/
status: number;
/**
* The response's HTTP status text.
*/
statusText: string;
/**
* The request's URL.
*/
url: string;
/**
* The response's body.
*/
body: Blob;
constructor(status: number, statusText: string, url: string, body: Blob);
}
export type ExpiryData = {
cacheControl?: string | null;
expires?: Date | string | null;
};
export type GetImageCallback = (error?: Error | null, image?: HTMLImageElement | ImageBitmap | null, expiry?: ExpiryData | null) => void;
/**
* A type of MapLibre resource.
*/
export declare const enum ResourceType {
Glyphs = "Glyphs",
Image = "Image",
Source = "Source",
SpriteImage = "SpriteImage",
SpriteJSON = "SpriteJSON",
Style = "Style",
Tile = "Tile",
Unknown = "Unknown"
}
export type RequestTransformFunction = (url: string, resourceType?: ResourceType) => RequestParameters | undefined;
export declare class RequestManager {
_transformRequestFn: RequestTransformFunction;
constructor(transformRequestFn?: RequestTransformFunction);
transformRequest(url: string, type: ResourceType): RequestParameters;
normalizeSpriteURL(url: string, format: string, extension: string): string;
setTransformRequest(transformRequest: RequestTransformFunction): void;
}
export type Listener = (a: any) => any;
export type Listeners = {
[_: string]: Array<Listener>;
};
export declare class Event {
readonly type: string;
constructor(type: string, data?: any);
}
export declare class Evented {
_listeners: Listeners;
_oneTimeListeners: Listeners;
_eventedParent: Evented;
_eventedParentData: any | (() => any);
/**
* Adds a listener to a specified event type.
*
* @param {string} type The event type to add a listen for.
* @param {Function} listener The function to be called when the event is fired.
* The listener function is called with the data object passed to `fire`,
* extended with `target` and `type` properties.
* @returns {Object} `this`
*/
on(type: string, listener: Listener): this;
/**
* Removes a previously registered event listener.
*
* @param {string} type The event type to remove listeners for.
* @param {Function} listener The listener function to remove.
* @returns {Object} `this`
*/
off(type: string, listener: Listener): this;
/**
* Adds a listener that will be called only once to a specified event type.
*
* The listener will be called first time the event fires after the listener is registered.
*
* @param {string} type The event type to listen for.
* @param {Function} listener The function to be called when the event is fired the first time.
* @returns {Object} `this` or a promise if a listener is not provided
*/
once(type: string, listener?: Listener): this | Promise<any>;
fire(event: Event | string, properties?: any): this;
/**
* Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.
*
* @param {string} type The event type
* @returns {boolean} `true` if there is at least one registered listener for specified event type, `false` otherwise
* @private
*/
listens(type: string): any;
/**
* Bubble all events fired by this instance of Evented to this parent instance of Evented.
*
* @private
* @returns {Object} `this`
* @private
*/
setEventedParent(parent?: Evented | null, data?: any | (() => any)): this;
}
export declare class ZoomHistory {
lastZoom: number;
lastFloorZoom: number;
lastIntegerZoom: number;
lastIntegerZoomTime: number;
first: boolean;
constructor();
update(z: number, now: number): boolean;
}
export type CrossfadeParameters = {
fromScale: number;
toScale: number;
t: number;
};
export declare class EvaluationParameters {
zoom: number;
now: number;
fadeDuration: number;
zoomHistory: ZoomHistory;
transition: TransitionSpecification;
constructor(zoom: number, options?: any);
isSupportedScript(str: string): boolean;
crossFadingFactor(): number;
getCrossfadeParameters(): CrossfadeParameters;
}
export declare class LngLat {
lng: number;
lat: number;
constructor(lng: number, lat: number);
/**
* Returns a new `LngLat` object whose longitude is wrapped to the range (-180, 180).
*
* @returns {LngLat} The wrapped `LngLat` object.
* @example
* var ll = new maplibregl.LngLat(286.0251, 40.7736);
* var wrapped = ll.wrap();
* wrapped.lng; // = -73.9749
*/
wrap(): LngLat;
/**
* Returns the coordinates represented as an array of two numbers.
*
* @returns {[number,number]} The coordinates represented as an array of longitude and latitude.
* @example
* var ll = new maplibregl.LngLat(-73.9749, 40.7736);
* ll.toArray(); // = [-73.9749, 40.7736]
*/
toArray(): [
number,
number
];
/**
* Returns the coordinates represent as a string.
*
* @returns {string} The coordinates represented as a string of the format `'LngLat(lng, lat)'`.
* @example
* var ll = new maplibregl.LngLat(-73.9749, 40.7736);
* ll.toString(); // = "LngLat(-73.9749, 40.7736)"
*/
toString(): string;
/**
* Returns the approximate distance between a pair of coordinates in meters
* Uses the Haversine Formula (from R.W. Sinnott, "Virtues of the Haversine", Sky and Telescope, vol. 68, no. 2, 1984, p. 159)
*
* @param {LngLat} lngLat coordinates to compute the distance to
* @returns {number} Distance in meters between the two coordinates.
* @example
* var new_york = new maplibregl.LngLat(-74.0060, 40.7128);
* var los_angeles = new maplibregl.LngLat(-118.2437, 34.0522);
* new_york.distanceTo(los_angeles); // = 3935751.690893987, "true distance" using a non-spherical approximation is ~3966km
*/
distanceTo(lngLat: LngLat): number;
/**
* Converts an array of two numbers or an object with `lng` and `lat` or `lon` and `lat` properties
* to a `LngLat` object.
*
* If a `LngLat` object is passed in, the function returns it unchanged.
*
* @param {LngLatLike} input An array of two numbers or object to convert, or a `LngLat` object to return.
* @returns {LngLat} A new `LngLat` object, if a conversion occurred, or the original `LngLat` object.
* @example
* var arr = [-73.9749, 40.7736];
* var ll = maplibregl.LngLat.convert(arr);
* ll; // = LngLat {lng: -73.9749, lat: 40.7736}
*/
static convert(input: LngLatLike): LngLat;
}
/**
* A {@link LngLat} object, an array of two numbers representing longitude and latitude,
* or an object with `lng` and `lat` or `lon` and `lat` properties.
*
* @typedef {LngLat | {lng: number, lat: number} | {lon: number, lat: number} | [number, number]} LngLatLike
* @example
* var v1 = new maplibregl.LngLat(-122.420679, 37.772537);
* var v2 = [-122.420679, 37.772537];
* var v3 = {lon: -122.420679, lat: 37.772537};
*/
export type LngLatLike = LngLat | {
lng: number;
lat: number;
} | {
lon: number;
lat: number;
} | [
number,
number
];
export declare class MercatorCoordinate implements IMercatorCoordinate {
x: number;
y: number;
z: number;
constructor(x: number, y: number, z?: number);
/**
* Project a `LngLat` to a `MercatorCoordinate`.
*
* @param {LngLatLike} lngLatLike The location to project.
* @param {number} altitude The altitude in meters of the position.
* @returns {MercatorCoordinate} The projected mercator coordinate.
* @example
* var coord = maplibregl.MercatorCoordinate.fromLngLat({ lng: 0, lat: 0}, 0);
* coord; // MercatorCoordinate(0.5, 0.5, 0)
*/
static fromLngLat(lngLatLike: LngLatLike, altitude?: number): MercatorCoordinate;
/**
* Returns the `LngLat` for the coordinate.
*
* @returns {LngLat} The `LngLat` object.
* @example
* var coord = new maplibregl.MercatorCoordinate(0.5, 0.5, 0);
* var lngLat = coord.toLngLat(); // LngLat(0, 0)
*/
toLngLat(): LngLat;
/**
* Returns the altitude in meters of the coordinate.
*
* @returns {number} The altitude in meters.
* @example
* var coord = new maplibregl.MercatorCoordinate(0, 0, 0.02);
* coord.toAltitude(); // 6914.281956295339
*/
toAltitude(): number;
/**
* Returns the distance of 1 meter in `MercatorCoordinate` units at this latitude.
*
* For coordinates in real world units using meters, this naturally provides the scale
* to transform into `MercatorCoordinate`s.
*
* @returns {number} Distance of 1 meter in `MercatorCoordinate` units.
*/
meterInMercatorCoordinateUnits(): number;
}
export declare class CanonicalTileID implements ICanonicalTileID {
z: number;
x: number;
y: number;
key: string;
constructor(z: number, x: number, y: number);
equals(id: ICanonicalTileID): boolean;
url(urls: Array<string>, pixelRatio: number, scheme?: string | null): string;
isChildOf(parent: ICanonicalTileID): boolean;
getTilePoint(coord: IMercatorCoordinate): Point;
toString(): string;
}
export declare class UnwrappedTileID {
wrap: number;
canonical: CanonicalTileID;
key: string;
constructor(wrap: number, canonical: CanonicalTileID);
}
export declare class OverscaledTileID {
overscaledZ: number;
wrap: number;
canonical: CanonicalTileID;
key: string;
posMatrix: mat4;
constructor(overscaledZ: number, wrap: number, z: number, x: number, y: number);
clone(): OverscaledTileID;
equals(id: OverscaledTileID): boolean;
scaledTo(targetZ: number): OverscaledTileID;
calculateScaledKey(targetZ: number, withWrap: boolean): string;
isChildOf(parent: OverscaledTileID): boolean;
children(sourceMaxZoom: number): OverscaledTileID[];
isLessThan(rhs: OverscaledTileID): boolean;
wrapped(): OverscaledTileID;
unwrapTo(wrap: number): OverscaledTileID;
overscaleFactor(): number;
toUnwrapped(): UnwrappedTileID;
toString(): string;
getTilePoint(coord: MercatorCoordinate): Point;
}
export type TimePoint = number;
export type CrossFaded<T> = {
to: T;
from: T;
};
/**
* Implements a number of classes that define state and behavior for paint and layout properties, most
* importantly their respective evaluation chains:
*
* Transitionable paint property value
* → Transitioning paint property value
* → Possibly evaluated paint property value
* → Fully evaluated paint property value
*
* Layout property value
* → Possibly evaluated layout property value
* → Fully evaluated layout property value
*
* @module
* @private
*/
/**
* Implementations of the `Property` interface:
*
* * Hold metadata about a property that's independent of any specific value: stuff like the type of the value,
* the default value, etc. This comes from the style specification JSON.
* * Define behavior that needs to be polymorphic across different properties: "possibly evaluating"
* an input value (see below), and interpolating between two possibly-evaluted values.
*
* The type `T` is the fully-evaluated value type (e.g. `number`, `string`, `Color`).
* The type `R` is the intermediate "possibly evaluated" value type. See below.
*
* There are two main implementations of the interface -- one for properties that allow data-driven values,
* and one for properties that don't. There are a few "special case" implementations as well: one for properties
* which cross-fade between two values rather than interpolating, one for `heatmap-color` and `line-gradient`,
* and one for `light-position`.
*
* @private
*/
export interface Property<T, R> {
specification: StylePropertySpecification;
possiblyEvaluate(value: PropertyValue<T, R>, parameters: EvaluationParameters, canonical?: CanonicalTileID, availableImages?: Array<string>): R;
interpolate(a: R, b: R, t: number): R;
}
export declare class PropertyValue<T, R> {
property: Property<T, R>;
value: PropertyValueSpecification<T> | void;
expression: StylePropertyExpression;
constructor(property: Property<T, R>, value: PropertyValueSpecification<T> | void);
isDataDriven(): boolean;
possiblyEvaluate(parameters: EvaluationParameters, canonical?: CanonicalTileID, availableImages?: Array<string>): R;
}
export type TransitionParameters = {
now: TimePoint;
transition: TransitionSpecification;
};
export declare class TransitionablePropertyValue<T, R> {
property: Property<T, R>;
value: PropertyValue<T, R>;
transition: TransitionSpecification | void;
constructor(property: Property<T, R>);
transitioned(parameters: TransitionParameters, prior: TransitioningPropertyValue<T, R>): TransitioningPropertyValue<T, R>;
untransitioned(): TransitioningPropertyValue<T, R>;
}
export declare class Transitionable<Props> {
_properties: Properties<Props>;
_values: {
[K in keyof Props]: TransitionablePropertyValue<any, unknown>;
};
constructor(properties: Properties<Props>);
getValue<S extends keyof Props, T>(name: S): PropertyValueSpecification<T> | void;
setValue<S extends keyof Props, T>(name: S, value: PropertyValueSpecification<T> | void): void;
getTransition<S extends keyof Props>(name: S): TransitionSpecification | void;
setTransition<S extends keyof Props>(name: S, value: TransitionSpecification | void): void;
serialize(): any;
transitioned(parameters: TransitionParameters, prior: Transitioning<Props>): Transitioning<Props>;
untransitioned(): Transitioning<Props>;
}
export declare class TransitioningPropertyValue<T, R> {
property: Property<T, R>;
value: PropertyValue<T, R>;
prior: TransitioningPropertyValue<T, R>;
begin: TimePoint;
end: TimePoint;
constructor(property: Property<T, R>, value: PropertyValue<T, R>, prior: TransitioningPropertyValue<T, R>, transition: TransitionSpecification, now: TimePoint);
possiblyEvaluate(parameters: EvaluationParameters, canonical: CanonicalTileID, availableImages: Array<string>): R;
}
export declare class Transitioning<Props> {
_properties: Properties<Props>;
_values: {
[K in keyof Props]: PossiblyEvaluatedPropertyValue<unknown>;
};
constructor(properties: Properties<Props>);
possiblyEvaluate(parameters: EvaluationParameters, canonical?: CanonicalTileID, availableImages?: Array<string>): PossiblyEvaluated<Props, any>;
hasTransition(): boolean;
}
export declare class Layout<Props> {
_properties: Properties<Props>;
_values: {
[K in keyof Props]: PropertyValue<any, PossiblyEvaluatedPropertyValue<any>>;
};
constructor(properties: Properties<Props>);
getValue<S extends keyof Props>(name: S): any;
setValue<S extends keyof Props>(name: S, value: any): void;
serialize(): any;
possiblyEvaluate(parameters: EvaluationParameters, canonical?: CanonicalTileID, availableImages?: Array<string>): PossiblyEvaluated<Props, any>;
}
/**
* "Possibly evaluated value" is an intermediate stage in the evaluation chain for both paint and layout property
* values. The purpose of this stage is to optimize away unnecessary recalculations for data-driven properties. Code
* which uses data-driven property values must assume that the value is dependent on feature data, and request that it
* be evaluated for each feature. But when that property value is in fact a constant or camera function, the calculation
* will not actually depend on the feature, and we can benefit from returning the prior result of having done the
* evaluation once, ahead of time, in an intermediate step whose inputs are just the value and "global" parameters
* such as current zoom level.
*
* `PossiblyEvaluatedValue` represents the three possible outcomes of this step: if the input value was a constant or
* camera expression, then the "possibly evaluated" result is a constant value. Otherwise, the input value was either
* a source or composite expression, and we must defer final evaluation until supplied a feature. We separate
* the source and composite cases because they are handled differently when generating GL attributes, buffers, and
* uniforms.
*
* Note that `PossiblyEvaluatedValue` (and `PossiblyEvaluatedPropertyValue`, below) are _not_ used for properties that
* do not allow data-driven values. For such properties, we know that the "possibly evaluated" result is always a constant
* scalar value. See below.
*
* @private
*/
export type PossiblyEvaluatedValue<T> = {
kind: "constant";
value: T;
} | SourceExpression | CompositeExpression;
export declare class PossiblyEvaluatedPropertyValue<T> {
property: DataDrivenProperty<T>;
value: PossiblyEvaluatedValue<T>;
parameters: EvaluationParameters;
constructor(property: DataDrivenProperty<T>, value: PossiblyEvaluatedValue<T>, parameters: EvaluationParameters);
isConstant(): boolean;
constantOr(value: T): T;
evaluate(feature: Feature, featureState: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>): T;
}
export declare class PossiblyEvaluated<Props, PossibleEvaluatedProps> {
_properties: Properties<Props>;
_values: PossibleEvaluatedProps;
constructor(properties: Properties<Props>);
get<S extends keyof PossibleEvaluatedProps>(name: S): PossibleEvaluatedProps[S];
}
export declare class DataConstantProperty<T> implements Property<T, T> {
specification: StylePropertySpecification;
constructor(specification: StylePropertySpecification);
possiblyEvaluate(value: PropertyValue<T, T>, parameters: EvaluationParameters): T;
interpolate(a: T, b: T, t: number): T;
}
export declare class DataDrivenProperty<T> implements Property<T, PossiblyEvaluatedPropertyValue<T>> {
specification: StylePropertySpecification;
overrides: any;
constructor(specification: StylePropertySpecification, overrides?: any);
possiblyEvaluate(value: PropertyValue<T, PossiblyEvaluatedPropertyValue<T>>, parameters: EvaluationParameters, canonical?: CanonicalTileID, availableImages?: Array<string>): PossiblyEvaluatedPropertyValue<T>;
interpolate(a: PossiblyEvaluatedPropertyValue<T>, b: PossiblyEvaluatedPropertyValue<T>, t: number): PossiblyEvaluatedPropertyValue<T>;
evaluate(value: PossiblyEvaluatedValue<T>, parameters: EvaluationParameters, feature: Feature, featureState: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>): T;
}
export declare class CrossFadedDataDrivenProperty<T> extends DataDrivenProperty<CrossFaded<T>> {
possiblyEvaluate(value: PropertyValue<CrossFaded<T>, PossiblyEvaluatedPropertyValue<CrossFaded<T>>>, parameters: EvaluationParameters, canonical?: CanonicalTileID, availableImages?: Array<string>): PossiblyEvaluatedPropertyValue<CrossFaded<T>>;
evaluate(value: PossiblyEvaluatedValue<CrossFaded<T>>, globals: EvaluationParameters, feature: Feature, featureState: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>): CrossFaded<T>;
_calculate(min: T, mid: T, max: T, parameters: EvaluationParameters): CrossFaded<T>;
interpolate(a: PossiblyEvaluatedPropertyValue<CrossFaded<T>>): PossiblyEvaluatedPropertyValue<CrossFaded<T>>;
}
export declare class CrossFadedProperty<T> implements Property<T, CrossFaded<T>> {
specification: StylePropertySpecification;
constructor(specification: StylePropertySpecification);
possiblyEvaluate(value: PropertyValue<T, CrossFaded<T>>, parameters: EvaluationParameters, canonical?: CanonicalTileID, availableImages?: Array<string>): CrossFaded<T>;
_calculate(min: T, mid: T, max: T, parameters: EvaluationParameters): CrossFaded<T>;
interpolate(a?: CrossFaded<T> | null): CrossFaded<T>;
}
export declare class ColorRampProperty implements Property<Color, boolean> {
specification: StylePropertySpecification;
constructor(specification: StylePropertySpecification);
possiblyEvaluate(value: PropertyValue<Color, boolean>, parameters: EvaluationParameters, canonical?: CanonicalTileID, availableImages?: Array<string>): boolean;
interpolate(): boolean;
}
export declare class Properties<Props> {
properties: Props;
defaultPropertyValues: {
[K in keyof Props]: PropertyValue<unknown, any>;
};
defaultTransitionablePropertyValues: {
[K in keyof Props]: TransitionablePropertyValue<unknown, unknown>;
};
defaultTransitioningPropertyValues: {
[K in keyof Props]: TransitioningPropertyValue<unknown, unknown>;
};
defaultPossiblyEvaluatedValues: {
[K in keyof Props]: PossiblyEvaluatedPropertyValue<unknown>;
};
overridableProperties: Array<string>;
constructor(properties: Props);
}
export type Transferable = ArrayBuffer | MessagePort | ImageBitmap;
declare const viewTypes: {
Int8: Int8ArrayConstructor;
Uint8: Uint8ArrayConstructor;
Int16: Int16ArrayConstructor;
Uint16: Uint16ArrayConstructor;
Int32: Int32ArrayConstructor;
Uint32: Uint32ArrayConstructor;
Float32: Float32ArrayConstructor;
};
export type ViewType = keyof typeof viewTypes;
export declare class Struct {
_pos1: number;
_pos2: number;
_pos4: number;
_pos8: number;
readonly _structArray: StructArray;
size: number;
/**
* @param {StructArray} structArray The StructArray the struct is stored in
* @param {number} index The index of the struct in the StructArray.
* @private
*/
constructor(structArray: StructArray, index: number);
}
export type StructArrayMember = {
name: string;
type: ViewType;
components: number;
offset: number;
};
export type SerializedStructArray = {
length: number;
arrayBuffer: ArrayBuffer;
};
declare abstract class StructArray {
capacity: number;
length: number;
isTransferred: boolean;
arrayBuffer: ArrayBuffer;
uint8: Uint8Array;
members: Array<StructArrayMember>;
bytesPerElement: number;
abstract emplaceBack(...v: number[]): any;
abstract emplace(i: number, ...v: number[]): any;
constructor();
/**
* Serialize a StructArray instance. Serializes both the raw data and the
* metadata needed to reconstruct the StructArray base class during
* deserialization.
* @private
*/
static serialize(array: StructArray, transferables?: Array<Transferable>): SerializedStructArray;
static deserialize(input: SerializedStructArray): any;
/**
* Resize the array to discard unused capacity.
*/
_trim(): void;
/**
* Resets the the length of the array to 0 without de-allocating capcacity.
*/
clear(): void;
/**
* Resize the array.
* If `n` is greater than the current length then additional elements with undefined values are added.
* If `n` is less than the current length then the array will be reduced to the first `n` elements.
* @param {number} n The new size of the array.
*/
resize(n: number): void;
/**
* Indicate a planned increase in size, so that any necessary allocation may
* be done once, ahead of time.
* @param {number} n The expected size of the array.
*/
reserve(n: number): void;
/**
* Create TypedArray views for the current ArrayBuffer.
*/
_refreshViews(): void;
}
export declare class StructArrayLayout2i4 extends StructArray {
uint8: Uint8Array;
int16: Int16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number): number;
emplace(i: number, v0: number, v1: number): number;
}
export declare class StructArrayLayout3i6 extends StructArray {
uint8: Uint8Array;
int16: Int16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number): number;
emplace(i: number, v0: number, v1: number, v2: number): number;
}
export declare class StructArrayLayout4i8 extends StructArray {
uint8: Uint8Array;
int16: Int16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number, v3: number): number;
emplace(i: number, v0: number, v1: number, v2: number, v3: number): number;
}
export declare class StructArrayLayout2i4i12 extends StructArray {
uint8: Uint8Array;
int16: Int16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number, v3: number, v4: number, v5: number): number;
emplace(i: number, v0: number, v1: number, v2: number, v3: number, v4: number, v5: number): number;
}
export declare class StructArrayLayout2i4ub8 extends StructArray {
uint8: Uint8Array;
int16: Int16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number, v3: number, v4: number, v5: number): number;
emplace(i: number, v0: number, v1: number, v2: number, v3: number, v4: number, v5: number): number;
}
export declare class StructArrayLayout2f8 extends StructArray {
uint8: Uint8Array;
float32: Float32Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number): number;
emplace(i: number, v0: number, v1: number): number;
}
export declare class StructArrayLayout4i4ui4i24 extends StructArray {
uint8: Uint8Array;
int16: Int16Array;
uint16: Uint16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number, v9: number, v10: number, v11: number): number;
emplace(i: number, v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number, v9: number, v10: number, v11: number): number;
}
export declare class StructArrayLayout3f12 extends StructArray {
uint8: Uint8Array;
float32: Float32Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number): number;
emplace(i: number, v0: number, v1: number, v2: number): number;
}
export declare class StructArrayLayout1ul4 extends StructArray {
uint8: Uint8Array;
uint32: Uint32Array;
_refreshViews(): void;
emplaceBack(v0: number): number;
emplace(i: number, v0: number): number;
}
export declare class StructArrayLayout6i1ul2ui20 extends StructArray {
uint8: Uint8Array;
int16: Int16Array;
uint32: Uint32Array;
uint16: Uint16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number): number;
emplace(i: number, v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number): number;
}
export declare class StructArrayLayout2ub2f12 extends StructArray {
uint8: Uint8Array;
float32: Float32Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number, v3: number): number;
emplace(i: number, v0: number, v1: number, v2: number, v3: number): number;
}
export declare class StructArrayLayout3ui6 extends StructArray {
uint8: Uint8Array;
uint16: Uint16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number): number;
emplace(i: number, v0: number, v1: number, v2: number): number;
}
export declare class StructArrayLayout2i2ui3ul3ui2f3ub1ul1i48 extends StructArray {
uint8: Uint8Array;
int16: Int16Array;
uint16: Uint16Array;
uint32: Uint32Array;
float32: Float32Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number, v9: number, v10: number, v11: number, v12: number, v13: number, v14: number, v15: number, v16: number): number;
emplace(i: number, v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number, v9: number, v10: number, v11: number, v12: number, v13: number, v14: number, v15: number, v16: number): number;
}
export declare class StructArrayLayout8i15ui1ul4f68 extends StructArray {
uint8: Uint8Array;
int16: Int16Array;
uint16: Uint16Array;
uint32: Uint32Array;
float32: Float32Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number, v9: number, v10: number, v11: number, v12: number, v13: number, v14: number, v15: number, v16: number, v17: number, v18: number, v19: number, v20: number, v21: number, v22: number, v23: number, v24: number, v25: number, v26: number, v27: number): number;
emplace(i: number, v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number, v9: number, v10: number, v11: number, v12: number, v13: number, v14: number, v15: number, v16: number, v17: number, v18: number, v19: number, v20: number, v21: number, v22: number, v23: number, v24: number, v25: number, v26: number, v27: number): number;
}
export declare class StructArrayLayout1f4 extends StructArray {
uint8: Uint8Array;
float32: Float32Array;
_refreshViews(): void;
emplaceBack(v0: number): number;
emplace(i: number, v0: number): number;
}
export declare class StructArrayLayout1ul2ui8 extends StructArray {
uint8: Uint8Array;
uint32: Uint32Array;
uint16: Uint16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number, v2: number): number;
emplace(i: number, v0: number, v1: number, v2: number): number;
}
export declare class StructArrayLayout2ui4 extends StructArray {
uint8: Uint8Array;
uint16: Uint16Array;
_refreshViews(): void;
emplaceBack(v0: number, v1: number): number;
emplace(i: number, v0: number, v1: number): number;
}
export declare class StructArrayLayout1ui2 extends StructArray {
uint8: Uint8Array;
uint16: Uint16Array;
_refreshViews(): void;
emplaceBack(v0: number): number;
emplace(i: number, v0: number): number;
}
export declare class CollisionBoxStruct extends Struct {
_structArray: CollisionBoxArray;
get anchorPointX(): number;
get anchorPointY(): number;
get x1(): number;
get y1(): number;
get x2(): number;
get y2(): number;
get featureIndex(): number;
get sourceLayerIndex(): number;
get bucketIndex(): number;
get anchorPoint(): Point;
}
export declare class CollisionBoxArray extends StructArrayLayout6i1ul2ui20 {
/**
* Return the CollisionBoxStruct at the given location in the array.
* @param {number} index The index of the element.
* @private
*/
get(index: number): CollisionBoxStruct;
}
export declare class PlacedSymbolStruct extends Struct {
_structArray: PlacedSymbolArray;
get anchorX(): number;
get anchorY(): number;
get glyphStartIndex(): number;
get numGlyphs(): number;
get vertexStartIndex(): number;
get lineStartIndex(): number;
get lineLength(): number;
get segment(): number;
get lowerSize(): number;
get upperSize(): number;
get lineOffsetX(): number;
get lineOffsetY(): number;
get writingMode(): number;
get placedOrientation(): number;
set placedOrientation(x: number);
get hidden(): number;
set hidden(x: number);
get crossTileID(): number;
set crossTileID(x: number);
get associatedIconIndex(): number;
}
export declare class PlacedSymbolArray extends StructArrayLayout2i2ui3ul3ui2f3ub1ul1i48 {
/**
* Return the PlacedSymbolStruct at the given location in the array.
* @param {number} index The index of the element.
* @private
*/
get(index: number): PlacedSymbolStruct;
}
export declare class SymbolInstanceStruct extends Struct {
_structArray: SymbolInstanceArray;
get anchorX(): number;
get anchorY(): number;
get rightJustifiedTextSymbolIndex(): number;
get centerJustifiedTextSymbolIndex(): number;
get leftJustifiedTextSymbolIndex(): number;
get verticalPlacedTextSymbolIndex(): number;
get placedIconSymbolIndex(): number;
get verticalPlacedIconSymbolIndex(): number;
get key(): number;
get textBoxStartIndex(): number;
get textBoxEndIndex(): number;
get verticalTextBoxStartIndex(): number;
get verticalTextBoxEndIndex(): number;
get iconBoxStartIndex(): number;
get iconBoxEndIndex(): number;
get verticalIconBoxStartIndex(): number;
get verticalIconBoxEndIndex(): number;
get featureIndex(): number;
get numHorizontalGlyphVertices(): number;
get numVerticalGlyphVertices(): number;
get numIconVertices(): number;
get numVerticalIconVertices(): number;
get useRuntimeCollisionCircles(): number;
get crossTileID(): number;
set crossTileID(x: number);
get textBoxScale(): number;
get textOffset0(): number;
get textOffset1(): number;
get collisionCircleDiameter(): number;
}
export type SymbolInstance = SymbolInstanceStruct;
export declare class SymbolInstanceArray extends StructArrayLayout8i15ui1ul4f68 {
/**
* Return the SymbolInstanceStruct at the given location in the array.
* @param {number} index The index of the element.
* @private
*/
get(index: number): SymbolInstanceStruct;
}
export declare class GlyphOffsetArray extends StructArrayLayout1f4 {
getoffsetX(index: number): number;
}
export declare class SymbolLineVertexArray extends StructArrayLayout3i6 {
getx(index: number): number;
gety(index: number): number;
gettileUnitDistanceFromAnchor(index: number): number;
}
export declare class FeatureIndexStruct extends Struct {
_structArray: FeatureIndexArray;
get featureIndex(): number;
get sourceLayerIndex(): number;
get bucketIndex(): number;
}
export declare class FeatureIndexArray extends StructArrayLayout1ul2ui8 {
/**
* Return the FeatureIndexStruct at the given location in the array.
* @param {number} index The index of the element.
* @private
*/
get(index: number): FeatureIndexStruct;
}
export declare class PosArray extends StructArrayLayout2i4 {
}
export declare class RasterBoundsArray extends StructArrayLayout4i8 {
}
export declare class CircleLayoutArray extends StructArrayLayout2i4 {
}
export declare class FillLayoutArray extends StructArrayLayout2i4 {
}
export declare class FillExtrusionLayoutArray extends StructArrayLayout2i4i12 {
}
export declare class LineLayoutArray extends StructArrayLayout2i4ub8 {
}
export declare class LineExtLayoutArray extends StructArrayLayout2f8 {
}
export declare class SymbolLayoutArray extends StructArrayLayout4i4ui4i24 {
}
export declare class SymbolDynamicLayoutArray extends StructArrayLayout3f12 {
}
export declare class SymbolOpacityArray extends StructArrayLayout1ul4 {
}
export declare class CollisionVertexArray extends StructArrayLayout2ub2f12 {
}
export declare class TriangleIndexArray extends StructArrayLayout3ui6 {
}
export declare class LineIndexArray extends StructArrayLayout2ui4 {
}
export declare class LineStripIndexArray extends StructArrayLayout1ui2 {
}
export type SerializedFeaturePositionMap = {
ids: Float64Array;
positions: Uint32Array;
};
export type FeaturePosition = {
index: number;
start: number;
end: number;
};
export declare class FeaturePositionMap {
ids: Array<number>;
positions: Array<number>;
indexed: boolean;
constructor();
add(id: unknown, index: number, start: number, end: number): void;
getPositions(id: unknown): Array<FeaturePosition>;
static serialize(map: FeaturePositionMap, transferables: Array<ArrayBuffer>): SerializedFeaturePositionMap;
static deserialize(obj: SerializedFeaturePositionMap): FeaturePositionMap;
}
export declare class IndexBuffer {
context: Context;
buffer: WebGLBuffer;
dynamicDraw: boolean;
constructor(context: Context, array: TriangleIndexArray | LineIndexArray | LineStripIndexArray, dynamicDraw?: boolean);
bind(): void;
updateData(array: StructArray): void;
destroy(): void;
}
export declare class VertexBuffer {
length: number;
attributes: ReadonlyArray<StructArrayMember>;
itemSize: number;
dynamicDraw: boolean;
context: Context;
buffer: WebGLBuffer;
/**
* @param dynamicDraw Whether this buffer will be repeatedly updated.
* @private
*/
constructor(context: Context, array: StructArray, attributes: ReadonlyArray<StructArrayMember>, dynamicDraw?: boolean);
bind(): void;
updateData(array: StructArray): void;
enableAttributes(gl: WebGL2RenderingContext, program: Program<any>): void;
/**
* Set the attribute pointers in a WebGL context
* @param gl The WebGL context
* @param program The active WebGL program
* @param vertexOffset Index of the starting vertex of the segment
*/
setVertexAttribPointers(gl: WebGL2RenderingContext, program: Program<any>, vertexOffset?: number | null): void;
/**
* Destroy the GL buffer bound to the given WebGL context
*/
destroy(): void;
}
export type BlendFuncConstant = typeof WebGL2RenderingContext.ZERO | typeof WebGL2RenderingContext.ONE | typeof WebGL2RenderingContext.SRC_COLOR | typeof WebGL2RenderingContext.ONE_MINUS_SRC_COLOR | typeof WebGL2RenderingContext.DST_COLOR | typeof WebGL2RenderingContext.ONE_MINUS_DST_COLOR | typeof WebGL2RenderingContext.SRC_ALPHA | typeof WebGL2RenderingContext.ONE_MINUS_SRC_ALPHA | typeof WebGL2RenderingContext.DST_ALPHA | typeof WebGL2RenderingContext.ONE_MINUS_DST_ALPHA | typeof WebGL2RenderingContext.CONSTANT_COLOR | typeof WebGL2RenderingContext.ONE_MINUS_CONSTANT_COLOR | typeof WebGL2RenderingContext.CONSTANT_ALPHA | typeof WebGL2RenderingContext.ONE_MINUS_CONSTANT_ALPHA | typeof WebGL2RenderingContext.BLEND_COLOR;
export type BlendFuncType = [
BlendFuncConstant,
BlendFuncConstant
];
export type BlendEquationType = typeof WebGL2RenderingContext.FUNC_ADD | typeof WebGL2RenderingContext.FUNC_SUBTRACT | typeof WebGL2RenderingContext.FUNC_REVERSE_SUBTRACT;
export type ColorMaskType = [
boolean,
boolean,
boolean,
boolean
];
export type CompareFuncType = typeof WebGL2RenderingContext.NEVER | typeof WebGL2RenderingContext.LESS | typeof WebGL2RenderingContext.EQUAL | typeof WebGL2RenderingContext.LEQUAL | typeof WebGL2RenderingContext.GREATER | typeof WebGL2RenderingContext.NOTEQUAL | typeof WebGL2RenderingContext.GEQUAL | typeof WebGL2RenderingContext.ALWAYS;
export type DepthMaskType = boolean;
export type DepthRangeType = [
number,
number
];
export type DepthFuncType = CompareFuncType;
export type StencilFuncType = {
func: CompareFuncType;
ref: number;
mask: number;
};
export type StencilOpConstant = typeof WebGL2RenderingContext.KEEP | typeof WebGL2RenderingContext.ZERO | typeof WebGL2RenderingContext.REPLACE | typeof WebGL2RenderingContext.INCR | typeof WebGL2RenderingContext.INCR_WRAP | typeof WebGL2RenderingContext.DECR | typeof WebGL2RenderingContext.DECR_WRAP | typeof WebGL2RenderingContext.INVERT;
export type StencilOpType = [
StencilOpConstant,
StencilOpConstant,
StencilOpConstant
];
export type TextureUnitType = number;
export type ViewportType = [
number,
number,
number,
number
];
export type StencilTestGL = {
func: typeof WebGL2RenderingContext.NEVER;
mask: 0;
} | {
func: typeof WebGL2RenderingContext.LESS;
mask: number;
} | {
func: typeof WebGL2RenderingContext.EQUAL;
mask: number;
} | {
func: typeof WebGL2RenderingContext.LEQUAL;