azure-maps-control 3.2.0 → 3.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
- import { PublicClientApplication } from "@azure/msal-browser";
2
- import { DataDrivenPropertyValueSpecification, PropertyValueSpecification, ExpressionFilterSpecification } from "@maplibre/maplibre-gl-style-spec";
1
+ import {PublicClientApplication} from "@azure/msal-browser";
2
+ import {DataDrivenPropertyValueSpecification, PropertyValueSpecification, ExpressionFilterSpecification} from "@maplibre/maplibre-gl-style-spec";
3
3
 
4
4
  type PositionAnchor = "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right";
5
5
  type Position = atlas.data.Position;
@@ -20,12 +20,12 @@ declare namespace atlas {
20
20
  * @param latitude The position's latitude.
21
21
  * @param elevation The position's elevation.
22
22
  */
23
- constructor(longitude: number, latitude: number, elevation?: number);
23
+ constructor (longitude: number, latitude: number, elevation?: number);
24
24
  /**
25
25
  * Clones a position.
26
26
  * @param position The position to clone.
27
27
  */
28
- static fromPosition(position: Position): Position;
28
+ static fromPosition (position: Position): Position;
29
29
  /**
30
30
  * Compares the longitude and latitude values of two positions to see if they are equal at an accuracy of 6 decimal places.
31
31
  * @param pos1 First position to compare.
@@ -33,7 +33,7 @@ declare namespace atlas {
33
33
  * @param precision The number of decimal places to compare to. Default: 6.
34
34
  * @returns A boolean indicating if two positions to see if they are equal at an accuracy of the specified precision or 6 decimal places.
35
35
  */
36
- static areEqual(pos1: Position, pos2: Position, precision?: number): boolean;
36
+ static areEqual (pos1: Position, pos2: Position, precision?: number): boolean;
37
37
  /**
38
38
  * Generates a Position object from an object that contains coordinate information.
39
39
  * The object is scanned for the following properties using a case insensitive test.
@@ -43,7 +43,7 @@ declare namespace atlas {
43
43
  * @param latLng The object to extract coordinate information from.
44
44
  * @returns A Position object that represents the provided LatLng information.
45
45
  */
46
- static fromLatLng(latLng: object): Position;
46
+ static fromLatLng (latLng: object): Position;
47
47
  /**
48
48
  * Generates a Position object from latitude and longitude values.
49
49
  * @param lat The latitude value.
@@ -51,13 +51,13 @@ declare namespace atlas {
51
51
  * @param elv An elevation value in meters.
52
52
  * @returns A Position object that represents the provided LatLng information.
53
53
  */
54
- static fromLatLng(lat: number, lng: number, elv?: number): Position;
54
+ static fromLatLng (lat: number, lng: number, elv?: number): Position;
55
55
  /**
56
56
  * Generates a Position object from an array that has the format; [lat, lng] or [lat, lng, elv]
57
57
  * @param latLng An array that contains latitude/longitude information in the format; [lat, lng] or [lat, lng, elv]
58
58
  * @returns A Position object that represents the provided LatLng information.
59
59
  */
60
- static fromLatLng(latLng: number[]): Position;
60
+ static fromLatLng (latLng: number[]): Position;
61
61
  /**
62
62
  * Converts an array of objects that contain coordinate information into an array of Positions. Objects that can't be converted are discarded.
63
63
  * Each object is either an array in the format; [lat, lng] or [lat, lng, elv], or an object with the any combination of the following properties:
@@ -67,7 +67,7 @@ declare namespace atlas {
67
67
  * @param latLngs The objects that contain coordinate information.
68
68
  * @returns An array of Position objects that contain all the provided coordinate information.
69
69
  */
70
- static fromLatLngs(latLngs: Array<object | number[]>): Position[];
70
+ static fromLatLngs (latLngs: Array<object | number[]>): Position[];
71
71
  }
72
72
 
73
73
  /**
@@ -81,25 +81,25 @@ declare namespace atlas {
81
81
  * Constructs a BoundingBox
82
82
  * @param positions Can be either [west, south, east, north] or [west, south, elevation1, east, north, elevation2]
83
83
  */
84
- constructor(positions: number[]);
84
+ constructor (positions: number[]);
85
85
  /**
86
86
  * Constructs a BoundingBox.
87
87
  * @param southwestPosition The southwestern most position of the bounding box.
88
88
  * @param northeastPosition The northeastern most position of the bounding box.
89
89
  */
90
- constructor(southwestPosition: Position, northeastPosition: Position);
90
+ constructor (southwestPosition: Position, northeastPosition: Position);
91
91
  /**
92
92
  * Clones a bounding box.
93
93
  * @param boundingBox The bounding box to clone.
94
94
  */
95
- static fromBoundingBox(boundingBox: BoundingBox): BoundingBox;
95
+ static fromBoundingBox (boundingBox: BoundingBox): BoundingBox;
96
96
  /**
97
97
  * Constructs a BoundingBox from the specified dimensions.
98
98
  * @param center The center position of the bounding box.
99
99
  * @param width The width of the bounding box.
100
100
  * @param height The height of the bounding box.
101
101
  */
102
- static fromDimensions(center: Position, width: number, height: number): BoundingBox;
102
+ static fromDimensions (center: Position, width: number, height: number): BoundingBox;
103
103
  /**
104
104
  * Constructs a BoundingBox from the specified edges.
105
105
  * @param west The west edge of the bounding box.
@@ -107,106 +107,106 @@ declare namespace atlas {
107
107
  * @param east The east edge of the bounding box.
108
108
  * @param north The north edge of the bounding box.
109
109
  */
110
- static fromEdges(west: number, south: number, east: number, north: number): BoundingBox;
110
+ static fromEdges (west: number, south: number, east: number, north: number): BoundingBox;
111
111
  /**
112
112
  * Determines if a position is within a bounding box.
113
113
  * @param bounds The bounding box to see if the position is in.
114
114
  * @param position The position to see if it is in the bounding box.
115
115
  * @returns True if the position is within the bounding box.
116
116
  */
117
- static containsPosition(bounds: BoundingBox, position: Position): boolean;
117
+ static containsPosition (bounds: BoundingBox, position: Position): boolean;
118
118
  /**
119
119
  * Returns a boolean indicating if the bounding box crosses the antimeridian or not.
120
120
  * @param bounds The bounding box to check.
121
121
  * @returns A boolean indicating if the bounding box crosses the antimeridian or not.
122
122
  */
123
- static crossesAntimeridian(bounds: BoundingBox): boolean;
123
+ static crossesAntimeridian (bounds: BoundingBox): boolean;
124
124
  /**
125
125
  * Calculates the center of a bounding box.
126
126
  * @param bounds A bounding box to calculate the center of.
127
127
  * @returns A position that represents the center of the bounding box.
128
128
  */
129
- static getCenter(bounds: BoundingBox): Position;
129
+ static getCenter (bounds: BoundingBox): Position;
130
130
  /**
131
131
  * Gets the height of a bounding box in degrees.
132
132
  * @param bounds The bounding box to check.
133
133
  * @returns The height of the bounding box in degrees.
134
134
  */
135
- static getHeight(bounds: BoundingBox): number;
135
+ static getHeight (bounds: BoundingBox): number;
136
136
  /**
137
137
  * Gets the width of a bounding box in degrees.
138
138
  * @param bounds The bounding box to check.
139
139
  * @returns The width of the bounding box in degrees.
140
140
  */
141
- static getWidth(bounds: BoundingBox): number;
141
+ static getWidth (bounds: BoundingBox): number;
142
142
  /**
143
143
  * Returns the south west position of the bounding box.
144
144
  * @param bounds The bounding box to get the position from.
145
145
  * @returns The south west position of the bounding box.
146
146
  */
147
- static getSouthWest(bounds: BoundingBox): Position;
147
+ static getSouthWest (bounds: BoundingBox): Position;
148
148
  /**
149
149
  * Returns the north east position of the bounding box.
150
150
  * @param bounds The bounding box to get the position from.
151
151
  * @returns The north east position of the bounding box.
152
152
  */
153
- static getNorthEast(bounds: BoundingBox): Position;
153
+ static getNorthEast (bounds: BoundingBox): Position;
154
154
  /**
155
155
  * Returns the north west position of the bounding box.
156
156
  * @param bounds The bounding box to get the position from.
157
157
  * @returns The north west position of the bounding box.
158
158
  */
159
- static getNorthWest(bounds: BoundingBox): Position;
159
+ static getNorthWest (bounds: BoundingBox): Position;
160
160
  /**
161
161
  * Returns the south east position of the bounding box.
162
162
  * @param bounds The bounding box to get the position from.
163
163
  * @returns The south east position of the bounding box.
164
164
  */
165
- static getSouthEast(bounds: BoundingBox): Position;
165
+ static getSouthEast (bounds: BoundingBox): Position;
166
166
  /**
167
167
  * Returns the south position value of the bounding box.
168
168
  * @param bounds The bounding box to get the position from.
169
169
  * @returns The south position value of the bounding box.
170
170
  */
171
- static getSouth(bounds: BoundingBox): number;
171
+ static getSouth (bounds: BoundingBox): number;
172
172
  /**
173
173
  * Returns the west position value of the bounding box.
174
174
  * @param bounds The bounding box to get the position from.
175
175
  * @returns The west position value of the bounding box.
176
176
  */
177
- static getWest(bounds: BoundingBox): number;
177
+ static getWest (bounds: BoundingBox): number;
178
178
  /**
179
179
  * Returns the north position value of the bounding box.
180
180
  * @param bounds The bounding box to get the position from.
181
181
  * @returns The north position value of the bounding box.
182
182
  */
183
- static getNorth(bounds: BoundingBox): number;
183
+ static getNorth (bounds: BoundingBox): number;
184
184
  /**
185
185
  * Returns the east position value of the bounding box.
186
186
  * @param bounds The bounding box to get the position from.
187
187
  * @returns The east position value of the bounding box.
188
188
  */
189
- static getEast(bounds: BoundingBox): number;
189
+ static getEast (bounds: BoundingBox): number;
190
190
  /**
191
191
  * Determines is two bounding boxes intersect.
192
192
  * @param bounds1 The first bounding box to compare with.
193
193
  * @param bounds2 The second bounding box to compare with.
194
194
  * @returns true if the provided bounding boxes intersect.
195
195
  */
196
- static intersect(bounds1: BoundingBox, bounds2: BoundingBox): boolean;
196
+ static intersect (bounds1: BoundingBox, bounds2: BoundingBox): boolean;
197
197
  /**
198
198
  * Merges two bounding boxes together.
199
199
  * @param bounds1 The first bounding box to merge with.
200
200
  * @param bounds2 The second bounding box to merge with.
201
201
  * @returns A bounding box in the format [minLon, minLat, maxLon, maxLat].
202
202
  */
203
- static merge(bounds1: BoundingBox, bounds2: BoundingBox): BoundingBox;
203
+ static merge (bounds1: BoundingBox, bounds2: BoundingBox): BoundingBox;
204
204
  /**
205
205
  * Creates a BoundingBox that contains all provided Position objects.
206
206
  * @param positions An array of locations to use to generate the bounding box.
207
207
  * @returns A bounding box that contains all given positions.
208
208
  */
209
- static fromPositions(positions: Position[]): BoundingBox;
209
+ static fromPositions (positions: Position[]): BoundingBox;
210
210
  /**
211
211
  * Creates a BoundingBox from any array of objects that contain coordinate information.
212
212
  * Each object is either an array in the format; [lat, lng] or [lat, lng, elv], or an object with the any combination of the following properties:
@@ -216,18 +216,18 @@ declare namespace atlas {
216
216
  * @param latLngs The objects that contain coordinate information.
217
217
  * @returns A BoundingBox that contains all the provided coordinate information.
218
218
  */
219
- static fromLatLngs(latLngs: Array<object | number[]>): BoundingBox;
219
+ static fromLatLngs (latLngs: Array<object | number[]>): BoundingBox;
220
220
  /**
221
221
  * Calculates the bounding box of a FeatureCollection, Feature, Geometry, Shape or array of these objects.
222
222
  * @param data The FeatureCollection, Feature, Geometry, Shape or array of these objects to calculate the bounding box for.
223
223
  * @returns A bounding box in the format [minLon, minLat, maxLon, maxLat].
224
224
  */
225
- static fromData(data: FeatureCollection | Feature<Geometry, any> | Geometry | Shape | Array<FeatureCollection | Feature<Geometry, any> | Geometry | Shape>): BoundingBox;
225
+ static fromData (data: FeatureCollection | Feature<Geometry, any> | Geometry | Shape | Array<FeatureCollection | Feature<Geometry, any> | Geometry | Shape>): BoundingBox;
226
226
  /**
227
227
  * Splits a BoundingBox that crosses the Antimeridian into two BoundingBox's. One entirely west of the Antimerdian and another entirely east of the Antimerdian.
228
228
  * @param bounds
229
229
  */
230
- static splitOnAntimeridian(bounds: BoundingBox): BoundingBox[];
230
+ static splitOnAntimeridian (bounds: BoundingBox): BoundingBox[];
231
231
  }
232
232
 
233
233
  /**
@@ -261,7 +261,7 @@ declare namespace atlas {
261
261
  * @param features The collection of features that make up the feature collection.
262
262
  * @param bbox The bounding box of the feature collection.
263
263
  */
264
- constructor(features: Array<Feature<Geometry, any>>, bbox?: BoundingBox);
264
+ constructor (features: Array<Feature<Geometry, any>>, bbox?: BoundingBox);
265
265
  }
266
266
 
267
267
  /**
@@ -300,7 +300,7 @@ declare namespace atlas {
300
300
  * @param id The id of the feature.
301
301
  * @param bbox The bounding box of the feature.
302
302
  */
303
- constructor(geometry: G, properties?: P, id?: string | number, bbox?: BoundingBox);
303
+ constructor (geometry: G, properties?: P, id?: string | number, bbox?: BoundingBox);
304
304
  }
305
305
 
306
306
  /**
@@ -324,7 +324,7 @@ declare namespace atlas {
324
324
  * Constructs a Point.
325
325
  * @param coordinates The position defining the point.
326
326
  */
327
- constructor(coordinates: Position);
327
+ constructor (coordinates: Position);
328
328
 
329
329
  }
330
330
 
@@ -355,7 +355,7 @@ declare namespace atlas {
355
355
  * @param coordinates The ordered list of positions defining the linestring.
356
356
  * @param bbox The bounding box of the linestring.
357
357
  */
358
- constructor(coordinates: Position[], bbox?: BoundingBox);
358
+ constructor (coordinates: Position[], bbox?: BoundingBox);
359
359
  }
360
360
 
361
361
  /**
@@ -385,7 +385,7 @@ declare namespace atlas {
385
385
  * @param coordinates The array of linear ring coordinate arrays defining the polygon.
386
386
  * @param bbox The bounding box of the polygon.
387
387
  */
388
- constructor(coordinates: Position[][] | Position[], bbox?: BoundingBox);
388
+ constructor (coordinates: Position[][] | Position[], bbox?: BoundingBox);
389
389
  }
390
390
 
391
391
  /**
@@ -419,7 +419,7 @@ declare namespace atlas {
419
419
  * @param coordinates The array of multiple positions defining the multipoint.
420
420
  * @param bbox The bounding box of the multipoint.
421
421
  */
422
- constructor(coordinates: Position[], bbox?: BoundingBox)
422
+ constructor (coordinates: Position[], bbox?: BoundingBox);
423
423
  }
424
424
 
425
425
  /**
@@ -453,7 +453,7 @@ declare namespace atlas {
453
453
  * @param coordinates The array of LineString coordinate arrays defining the multilinestring.
454
454
  * @param bbox The bounding box of the multilinestring.
455
455
  */
456
- constructor(coordinates: Position[][], bbox?: BoundingBox)
456
+ constructor (coordinates: Position[][], bbox?: BoundingBox);
457
457
  }
458
458
 
459
459
  /**
@@ -487,7 +487,7 @@ declare namespace atlas {
487
487
  * @param coordinates The array of polygon coordinate arrays defining the multipolygon.
488
488
  * @param bbox The bounding box of the multipolygon.
489
489
  */
490
- constructor(coordinates: Position[][][], bbox?: BoundingBox)
490
+ constructor (coordinates: Position[][][], bbox?: BoundingBox);
491
491
  }
492
492
 
493
493
  /**
@@ -515,7 +515,7 @@ declare namespace atlas {
515
515
  * Constructs a GeometryCollection.
516
516
  * @param geometries The collection of geometries that make up the geometry collection.
517
517
  */
518
- constructor(geometries: Geometry[]);
518
+ constructor (geometries: Geometry[]);
519
519
  }
520
520
 
521
521
  /**
@@ -539,37 +539,37 @@ declare namespace atlas {
539
539
  * @param y A points y position in mercator units.
540
540
  * @param z A points z position in mercator units.
541
541
  */
542
- constructor(x: number, y: number, z?: number);
542
+ constructor (x: number, y: number, z?: number);
543
543
  /**
544
544
  * Converts a position into a mercator point.
545
545
  * @param position Position to convert.
546
546
  * @returns A mercator point.
547
547
  */
548
- static fromPosition(position: Position): MercatorPoint;
548
+ static fromPosition (position: Position): MercatorPoint;
549
549
  /**
550
550
  * Converts an array of positions into an array of mercator points.
551
551
  * @param positions Array of positions to convert.
552
552
  * @returns An array of mercator points.
553
553
  */
554
- static fromPositions(positions: Position[]): MercatorPoint[];
554
+ static fromPositions (positions: Position[]): MercatorPoint[];
555
555
  /**
556
556
  * Converts an array of positions into a Float32Array of mercator xyz values.
557
557
  * @param positions Array of positions to convert.
558
558
  * @returns A Float32Array of mercator xyz values.
559
559
  */
560
- static toFloat32Array(positions: Position[]): Float32Array;
560
+ static toFloat32Array (positions: Position[]): Float32Array;
561
561
  /**
562
562
  * Converts a mercator point into a map position.
563
563
  * @param mercator Mercator point to convert.
564
564
  * @returns A map position.
565
565
  */
566
- static toPosition(mercator: MercatorPoint): Position;
566
+ static toPosition (mercator: MercatorPoint): Position;
567
567
  /**
568
568
  * Converts an array of mercator points into an array of map positions.
569
569
  * @param mercators Mercator points to convert.
570
570
  * @returns An array of map positions.
571
571
  */
572
- static toPositions(mercators: MercatorPoint[]): Position[];
572
+ static toPositions (mercators: MercatorPoint[]): Position[];
573
573
  /**
574
574
  * Determine the Mercator scale factor for a given latitude, see
575
575
  * https://en.wikipedia.org/wiki/Mercator_projection#Scale_factor
@@ -579,7 +579,7 @@ declare namespace atlas {
579
579
  * @param latitude Latitude
580
580
  * @returns The mercator scale factor.
581
581
  */
582
- static mercatorScale(latitude: number): number;
582
+ static mercatorScale (latitude: number): number;
583
583
  /**
584
584
  * Returns the distance of 1 meter in `MercatorPoint` units at this latitude.
585
585
  *
@@ -588,7 +588,7 @@ declare namespace atlas {
588
588
  *
589
589
  * @returns {number} Distance of 1 meter in `MercatorPoint` units.
590
590
  */
591
- static meterInMercatorUnits(latitude: number): number;
591
+ static meterInMercatorUnits (latitude: number): number;
592
592
  }
593
593
  }
594
594
 
@@ -611,12 +611,12 @@ declare namespace atlas {
611
611
  * @param options The ControlOptions for this control.
612
612
  * @return An HTMLElement to be placed on the map for the control.
613
613
  */
614
- abstract onAdd(map: Map, options?: ControlOptions): HTMLElement;
614
+ abstract onAdd (map: Map, options?: ControlOptions): HTMLElement;
615
615
  /**
616
616
  * Method that is called when the control is removed from the map. Should perform any necessary cleanup for the
617
617
  * control.
618
618
  */
619
- onRemove(): void;
619
+ onRemove (): void;
620
620
  /**
621
621
  * Build the outermost container for the control, applies styling including any listeners for auto styling.
622
622
  */
@@ -639,14 +639,14 @@ declare namespace atlas {
639
639
  * Constructs a CompassControl.
640
640
  * @param options The options for the control.
641
641
  */
642
- constructor(options?: CompassControlOptions);
642
+ constructor (options?: CompassControlOptions);
643
643
  /**
644
644
  * Initialization method for the control which is called when added to the map.
645
645
  * @param map The map that the control will be added to.
646
646
  * @param options The ControlOptions for this control.
647
647
  * @return An HTMLElement to be placed on the map for the control.
648
648
  */
649
- onAdd(map: Map, options?: ControlOptions): HTMLElement;
649
+ onAdd (map: Map, options?: ControlOptions): HTMLElement;
650
650
 
651
651
  protected constructRotationGrid: (map: Map, options?: ControlOptions) => HTMLElement;
652
652
  protected constructRotationButton: (map: Map) => HTMLElement;
@@ -678,15 +678,15 @@ declare namespace atlas {
678
678
  * Constructs a PitchControl.
679
679
  * @param options The options for the control.
680
680
  */
681
- constructor(options?: PitchControlOptions);
681
+ constructor (options?: PitchControlOptions);
682
682
  /**
683
683
  * Initialization method for the control which is called when added to the map.
684
684
  * @param map The map that the control will be added to.
685
685
  * @param options The ControlOptions for this control.
686
686
  * @return An HTMLElement to be placed on the map for the control.
687
687
  */
688
- onAdd(map: Map, options?: ControlOptions): HTMLElement;
689
- onRemove(): void;
688
+ onAdd (map: Map, options?: ControlOptions): HTMLElement;
689
+ onRemove (): void;
690
690
 
691
691
  protected pitchChanged: (map: MapEvent) => void;
692
692
 
@@ -710,25 +710,25 @@ declare namespace atlas {
710
710
  * Constructs a ScaleControl.
711
711
  * @param options The options for the control.
712
712
  */
713
- constructor(options?: ScaleControlOptions);
713
+ constructor (options?: ScaleControlOptions);
714
714
  /**
715
715
  * Initialization method for the control which is called when added to the map.
716
716
  * @param map The map that the control will be added to.
717
717
  * @param options The ControlOptions for this control.
718
718
  * @return An HTMLElement to be placed on the map for the control.
719
719
  */
720
- onAdd(map: Map, options?: ControlOptions): HTMLElement;
720
+ onAdd (map: Map, options?: ControlOptions): HTMLElement;
721
721
  /**
722
722
  * Method that is called when the control is removed from the map. Should perform any necessary cleanup for the
723
723
  * control.
724
724
  */
725
- onRemove(): void;
725
+ onRemove (): void;
726
726
 
727
727
  /**
728
728
  * Set the scale's unit of the distance
729
729
  * @param unit - Unit of the distance (`'imperial'`, `'metric'` or `'nautical'`).
730
730
  */
731
- setUnit(unit: "imperial" | "metric" | "nautical"): void;
731
+ setUnit (unit: "imperial" | "metric" | "nautical"): void;
732
732
  }
733
733
 
734
734
  /**
@@ -745,35 +745,35 @@ declare namespace atlas {
745
745
  * Constructs a StyleControl.
746
746
  * @param options The options for the control.
747
747
  */
748
- constructor(options?: StyleControlOptions);
748
+ constructor (options?: StyleControlOptions);
749
749
  /**
750
750
  * Initialization method for the control which is called when added to the map.
751
751
  * @param map The map that the control will be added to.
752
752
  * @param options The ControlOptions for this control.
753
753
  * @return An HTMLElement to be placed on the map for the control.
754
754
  */
755
- onAdd(map: Map, options?: ControlOptions): HTMLElement;
755
+ onAdd (map: Map, options?: ControlOptions): HTMLElement;
756
756
  /**
757
757
  * Method that is called when the control is removed from the map. Should perform any necessary cleanup for the
758
758
  * control.
759
759
  */
760
- onRemove(): void;
760
+ onRemove (): void;
761
761
  /**
762
762
  * Set the style that need to be displayed as currently selected.
763
763
  * Style will automatically get selected if `StyleControlOptions.autoSelectionMode` is `true`
764
764
  * @param styleName - Style name that need to be disabled as currently selected
765
765
  */
766
- setSelectedStyle(styleName: string): void;
766
+ setSelectedStyle (styleName: string): void;
767
767
  /**
768
768
  * Set style in a disabled state
769
769
  * @param styleName Style to be disabled
770
770
  */
771
- disableStyle(styleName: string): void;
771
+ disableStyle (styleName: string): void;
772
772
  /**
773
773
  * Enabled style that was previously disabled
774
774
  * @param styleName Style to be disabled
775
775
  */
776
- enableStyle(styleName: string): void;
776
+ enableStyle (styleName: string): void;
777
777
  private buildSelectStyleBtn;
778
778
  private buildCurrStyleBtn;
779
779
  private buildStyleOpsGrid;
@@ -797,20 +797,20 @@ declare namespace atlas {
797
797
  * Constructs a ZoomControl.
798
798
  * @param options The options for the control.
799
799
  */
800
- constructor(options?: ZoomControlOptions);
800
+ constructor (options?: ZoomControlOptions);
801
801
  /**
802
802
  * Initialization method for the control which is called when added to the map.
803
803
  * @param map The map that the control will be added to.
804
804
  * @return An HTMLElement to be placed on the map for the control.
805
805
  */
806
- onAdd(map: Map): HTMLElement;
806
+ onAdd (map: Map): HTMLElement;
807
807
  onRemove (): void;
808
808
 
809
809
  protected zoomChanged: (event: MapEvent) => void;
810
810
  protected minZoomChanged: (zoom: number) => void;
811
811
  protected maxZoomChanged: (zoom: number) => void;
812
812
 
813
- protected updateZoomButtonsState(): void;
813
+ protected updateZoomButtonsState (): void;
814
814
  protected constructZoomInButton: (map: Map) => HTMLElement;
815
815
  protected constructZoomOutButton: (map: Map) => HTMLElement;
816
816
  }
@@ -832,17 +832,17 @@ declare namespace atlas {
832
832
  * Constructs a TrafficControl
833
833
  * @param options The options for the control.
834
834
  */
835
- constructor(options?: TrafficControlOptions);
835
+ constructor (options?: TrafficControlOptions);
836
836
 
837
837
  /**
838
838
  * Current control state (is traffic information displayed?)
839
839
  */
840
- get isActive(): boolean;
840
+ get isActive (): boolean;
841
841
 
842
842
  /**
843
843
  * Sets the control state
844
844
  */
845
- set isActive(newValue: boolean);
845
+ set isActive (newValue: boolean);
846
846
 
847
847
  /**
848
848
  * Initialization method for the control which is called when added to the map.
@@ -850,23 +850,23 @@ declare namespace atlas {
850
850
  * @param options The ControlOptions for this control.
851
851
  * @return An HTMLElement to be placed on the map for the control.
852
852
  */
853
- onAdd(map: Map): HTMLElement;
853
+ onAdd (map: Map): HTMLElement;
854
854
 
855
855
  /**
856
856
  * Method that is called when the control is removed from the map. Should perform any necessary cleanup for the
857
857
  * control.
858
858
  */
859
- onRemove(): void;
859
+ onRemove (): void;
860
860
 
861
861
  /**
862
862
  * Updates the button state according to current traffic state
863
863
  */
864
- updateButtonState(): void;
864
+ updateButtonState (): void;
865
865
 
866
866
  /**
867
867
  * Get the TrafficControlOptions
868
868
  */
869
- getOptions(): TrafficControlOptions
869
+ getOptions (): TrafficControlOptions;
870
870
  private constructTrafficButton;
871
871
  }
872
872
 
@@ -878,7 +878,7 @@ declare namespace atlas {
878
878
  /**
879
879
  * Construct a traffic legend control
880
880
  */
881
- constructor();
881
+ constructor ();
882
882
 
883
883
  /**
884
884
  * Initialization method for the control which is called when added to the map.
@@ -886,7 +886,7 @@ declare namespace atlas {
886
886
  * @param options The ControlOptions for this control.
887
887
  * @return An HTMLElement to be placed on the map for the control.
888
888
  */
889
- onAdd(map: Map): HTMLElement
889
+ onAdd (map: Map): HTMLElement;
890
890
  private buildTrafficLegendDiv;
891
891
  }
892
892
  }
@@ -910,14 +910,14 @@ declare namespace atlas {
910
910
  * @param callback The event handler callback.
911
911
  */
912
912
  _addEventListener<K extends keyof T>(eventType: K, callback: (e: T[K]) => void, once: boolean): void;
913
- _addEventListener(eventType: string, callback: (e: T[string]) => void, once: boolean): void;
913
+ _addEventListener (eventType: string, callback: (e: T[string]) => void, once: boolean): void;
914
914
  /**
915
915
  * Removes an event listener.
916
916
  * @param eventType The event name.
917
917
  * @param callback The event handler callback.
918
918
  */
919
919
  _removeEventListener<K extends keyof T>(eventType: K, callback: (e: T[K]) => void): void;
920
- _removeEventListener(eventType: string, callback: (e: T[string]) => void): void;
920
+ _removeEventListener (eventType: string, callback: (e: T[string]) => void): void;
921
921
  /**
922
922
  * Invokes a given event type.
923
923
  * @param eventType The event name.
@@ -941,23 +941,23 @@ declare namespace atlas {
941
941
  * @param id The id of the layer. If not specified a random one will be generated.
942
942
  * @param options The options of the bubble layer.
943
943
  */
944
- constructor(source: string | atlas.source.Source, id?: string, options?: BubbleLayerOptions);
944
+ constructor (source: string | atlas.source.Source, id?: string, options?: BubbleLayerOptions);
945
945
 
946
946
  /**
947
947
  * Gets the options of the bubble layer.
948
948
  */
949
- getOptions(): BubbleLayerOptions;
949
+ getOptions (): BubbleLayerOptions;
950
950
 
951
951
  /**
952
952
  * Gets the source provided when creating the layer.
953
953
  */
954
- getSource(): string | atlas.source.Source;
954
+ getSource (): string | atlas.source.Source;
955
955
 
956
956
  /**
957
957
  * Sets the options of the bubble layer.
958
958
  * @param newOptions The new options of the bubble layer.
959
959
  */
960
- setOptions(options: BubbleLayerOptions): void;
960
+ setOptions (options: BubbleLayerOptions): void;
961
961
  }
962
962
 
963
963
  export interface LayerEvents {
@@ -976,25 +976,25 @@ declare namespace atlas {
976
976
  * A property for associating custom data with the layer.
977
977
  */
978
978
  metadata?: any;
979
- constructor(id?: string);
979
+ constructor (id?: string);
980
980
  /**
981
981
  * Gets the id of the layer
982
982
  */
983
- getId(): string;
983
+ getId (): string;
984
984
  /**
985
985
  * Gets the map that the layer is currently added to, or null.
986
986
  */
987
- getMap(): Map;
987
+ getMap (): Map;
988
988
  /**
989
989
  * Initialization method for the layer which is called when added to the map.
990
990
  * @param map The map the layer has been added to.
991
991
  */
992
- onAdd(map: Map): void;
992
+ onAdd (map: Map): void;
993
993
  /**
994
994
  * Method that is called when the layer is removed from the map.
995
995
  * Should perform any necessary cleanup for the layer.
996
996
  */
997
- onRemove(): void;
997
+ onRemove (): void;
998
998
  }
999
999
 
1000
1000
  /**
@@ -1008,23 +1008,23 @@ declare namespace atlas {
1008
1008
  * @param id The id of the layer. If not specified a random one will be generated.
1009
1009
  * @param options The options of the line layer.
1010
1010
  */
1011
- constructor(source: string | atlas.source.Source, id?: string, options?: HeatMapLayerOptions);
1011
+ constructor (source: string | atlas.source.Source, id?: string, options?: HeatMapLayerOptions);
1012
1012
 
1013
1013
  /**
1014
1014
  * Gets the options of the heat map layer.
1015
1015
  */
1016
- getOptions(): HeatMapLayerOptions;
1016
+ getOptions (): HeatMapLayerOptions;
1017
1017
 
1018
1018
  /**
1019
1019
  * Gets the source provided when creating the layer.
1020
1020
  */
1021
- getSource(): string | atlas.source.Source;
1021
+ getSource (): string | atlas.source.Source;
1022
1022
 
1023
1023
  /**
1024
1024
  * Sets the options of the heat map layer.
1025
1025
  * @param newOptions The new options of the heat map layer.
1026
1026
  */
1027
- setOptions(options: HeatMapLayerOptions): void;
1027
+ setOptions (options: HeatMapLayerOptions): void;
1028
1028
 
1029
1029
  }
1030
1030
 
@@ -1037,26 +1037,26 @@ declare namespace atlas {
1037
1037
  * @param options The options for the tile layer.
1038
1038
  * @param id The id of the layer. If not specified a random one will be generated.
1039
1039
  */
1040
- constructor(options: ImageLayerOptions, id?: string);
1040
+ constructor (options: ImageLayerOptions, id?: string);
1041
1041
  /**
1042
1042
  * Gets the options of the tile layer.
1043
1043
  */
1044
- getOptions(): ImageLayerOptions;
1044
+ getOptions (): ImageLayerOptions;
1045
1045
  /**
1046
1046
  * Sets the options of the tile layer.
1047
1047
  * @param newOptions The new options of the tile layer.
1048
1048
  */
1049
- setOptions(options: ImageLayerOptions): void;
1049
+ setOptions (options: ImageLayerOptions): void;
1050
1050
  /**
1051
1051
  * Calculates the approximate positions that align with the provided pixels from the source image.
1052
1052
  * @param pixels the provided pixels from the source image used to calculate the positions
1053
1053
  */
1054
- getPositions(pixels: Pixel[]): Promise<atlas.data.Position[]>;
1054
+ getPositions (pixels: Pixel[]): Promise<atlas.data.Position[]>;
1055
1055
  /**
1056
1056
  * Calculates the approximate pixels on the source image that align with the provided positions.
1057
1057
  * @param positions the provided positions from the source image used to calculate the pixels
1058
1058
  */
1059
- getPixels(positions: atlas.data.Position[]): Promise<Pixel[]>;
1059
+ getPixels (positions: atlas.data.Position[]): Promise<Pixel[]>;
1060
1060
  /**
1061
1061
  * Calculates coordinates for a rotated image layer when provided with the bounding box edges and rotation value.
1062
1062
  * Note: If your rotation value is from a KML Ground Overlay it will need to be converted to a clockwise rotation using the following formula: `rotation = 360 – KmlRotation`
@@ -1066,7 +1066,7 @@ declare namespace atlas {
1066
1066
  * @param west The west edge of the bounding box.
1067
1067
  * @param rotation Clockwise rotation in degrees
1068
1068
  */
1069
- static getCoordinatesFromEdges(north: number, south: number, east: number, west: number, rotation?: number): atlas.data.Position[];
1069
+ static getCoordinatesFromEdges (north: number, south: number, east: number, west: number, rotation?: number): atlas.data.Position[];
1070
1070
  /**
1071
1071
  * Calculates coordinates for a rotated image layer when provided with the bounding box edges and rotation value.
1072
1072
  * Note: If your rotation value is from a KML Ground Overlay it will need to be converted to a clockwise rotation using the following formula: `rotation = 360 – KmlRotation`
@@ -1076,7 +1076,7 @@ declare namespace atlas {
1076
1076
  * @param west The west edge of the bounding box.
1077
1077
  * @param rotation Clockwise rotation in degrees
1078
1078
  */
1079
- static getCoordinatesFromEdges(north: number, south: number, east: number, west: number, rotation?: number): atlas.data.Position[];
1079
+ static getCoordinatesFromEdges (north: number, south: number, east: number, west: number, rotation?: number): atlas.data.Position[];
1080
1080
  }
1081
1081
 
1082
1082
  /**
@@ -1091,20 +1091,20 @@ declare namespace atlas {
1091
1091
  * @param id The id of the layer. If not specified a random one will be generated.
1092
1092
  * @param options The options of the line layer.
1093
1093
  */
1094
- constructor(source: string | atlas.source.Source, id?: string, options?: LineLayerOptions);
1094
+ constructor (source: string | atlas.source.Source, id?: string, options?: LineLayerOptions);
1095
1095
  /**
1096
1096
  * Gets the options of the line layer.
1097
1097
  */
1098
- getOptions(): LineLayerOptions;
1098
+ getOptions (): LineLayerOptions;
1099
1099
  /**
1100
1100
  * Gets the source provided when creating the layer.
1101
1101
  */
1102
- getSource(): string | atlas.source.Source;
1102
+ getSource (): string | atlas.source.Source;
1103
1103
  /**
1104
1104
  * Sets the options of the line layer.
1105
1105
  * @param options The new options of the line layer.
1106
1106
  */
1107
- setOptions(options: LineLayerOptions): void;
1107
+ setOptions (options: LineLayerOptions): void;
1108
1108
  }
1109
1109
 
1110
1110
  /**
@@ -1118,20 +1118,20 @@ declare namespace atlas {
1118
1118
  * @param id The id of the layer. If not specified a random one will be generated.
1119
1119
  * @param options The options of the polygon extrusion layer.
1120
1120
  */
1121
- constructor(source: string | atlas.source.Source, id?: string, options?: PolygonExtrusionLayerOptions);
1121
+ constructor (source: string | atlas.source.Source, id?: string, options?: PolygonExtrusionLayerOptions);
1122
1122
  /**
1123
1123
  * Gets the options of the polygon layer.
1124
1124
  */
1125
- getOptions(): PolygonExtrusionLayerOptions;
1125
+ getOptions (): PolygonExtrusionLayerOptions;
1126
1126
  /**
1127
1127
  * Gets the source provided when creating the layer.
1128
1128
  */
1129
- getSource(): string | atlas.source.Source;
1129
+ getSource (): string | atlas.source.Source;
1130
1130
  /**
1131
1131
  * Sets the options of the polygon layer.
1132
1132
  * @param newOptions The new options of the polygon layer.
1133
1133
  */
1134
- setOptions(options: PolygonExtrusionLayerOptions): void;
1134
+ setOptions (options: PolygonExtrusionLayerOptions): void;
1135
1135
  }
1136
1136
 
1137
1137
  /**
@@ -1145,17 +1145,17 @@ declare namespace atlas {
1145
1145
  * @param id The id of the layer. If not specified a random one will be generated.
1146
1146
  * @param options The options of the polygon layer.
1147
1147
  */
1148
- constructor(source: string | atlas.source.Source, id?: string, options?: PolygonLayerOptions);
1148
+ constructor (source: string | atlas.source.Source, id?: string, options?: PolygonLayerOptions);
1149
1149
 
1150
1150
  /**
1151
1151
  * Gets the options of the polygon layer.
1152
1152
  */
1153
- getOptions(): PolygonLayerOptions;
1153
+ getOptions (): PolygonLayerOptions;
1154
1154
 
1155
1155
  /**
1156
1156
  * Gets the source provided when creating the layer.
1157
1157
  */
1158
- getSource(): string | atlas.source.Source;
1158
+ getSource (): string | atlas.source.Source;
1159
1159
 
1160
1160
  /**
1161
1161
  * Sets the options of the polygon layer.
@@ -1163,7 +1163,7 @@ declare namespace atlas {
1163
1163
  * To set `fillColor`, make sure `fillPattern` is set to `undefined`.
1164
1164
  * @param newOptions The new options of the polygon layer.
1165
1165
  */
1166
- setOptions(options: PolygonLayerOptions): void;
1166
+ setOptions (options: PolygonLayerOptions): void;
1167
1167
 
1168
1168
  }
1169
1169
 
@@ -1178,20 +1178,20 @@ declare namespace atlas {
1178
1178
  * @param id The id of the layer. If not specified a random one will be generated.
1179
1179
  * @param options The options of the polygon layer.
1180
1180
  */
1181
- constructor(source: string | atlas.source.Source, id?: string, options?: SymbolLayerOptions);
1181
+ constructor (source: string | atlas.source.Source, id?: string, options?: SymbolLayerOptions);
1182
1182
  /**
1183
1183
  * Gets the options of the symbol layer.
1184
1184
  */
1185
- getOptions(): SymbolLayerOptions;
1185
+ getOptions (): SymbolLayerOptions;
1186
1186
  /**
1187
1187
  * Gets the source provided when creating the layer.
1188
1188
  */
1189
- getSource(): string | atlas.source.Source;
1189
+ getSource (): string | atlas.source.Source;
1190
1190
  /**
1191
1191
  * Sets the options of the symbol layer.
1192
1192
  * @param newOptions The new options of the polygon layer.
1193
1193
  */
1194
- setOptions(options: SymbolLayerOptions): void;
1194
+ setOptions (options: SymbolLayerOptions): void;
1195
1195
  }
1196
1196
 
1197
1197
  /**
@@ -1203,16 +1203,16 @@ declare namespace atlas {
1203
1203
  * @param options The options for the tile layer.
1204
1204
  * @param id The id of the layer. If not specified a random one will be generated.
1205
1205
  */
1206
- constructor(options?: TileLayerOptions, id?: string);
1206
+ constructor (options?: TileLayerOptions, id?: string);
1207
1207
  /**
1208
1208
  * Gets the options of the tile layer.
1209
1209
  */
1210
- getOptions(): TileLayerOptions;
1210
+ getOptions (): TileLayerOptions;
1211
1211
  /**
1212
1212
  * Sets the options of the tile layer.
1213
1213
  * @param newOptions The new options of the tile layer.
1214
1214
  */
1215
- setOptions(options: TileLayerOptions): void;
1215
+ setOptions (options: TileLayerOptions): void;
1216
1216
  }
1217
1217
 
1218
1218
  /**
@@ -1224,16 +1224,16 @@ declare namespace atlas {
1224
1224
  * @param id The id of the layer. If not specified a random one will be generated.
1225
1225
  * @param options The options of the WebGL layer.
1226
1226
  */
1227
- constructor(id?: string, options?: WebGLLayerOptions);
1227
+ constructor (id?: string, options?: WebGLLayerOptions);
1228
1228
  /**
1229
1229
  * Gets the options of the WebGL layer.
1230
1230
  */
1231
- getOptions(): WebGLLayerOptions;
1231
+ getOptions (): WebGLLayerOptions;
1232
1232
  /**
1233
1233
  * Sets the options of the WebGL layer.
1234
1234
  * @param options The new options of the WebGL layer.
1235
1235
  */
1236
- setOptions(options: WebGLLayerOptions): void;
1236
+ setOptions (options: WebGLLayerOptions): void;
1237
1237
  }
1238
1238
  }
1239
1239
 
@@ -1262,7 +1262,7 @@ declare namespace atlas {
1262
1262
  * @param id a unique id that the user assigns to the data source. If this is not specified, then the data source will automatically be assigned an id.
1263
1263
  * @param options the options for the data source.
1264
1264
  */
1265
- constructor(id?: string, options?: DataSourceOptions);
1265
+ constructor (id?: string, options?: DataSourceOptions);
1266
1266
  /**
1267
1267
  * Adds shapes to the data source.
1268
1268
  * GeoJSON objects will be wrapped within a Shape class to make them easier to manage.
@@ -1270,80 +1270,80 @@ declare namespace atlas {
1270
1270
  * @param data
1271
1271
  * @param index
1272
1272
  */
1273
- add(data: atlas.data.FeatureCollection | atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.Geometry | atlas.data.GeometryCollection | Shape | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, index?: number): void;
1273
+ add (data: atlas.data.FeatureCollection | atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.Geometry | atlas.data.GeometryCollection | Shape | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, index?: number): void;
1274
1274
  /**
1275
1275
  * Removes all data in the data source.
1276
1276
  */
1277
- clear(): void;
1277
+ clear (): void;
1278
1278
  /**
1279
1279
  * Cleans up any resources this object is consuming.
1280
1280
  */
1281
- dispose(): void;
1281
+ dispose (): void;
1282
1282
  /**
1283
1283
  * Calculates a zoom level at which the cluster will start expanding or break apart.
1284
1284
  * @param clusterId
1285
1285
  */
1286
- getClusterExpansionZoom(clusterId: number): Promise<number>;
1286
+ getClusterExpansionZoom (clusterId: number): Promise<number>;
1287
1287
  /**
1288
1288
  * Retrieves the children of the given cluster on the next zoom level. This may be a combination of shapes and sub-clusters.
1289
1289
  * The sub-clusters will be features with properties matching ClusteredProperties.
1290
1290
  * @param clusterId
1291
1291
  */
1292
- getClusterChildren(clusterId: number): Promise<Array<atlas.data.Feature<atlas.data.Geometry, ClusteredProperties | any> | Shape>>;
1292
+ getClusterChildren (clusterId: number): Promise<Array<atlas.data.Feature<atlas.data.Geometry, ClusteredProperties | any> | Shape>>;
1293
1293
  /**
1294
1294
  * Retrieves shapes that are within the cluster.
1295
1295
  * @param clusterId
1296
1296
  * @param limit The maximum number of features to return. Set to Infinity to return all shapes.
1297
1297
  * @param offset The number of shapes to skip. Allows you to page through the shapes in the cluster.
1298
1298
  */
1299
- getClusterLeaves(clusterId: number, limit: number, offset: number): Promise<Array<atlas.data.Feature<atlas.data.Geometry, any> | Shape>>;
1299
+ getClusterLeaves (clusterId: number, limit: number, offset: number): Promise<Array<atlas.data.Feature<atlas.data.Geometry, any> | Shape>>;
1300
1300
  /**
1301
1301
  * Gets the options used by the data source.
1302
1302
  */
1303
- getOptions(): DataSourceOptions;
1303
+ getOptions (): DataSourceOptions;
1304
1304
  /**
1305
1305
  * Returns all shapes that are in the DataSource.
1306
1306
  */
1307
- getShapes(): Shape[];
1307
+ getShapes (): Shape[];
1308
1308
  /**
1309
1309
  * Downloads a GeoJSON document and imports its data into the data source.
1310
1310
  * The GeoJSON document must be on the same domain or accessible using CORS.
1311
1311
  * @param url
1312
1312
  */
1313
- importDataFromUrl(url: string): Promise<void>;
1313
+ importDataFromUrl (url: string): Promise<void>;
1314
1314
  /**
1315
1315
  * Retrieves a shape with the specified id.
1316
1316
  * If no shape with the specified id is contained in the data source, null will be return.
1317
1317
  * @param id The id of the shape to return.
1318
1318
  */
1319
- getShapeById(id: string | number): Shape;
1319
+ getShapeById (id: string | number): Shape;
1320
1320
  /**
1321
1321
  * Removes one or more shapes from the data source.
1322
1322
  * If a string is passed in, it is assumed to be an id.
1323
1323
  * If a number is passed in, removes the shape at that index.
1324
1324
  * @param shape The shape(s), shape id(s), or feature(s) to be removed
1325
1325
  */
1326
- remove(shape: number | string | Shape | atlas.data.Feature<atlas.data.Geometry, any> | Array<number | string | Shape | atlas.data.Feature<atlas.data.Geometry, any>>): void;
1326
+ remove (shape: number | string | Shape | atlas.data.Feature<atlas.data.Geometry, any> | Array<number | string | Shape | atlas.data.Feature<atlas.data.Geometry, any>>): void;
1327
1327
  /**
1328
1328
  * Removes one or more shapes from the datasource based on its id.
1329
1329
  * @param shape shape id
1330
1330
  */
1331
- removeById(id: number | string | Array<number | string>): void;
1331
+ removeById (id: number | string | Array<number | string>): void;
1332
1332
  /**
1333
1333
  * Sets the data source options.
1334
1334
  * The data source will retain its current values for any option not specified in the supplied options.
1335
1335
  * @param options the DataSourceOptions to be set
1336
1336
  */
1337
- setOptions(options: DataSourceOptions): void;
1337
+ setOptions (options: DataSourceOptions): void;
1338
1338
  /**
1339
1339
  * Overwrites all shapes in the data source with the new array of shapes.
1340
1340
  * @param shape the new shapes to update
1341
1341
  */
1342
- setShapes(shape: atlas.data.FeatureCollection | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>): void;
1342
+ setShapes (shape: atlas.data.FeatureCollection | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>): void;
1343
1343
  /**
1344
1344
  * Returns a GeoJSON FeatureCollection which contains all the shape data that is in the data source.
1345
1345
  */
1346
- toJson(): atlas.data.FeatureCollection;
1346
+ toJson (): atlas.data.FeatureCollection;
1347
1347
  private _addToSources;
1348
1348
  private _removeFromSources;
1349
1349
  private _updateShapesMap;
@@ -1362,11 +1362,11 @@ declare namespace atlas {
1362
1362
  export abstract class Source<T extends SourceEvents = SourceEvents> extends atlas.internal.EventEmitter<T> {
1363
1363
  private id;
1364
1364
  protected map: Map;
1365
- constructor(id?: string);
1365
+ constructor (id?: string);
1366
1366
  /**
1367
1367
  * Gets the id of the data source
1368
1368
  */
1369
- getId(): string;
1369
+ getId (): string;
1370
1370
  }
1371
1371
 
1372
1372
  /**
@@ -1374,17 +1374,17 @@ declare namespace atlas {
1374
1374
  * Vector tile sources can be used with; SymbolLayer, LineLayer, PolygonLayer, BubbleLayer, HeatmapLayer and VectorTileLayer.
1375
1375
  */
1376
1376
  export class VectorTileSource extends Source {
1377
- constructor(id?: string, options?: VectorTileSourceOptions);
1377
+ constructor (id?: string, options?: VectorTileSourceOptions);
1378
1378
  /**
1379
1379
  * Gets the options of the VectorTileSource.
1380
1380
  */
1381
- getOptions(): VectorTileSourceOptions;
1381
+ getOptions (): VectorTileSourceOptions;
1382
1382
  /**
1383
1383
  * Returns all GeoJSON features that are in the VectorTileSource and which satisfy the specified filter expression.
1384
1384
  * @param sourceLayer Required if the source is a VectorTileSource. Specifies the layer within the VectorTileSource to query.
1385
1385
  * @param filter A filter that will limit the query.
1386
1386
  */
1387
- getShape(sourceLayer: string, filter?: Expression): Array<atlas.data.Feature<atlas.data.Geometry, any>>;
1387
+ getShape (sourceLayer: string, filter?: Expression): Array<atlas.data.Feature<atlas.data.Geometry, any>>;
1388
1388
  }
1389
1389
 
1390
1390
  /**
@@ -1414,21 +1414,21 @@ declare namespace atlas {
1414
1414
  * @param source A set of reference points from the source reference system to transform from.
1415
1415
  * @param target A set of reference points from the target reference system to transform to.
1416
1416
  */
1417
- constructor(source: number[][], target: number[][]);
1417
+ constructor (source: number[][], target: number[][]);
1418
1418
  /**
1419
1419
  * Converts an array of points from the source reference system to the target reference system.
1420
1420
  * @param sourcePoints An array of points from the source reference system to transform.
1421
1421
  * @param decimals Number of decimal places to round the results off to.
1422
1422
  * @returns An array of points that have been transformed to the target reference system.
1423
1423
  */
1424
- toTarget(sourcePoints: number[][], decimals?: number): number[][];
1424
+ toTarget (sourcePoints: number[][], decimals?: number): number[][];
1425
1425
  /**
1426
1426
  * Converts an array of points from the target reference system to the source reference system.
1427
1427
  * @param targetPoints An array of points from the target reference system to transform.
1428
1428
  * @param decimals Number of decimal places to round the results off to.
1429
1429
  * @returns An array of points that have been transformed to the source reference system.
1430
1430
  */
1431
- toSource(targetPoints: number[][], decimals?: number): number[][];
1431
+ toSource (targetPoints: number[][], decimals?: number): number[][];
1432
1432
  }
1433
1433
  /**
1434
1434
  * Units of measurement for areas.
@@ -1625,7 +1625,7 @@ declare namespace atlas {
1625
1625
  * @param bounds The BoundingBox to convert to a Polygon.
1626
1626
  * @returns A polygon representation of the BoundingBox.
1627
1627
  */
1628
- export function boundingBoxToPolygon(bounds: atlas.data.BoundingBox): atlas.data.Polygon;
1628
+ export function boundingBoxToPolygon (bounds: atlas.data.BoundingBox): atlas.data.Polygon;
1629
1629
  /**
1630
1630
  * Converts a distance from one distance units to another. Supported units: miles, nauticalMiles, yards, meters, kilometers, feet
1631
1631
  * @param distance A number that represents a distance to convert.
@@ -1634,7 +1634,7 @@ declare namespace atlas {
1634
1634
  * @param decimals Specifies the number of decimal places to round the result to. If undefined, no rounding will occur.
1635
1635
  * @returns A distance in the new units.
1636
1636
  */
1637
- export function convertDistance(distance: number, fromUnits: string | DistanceUnits, toUnits: string | DistanceUnits, decimals?: number): number;
1637
+ export function convertDistance (distance: number, fromUnits: string | DistanceUnits, toUnits: string | DistanceUnits, decimals?: number): number;
1638
1638
  /**
1639
1639
  * Calculates an array of positions that form a cardinal spline between the specified array of positions.
1640
1640
  * @param positions The array of positions to calculate the spline through.
@@ -1643,7 +1643,7 @@ declare namespace atlas {
1643
1643
  * @param close A boolean indicating if the spline should be a closed ring or not. Default: false
1644
1644
  * @returns An array of positions that form a cardinal spline between the specified array of positions.
1645
1645
  */
1646
- export function getCardinalSpline(positions: atlas.data.Position[], tension?: number, nodeSize?: number, close?: boolean): atlas.data.Position[];
1646
+ export function getCardinalSpline (positions: atlas.data.Position[], tension?: number, nodeSize?: number, close?: boolean): atlas.data.Position[];
1647
1647
  /**
1648
1648
  * Calculates a destination position based on a starting position, a heading, a distance, and a distance unit type.
1649
1649
  * @param origin Position that the destination is relative to.
@@ -1652,7 +1652,7 @@ declare namespace atlas {
1652
1652
  * @param units Unit of distance measurement. Default is meters.
1653
1653
  * @returns A position that is the specified distance away from the origin.
1654
1654
  */
1655
- export function getDestination(origin: atlas.data.Position | atlas.data.Point, heading: number, distance: number, units?: string | DistanceUnits): atlas.data.Position;
1655
+ export function getDestination (origin: atlas.data.Position | atlas.data.Point, heading: number, distance: number, units?: string | DistanceUnits): atlas.data.Position;
1656
1656
  /**
1657
1657
  * Calculate the distance between two position objects on the surface of the earth using the Haversine formula.
1658
1658
  * @param origin First position to calculate distance between.
@@ -1660,41 +1660,41 @@ declare namespace atlas {
1660
1660
  * @param units Unit of distance measurement. Default is meters.
1661
1661
  * @returns The shortest distance between two positions in the specified units.
1662
1662
  */
1663
- export function getDistanceTo(origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point, units?: string | DistanceUnits): number;
1663
+ export function getDistanceTo (origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point, units?: string | DistanceUnits): number;
1664
1664
  /**
1665
1665
  * Retrieves the radius of the earth in a specific distance unit for WGS84.
1666
1666
  * @param units Unit of distance measurement. Default: meters
1667
1667
  * @returns A number that represents the radius of the earth in a specific distance unit.
1668
1668
  */
1669
- export function getEarthRadius(units?: string | DistanceUnits): number;
1669
+ export function getEarthRadius (units?: string | DistanceUnits): number;
1670
1670
  /**
1671
1671
  * Takes an array of positions objects and fills in the space between them with accurately positioned positions to form an approximated Geodesic path.
1672
1672
  * @param path Array of position objects that form a path to fill in.
1673
1673
  * @param nodeSize Number of nodes to insert between each position. Default: 15
1674
1674
  * @returns An array of position objects that form a geodesic paths, geodesic path crossing antimeridian will contain longitude outside of -180 to 180 range. See getGeodesicPaths() when this is undesired.
1675
1675
  */
1676
- export function getGeodesicPath(path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[];
1676
+ export function getGeodesicPath (path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[];
1677
1677
  /**
1678
1678
  * Takes an array of positions objects and fills in the space between them with accurately positioned positions to form an approximated Geodesic path broken by antimeridian into multiple sub-paths.
1679
1679
  * @param path Array of position objects that form a path to fill in.
1680
1680
  * @param nodeSize Number of nodes to insert between each position. Default: 15
1681
1681
  * @returns An array of paths that form geodesic paths, Comparing to getGeodesicPath, sub-paths will always contain longitude in -180 to 180 range
1682
1682
  */
1683
- export function getGeodesicPaths(path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[][]
1683
+ export function getGeodesicPaths (path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[][];
1684
1684
  /**
1685
1685
  * Calculates the heading from one position object to another.
1686
1686
  * @param origin Point of origin.
1687
1687
  * @param destination Destination to calculate relative heading to.
1688
1688
  * @returns A heading in degrees between 0 and 360. 0 degrees points due North.
1689
1689
  */
1690
- export function getHeading(origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point): number;
1690
+ export function getHeading (origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point): number;
1691
1691
  /**
1692
1692
  * Calculates the distance between all position objects in an array.
1693
1693
  * @param path The array of position objects that make up the path to calculate the length of.
1694
1694
  * @param units Unit of distance measurement. Default: meters
1695
1695
  * @returns The distance between all positions in between all position objects in an array on the surface of a earth in the specified units.
1696
1696
  */
1697
- export function getLengthOfPath(path: atlas.data.LineString | atlas.data.Position[], units?: string | DistanceUnits): number;
1697
+ export function getLengthOfPath (path: atlas.data.LineString | atlas.data.Position[], units?: string | DistanceUnits): number;
1698
1698
  /**
1699
1699
  * Calculates the position object on a path that is a specified distance away from the start of the path. If the specified distance is longer
1700
1700
  * than the length of the path, the last position of the path will be returned.
@@ -1703,7 +1703,7 @@ declare namespace atlas {
1703
1703
  * @param units Unit of distance measurement. Default is meters.
1704
1704
  * @returns A position object that is the specified distance away from the start of the path when following the path.
1705
1705
  */
1706
- export function getPositionAlongPath(path: atlas.data.LineString | atlas.data.Position[], distance: number, units?: string | DistanceUnits): atlas.data.Position;
1706
+ export function getPositionAlongPath (path: atlas.data.LineString | atlas.data.Position[], distance: number, units?: string | DistanceUnits): atlas.data.Position;
1707
1707
  /**
1708
1708
  * Calculates an array of position objects that are an equal distance away from a central point to create a regular polygon.
1709
1709
  * @param origin Center of the regular polygon.
@@ -1713,7 +1713,7 @@ declare namespace atlas {
1713
1713
  * @param offset An offset to rotate the polygon. When 0 the first position will align with North.
1714
1714
  * @returns An array of position objects that form a regular polygon.
1715
1715
  */
1716
- export function getRegularPolygonPath(origin: atlas.data.Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): atlas.data.Position[];
1716
+ export function getRegularPolygonPath (origin: atlas.data.Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): atlas.data.Position[];
1717
1717
  /**
1718
1718
  * Calculates an array of position objects that are an equal distance away from a central point to create a regular polygon broken by antimeridian into multiple sub-paths.
1719
1719
  * @param origin Center of the regular polygon.
@@ -1723,7 +1723,7 @@ declare namespace atlas {
1723
1723
  * @param offset An offset to rotate the polygon. When 0 the first position will align with North.
1724
1724
  * @returns An array of paths that form a regular polygon. Comparing to getRegularPolygonPath, sub-paths will always contain longitude in -180 to 180 range
1725
1725
  */
1726
- export function getRegularPolygonPaths(origin: Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): Position[][]
1726
+ export function getRegularPolygonPaths (origin: Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): Position[][];
1727
1727
  /**
1728
1728
  * Calculates a position object that is a fractional distance between two position objects.
1729
1729
  * @param origin First position to calculate mid-point between.
@@ -1731,30 +1731,30 @@ declare namespace atlas {
1731
1731
  * @param fraction The fractional parameter to calculate a mid-point for. Default 0.5.
1732
1732
  * @returns A position that lies a fraction of the distance between two position objects, relative to the first position object.
1733
1733
  */
1734
- export function interpolate(origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point, fraction?: number): atlas.data.Position;
1734
+ export function interpolate (origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point, fraction?: number): atlas.data.Position;
1735
1735
  /**
1736
1736
  * Normalizes a latitude value between -90 and 90 degrees.
1737
1737
  * @param lat The latitude value to normalize.
1738
1738
  */
1739
- export function normalizeLatitude(lat: number): number;
1739
+ export function normalizeLatitude (lat: number): number;
1740
1740
  /**
1741
1741
  * Normalizes a longitude value between -180 and 180 degrees.
1742
1742
  * @param lng The longitude value to normalize.
1743
1743
  */
1744
- export function normalizeLongitude(lng: number): number;
1744
+ export function normalizeLongitude (lng: number): number;
1745
1745
  /**
1746
1746
  * Takes an array of positions and rotates them around a given position for the specified angle of rotation.
1747
1747
  * @param positions An array of positions to be rotated.
1748
1748
  * @param origin The position to rotate the positions around.
1749
1749
  * @param angle The amount to rotate the array of positions in degrees clockwise.
1750
1750
  */
1751
- export function rotatePositions(positions: atlas.data.Position[], origin: atlas.data.Position | atlas.data.Point, angle: number): atlas.data.Position[];
1751
+ export function rotatePositions (positions: atlas.data.Position[], origin: atlas.data.Position | atlas.data.Point, angle: number): atlas.data.Position[];
1752
1752
  /**
1753
1753
  * Calculates the pixel accurate heading from one position to another based on the Mercator map projection. This heading is visually accurate.
1754
1754
  * @param origin
1755
1755
  * @param destination
1756
1756
  */
1757
- export function getPixelHeading(origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point): number;
1757
+ export function getPixelHeading (origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point): number;
1758
1758
  /**
1759
1759
  * Converts an array of global Mercator pixel coordinates into an array of geospatial positions at a specified zoom level.
1760
1760
  * Global pixel coordinates are relative to the top left corner of the map [-180, 90].
@@ -1762,14 +1762,14 @@ declare namespace atlas {
1762
1762
  * @param zoom Zoom level.
1763
1763
  * @returns An array of positions.
1764
1764
  */
1765
- export function mercatorPixelsToPositions(pixels: Pixel[], zoom: number): atlas.data.Position[];
1765
+ export function mercatorPixelsToPositions (pixels: Pixel[], zoom: number): atlas.data.Position[];
1766
1766
  /**
1767
1767
  * Converts an array of positions into an array of global Mercator pixel coordinates at a specified zoom level.
1768
1768
  * @param positions Array of positions.
1769
1769
  * @param zoom Zoom level.
1770
1770
  * @returns Array of global Mercator pixels.
1771
1771
  */
1772
- export function mercatorPositionsToPixels(positions: atlas.data.Position[], zoom: number): Pixel[];
1772
+ export function mercatorPositionsToPixels (positions: atlas.data.Position[], zoom: number): Pixel[];
1773
1773
  /**
1774
1774
  * Converts an acceleration value from one unit to another.
1775
1775
  * Supported units:
@@ -1781,7 +1781,7 @@ declare namespace atlas {
1781
1781
  * @param decimals The number of decimal places to round the result to.
1782
1782
  * @returns An acceleration value convertered from one unit to another.
1783
1783
  */
1784
- export function convertAcceleration(acceleration: number, fromUnits: string | AccelerationUnits, toUnits: string | AccelerationUnits, decimals?: number): number;
1784
+ export function convertAcceleration (acceleration: number, fromUnits: string | AccelerationUnits, toUnits: string | AccelerationUnits, decimals?: number): number;
1785
1785
  /**
1786
1786
  * Converts an area value from one unit to another.
1787
1787
  * Supported units: squareMeters, acres, hectares, squareFeet, squareYards, squareMiles, squareKilometers
@@ -1791,7 +1791,7 @@ declare namespace atlas {
1791
1791
  * @param decimals The number of decimal places to round the result to.
1792
1792
  * @returns An area value convertered from one unit to another.
1793
1793
  */
1794
- export function convertArea(area: number, fromUnits: string, toUnits: string, decimals?: number): number;
1794
+ export function convertArea (area: number, fromUnits: string, toUnits: string, decimals?: number): number;
1795
1795
  /**
1796
1796
  * Converts a speed value from one unit to another.
1797
1797
  * Supported units:
@@ -1802,7 +1802,7 @@ declare namespace atlas {
1802
1802
  * @param decimals The number of decimal places to round the result to.
1803
1803
  * @returns A speed value convertered from one unit to another.
1804
1804
  */
1805
- export function convertSpeed(speed: number, fromUnits: string | SpeedUnits, toUnits: string | SpeedUnits, decimals?: number): number;
1805
+ export function convertSpeed (speed: number, fromUnits: string | SpeedUnits, toUnits: string | SpeedUnits, decimals?: number): number;
1806
1806
  /**
1807
1807
  * Converts a timespan value from one unit to another.
1808
1808
  * Supported units:
@@ -1813,7 +1813,7 @@ declare namespace atlas {
1813
1813
  * @param decimals The number of decimal places to round the result to.
1814
1814
  * @returns A time value convertered from one unit to another.
1815
1815
  */
1816
- export function convertTimespan(timespan: number, fromUnits: string | TimeUnits, toUnits: string | TimeUnits, decimals?: number): number;
1816
+ export function convertTimespan (timespan: number, fromUnits: string | TimeUnits, toUnits: string | TimeUnits, decimals?: number): number;
1817
1817
  /**
1818
1818
  * Calculates an acceleration based on an initial speed, travel distance and timespan. Formula: a = 2*(d - v*t)/t^2
1819
1819
  * @param initialSpeed The initial speed.
@@ -1826,7 +1826,7 @@ declare namespace atlas {
1826
1826
  * @param decimals The number of decimal places to round the result to.
1827
1827
  * @returns An acceleration based on an initial speed, travel distance and timespan.
1828
1828
  */
1829
- export function getAcceleration(initialSpeed: number, distance: number, timespan: number, speedUnits?: string | SpeedUnits, distanceUnits?: string | DistanceUnits, timeUnits?: string | TimeUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number;
1829
+ export function getAcceleration (initialSpeed: number, distance: number, timespan: number, speedUnits?: string | SpeedUnits, distanceUnits?: string | DistanceUnits, timeUnits?: string | TimeUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number;
1830
1830
  /**
1831
1831
  * Calculates an acceleration based on an initial speed, final speed and timespan. Formula: a = 2* (v2 - v1)/t
1832
1832
  * @param initialSpeed The initial speed.
@@ -1838,7 +1838,7 @@ declare namespace atlas {
1838
1838
  * @param decimals The number of decimal places to round the result to.
1839
1839
  * @returns An acceleration based on an initial speed, final speed and timespan.
1840
1840
  */
1841
- export function getAccelerationFromSpeeds(initialSpeed: number, finalSpeed: number, timespan: number, speedUnits?: string | SpeedUnits, timeUnits?: string | TimeUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number;
1841
+ export function getAccelerationFromSpeeds (initialSpeed: number, finalSpeed: number, timespan: number, speedUnits?: string | SpeedUnits, timeUnits?: string | TimeUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number;
1842
1842
  /**
1843
1843
  * Calculates an acceleration between two point features that have a timestamp property and optionally a speed property.
1844
1844
  * if speeds are provided, ignore distance between points as the path may not have been straight and calculate: a = (v2 - v1)/(t2 - t1)
@@ -1852,7 +1852,7 @@ declare namespace atlas {
1852
1852
  * @param decimals The number of decimal places to round the result to.
1853
1853
  * @returns An acceleration between two point features that have a timestamp property and optionally a speed property. Returns NaN if unable to parse timestamp.
1854
1854
  */
1855
- export function getAccelerationFromFeatures(origin: atlas.data.Feature<atlas.data.Point, any>, destination: atlas.data.Feature<atlas.data.Point, any>, timestampProperty: string, speedProperty?: string, speedUnits?: string | SpeedUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number;
1855
+ export function getAccelerationFromFeatures (origin: atlas.data.Feature<atlas.data.Point, any>, destination: atlas.data.Feature<atlas.data.Point, any>, timestampProperty: string, speedProperty?: string, speedUnits?: string | SpeedUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number;
1856
1856
  /**
1857
1857
  * Calculates the approximate area of a geometry in the specified units
1858
1858
  * @param coordinates The coordinates of the polyon ring.
@@ -1861,7 +1861,7 @@ declare namespace atlas {
1861
1861
  * @param decimals The number of decimal places to round the result to.
1862
1862
  * @returns The area of a geometry in the specified units.
1863
1863
  */
1864
- export function getArea(data: atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape, areaUnits?: AreaUnits, decimals?: number): number;
1864
+ export function getArea (data: atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape, areaUnits?: AreaUnits, decimals?: number): number;
1865
1865
  /**
1866
1866
  * Calculates the average speed of travel between two points based on the provided amount of time.
1867
1867
  * @param origin The initial point in which the speed is calculated from.
@@ -1872,7 +1872,7 @@ declare namespace atlas {
1872
1872
  * @param decimals The number of decimal places to round the result to.
1873
1873
  * @returns The average speed of travel between two points based on the provided amount of time.
1874
1874
  */
1875
- export function getSpeed(origin: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any>, destination: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any>, timespan: number, timeUnits?: string | TimeUnits, speedUnits?: string | SpeedUnits, decimals?: number): number;
1875
+ export function getSpeed (origin: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any>, destination: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any>, timespan: number, timeUnits?: string | TimeUnits, speedUnits?: string | SpeedUnits, decimals?: number): number;
1876
1876
  /**
1877
1877
  * Calculates the average speed of travel between two point features that have a property containing a timestamp.
1878
1878
  * The timestamp can be;
@@ -1889,7 +1889,7 @@ declare namespace atlas {
1889
1889
  * @param decimals The number of decimal places to round the result to.
1890
1890
  * @returns The speed in the specified units or NaN if valid timestamps are not found.
1891
1891
  */
1892
- export function getSpeedFromFeatures(origin: atlas.data.Feature<atlas.data.Point, any>, destination: atlas.data.Feature<atlas.data.Point, any>, timestampProperty: string, speedUnits?: string | SpeedUnits, decimals?: number): number;
1892
+ export function getSpeedFromFeatures (origin: atlas.data.Feature<atlas.data.Point, any>, destination: atlas.data.Feature<atlas.data.Point, any>, timestampProperty: string, speedUnits?: string | SpeedUnits, decimals?: number): number;
1893
1893
  /**
1894
1894
  * Calculates the timespan between two dates or timestamps.
1895
1895
  * Timestamps can be;
@@ -1904,7 +1904,7 @@ declare namespace atlas {
1904
1904
  * @param units The units to return the time value in. If not specified seconds are used.
1905
1905
  * @returns A timespan between two dates or timestamps. Returns NaN if unable to parse timestamps.
1906
1906
  */
1907
- export function getTimespan(startTime: Date | string | number, endTime: Date | string | number, units?: TimeUnits, decimals?: number): number;
1907
+ export function getTimespan (startTime: Date | string | number, endTime: Date | string | number, units?: TimeUnits, decimals?: number): number;
1908
1908
  /**
1909
1909
  * Calculates the distance traveled for a specified timespan, speed and optionally an acceleration.
1910
1910
  * Formula: d = v*t + 0.5*a*t^2
@@ -1918,7 +1918,7 @@ declare namespace atlas {
1918
1918
  * @param decimals The number of decimal places to round the result to.
1919
1919
  * @returns The distance traveled for a specified timespan, speed and optionally an acceleration.
1920
1920
  */
1921
- export function getTravelDistance(distanceUnits: string, timespan: number, speed: number, acceleration?: number, timeUnits?: string | TimeUnits, speedUnits?: string | SpeedUnits, accelerationUnits?: string, decimals?: number): number;
1921
+ export function getTravelDistance (distanceUnits: string, timespan: number, speed: number, acceleration?: number, timeUnits?: string | TimeUnits, speedUnits?: string | SpeedUnits, accelerationUnits?: string, decimals?: number): number;
1922
1922
  /**
1923
1923
  * Parses a timestamp into a JavaScript Date object.
1924
1924
  * Timestamps can be;
@@ -1931,32 +1931,32 @@ declare namespace atlas {
1931
1931
  * @param timestamp The timestamp value to parse.
1932
1932
  * @returns A Date object that represents the timestamp or null if the timestamp could not be parsed.
1933
1933
  */
1934
- export function parseTimestamp(timestamp: Date | string | number): Date;
1934
+ export function parseTimestamp (timestamp: Date | string | number): Date;
1935
1935
  /**
1936
1936
  * Calculates a Convex Hull from an array of positions, geometries or features.
1937
1937
  * @param data The array of positions, geometries or features to calculate a convex hull for.
1938
1938
  * @returns A Convex Hull from an array of positions, geometries or features.
1939
1939
  */
1940
- export function getConvexHull(data: atlas.data.Position[] | atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.FeatureCollection | atlas.data.GeometryCollection | atlas.data.Geometry[] | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape> | atlas.Shape): atlas.data.Polygon;
1940
+ export function getConvexHull (data: atlas.data.Position[] | atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.FeatureCollection | atlas.data.GeometryCollection | atlas.data.Geometry[] | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape> | atlas.Shape): atlas.data.Polygon;
1941
1941
  /**
1942
1942
  * Retrieves an array of all positions in the provided geometry, feature or array of geometries/features.
1943
1943
  * @param data The geometries or features to retrieve the positions from.
1944
1944
  * @returns An array of all positions in the provided geometry, feature or array of geometries/features.
1945
1945
  */
1946
- export function getPositions(data: atlas.data.Position[] | atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.FeatureCollection | atlas.data.GeometryCollection | atlas.data.Geometry[] | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape> | atlas.Shape): atlas.data.Position[];
1946
+ export function getPositions (data: atlas.data.Position[] | atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.FeatureCollection | atlas.data.GeometryCollection | atlas.data.Geometry[] | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape> | atlas.Shape): atlas.data.Position[];
1947
1947
  /**
1948
1948
  * Gets the position of an object that is a position, point, point feature, or circle. If it is a circle, its center coordinate will be returned.
1949
1949
  * @param data The data object to extract the position from.
1950
1950
  * @returns The position of an object that is a position, point, or point feature. Returns null if invalid data passed in.
1951
1951
  */
1952
- export function getPosition(data: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any> | atlas.Shape): atlas.data.Position;
1952
+ export function getPosition (data: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any> | atlas.Shape): atlas.data.Position;
1953
1953
  /**
1954
1954
  * Gets an array of evenly spaced positions along a path.
1955
1955
  * @param path The path to get the positions from.
1956
1956
  * @param numPositions The number of positions to get.
1957
1957
  * @returns An array of evenly spaced positions along a path.
1958
1958
  */
1959
- export function getPositionsAlongPath(path: atlas.data.LineString | atlas.data.Position[], numPositions: number): atlas.data.Position[];
1959
+ export function getPositionsAlongPath (path: atlas.data.LineString | atlas.data.Position[], numPositions: number): atlas.data.Position[];
1960
1960
  /**
1961
1961
  * Gets a point with heading a specified distance along a path.
1962
1962
  * @param path The path to get the point from.
@@ -1964,7 +1964,7 @@ declare namespace atlas {
1964
1964
  * @param units The distance units.
1965
1965
  * @returns A point with heading a specified distance along a path.
1966
1966
  */
1967
- export function getPointWithHeadingAlongPath(path: atlas.data.LineString | atlas.data.Position[], distance: number, units?: string | DistanceUnits): atlas.data.Feature<atlas.data.Point, {
1967
+ export function getPointWithHeadingAlongPath (path: atlas.data.LineString | atlas.data.Position[], distance: number, units?: string | DistanceUnits): atlas.data.Feature<atlas.data.Point, {
1968
1968
  heading: number;
1969
1969
  }>;
1970
1970
  /**
@@ -1973,7 +1973,7 @@ declare namespace atlas {
1973
1973
  * @param numPoints The number of points to get.
1974
1974
  * @returns An array of evenly spaced points with headings along a path.
1975
1975
  */
1976
- export function getPointsWithHeadingsAlongPath(path: atlas.data.LineString | atlas.data.Position[], numPoints: number): Array<atlas.data.Feature<atlas.data.Point, {
1976
+ export function getPointsWithHeadingsAlongPath (path: atlas.data.LineString | atlas.data.Position[], numPoints: number): Array<atlas.data.Feature<atlas.data.Point, {
1977
1977
  heading: number;
1978
1978
  }>>;
1979
1979
  /**
@@ -1988,7 +1988,7 @@ declare namespace atlas {
1988
1988
  * @param decimals The number of decimal places to round the result to.
1989
1989
  * @returns
1990
1990
  */
1991
- export function getClosestPointOnGeometry(pt: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any> | atlas.Shape, geom: atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape, units?: string | DistanceUnits, decimals?: number): atlas.data.Feature<atlas.data.Point, {
1991
+ export function getClosestPointOnGeometry (pt: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any> | atlas.Shape, geom: atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape, units?: string | DistanceUnits, decimals?: number): atlas.data.Feature<atlas.data.Point, {
1992
1992
  distance: number;
1993
1993
  }>;
1994
1994
 
@@ -1998,7 +1998,7 @@ declare namespace atlas {
1998
1998
  * @param tolerance A tolerance to use in the simplification.
1999
1999
  * @returns A new array of the simplified set of points.
2000
2000
  */
2001
- export function simplify(points: (Position | Pixel)[], tolerance: number): (Position | Pixel)[];
2001
+ export function simplify (points: (Position | Pixel)[], tolerance: number): (Position | Pixel)[];
2002
2002
 
2003
2003
  /**
2004
2004
  * Denormalizes path on antimeridian, this makes lines with coordinates on the opposite side of the antimeridian to always cross it. Note that the path crossing antimeridian will contain longitude outside of -180 to 180 range.
@@ -2006,7 +2006,7 @@ declare namespace atlas {
2006
2006
  * @param path Array of position objects or linestring to denormalize
2007
2007
  * @returns A denormalized array of position objects, path crossing antimeridian will contain longitude outside of -180 to 180 range.
2008
2008
  */
2009
- export function getPathDenormalizedAtAntimerian(path: atlas.data.LineString | Position[]): Position[];
2009
+ export function getPathDenormalizedAtAntimerian (path: atlas.data.LineString | Position[]): Position[];
2010
2010
 
2011
2011
  /**
2012
2012
  * Split path on antimeridian into multiple paths.
@@ -2014,7 +2014,7 @@ declare namespace atlas {
2014
2014
  * @param path Array of position objects or linestring to split
2015
2015
  * @returns A path split into multiple paths by antimeridian.
2016
2016
  */
2017
- export function getPathSplitByAntimeridian(path: atlas.data.LineString | Position[]): Position[][];
2017
+ export function getPathSplitByAntimeridian (path: atlas.data.LineString | Position[]): Position[][];
2018
2018
  }
2019
2019
 
2020
2020
  /**
@@ -2050,109 +2050,109 @@ declare namespace atlas {
2050
2050
  * @param container The id of the element where the map should be displayed.
2051
2051
  * @param options Options for the initial display and interactability with the map.
2052
2052
  */
2053
- constructor(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions));
2053
+ constructor (container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions));
2054
2054
  /**
2055
2055
  * Returns true if the map has been disposed.
2056
2056
  */
2057
- get isDisposed(): boolean;
2057
+ get isDisposed (): boolean;
2058
2058
  /**
2059
2059
  * Returns the HTMLCanvasElement that the map is drawn to.
2060
2060
  */
2061
- getCanvas(): HTMLCanvasElement;
2061
+ getCanvas (): HTMLCanvasElement;
2062
2062
  /**
2063
2063
  * Returns the HTMLElement that contains the map's HTMLCanvasElement. The map's events (e.g. panning and zooming)
2064
2064
  * are attached to this element.
2065
2065
  */
2066
- getCanvasContainer(): HTMLElement;
2066
+ getCanvasContainer (): HTMLElement;
2067
2067
  /**
2068
2068
  * Returns the HTMLElement that contains the map.
2069
2069
  */
2070
- getMapContainer(): HTMLElement;
2070
+ getMapContainer (): HTMLElement;
2071
2071
  /**
2072
2072
  * Returns the service options with which the map control was initialized.
2073
2073
  */
2074
- getServiceOptions(): ServiceOptions;
2074
+ getServiceOptions (): ServiceOptions;
2075
2075
  /**
2076
2076
  * Set the service options.
2077
2077
  */
2078
- setServiceOptions(options: ServiceOptions): void;
2078
+ setServiceOptions (options: ServiceOptions): void;
2079
2079
  /**
2080
2080
  * Set the camera of the map control with an animated transition. Any options not specified will default to their
2081
2081
  * current values.
2082
2082
  * @param options The options for setting the map's camera and for the animation of any view change.
2083
2083
  */
2084
- setCamera(options?: (CameraOptions | (CameraBoundsOptions & { pitch?: number, bearing?: number })) & AnimationOptions): void;
2084
+ setCamera (options?: (CameraOptions | (CameraBoundsOptions & { pitch?: number, bearing?: number })) & AnimationOptions): void;
2085
2085
  /**
2086
2086
  * Returns the camera's current properties.
2087
2087
  */
2088
- getCamera(): CameraOptions & CameraBoundsOptions;
2088
+ getCamera (): CameraOptions & CameraBoundsOptions;
2089
2089
  /**
2090
2090
  * Set the map control's style options. Any options not specified will default to their current values.
2091
2091
  * @param options The options for setting the style of the map control.
2092
2092
  * @param diff [true] If false, forces a 'full' style update, removing the current style and building the given one instead of attempting a diff-based update. Defaults to true.
2093
2093
  */
2094
- setStyle(options?: StyleOptions, diff?: boolean): void;
2094
+ setStyle (options?: StyleOptions, diff?: boolean): void;
2095
2095
  /**
2096
2096
  * Returns the map control's current style settings.
2097
2097
  */
2098
- getStyle(): StyleOptions;
2098
+ getStyle (): StyleOptions;
2099
2099
  /**
2100
2100
  * Set the map control's user interaction handlers. Any options not specified will default to their current values.
2101
2101
  * @param options The options for enabling/disabling the user interaction handlers.
2102
2102
  */
2103
- setUserInteraction(options?: UserInteractionOptions): void;
2103
+ setUserInteraction (options?: UserInteractionOptions): void;
2104
2104
  /**
2105
2105
  * Return the map control's current user interaction handler settings.
2106
2106
  */
2107
- getUserInteraction(): UserInteractionOptions;
2107
+ getUserInteraction (): UserInteractionOptions;
2108
2108
  /**
2109
2109
  * Set the traffic options for the map. Any options not specified will default to their current values.
2110
2110
  * @param options The options for defining the map's traffic display.
2111
2111
  */
2112
- setTraffic(options?: TrafficOptions): void;
2112
+ setTraffic (options?: TrafficOptions): void;
2113
2113
  /**
2114
2114
  * Return the map control's current traffic settings.
2115
2115
  */
2116
- getTraffic(): TrafficOptions;
2116
+ getTraffic (): TrafficOptions;
2117
2117
  /**
2118
2118
  * Removes all sources, layers, markers, and popups from the map.
2119
2119
  * User added images are preserved.
2120
2120
  */
2121
- clear(): void;
2121
+ clear (): void;
2122
2122
  /**
2123
2123
  * Clean up the map's resources. Map will not function correctly after calling this method.
2124
2124
  */
2125
- dispose(): void;
2125
+ dispose (): void;
2126
2126
  /**
2127
2127
  * Resize the map according to the dimensions of its container element.
2128
2128
  * @param eventData Optional additional properties to be added to event objects of events triggered by this method.
2129
2129
  */
2130
- resize(eventData?: any): void;
2130
+ resize (eventData?: any): void;
2131
2131
  /**
2132
2132
  * Resizes the map's container element then the map itself.
2133
2133
  * @param height The height for the map and its container element. A number input is assumed to be in pixels.
2134
2134
  * @param width The width for the map and its container element. A number input is assumed to be in pixels.
2135
2135
  * @param eventData Optional additional properties to be added to event objects of events triggered by this method.
2136
2136
  */
2137
- resize(height: number | string, width: number | string, eventData?: any): void;
2137
+ resize (height: number | string, width: number | string, eventData?: any): void;
2138
2138
  /**
2139
2139
  * Converts an array of Pixel objects to an array of geographic Positions objects on the map.
2140
2140
  * @param pixels The pixels to be converted.
2141
2141
  */
2142
- pixelsToPositions(pixels: Pixel[]): atlas.data.Position[];
2142
+ pixelsToPositions (pixels: Pixel[]): atlas.data.Position[];
2143
2143
  /**
2144
2144
  * Converts an array of Positions objects to an array of Pixel objects relative to the map container.
2145
2145
  * @param positions The positions to be converted.
2146
2146
  */
2147
- positionsToPixels(positions: atlas.data.Position[]): Pixel[];
2147
+ positionsToPixels (positions: atlas.data.Position[]): Pixel[];
2148
2148
  /**
2149
2149
  * Returns a boolean indicating if all tiles in the current viewport for all sources have loaded or not.
2150
2150
  */
2151
- areTilesLoaded(): boolean;
2151
+ areTilesLoaded (): boolean;
2152
2152
  /**
2153
2153
  * Stops any animated transition that is currently underway.
2154
2154
  */
2155
- stop(): void;
2155
+ stop (): void;
2156
2156
  /**
2157
2157
  * Trigger the rendering of a single frame.
2158
2158
  * Use this method with WebGL layers to repaint the map when the layer's
@@ -2160,18 +2160,18 @@ declare namespace atlas {
2160
2160
  * Calling this multiple times before the next frame is rendered will still
2161
2161
  * result in only a single frame being rendered.
2162
2162
  */
2163
- triggerRepaint(): void;
2163
+ triggerRepaint (): void;
2164
2164
  /**
2165
2165
  * Loads a 3D terrain mesh, based on a "raster-dem" source.
2166
2166
  *
2167
2167
  * @param elevationSource elevation tile source
2168
2168
  * @param exaggeration the elevation exaggeration factor
2169
2169
  */
2170
- enableElevation(elevationSource: string | atlas.source.ElevationTileSource, exaggeration?: number): void;
2170
+ enableElevation (elevationSource: string | atlas.source.ElevationTileSource, exaggeration?: number): void;
2171
2171
  /**
2172
2172
  * Disables the 3D terrain mesh.
2173
2173
  */
2174
- disableElevation(): void;
2174
+ disableElevation (): void;
2175
2175
  /**
2176
2176
  * The callback used when styleOptions.autoResize is true.
2177
2177
  */
@@ -2204,24 +2204,24 @@ declare namespace atlas {
2204
2204
  * @param x The horizontal pixel offset.
2205
2205
  * @param y The vertical pixel offset.
2206
2206
  */
2207
- constructor(x: number, y: number);
2207
+ constructor (x: number, y: number);
2208
2208
  /**
2209
2209
  * Generates a Pixel object from an object that contains coordinate information.
2210
2210
  * The object is scanned for x and y properties using a case insensitive test.
2211
2211
  * @param data The object to extract coordinate information from.
2212
2212
  * @returns A Pixel object that represents the provided data information.
2213
2213
  */
2214
- static fromData(data: object): Pixel;
2214
+ static fromData (data: object): Pixel;
2215
2215
  /**
2216
2216
  * Return the x coordinate of the specified pixel.
2217
2217
  * @param pixel The pixel to get the x coordinate of.
2218
2218
  */
2219
- static getX(pixel: Pixel): number;
2219
+ static getX (pixel: Pixel): number;
2220
2220
  /**
2221
2221
  * Return the y coordinate of the specified pixel.
2222
2222
  * @param pixel The pixel to get the y coordinate of.
2223
2223
  */
2224
- static getY(pixel: Pixel): number;
2224
+ static getY (pixel: Pixel): number;
2225
2225
  /**
2226
2226
  * Calculates a destination pixel given an origin pixel,
2227
2227
  * a heading relative to the y-axis (0 = north) with clockwise-rotation,
@@ -2230,20 +2230,20 @@ declare namespace atlas {
2230
2230
  * @param heading The heading at which to move away from the origin pixel.
2231
2231
  * @param distance The distance to move from the origin pixel.
2232
2232
  */
2233
- static getDestination(origin: Pixel, heading: number, distance: number): Pixel;
2233
+ static getDestination (origin: Pixel, heading: number, distance: number): Pixel;
2234
2234
  /**
2235
2235
  * Calculates the distance between two pixels.
2236
2236
  * Returned value is in screen pixel units.
2237
2237
  * @param p1 The first pixel.
2238
2238
  * @param p2 The second pixel.
2239
2239
  */
2240
- static getDistance(p1: Pixel, p2: Pixel): number;
2240
+ static getDistance (p1: Pixel, p2: Pixel): number;
2241
2241
  /**
2242
2242
  * Calculates the heading between two pixels.​ The heading value is relative to the y-axis (0 = north) with clockwise-rotation.
2243
2243
  * @param origin The pixel the heading will point away from.
2244
2244
  * @param destination The pixel the heading will point toward.
2245
2245
  */
2246
- static getHeading(origin: Pixel, destination: Pixel): number;
2246
+ static getHeading (origin: Pixel, destination: Pixel): number;
2247
2247
  }
2248
2248
 
2249
2249
  export interface PopupEvents {
@@ -2274,31 +2274,31 @@ declare namespace atlas {
2274
2274
  * Constructs a Popup object and initializes it with the specified options.
2275
2275
  * @param options The options for the popup.
2276
2276
  */
2277
- constructor(options?: PopupOptions);
2277
+ constructor (options?: PopupOptions);
2278
2278
  /**
2279
2279
  * Sets the options for the popup.
2280
2280
  * @param options The options for the popup.
2281
2281
  * @deprecated Use setOptions(...) instead.
2282
2282
  */
2283
- setPopupOptions(options?: PopupOptions): void;
2283
+ setPopupOptions (options?: PopupOptions): void;
2284
2284
  /**
2285
2285
  * Sets the options for the popup.
2286
2286
  * @param options The options for the popup.
2287
2287
  */
2288
- setOptions(options?: PopupOptions): void;
2288
+ setOptions (options?: PopupOptions): void;
2289
2289
  /**
2290
2290
  * Returns the options for the popup.
2291
2291
  * @deprecated Use getOptions() instead.
2292
2292
  */
2293
- getPopupOptions(): PopupOptions;
2293
+ getPopupOptions (): PopupOptions;
2294
2294
  /**
2295
2295
  * Returns the options for the popup.
2296
2296
  */
2297
- getOptions(): PopupOptions;
2297
+ getOptions (): PopupOptions;
2298
2298
  /**
2299
2299
  * Returns popup container element.
2300
2300
  */
2301
- getPopupContainer(): HTMLElement
2301
+ getPopupContainer (): HTMLElement;
2302
2302
  /**
2303
2303
  * Attaches the popup to the HTML document in a hidden state.
2304
2304
  * @param map The map.
@@ -2488,7 +2488,7 @@ declare namespace atlas {
2488
2488
  * @param prop The properties object generate the popup content from.
2489
2489
  * @param template The template to apply.
2490
2490
  */
2491
- static applyTemplate(prop: Properties, template?: PopupTemplate): HTMLElement;
2491
+ static applyTemplate (prop: Properties, template?: PopupTemplate): HTMLElement;
2492
2492
  /** Regular expression for content property placeholders. */
2493
2493
  private static readonly _placeholderRx;
2494
2494
  /** Regular expression for external URLs. */
@@ -2553,7 +2553,7 @@ declare namespace atlas {
2553
2553
  * @param key The property name key.
2554
2554
  * @param value The value of the property.
2555
2555
  */
2556
- static _ignoreProperty(key: string, value: any): boolean;
2556
+ static _ignoreProperty (key: string, value: any): boolean;
2557
2557
  }
2558
2558
 
2559
2559
  export interface ShapeEvents {
@@ -2572,69 +2572,69 @@ declare namespace atlas {
2572
2572
  * @param data: a Feature which contains a Geometry object and properties.
2573
2573
  * If the feature does not have an id, a unique id value will be assigned to it.
2574
2574
  */
2575
- constructor(data: atlas.data.Feature<atlas.data.Geometry, any>);
2575
+ constructor (data: atlas.data.Feature<atlas.data.Geometry, any>);
2576
2576
  /**
2577
2577
  * Constructs a Shape object and initializes it with the specified Geometry, ID, and properties.
2578
2578
  * @param data a Geometry object
2579
2579
  * @param id a unique id that the user assigns to the shape. If not provided, a unique id value will be assigned to it.
2580
2580
  * @param properties User defined properties for the shape.
2581
2581
  */
2582
- constructor(data: atlas.data.Geometry, id?: string | number, properties?: any);
2582
+ constructor (data: atlas.data.Geometry, id?: string | number, properties?: any);
2583
2583
  /**
2584
2584
  * Adds or updates an existing property value in the shape.
2585
2585
  * @param key
2586
2586
  * @param value
2587
2587
  */
2588
- addProperty(key: string, value: any): void;
2588
+ addProperty (key: string, value: any): void;
2589
2589
  /**
2590
2590
  * Gets the bounding box of the shape
2591
2591
  */
2592
- getBounds(): atlas.data.BoundingBox;
2592
+ getBounds (): atlas.data.BoundingBox;
2593
2593
  /**
2594
2594
  * Gets the coordinates of the shape.
2595
2595
  */
2596
- getCoordinates(): atlas.data.Position | atlas.data.Position[] | atlas.data.Position[][] | atlas.data.Position[][][];
2596
+ getCoordinates (): atlas.data.Position | atlas.data.Position[] | atlas.data.Position[][] | atlas.data.Position[][][];
2597
2597
  /**
2598
2598
  * If the shape is a circle, this gets its coordinates. Otherwise returns null.
2599
2599
  */
2600
- getCircleCoordinates(): atlas.data.Position[];
2600
+ getCircleCoordinates (): atlas.data.Position[];
2601
2601
  /**
2602
2602
  * Gets the id of the shape.
2603
2603
  */
2604
- getId(): string | number;
2604
+ getId (): string | number;
2605
2605
  /**
2606
2606
  * Gets the properties of the shape.
2607
2607
  */
2608
- getProperties(): any;
2608
+ getProperties (): any;
2609
2609
  /**
2610
2610
  * Returns a string indicating the type of geometry this shape contains.
2611
2611
  */
2612
- getType(): string;
2612
+ getType (): string;
2613
2613
  /**
2614
2614
  * Indicates if the contained shape is a Circle, defined by the extended GeoJSON specification supported by Azure Maps.
2615
2615
  * [Extended Spec]{@link https://docs.microsoft.com/en-us/azure/azure-maps/extend-geojson}
2616
2616
  */
2617
- isCircle(): boolean;
2617
+ isCircle (): boolean;
2618
2618
  /**
2619
2619
  * Indicates if the contained shape is a Rectangle, defined by the extended GeoJSON specification supported by Azure Maps.
2620
2620
  * [Extended Spec]{@link https://docs.microsoft.com/en-us/azure/azure-maps/extend-geojson}
2621
2621
  */
2622
- isRectangle(): boolean;
2622
+ isRectangle (): boolean;
2623
2623
  /**
2624
2624
  * Updates the coordinates of the shape
2625
2625
  * @param coords Point: Position, LineString: Position[], Polygon: Position[][],
2626
2626
  * MultiPoint: Position[], MultiLineString: Position[][], MultiPolygon: Position[][]
2627
2627
  */
2628
- setCoordinates(coords: atlas.data.Position | atlas.data.Position[] | atlas.data.Position[][] | atlas.data.Position[][][]): void;
2628
+ setCoordinates (coords: atlas.data.Position | atlas.data.Position[] | atlas.data.Position[][] | atlas.data.Position[][][]): void;
2629
2629
  /**
2630
2630
  * Sets the properties on the shape. Overwrites all existing properties.
2631
2631
  * @param properties
2632
2632
  */
2633
- setProperties(properties: any): void;
2633
+ setProperties (properties: any): void;
2634
2634
  /**
2635
2635
  * Returns a GeoJSON feature that represents the shape.
2636
2636
  */
2637
- toJson(): atlas.data.Feature<atlas.data.Geometry, any>;
2637
+ toJson (): atlas.data.Feature<atlas.data.Geometry, any>;
2638
2638
  /**
2639
2639
  * Check if the shape's wrapped feature is a circle form the extended GeoJSON spec.
2640
2640
  * If so it will calculate a polygon feature that approximates the specified circle.
@@ -2677,24 +2677,24 @@ declare namespace atlas {
2677
2677
  * Constructs a new HtmlMarker.
2678
2678
  * @param options The options for the HtmlMarker.
2679
2679
  */
2680
- constructor(options?: HtmlMarkerOptions);
2680
+ constructor (options?: HtmlMarkerOptions);
2681
2681
  /**
2682
2682
  * Gets the HTML marker options.
2683
2683
  */
2684
- getOptions(): HtmlMarkerOptions;
2684
+ getOptions (): HtmlMarkerOptions;
2685
2685
  /**
2686
2686
  * Returns the underlying `Marker`'s HTML element.
2687
2687
  */
2688
- getElement(): HTMLElement;
2688
+ getElement (): HTMLElement;
2689
2689
  /**
2690
2690
  * Sets the options of the marker.
2691
2691
  * @param options The options for the marker.
2692
2692
  */
2693
- setOptions(options: HtmlMarkerOptions): void;
2693
+ setOptions (options: HtmlMarkerOptions): void;
2694
2694
  /**
2695
2695
  * Toggles the popup attached to the marker.
2696
2696
  */
2697
- togglePopup(): void;
2697
+ togglePopup (): void;
2698
2698
  /**
2699
2699
  * Builds the Mapbox marker that this HtmlMarker will wrap.
2700
2700
  * @private
@@ -2747,54 +2747,54 @@ declare namespace atlas {
2747
2747
  * Gets the default authentication options that were provided.
2748
2748
  * If not previously set all properties will be undefined.
2749
2749
  */
2750
- export function getAuthenticationOptions(): AuthenticationOptions;
2750
+ export function getAuthenticationOptions (): AuthenticationOptions;
2751
2751
  /**
2752
2752
  * Gets the default domain that was provided.
2753
2753
  * If not previously set the default value is `"atlas.microsoft.com"`.
2754
2754
  */
2755
- export function getDomain(): string;
2755
+ export function getDomain (): string;
2756
2756
  /**
2757
2757
  * Gets the default language that was provided.
2758
2758
  * If not previously set the default value is `"NGT"`.
2759
2759
  */
2760
- export function getLanguage(): string;
2760
+ export function getLanguage (): string;
2761
2761
  /**
2762
2762
  * Gets the Maximum number of images (raster tiles, sprites, icons) to load in parallel
2763
2763
  */
2764
- export function getMaxParallelImageRequests(): number;
2764
+ export function getMaxParallelImageRequests (): number;
2765
2765
  /**
2766
2766
  * Gets the default session id that was provided.
2767
2767
  * If not previously set the default value is a random UUID.
2768
2768
  */
2769
- export function getSessionId(): string;
2769
+ export function getSessionId (): string;
2770
2770
  /**
2771
2771
  * Gets the default Azure Maps subscription key that was provided.
2772
2772
  */
2773
- export function getSubscriptionKey(): string;
2773
+ export function getSubscriptionKey (): string;
2774
2774
  /**
2775
2775
  * @deprecated use atlas.getView() instead
2776
2776
  */
2777
- export function getUserRegion(): string;
2777
+ export function getUserRegion (): string;
2778
2778
  /**
2779
2779
  * Gets the default view setting of the map control.
2780
2780
  * If not previously set the default value is `undefined`.
2781
2781
  */
2782
- export function getView(): string;
2782
+ export function getView (): string;
2783
2783
  /**
2784
2784
  * Current API version number based on build number.
2785
2785
  */
2786
- export function getVersion(): string;
2786
+ export function getVersion (): string;
2787
2787
  /**
2788
2788
  * Gets the worker count that will get created.
2789
2789
  */
2790
- export function getWorkerCount(): number;
2790
+ export function getWorkerCount (): number;
2791
2791
  /**
2792
2792
  * Checks to see if the user's browser is supported by the map control.
2793
2793
  * @param failIfMajorPerformanceCaveat If true the function will return false
2794
2794
  * if the performance of the map control would be dramatically worse than expected
2795
2795
  * (e.g. a software WebGL renderer would be used).
2796
2796
  */
2797
- export function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean;
2797
+ export function isSupported (failIfMajorPerformanceCaveat?: boolean): boolean;
2798
2798
  /**
2799
2799
  * Sets your authentication options as the default options in the atlas namespace
2800
2800
  * which is used by the map control and any modules that make requests to the Azure maps services.
@@ -2802,7 +2802,7 @@ declare namespace atlas {
2802
2802
  * setAuthenticationOptions hasn't previously been called it will automatically be called by the Map constructor.
2803
2803
  * @param options The new default authentication options.
2804
2804
  */
2805
- export function setAuthenticationOptions(options: AuthenticationOptions): void;
2805
+ export function setAuthenticationOptions (options: AuthenticationOptions): void;
2806
2806
  /**
2807
2807
  * Sets the default domain used by the map and service modules unless the
2808
2808
  * domain is explicitly specified when using those parts of the API.
@@ -2811,7 +2811,7 @@ declare namespace atlas {
2811
2811
  * If the protocol is not specified `https` is assumed.
2812
2812
  * @param domain The new default domain.
2813
2813
  */
2814
- export function setDomain(domain: string): void;
2814
+ export function setDomain (domain: string): void;
2815
2815
  /**
2816
2816
  * Sets the default language used by the map and service modules unless the
2817
2817
  * language is explicitly specified when using those parts of the API.
@@ -2819,13 +2819,13 @@ declare namespace atlas {
2819
2819
  * setLanguage hasn't previously been called it will automatically be called by the Map constructor.
2820
2820
  * @param language The new default language.
2821
2821
  */
2822
- export function setLanguage(language: string): void;
2822
+ export function setLanguage (language: string): void;
2823
2823
  /**
2824
2824
  * Sets Maximum number of images (raster tiles, sprites, icons) to load in parallel,
2825
2825
  * which affects performance in raster-heavy maps. 16 by default.
2826
2826
  * @param maxParallelImageRequests Maximum number of images to load in parallel.
2827
2827
  */
2828
- export function setMaxParallelImageRequests(maxParallelImageRequests: number): void;
2828
+ export function setMaxParallelImageRequests (maxParallelImageRequests: number): void;
2829
2829
  /**
2830
2830
  * Sets the default session id used by the map and service modules unless the
2831
2831
  * session id is explicitly specified when using those parts of the API.
@@ -2833,7 +2833,7 @@ declare namespace atlas {
2833
2833
  * setSessionId hasn't previously been called it will automatically be called by the Map constructor.
2834
2834
  * @param id The new default session id.
2835
2835
  */
2836
- export function setSessionId(id: string): void;
2836
+ export function setSessionId (id: string): void;
2837
2837
  /**
2838
2838
  * Sets your Azure Maps subscription key as the default subscription key in the atlas namespace
2839
2839
  * which is used by the map control and any modules that make requests to the Azure maps services.
@@ -2841,41 +2841,41 @@ declare namespace atlas {
2841
2841
  * setSubscriptionKey hasn't previously been called it will automatically be called by the Map constructor.
2842
2842
  * @param key The new default subscription key.
2843
2843
  */
2844
- export function setSubscriptionKey(key: string): void;
2844
+ export function setSubscriptionKey (key: string): void;
2845
2845
  /**
2846
2846
  * @deprecated use atlas.setView(view: string) instead.
2847
2847
  */
2848
- export function setUserRegion(userRegion: string): void;
2848
+ export function setUserRegion (userRegion: string): void;
2849
2849
  /**
2850
2850
  * Specifies which set of geopolitically disputed borders and labels are displayed on the map. The View parameter (also referred to as “user region parameter”) is a 2-letter ISO-3166 Country Code that will show the correct maps for that country/region. Country/Regions that are not on the View list or if unspecified will default to the “Unified” View.
2851
2851
  * Please see the supported [Views]{@link https://aka.ms/AzureMapsLocalizationViews }.
2852
2852
  * It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that You are authorized to access via Azure Maps is made available.
2853
2853
  * @param view The new default view
2854
2854
  */
2855
- export function setView(view: string): void;
2855
+ export function setView (view: string): void;
2856
2856
  /**
2857
2857
  * Sets number of web workers instantiated on a page.
2858
2858
  * By default, it is set to half the number of CPU cores (capped at 6).
2859
2859
  * @param workerCount worker count.
2860
2860
  */
2861
- export function setWorkerCount(workerCount: number): void;
2861
+ export function setWorkerCount (workerCount: number): void;
2862
2862
  /**
2863
2863
  * Adds an image template to the atlas namespace.
2864
2864
  * @param templateName The name of the template.
2865
2865
  * @param template The SVG template to add. Supports {color}, {secondaryColor}, {scale}, {text}.
2866
2866
  * @param override Specifies if it should override existing templates if one with the same name already exists.
2867
2867
  */
2868
- export function addImageTemplate(templateName: string, template: string, override: boolean): void;
2868
+ export function addImageTemplate (templateName: string, template: string, override: boolean): void;
2869
2869
  /**
2870
2870
  * Retrieves an SVG template by name.
2871
2871
  * @param templateName The name of the template to retrieve.
2872
2872
  * @param scale Specifies how much to scale the template. For best results, scale the icon to the maximum size you want to display it on the map, then use the symbol layers icon size option to scale down if needed. This will reduce blurriness due to scaling. Default: 1
2873
2873
  */
2874
- export function getImageTemplate(templateName: string, scale?: number): string;
2874
+ export function getImageTemplate (templateName: string, scale?: number): string;
2875
2875
  /**
2876
2876
  * Retrieves an array of names for all image templates that are available in the atlas namespace.
2877
2877
  */
2878
- export function getAllImageTemplateNames(): string[];
2878
+ export function getAllImageTemplateNames (): string[];
2879
2879
  /**
2880
2880
  * Initializes resources like WebWorkers that can be shared across maps to lower load
2881
2881
  * times in some situations. `atlas.setWorkerCount`, if being
@@ -2893,14 +2893,14 @@ declare namespace atlas {
2893
2893
  * would navigate between various views that can cause Map instances to constantly be
2894
2894
  * created and destroyed.
2895
2895
  */
2896
- export function prewarm(): void;
2896
+ export function prewarm (): void;
2897
2897
  /**
2898
2898
  * Clears up resources that have previously been created by `atlas.prewarm()`.
2899
2899
  * Note that this is typically not necessary. You should only call this function
2900
2900
  * if you expect the user of your app to not return to a Map view at any point
2901
2901
  * in your application.
2902
2902
  */
2903
- export function clearPrewarmedResources(): void;
2903
+ export function clearPrewarmedResources (): void;
2904
2904
  /**
2905
2905
  * Options used when rendering Point objects in a BubbleLayer.
2906
2906
  */
@@ -2953,9 +2953,9 @@ declare namespace atlas {
2953
2953
  */
2954
2954
  strokeWidth?: number | DataDrivenPropertyValueSpecification<number>;
2955
2955
  /**
2956
- * Specifies the orientation of circle when map is pitched.
2957
- * <p>`"map"`: The circle is aligned to the plane of the map.</p>
2958
- * <p>`"viewport"`: The circle is aligned to the plane of the viewport.</p>
2956
+ * Specifies the orientation of circle when map is pitched.<br />
2957
+ * `"map"`: The circle is aligned to the plane of the map.<br />
2958
+ * `"viewport"`: The circle is aligned to the plane of the viewport.<br />
2959
2959
  * Default: `"viewport"`
2960
2960
  * @default "viewport"
2961
2961
  */
@@ -2982,16 +2982,16 @@ declare namespace atlas {
2982
2982
  */
2983
2983
  allowOverlap?: boolean;
2984
2984
  /**
2985
- * Specifies which part of the icon is placed closest to the icons anchor position on the map.
2986
- * <p>`"center"`: The center of the icon is placed closest to the anchor.</p>
2987
- * <p>`"left"`: The left side of the icon is placed closest to the anchor.</p>
2988
- * <p>`"right"`: The right side of the icon is placed closest to the anchor.</p>
2989
- * <p>`"top"`: The top of the icon is placed closest to the anchor.</p>
2990
- * <p>`"bottom"`: The bottom of the icon is placed closest to the anchor.</p>
2991
- * <p>`"top-left"`: The top left corner of the icon is placed closest to the anchor.</p>
2992
- * <p>`"top-right"`: The top right corner of the icon is placed closest to the anchor.</p>
2993
- * <p>`"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.</p>
2994
- * <p>`"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.</p>
2985
+ * Specifies which part of the icon is placed closest to the icons anchor position on the map.<br />
2986
+ * `"center"`: The center of the icon is placed closest to the anchor.<br />
2987
+ * `"left"`: The left side of the icon is placed closest to the anchor.<br />
2988
+ * `"right"`: The right side of the icon is placed closest to the anchor.<br />
2989
+ * `"top"`: The top of the icon is placed closest to the anchor.<br />
2990
+ * `"bottom"`: The bottom of the icon is placed closest to the anchor.<br />
2991
+ * `"top-left"`: The top left corner of the icon is placed closest to the anchor.<br />
2992
+ * `"top-right"`: The top right corner of the icon is placed closest to the anchor.<br />
2993
+ * `"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.<br />
2994
+ * `"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.<br />
2995
2995
  * Default `"bottom"`.
2996
2996
  * @default "bottom"
2997
2997
  */
@@ -3036,10 +3036,10 @@ declare namespace atlas {
3036
3036
  */
3037
3037
  padding?: number | DataDrivenPropertyValueSpecification<number>;
3038
3038
  /**
3039
- * Specifies the orientation of the icon when the map is pitched.
3040
- * <p>`"auto"`: Automatically matches the value of `rotationAlignment`.</p>
3041
- * <p>`"map"`: The icon is aligned to the plane of the map.</p>
3042
- * <p>`"viewport"`: The icon is aligned to the plane of the viewport</p>
3039
+ * Specifies the orientation of the icon when the map is pitched.<br />
3040
+ * `"auto"`: Automatically matches the value of `rotationAlignment`.<br />
3041
+ * `"map"`: The icon is aligned to the plane of the map.<br />
3042
+ * `"viewport"`: The icon is aligned to the plane of the viewport<br />
3043
3043
  * Default `"auto"`
3044
3044
  * @default "auto"
3045
3045
  */
@@ -3052,12 +3052,12 @@ declare namespace atlas {
3052
3052
  rotation?: number | DataDrivenPropertyValueSpecification<number>;
3053
3053
  /**
3054
3054
  * In combination with the placement property of a SymbolLayerOptions
3055
- * this determines the rotation behavior of icons.
3056
- * <p>`"auto"`: When placement is "point" this is equivalent to "viewport".
3057
- * When placement is "line" this is equivalent to "map".</p>
3058
- * <p>`"map"`: When placement is "point" aligns icons east-west.
3059
- * When placement is "line" aligns the icons' x-axes with the line.</p>
3060
- * <p>`"viewport"`: Icons' x-axes will align with the x-axis of the viewport.</p>
3055
+ * this determines the rotation behavior of icons.<br />
3056
+ * `"auto"`: When placement is "point" this is equivalent to "viewport".
3057
+ * When placement is "line" this is equivalent to "map".<br />
3058
+ * `"map"`: When placement is "point" aligns icons east-west.
3059
+ * When placement is "line" aligns the icons' x-axes with the line.<br />
3060
+ * `"viewport"`: Icons' x-axes will align with the x-axis of the viewport.<br />
3061
3061
  * Default `"auto"`.
3062
3062
  * @default "auto"
3063
3063
  */
@@ -3196,24 +3196,24 @@ declare namespace atlas {
3196
3196
  */
3197
3197
  sourceLayer?: string;
3198
3198
  /**
3199
- * Specifies how the ends of the lines are rendered.
3200
- * <p>`"butt"`: A cap with a squared-off end which is drawn to the exact endpoint of the line.</p>
3201
- * <p>`"round"`: A cap with a rounded end which is drawn beyond the endpoint of the line
3202
- * at a radius of one-half of the lines width and centered on the endpoint of the line.</p>
3203
- * <p>`"square"`: A cap with a squared-off end which is drawn beyond the endpoint of the line
3204
- * at a distance of one-half of the line width.</p>
3199
+ * Specifies how the ends of the lines are rendered.<br />
3200
+ * `"butt"`: A cap with a squared-off end which is drawn to the exact endpoint of the line.<br />
3201
+ * `"round"`: A cap with a rounded end which is drawn beyond the endpoint of the line
3202
+ * at a radius of one-half of the lines width and centered on the endpoint of the line.<br />
3203
+ * `"square"`: A cap with a squared-off end which is drawn beyond the endpoint of the line
3204
+ * at a distance of one-half of the line width.<br />
3205
3205
  * Default `"round"`.
3206
3206
  * @default "round"
3207
3207
  */
3208
3208
  lineCap?: "butt" | "round" | "square";
3209
3209
  /**
3210
- * Specifies how the joints in the lines are rendered.
3211
- * <p>`"bevel"`: A join with a squared-off end which is drawn beyond the endpoint of the line
3212
- * at a distance of one-half of the lines width.</p>
3213
- * <p>`"round"`: A join with a rounded end which is drawn beyond the endpoint of the line
3214
- * at a radius of one-half of the lines width and centered on the endpoint of the line.</p>
3215
- * <p>`"miter"`: A join with a sharp, angled corner which is drawn with the outer sides
3216
- * beyond the endpoint of the path until they meet.</p>
3210
+ * Specifies how the joints in the lines are rendered.<br />
3211
+ * `"bevel"`: A join with a squared-off end which is drawn beyond the endpoint of the line
3212
+ * at a distance of one-half of the lines width.<br />
3213
+ * `"round"`: A join with a rounded end which is drawn beyond the endpoint of the line
3214
+ * at a radius of one-half of the lines width and centered on the endpoint of the line.<br />
3215
+ * `"miter"`: A join with a sharp, angled corner which is drawn with the outer sides
3216
+ * beyond the endpoint of the path until they meet.<br />
3217
3217
  * Default `"round"`.
3218
3218
  * @default "round"
3219
3219
  */
@@ -3264,9 +3264,9 @@ declare namespace atlas {
3264
3264
  */
3265
3265
  translate?: Pixel;
3266
3266
  /**
3267
- * Specifies the frame of reference for `translate`.
3268
- * <p>`"map"`: Lines are translated relative to the map.</p>
3269
- * <p>`"viewport"`: Lines are translated relative to the viewport</p>
3267
+ * Specifies the frame of reference for `translate`.<br />
3268
+ * `"map"`: Lines are translated relative to the map.<br />
3269
+ * `"viewport"`: Lines are translated relative to the viewport<br />
3270
3270
  * Default: `"map"`
3271
3271
  * @default "map"
3272
3272
  */
@@ -3385,9 +3385,9 @@ declare namespace atlas {
3385
3385
  */
3386
3386
  translate?: Pixel;
3387
3387
  /**
3388
- * Specifies the frame of reference for `translate`.
3389
- * <p>`"map"`: Polygons are translated relative to the map.</p>
3390
- * <p>`"viewport"`: Polygons are translated relative to the viewport.</p>
3388
+ * Specifies the frame of reference for `translate`.<br />
3389
+ * `"map"`: Polygons are translated relative to the map.<br />
3390
+ * `"viewport"`: Polygons are translated relative to the viewport.<br />
3391
3391
  * Default: `"map"`
3392
3392
  * @default "map"
3393
3393
  */
@@ -3463,12 +3463,12 @@ declare namespace atlas {
3463
3463
  */
3464
3464
  textOptions?: TextOptions;
3465
3465
  /**
3466
- * Specifies the label placement relative to its geometry.
3467
- * <p>`"point"`: The label is placed at the point where the geometry is located.</p>
3468
- * <p>`"line"`: The label is placed along the line of the geometry.
3469
- * Can only be used on LineString and Polygon geometries.</p>
3470
- * <p> `"line-center"`: The label is placed at the center of the line of the geometry.
3471
- * Can only be used on `LineString` and `Polygon` geometries </p>
3466
+ * Specifies the label placement relative to its geometry.<br />
3467
+ * `"point"`: The label is placed at the point where the geometry is located.<br />
3468
+ * `"line"`: The label is placed along the line of the geometry.
3469
+ * Can only be used on LineString and Polygon geometries.<br />
3470
+ * `"line-center"`: The label is placed at the center of the line of the geometry.
3471
+ * Can only be used on `LineString` and `Polygon` geometries <br />
3472
3472
  * Default `"point"`.
3473
3473
  * @default "point"
3474
3474
  */
@@ -3483,12 +3483,12 @@ declare namespace atlas {
3483
3483
  /**
3484
3484
  * Determines whether overlapping symbols in the same layer are rendered in the order
3485
3485
  * that they appear in the data source, or by their y position relative to the viewport.
3486
- * To control the order and prioritization of symbols otherwise, use `sortKey`.
3487
- * <p>`"auto"`: Sorts symbols by `sortKey` if set. Otherwise behaves like `"viewport-y"`.
3488
- * <p>`"viewport-y"`: Sorts symbols by their y position if `allowOverlap` is `true` or
3489
- * if `ignorePlacement` is `false`.
3490
- * <p>`"source"`: Sorts symbols by `sortKey` if set. Otherwise, symbols are rendered in the
3491
- * same order as the source data.
3486
+ * To control the order and prioritization of symbols otherwise, use `sortKey`.<br />
3487
+ * `"auto"`: Sorts symbols by `sortKey` if set. Otherwise behaves like `"viewport-y"`.<br />
3488
+ * `"viewport-y"`: Sorts symbols by their y position if `allowOverlap` is `true` or
3489
+ * if `ignorePlacement` is `false`.<br />
3490
+ * `"source"`: Sorts symbols by `sortKey` if set. Otherwise, symbols are rendered in the
3491
+ * same order as the source data.<br />
3492
3492
  * Default `"auto"`
3493
3493
  * @default "auto"
3494
3494
  */
@@ -3513,16 +3513,16 @@ declare namespace atlas {
3513
3513
  */
3514
3514
  allowOverlap?: boolean;
3515
3515
  /**
3516
- * Specifies which part of the icon is placed closest to the icons anchor position on the map.
3517
- * <p>`"center"`: The center of the icon is placed closest to the anchor.</p>
3518
- * <p>`"left"`: The left side of the icon is placed closest to the anchor.</p>
3519
- * <p>`"right"`: The right side of the icon is placed closest to the anchor.</p>
3520
- * <p>`"top"`: The top of the icon is placed closest to the anchor.</p>
3521
- * <p>`"bottom"`: The bottom of the icon is placed closest to the anchor.</p>
3522
- * <p>`"top-left"`: The top left corner of the icon is placed closest to the anchor.</p>
3523
- * <p>`"top-right"`: The top right corner of the icon is placed closest to the anchor.</p>
3524
- * <p>`"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.</p>
3525
- * <p>`"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.</p>
3516
+ * Specifies which part of the icon is placed closest to the icons anchor position on the map.<br />
3517
+ * `"center"`: The center of the icon is placed closest to the anchor.<br />
3518
+ * `"left"`: The left side of the icon is placed closest to the anchor.<br />
3519
+ * `"right"`: The right side of the icon is placed closest to the anchor.<br />
3520
+ * `"top"`: The top of the icon is placed closest to the anchor.<br />
3521
+ * `"bottom"`: The bottom of the icon is placed closest to the anchor.<br />
3522
+ * `"top-left"`: The top left corner of the icon is placed closest to the anchor.<br />
3523
+ * `"top-right"`: The top right corner of the icon is placed closest to the anchor.<br />
3524
+ * `"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.<br />
3525
+ * `"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.<br />
3526
3526
  * Default `"center"`.
3527
3527
  * @default "center"
3528
3528
  */
@@ -3552,11 +3552,11 @@ declare namespace atlas {
3552
3552
  */
3553
3553
  ignorePlacement?: boolean;
3554
3554
  /**
3555
- * Text justification options.
3556
- * <p>`"auto"`: The text is aligned towards the anchor position.
3557
- * <p>`"left"`: The text is aligned to the left.
3558
- * <p>`"center"`: The text is centered.
3559
- * <p>`"right"`: The text is aligned to the right.
3555
+ * Text justification options.<br />
3556
+ * `"auto"`: The text is aligned towards the anchor position.<br />
3557
+ * `"left"`: The text is aligned to the left.<br />
3558
+ * `"center"`: The text is centered.<br />
3559
+ * `"right"`: The text is aligned to the right.<br />
3560
3560
  * Default `"center"`.
3561
3561
  * @default "center"
3562
3562
  */
@@ -3584,10 +3584,10 @@ declare namespace atlas {
3584
3584
  */
3585
3585
  padding?: number | PropertyValueSpecification<number>;
3586
3586
  /**
3587
- * Specifies the orientation of the text when the map is pitched.
3588
- * <p>`"auto"`: Automatically matches the value of `rotationAlignment`.</p>
3589
- * <p>`"map"`: The text is aligned to the plane of the map.</p>
3590
- * <p>`"viewport"`: The text is aligned to the plane of the viewport.</p>
3587
+ * Specifies the orientation of the text when the map is pitched.<br />
3588
+ * `"auto"`: Automatically matches the value of `rotationAlignment`.<br />
3589
+ * `"map"`: The text is aligned to the plane of the map.<br />
3590
+ * `"viewport"`: The text is aligned to the plane of the viewport.<br />
3591
3591
  * Default: `"auto"`
3592
3592
  * @default "auto"
3593
3593
  */
@@ -3607,13 +3607,13 @@ declare namespace atlas {
3607
3607
  rotation?: number | DataDrivenPropertyValueSpecification<number>;
3608
3608
  /**
3609
3609
  * In combination with the `placement` property of the `SymbolLayerOptions`,
3610
- * specifies the rotation behavior of the individual glyphs forming the text.
3611
- * <p>`"auto"`: When the `placement` is set to `"point"`, this is equivalent to `"map"`.
3612
- * When the `placement` is set to `"line"` this is equivalent to `"map"`.</p>
3613
- * <p>`"map"`: When the `placement` is set to `"point"`, aligns text east-west.
3614
- * When the `placement` is set to `"line"`, aligns text x-axes with the line.</p>
3615
- * <p>`"viewport"`: Produces glyphs whose x-axes are aligned with the x-axis of the viewport,
3616
- * regardless of the value of `placement`.</p>
3610
+ * specifies the rotation behavior of the individual glyphs forming the text.<br />
3611
+ * `"auto"`: When the `placement` is set to `"point"`, this is equivalent to `"map"`.
3612
+ * When the `placement` is set to `"line"` this is equivalent to `"map"`.<br />
3613
+ * `"map"`: When the `placement` is set to `"point"`, aligns text east-west.
3614
+ * When the `placement` is set to `"line"`, aligns text x-axes with the line.<br />
3615
+ * `"viewport"`: Produces glyphs whose x-axes are aligned with the x-axis of the viewport,
3616
+ * regardless of the value of `placement`.<br />
3617
3617
  * Default: `"auto"`
3618
3618
  * @default "auto"
3619
3619
  */
@@ -3623,16 +3623,16 @@ declare namespace atlas {
3623
3623
  * labels on the map. The renderer will attempt to place the label at each location,
3624
3624
  * in order, before moving onto the next label. Use `justify: "auto"` to choose text
3625
3625
  * justification based on anchor position. To apply an offset use the `radialOffset` or
3626
- * two-dimensional `offset` options.
3627
- * <p>`"center"`: The center of the icon is placed closest to the anchor.</p>
3628
- * <p>`"left"`: The left side of the icon is placed closest to the anchor.</p>
3629
- * <p>`"right"`: The right side of the icon is placed closest to the anchor.</p>
3630
- * <p>`"top"`: The top of the icon is placed closest to the anchor.</p>
3631
- * <p>`"bottom"`: The bottom of the icon is placed closest to the anchor.</p>
3632
- * <p>`"top-left"`: The top left corner of the icon is placed closest to the anchor.</p>
3633
- * <p>`"top-right"`: The top right corner of the icon is placed closest to the anchor.</p>
3634
- * <p>`"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.</p>
3635
- * <p>`"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.</p>
3626
+ * two-dimensional `offset` options.<br />
3627
+ * `"center"`: The center of the icon is placed closest to the anchor.<br />
3628
+ * `"left"`: The left side of the icon is placed closest to the anchor.<br />
3629
+ * `"right"`: The right side of the icon is placed closest to the anchor.<br />
3630
+ * `"top"`: The top of the icon is placed closest to the anchor.<br />
3631
+ * `"bottom"`: The bottom of the icon is placed closest to the anchor.<br />
3632
+ * `"top-left"`: The top left corner of the icon is placed closest to the anchor.<br />
3633
+ * `"top-right"`: The top right corner of the icon is placed closest to the anchor.<br />
3634
+ * `"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.<br />
3635
+ * `"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.<br />
3636
3636
  * Default: `undefined`
3637
3637
  * @default undefined
3638
3638
  */
@@ -3834,9 +3834,9 @@ declare namespace atlas {
3834
3834
  */
3835
3835
  export interface StyleControlOptions extends Options {
3836
3836
  /**
3837
- * The layout to display the styles in.
3838
- * <p>`"icons"`: A row of clickable icons for each style.</p>
3839
- * <p>`"list"`: A scrollable list with the icons and names for each style.</p>
3837
+ * The layout to display the styles in.<br />
3838
+ * `"icons"`: A row of clickable icons for each style.<br />
3839
+ * `"list"`: A scrollable list with the icons and names for each style.<br />
3840
3840
  * Default `"icons"`
3841
3841
  * @default "icons"
3842
3842
  */
@@ -3886,13 +3886,12 @@ declare namespace atlas {
3886
3886
 
3887
3887
  export interface TrafficControlOptions extends Options {
3888
3888
  /**
3889
- * The type of traffic flow to display:
3890
- * <p>"none" is to display no traffic flow data</p>
3891
- * <p>"relative" is the speed of the road relative to free-flow</p>
3892
- * <p>@deprecated "absolute" is the absolute speed of the road</p>
3893
- * <p>@deprecated "relative-delay" displays relative speed only where they differ from free-flow;
3894
- * false to stop displaying the traffic flow.</p>
3895
- * default `"relative"``
3889
+ * The type of traffic flow to display:<br />
3890
+ * `"none"` is to display no traffic flow data<br />
3891
+ * `"relative"` is the speed of the road relative to free-flow<br />
3892
+ * @deprecated `"absolute"` is the absolute speed of the road<br />
3893
+ * @deprecated `"relative-delay"` displays relative speed only where they differ from free-flow;
3894
+ * false to stop displaying the traffic flow.<br />
3896
3895
  * @default "relative"
3897
3896
  */
3898
3897
  flow?: "none" | "relative" | "absolute" | "relative-delay";
@@ -3929,10 +3928,10 @@ declare namespace atlas {
3929
3928
  */
3930
3929
  duration?: number;
3931
3930
  /**
3932
- * The type of animation.
3933
- * <p>"jump" is an immediate change.</p>
3934
- * <p>"ease" is a gradual change of the camera's settings.</p>
3935
- * <p>"fly" is a gradual change of the camera's settings following an arc resembling flight.</p>
3931
+ * The type of animation.<br />
3932
+ * `"jump"` is an immediate change.<br />
3933
+ * `"ease"` is a gradual change of the camera's settings.<br />
3934
+ * `"fly"` is a gradual change of the camera's settings following an arc resembling flight.<br />
3936
3935
  * Default `"jump"`.
3937
3936
  * @default "jump"
3938
3937
  */
@@ -4016,6 +4015,7 @@ declare namespace atlas {
4016
4015
  pitch?: number;
4017
4016
  /**
4018
4017
  * The minimum zoom level that the map can be zoomed out to during the animation. Must be between 0 and 24, and less than or equal to `maxZoom`.
4018
+ * Setting `minZoom` below 1 may result in an empty map when the zoom level is less than 1.
4019
4019
  * `default 1`
4020
4020
  * @default 1
4021
4021
  */
@@ -4228,9 +4228,9 @@ declare namespace atlas {
4228
4228
 
4229
4229
  export interface ElevationTileSourceOptions extends RasterTileSourceOptions {
4230
4230
  /**
4231
- * DEM tiles encoding format. Supported: `mapbox` or `terrarium`.
4232
- * <p>`"terrarium": Terrarium format PNG tiles. See https://aws.amazon.com/es/public-datasets/terrain/ for more info.</p>
4233
- * <p>`"mapbox": Mapbox Terrain RGB tiles. See https://www.mapbox.com/help/access-elevation-data/#mapbox-terrain-rgb for more info.</p>
4231
+ * DEM tiles encoding format. Supported: `mapbox` or `terrarium`.<br />
4232
+ * `"terrarium": Terrarium format PNG tiles. See https://aws.amazon.com/es/public-datasets/terrain/ for more info.<br />
4233
+ * `"mapbox": Mapbox Terrain RGB tiles. See https://www.mapbox.com/help/access-elevation-data/#mapbox-terrain-rgb for more info.<br />
4234
4234
  * default `mapbox`
4235
4235
  * @default mapbox
4236
4236
  */
@@ -4376,15 +4376,15 @@ declare namespace atlas {
4376
4376
  export interface LightOptions extends Options {
4377
4377
  /**
4378
4378
  * Specifies wether extruded geometries are lit relative to the map or viewport.
4379
- * Supported values:
4380
- * <p>`"map"`: The position of the light source is aligned to the rotation of the map.</p>
4381
- * <p>`"viewport"`: The position fo the light source is aligned to the rotation of the viewport.</p>
4379
+ * Supported values:<br />
4380
+ * `"map"`: The position of the light source is aligned to the rotation of the map.<br />
4381
+ * `"viewport"`: The position fo the light source is aligned to the rotation of the viewport.<br />
4382
4382
  * Default: `"map"`
4383
4383
  * @default "map"
4384
4384
  */
4385
4385
  anchor?: "map" | "viewport";
4386
4386
  /**
4387
- * Color tint for lighting extruded geometries
4387
+ * Color tint for lighting extruded geometries.
4388
4388
  * Default: `"#FFFFFF"`
4389
4389
  * @default "#FFFFFF"
4390
4390
  */
@@ -4521,13 +4521,13 @@ declare namespace atlas {
4521
4521
  */
4522
4522
  export interface TrafficOptions extends Options {
4523
4523
  /**
4524
- * The type of traffic flow to display:
4525
- * <p>"none" is to display no traffic flow data</p>
4526
- * <p>"relative" is the speed of the road relative to free-flow</p>
4527
- * <p>@deprecated "absolute" is the absolute speed of the road</p>
4528
- * <p>@deprecated "relative-delay" displays relative speed only where they differ from free-flow;
4529
- * false to stop displaying the traffic flow.</p>
4530
- * default `"none"``
4524
+ * The type of traffic flow to display:<br />
4525
+ * `"none"` is to display no traffic flow data<br />
4526
+ * `"relative"` is the speed of the road relative to free-flow<br />
4527
+ * @deprecated `"absolute"` is the absolute speed of the road<br />
4528
+ * @deprecated `"relative-delay"` displays relative speed only where they differ from free-flow;
4529
+ * false to stop displaying the traffic flow.<br />
4530
+ * default `"none"`
4531
4531
  * @default "none"
4532
4532
  */
4533
4533
  flow?: "none" | "relative" | "absolute" | "relative-delay";
@@ -5061,281 +5061,281 @@ declare namespace atlas {
5061
5061
  * @param eventType The data event name.
5062
5062
  * @param callback The event handler callback.
5063
5063
  */
5064
- add(eventType: "data" | "sourcedata" | "styledata", callback: (e: MapDataEvent) => void): void;
5064
+ add (eventType: "data" | "sourcedata" | "styledata", callback: (e: MapDataEvent) => void): void;
5065
5065
  /**
5066
5066
  * Adds an event to the map.
5067
5067
  * @param eventType The error event name.
5068
5068
  * @param callback The event handler callback.
5069
5069
  */
5070
- add(eventType: "error", callback: (e: MapErrorEvent) => void): void;
5070
+ add (eventType: "error", callback: (e: MapErrorEvent) => void): void;
5071
5071
  /**
5072
5072
  * Adds a touch event to the map.
5073
5073
  * @param eventType The touch event name.
5074
5074
  * @param callback The event handler callback.
5075
5075
  */
5076
- add(eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", callback: (e: MapTouchEvent) => void): void;
5076
+ add (eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", callback: (e: MapTouchEvent) => void): void;
5077
5077
  /**
5078
5078
  * Adds a mouse event to the map.
5079
5079
  * @param eventType The mouse event name.
5080
5080
  * @param callback The event handler callback.
5081
5081
  */
5082
- add(eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "contextmenu", callback: (e: MapMouseEvent) => void): void;
5082
+ add (eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "contextmenu", callback: (e: MapMouseEvent) => void): void;
5083
5083
  /**
5084
5084
  * Adds a style image missing event to the map.
5085
5085
  * @param eventType The style image missing event name.
5086
5086
  * @param callback The event handler callback.
5087
5087
  */
5088
- add(eventType: "styleimagemissing", callback: (e: string) => void): void;
5088
+ add (eventType: "styleimagemissing", callback: (e: string) => void): void;
5089
5089
  /**
5090
5090
  * Adds a wheel event to the map.
5091
5091
  * @param eventType The wheel event name.
5092
5092
  * @param callback The event handler callback.
5093
5093
  */
5094
- add(eventType: "stylechanged", callback: (e: StyleChangedEvent) => void): void;
5094
+ add (eventType: "stylechanged", callback: (e: StyleChangedEvent) => void): void;
5095
5095
  /**
5096
5096
  * Adds a mapConfiguration change event to the map.
5097
5097
  * @param eventType A mapConfiguration changed event name
5098
5098
  * @param callback The event handler callback
5099
5099
  */
5100
- add(eventType: "mapconfigurationchanged", callback: (e: MapConfiguration) => void): void;
5100
+ add (eventType: "mapconfigurationchanged", callback: (e: MapConfiguration) => void): void;
5101
5101
  /**
5102
5102
  * Adds a wheel event to the map.
5103
5103
  * @param eventType The wheel event name.
5104
5104
  * @param callback The event handler callback.
5105
5105
  */
5106
- add(eventType: "wheel", callback: (e: MapMouseWheelEvent) => void): void;
5106
+ add (eventType: "wheel", callback: (e: MapMouseWheelEvent) => void): void;
5107
5107
  /**
5108
5108
  * Adds an event to the map.
5109
5109
  * @param eventType The event name.
5110
5110
  * @param callback The event handler callback.
5111
5111
  */
5112
- add(eventType: "boxzoomstart" | "boxzoomend" | "dragstart" | "drag" | "dragend" | "idle" | "load" | "movestart" | "move" | "moveend" | "pitchstart" | "pitch" | "pitchend" | "ready" | "render" | "resize" | "rotatestart" | "rotate" | "rotateend" | "tokenacquired" | "zoomstart" | "zoom" | "zoomend", callback: (e: MapEvent) => void): void;
5112
+ add (eventType: "boxzoomstart" | "boxzoomend" | "dragstart" | "drag" | "dragend" | "idle" | "load" | "movestart" | "move" | "moveend" | "pitchstart" | "pitch" | "pitchend" | "ready" | "render" | "resize" | "rotatestart" | "rotate" | "rotateend" | "tokenacquired" | "zoomstart" | "zoom" | "zoomend", callback: (e: MapEvent) => void): void;
5113
5113
  /**
5114
5114
  * Adds an event to the map.
5115
5115
  * @param eventType The event name.
5116
5116
  * @param callback The event handler callback.
5117
5117
  */
5118
- add(eventType: "layeradded" | "layerremoved", callback: (e: atlas.layer.Layer) => void): void;
5118
+ add (eventType: "layeradded" | "layerremoved", callback: (e: atlas.layer.Layer) => void): void;
5119
5119
  /**
5120
5120
  * Adds an event to the map.
5121
5121
  * @param eventType The event name.
5122
5122
  * @param callback The event handler callback.
5123
5123
  */
5124
- add(eventType: "sourceadded" | "sourceremoved", callback: (e: atlas.source.Source) => void): void;
5124
+ add (eventType: "sourceadded" | "sourceremoved", callback: (e: atlas.source.Source) => void): void;
5125
5125
  /**
5126
5126
  * Adds an event to the DataSource(s).
5127
5127
  * @param eventType The event name.
5128
5128
  * @param target The DataSource(s) to add the event for.
5129
5129
  * @param callback The event handler callback.
5130
5130
  */
5131
- add(eventType: "datasourceupdated", target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: atlas.source.DataSource) => void): void;
5131
+ add (eventType: "datasourceupdated", target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: atlas.source.DataSource) => void): void;
5132
5132
  /**
5133
5133
  * Adds an event to the DataSource(s).
5134
5134
  * @param eventType The event name.
5135
5135
  * @param target The DataSource(s) to add the event for.
5136
5136
  * @param callback The event handler callback.
5137
5137
  */
5138
- add(eventType: "dataadded" | "dataremoved", target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: Shape[]) => void): void;
5138
+ add (eventType: "dataadded" | "dataremoved", target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: Shape[]) => void): void;
5139
5139
  /**
5140
5140
  * Adds an event to the HtmlMarker(s).
5141
5141
  * @param eventType The event name.
5142
5142
  * @param target The HtmlMarker(s) to add the event for.
5143
5143
  * @param callback The event handler callback.
5144
5144
  */
5145
- add(eventType: "click" | "contextmenu" | "dblclick" | "drag" | "dragstart" | "dragend" | "keydown" | "keypress" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup", target: HtmlMarker | HtmlMarker[], callback: (e: TargetedEvent) => void): void;
5145
+ add (eventType: "click" | "contextmenu" | "dblclick" | "drag" | "dragstart" | "dragend" | "keydown" | "keypress" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup", target: HtmlMarker | HtmlMarker[], callback: (e: TargetedEvent) => void): void;
5146
5146
  /**
5147
5147
  * Adds a touch event to the Layer(s).
5148
5148
  * @param eventType The event name.
5149
5149
  * @param target The Layer(s) to add the event for.
5150
5150
  * @param callback The event handler callback.
5151
5151
  */
5152
- add(eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapTouchEvent) => void): void;
5152
+ add (eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapTouchEvent) => void): void;
5153
5153
  /**
5154
5154
  * Adds an event to the Layer(s).
5155
5155
  * @param eventType The event name.
5156
5156
  * @param target The Layer(s) to add the event for.
5157
5157
  * @param callback The event handler callback.
5158
5158
  */
5159
- add(eventType: "layeradded" | "layerremoved", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: atlas.layer.Layer) => void): void;
5159
+ add (eventType: "layeradded" | "layerremoved", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: atlas.layer.Layer) => void): void;
5160
5160
  /**
5161
5161
  * Adds a mouse event to the Layer(s).
5162
5162
  * @param eventType The event name.
5163
5163
  * @param target The Layer(s) to add the event for.
5164
5164
  * @param callback The event handler callback.
5165
5165
  */
5166
- add(eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "mouseenter" | "mouseleave" | "contextmenu", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapMouseEvent) => void): void;
5166
+ add (eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "mouseenter" | "mouseleave" | "contextmenu", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapMouseEvent) => void): void;
5167
5167
  /**
5168
5168
  * Adds a wheel event to the Layer(s).
5169
5169
  * @param eventType The event name.
5170
5170
  * @param target The Layer(s) to add the event for.
5171
5171
  * @param callback The event handler callback.
5172
5172
  */
5173
- add(eventType: "wheel", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapMouseWheelEvent) => void): void;
5173
+ add (eventType: "wheel", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapMouseWheelEvent) => void): void;
5174
5174
  /**
5175
5175
  * Adds an event to the Popup(s).
5176
5176
  * @param eventType The event name.
5177
5177
  * @param target The Popup(s) to add the event for.
5178
5178
  * @param callback The event handler callback.
5179
5179
  */
5180
- add(eventType: "drag" | "dragend" | "dragstart" | "open" | "close", target: Popup | Popup[], callback: (e: TargetedEvent) => void): void;
5180
+ add (eventType: "drag" | "dragend" | "dragstart" | "open" | "close", target: Popup | Popup[], callback: (e: TargetedEvent) => void): void;
5181
5181
  /**
5182
5182
  * Adds an event to the StyleControl
5183
5183
  * @param eventType The event name.
5184
5184
  * @param target The StyleControl to add the event for.
5185
5185
  * @param callback The event handler callback.
5186
5186
  */
5187
- add(eventType: "styleselected", target: atlas.control.StyleControl, callback: (e: string) => void): void;
5187
+ add (eventType: "styleselected", target: atlas.control.StyleControl, callback: (e: string) => void): void;
5188
5188
  /**
5189
5189
  * Adds an event to the Shape(s).
5190
5190
  * @param eventType The event name.
5191
5191
  * @param target The Shape(s) to add the event for.
5192
5192
  * @param callback The event handler callback.
5193
5193
  */
5194
- add(eventType: "shapechanged", target: Shape | Shape[], callback: (e: Shape) => void): void;
5194
+ add (eventType: "shapechanged", target: Shape | Shape[], callback: (e: Shape) => void): void;
5195
5195
  /**
5196
5196
  * Adds an event to the Source(s).
5197
5197
  * @param eventType The event name.
5198
5198
  * @param target The Source(s) to add the event for.
5199
5199
  * @param callback The event handler callback.
5200
5200
  */
5201
- add(eventType: "sourceadded" | "sourceremoved", target: atlas.source.Source | atlas.source.Source[], callback: (e: atlas.source.Source) => void): void;
5201
+ add (eventType: "sourceadded" | "sourceremoved", target: atlas.source.Source | atlas.source.Source[], callback: (e: atlas.source.Source) => void): void;
5202
5202
  /**
5203
5203
  * Adds a data event to the map.
5204
5204
  * @param eventType The data event name.
5205
5205
  * @param callback The event handler callback.
5206
5206
  */
5207
- addOnce(eventType: "data" | "sourcedata" | "styledata", callback: (e: MapDataEvent) => void): void;
5207
+ addOnce (eventType: "data" | "sourcedata" | "styledata", callback: (e: MapDataEvent) => void): void;
5208
5208
  /**
5209
5209
  * Adds an event to the map.
5210
5210
  * @param eventType The error event name.
5211
5211
  * @param callback The event handler callback.
5212
5212
  */
5213
- addOnce(eventType: "error", callback: (e: MapErrorEvent) => void): void;
5213
+ addOnce (eventType: "error", callback: (e: MapErrorEvent) => void): void;
5214
5214
  /**
5215
5215
  * Adds a touch event to the map.
5216
5216
  * @param eventType The touch event name.
5217
5217
  * @param callback The event handler callback.
5218
5218
  */
5219
- addOnce(eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", callback: (e: MapTouchEvent) => void): void;
5219
+ addOnce (eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", callback: (e: MapTouchEvent) => void): void;
5220
5220
  /**
5221
5221
  * Adds an event to the map.
5222
5222
  * @param eventType The event name.
5223
5223
  * @param callback The event handler callback.
5224
5224
  */
5225
- addOnce(eventType: "layeradded" | "layerremoved", callback: (e: atlas.layer.Layer) => void): void;
5225
+ addOnce (eventType: "layeradded" | "layerremoved", callback: (e: atlas.layer.Layer) => void): void;
5226
5226
  /**
5227
5227
  * Adds a mouse event to the map.
5228
5228
  * @param eventType The mouse event name.
5229
5229
  * @param callback The event handler callback.
5230
5230
  */
5231
- addOnce(eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "contextmenu", callback: (e: MapMouseEvent) => void): void;
5231
+ addOnce (eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "contextmenu", callback: (e: MapMouseEvent) => void): void;
5232
5232
  /**
5233
5233
  * Adds an event to the map.
5234
5234
  * @param eventType The event name.
5235
5235
  * @param callback The event handler callback.
5236
5236
  */
5237
- addOnce(eventType: "sourceadded" | "sourceremoved", callback: (e: atlas.source.Source) => void): void;
5237
+ addOnce (eventType: "sourceadded" | "sourceremoved", callback: (e: atlas.source.Source) => void): void;
5238
5238
  /**
5239
5239
  * Adds a style image missing event to the map.
5240
5240
  * @param eventType The style image missing event name.
5241
5241
  * @param callback The event handler callback.
5242
5242
  */
5243
- addOnce(eventType: "styleimagemissing", callback: (e: string) => void): void;
5243
+ addOnce (eventType: "styleimagemissing", callback: (e: string) => void): void;
5244
5244
  /**
5245
5245
  * Adds a wheel event to the map.
5246
5246
  * @param eventType The wheel event name.
5247
5247
  * @param callback The event handler callback.
5248
5248
  */
5249
- addOnce(eventType: "stylechanged", callback: (e: StyleChangedEvent) => void): void;
5249
+ addOnce (eventType: "stylechanged", callback: (e: StyleChangedEvent) => void): void;
5250
5250
  /**
5251
5251
  * Adds a wheel event to the map.
5252
5252
  * @param eventType The wheel event name.
5253
5253
  * @param callback The event handler callback.
5254
5254
  */
5255
- addOnce(eventType: "wheel", callback: (e: MapMouseWheelEvent) => void): void;
5255
+ addOnce (eventType: "wheel", callback: (e: MapMouseWheelEvent) => void): void;
5256
5256
  /**
5257
5257
  * Adds an event to the map.
5258
5258
  * @param eventType The event name.
5259
5259
  * @param callback The event handler callback.
5260
5260
  */
5261
- addOnce(eventType: "boxzoomstart" | "boxzoomend" | "dragstart" | "drag" | "dragend" | "idle" | "load" | "movestart" | "move" | "moveend" | "pitchstart" | "pitch" | "pitchend" | "ready" | "render" | "resize" | "rotatestart" | "rotate" | "rotateend" | "tokenacquired" | "zoomstart" | "zoom" | "zoomend", callback: (e: MapEvent) => void): void;
5261
+ addOnce (eventType: "boxzoomstart" | "boxzoomend" | "dragstart" | "drag" | "dragend" | "idle" | "load" | "movestart" | "move" | "moveend" | "pitchstart" | "pitch" | "pitchend" | "ready" | "render" | "resize" | "rotatestart" | "rotate" | "rotateend" | "tokenacquired" | "zoomstart" | "zoom" | "zoomend", callback: (e: MapEvent) => void): void;
5262
5262
  /**
5263
5263
  * Adds an event to the DataSource.
5264
5264
  * @param eventType The event name.
5265
5265
  * @param target The DataSource to add the event for.
5266
5266
  * @param callback The event handler callback.
5267
5267
  */
5268
- addOnce(eventType: "datasourceupdated", target: atlas.source.DataSource, callback: (e: atlas.source.DataSource) => void): void;
5268
+ addOnce (eventType: "datasourceupdated", target: atlas.source.DataSource, callback: (e: atlas.source.DataSource) => void): void;
5269
5269
  /**
5270
5270
  * Adds an event to the DataSource.
5271
5271
  * @param eventType The event name.
5272
5272
  * @param target The DataSource to add the event for.
5273
5273
  * @param callback The event handler callback.
5274
5274
  */
5275
- addOnce(eventType: "dataadded" | "dataremoved", target: atlas.source.DataSource, callback: (e: Shape[]) => void): void;
5275
+ addOnce (eventType: "dataadded" | "dataremoved", target: atlas.source.DataSource, callback: (e: Shape[]) => void): void;
5276
5276
  /**
5277
5277
  * Adds an event to the HtmlMarker.
5278
5278
  * @param eventType The event name.
5279
5279
  * @param target The HtmlMarker to add the event for.
5280
5280
  * @param callback The event handler callback.
5281
5281
  */
5282
- addOnce(eventType: "click" | "contextmenu" | "dblclick" | "drag" | "dragstart" | "dragend" | "keydown" | "keypress" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup", target: HtmlMarker, callback: (e: TargetedEvent) => void): void;
5282
+ addOnce (eventType: "click" | "contextmenu" | "dblclick" | "drag" | "dragstart" | "dragend" | "keydown" | "keypress" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup", target: HtmlMarker, callback: (e: TargetedEvent) => void): void;
5283
5283
  /**
5284
5284
  * Adds a touch event to the Layer.
5285
5285
  * @param eventType The touch event name.
5286
5286
  * @param target The Layer to add the event for.
5287
5287
  * @param callback The event handler callback.
5288
5288
  */
5289
- addOnce(eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", target: atlas.layer.Layer, callback: (e: MapTouchEvent) => void): void;
5289
+ addOnce (eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", target: atlas.layer.Layer, callback: (e: MapTouchEvent) => void): void;
5290
5290
  /**
5291
5291
  * Adds a touch event to the Layer.
5292
5292
  * @param eventType The touch event name.
5293
5293
  * @param target The Layer to add the event for.
5294
5294
  * @param callback The event handler callback.
5295
5295
  */
5296
- addOnce(eventType: "layeradded" | "layerremoved", target: atlas.layer.Layer, callback: (e: atlas.layer.Layer) => void): void;
5296
+ addOnce (eventType: "layeradded" | "layerremoved", target: atlas.layer.Layer, callback: (e: atlas.layer.Layer) => void): void;
5297
5297
  /**
5298
5298
  * Adds a mouse event to the Layer.
5299
5299
  * @param eventType The mouse event name.
5300
5300
  * @param target The Layer to add the event for.
5301
5301
  * @param callback The event handler callback.
5302
5302
  */
5303
- addOnce(eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "mouseenter" | "mouseleave" | "contextmenu", target: atlas.layer.Layer, callback: (e: MapMouseEvent) => void): void;
5303
+ addOnce (eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "mouseenter" | "mouseleave" | "contextmenu", target: atlas.layer.Layer, callback: (e: MapMouseEvent) => void): void;
5304
5304
  /**
5305
5305
  * Adds a wheel event to the Layer.
5306
5306
  * @param eventType The wheel event name.
5307
5307
  * @param target The Layer to add the event for.
5308
5308
  * @param callback The event handler callback.
5309
5309
  */
5310
- addOnce(eventType: "wheel", target: atlas.layer.Layer, callback: (e: MapMouseWheelEvent) => void): void;
5310
+ addOnce (eventType: "wheel", target: atlas.layer.Layer, callback: (e: MapMouseWheelEvent) => void): void;
5311
5311
  /**
5312
5312
  * Adds an event to the Popup.
5313
5313
  * @param eventType The event name.
5314
5314
  * @param target The Popup to add the event for.
5315
5315
  * @param callback The event handler callback.
5316
5316
  */
5317
- addOnce(eventType: "drag" | "dragend" | "dragstart" | "open" | "close", target: Popup, callback: (e: TargetedEvent) => void): void;
5317
+ addOnce (eventType: "drag" | "dragend" | "dragstart" | "open" | "close", target: Popup, callback: (e: TargetedEvent) => void): void;
5318
5318
  /**
5319
5319
  * Adds an event to the StyleControl
5320
5320
  * @param eventType The event name.
5321
5321
  * @param target The StyleControl to add the event for.
5322
5322
  * @param callback The event handler callback.
5323
5323
  */
5324
- addOnce(eventType: "styleselected", target: atlas.control.StyleControl, callback: (e: string) => void): void;
5324
+ addOnce (eventType: "styleselected", target: atlas.control.StyleControl, callback: (e: string) => void): void;
5325
5325
  /**
5326
5326
  * Adds an event to the Shape.
5327
5327
  * @param eventType The event name.
5328
5328
  * @param target The Shape to add the event for.
5329
5329
  * @param callback The event handler callback.
5330
5330
  */
5331
- addOnce(eventType: "shapechanged", target: Shape, callback: (e: Shape) => void): void;
5331
+ addOnce (eventType: "shapechanged", target: Shape, callback: (e: Shape) => void): void;
5332
5332
  /**
5333
5333
  * Adds an event to the Source.
5334
5334
  * @param eventType The event name.
5335
5335
  * @param target The Source to add the event for.
5336
5336
  * @param callback The event handler callback.
5337
5337
  */
5338
- addOnce(eventType: "sourceadded" | "sourceremoved", target: atlas.source.Source, callback: (e: atlas.source.Source) => void): void;
5338
+ addOnce (eventType: "sourceadded" | "sourceremoved", target: atlas.source.Source, callback: (e: atlas.source.Source) => void): void;
5339
5339
  /**
5340
5340
  * Adds a listener to a single layer. Will add the event listeners to the layer's underlying Mapbox layers too.
5341
5341
  * @private
@@ -5352,7 +5352,7 @@ declare namespace atlas {
5352
5352
  * @param eventType The name of the event to invoke.
5353
5353
  * @param args The data to be passed to the callbacks.
5354
5354
  */
5355
- invoke(eventType: string, args: any): any;
5355
+ invoke (eventType: string, args: any): any;
5356
5356
  /**
5357
5357
  * Invokes an event of the target.
5358
5358
  * This causes all event handlers on the target with the specified event name to be called.
@@ -5360,7 +5360,7 @@ declare namespace atlas {
5360
5360
  * @param target The target to invoke the event on. Supported target types are Layer, HtmlMarker, and Popup.
5361
5361
  * @param args The data to be passed to the callbacks. The data can be `null` but cannot be `undefined`.
5362
5362
  */
5363
- invoke(eventType: string, target: any, args: any): any;
5363
+ invoke (eventType: string, target: any, args: any): any;
5364
5364
  /**
5365
5365
  * Invokes all listeners for the given event and layer.
5366
5366
  * @param eventType The event type to invoke.
@@ -5374,56 +5374,56 @@ declare namespace atlas {
5374
5374
  * @param eventType The event name.
5375
5375
  * @param callback The event handler callback.
5376
5376
  */
5377
- remove(eventType: string, callback: (e: void | atlas.layer.Layer | MapEvent | MapDataEvent | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.source.Source | string | MapConfiguration) => void): void;
5377
+ remove (eventType: string, callback: (e: void | atlas.layer.Layer | MapEvent | MapDataEvent | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.source.Source | string | MapConfiguration) => void): void;
5378
5378
  /**
5379
5379
  * Removes an event listener from the DataSource(s).
5380
5380
  * @param eventType The event name.
5381
5381
  * @param target The DataSource(s) to remove the event for.
5382
5382
  * @param callback The event handler callback.
5383
5383
  */
5384
- remove(eventType: string, target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: atlas.source.DataSource | Shape[]) => void): void;
5384
+ remove (eventType: string, target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: atlas.source.DataSource | Shape[]) => void): void;
5385
5385
  /**
5386
5386
  * Removes an event listener from the HtmlMarker(s).
5387
5387
  * @param eventType The event name.
5388
5388
  * @param target The HtmlMarker(s) to remove the event for.
5389
5389
  * @param callback The event handler callback.
5390
5390
  */
5391
- remove(eventType: string, target: HtmlMarker | HtmlMarker[], callback: (e: TargetedEvent) => void): void;
5391
+ remove (eventType: string, target: HtmlMarker | HtmlMarker[], callback: (e: TargetedEvent) => void): void;
5392
5392
  /**
5393
5393
  * Removes an event listener from the Layer(s).
5394
5394
  * @param eventType The event name.
5395
5395
  * @param target The Layer(s) to remove the event for.
5396
5396
  * @param callback The event handler callback.
5397
5397
  */
5398
- remove(eventType: string, target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: void | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.layer.Layer) => void): void;
5398
+ remove (eventType: string, target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: void | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.layer.Layer) => void): void;
5399
5399
  /**
5400
5400
  * Removes an event listener from the Popup(s).
5401
5401
  * @param eventType The event name.
5402
5402
  * @param target The Popup(s) to remove the event for.
5403
5403
  * @param callback The event handler callback.
5404
5404
  */
5405
- remove(eventType: string, target: Popup | Popup[], callback: (e: TargetedEvent) => void): void;
5405
+ remove (eventType: string, target: Popup | Popup[], callback: (e: TargetedEvent) => void): void;
5406
5406
  /**
5407
5407
  * Removes an event to the StyleControl
5408
5408
  * @param eventType The event name.
5409
5409
  * @param target The StyleControl to add the event for.
5410
5410
  * @param callback The event handler callback.
5411
5411
  */
5412
- remove(eventType: string, target: atlas.control.StyleControl, callback: (e: string) => void): void;
5412
+ remove (eventType: string, target: atlas.control.StyleControl, callback: (e: string) => void): void;
5413
5413
  /**
5414
5414
  * Removes an event listener from the Shape(s).
5415
5415
  * @param eventType The event name.
5416
5416
  * @param target The Shapes(s) to remove the event for.
5417
5417
  * @param callback The event handler callback.
5418
5418
  */
5419
- remove(eventType: string, target: Shape | Shape[], callback: (e: Shape) => void): void;
5419
+ remove (eventType: string, target: Shape | Shape[], callback: (e: Shape) => void): void;
5420
5420
  /**
5421
5421
  * Removes an event listener from the Source(s).
5422
5422
  * @param eventType The event name.
5423
5423
  * @param target The Source(s) to remove the event for.
5424
5424
  * @param callback The event handler callback.
5425
5425
  */
5426
- remove(eventType: string, target: atlas.source.Source | atlas.source.Source[], callback: (e: atlas.source.Source) => void): void;
5426
+ remove (eventType: string, target: atlas.source.Source | atlas.source.Source[], callback: (e: atlas.source.Source) => void): void;
5427
5427
  }
5428
5428
 
5429
5429
  /**
@@ -5560,20 +5560,20 @@ declare namespace atlas {
5560
5560
  */
5561
5561
  move(layer: string | atlas.layer.Layer, before?: string | atlas.layer.Layer): void;
5562
5562
  /**
5563
- * Retrieve all Shapes and GeoJSON features that are visible on the map that are in a DataSource or VectorTileSource.
5564
- * Shape objects are editable, while Feature objects are not editable and either reside in a VectorTileSource or represent a cluster point.
5565
- * Clusters have the following properties:
5566
- * <p>cluster: `boolean` - Indicates that the point is a cluster.
5567
- * This will be set to true if Point object represents a cluster.
5568
- * All other point objects are unlikely to have this value unless
5569
- * a property with this same name was added to the Point property data from your app.</p>
5570
- * <p>cluster_id: `string` - A unique id for the cluster.</p>
5571
- * <p>point_count: `number` - The number of points inside the cluster.</p>
5572
- * <p>point_count_abbreviated: `string` - An abbreviated string version of the point count. i.e. `"10K"`</p>
5573
- * Features/Shapes that are not visible or who's layer zoom range does not include the current zoom level will not be returned.
5574
- * Symbol features/Shapes that have been hidden due to text or icon collisions are not included.
5575
- * Features/Shapes from all other layers are included even if they have no contribution to the map rendering, e.g. alpha set to zero.
5576
- * The topmost rendered features/shapes appears first in the returned array and subsequent features are sorted in descending z-order.
5563
+ * Retrieve all Shapes and GeoJSON features that are visible on the map that are in a DataSource or VectorTileSource.
5564
+ * Shape objects are editable, while Feature objects are not editable and either reside in a VectorTileSource or represent a cluster point.
5565
+ * Clusters have the following properties:<br />
5566
+ * `cluster`: `boolean` - Indicates that the point is a cluster.
5567
+ * This will be set to true if Point object represents a cluster.
5568
+ * All other point objects are unlikely to have this value unless
5569
+ * a property with this same name was added to the Point property data from your app.<br />
5570
+ * `cluster_id`: `string` - A unique id for the cluster.<br />
5571
+ * `point_count`: `number` - The number of points inside the cluster.<br />
5572
+ * `point_count_abbreviated`: `string` - An abbreviated string version of the point count. i.e. `"10K"`<br />
5573
+ * Features/Shapes that are not visible or who's layer zoom range does not include the current zoom level will not be returned.
5574
+ * Symbol features/Shapes that have been hidden due to text or icon collisions are not included.
5575
+ * Features/Shapes from all other layers are included even if they have no contribution to the map rendering, e.g. alpha set to zero.
5576
+ * The topmost rendered features/shapes appears first in the returned array and subsequent features are sorted in descending z-order.
5577
5577
  * @param geometry A Position, Point, or BoundingBox that returned features must intersect. If not specified the whole visible world is used.
5578
5578
  * @param layers An array of layers or their ids to limit the query to.
5579
5579
  * @param filter A expression to filter the returned features by.
@@ -5697,14 +5697,14 @@ declare namespace atlas {
5697
5697
  */
5698
5698
  size: number;
5699
5699
  /**
5700
- * The state of the tile.
5701
- * <p>`"loading"`: Tile data is in the process of loading.</p>
5702
- * <p>`"loaded"`: Tile data has been loaded.</p>
5703
- * <p>`"reloading"`: Tile data has been loaded and is being updated.</p>
5704
- * <p>`"unloaded"`: The data has been deleted.</p>
5705
- * <p>`"errored"`: Tile data was not loaded because of an error.<p>
5706
- * <p>`"expired"`: Tile data was previously loaded, but has expired per its HTTP headers
5707
- * and is in the process of refreshing.</p>
5700
+ * The state of the tile.<br />
5701
+ * `"loading"`: Tile data is in the process of loading.<br />
5702
+ * `"loaded"`: Tile data has been loaded.<br />
5703
+ * `"reloading"`: Tile data has been loaded and is being updated.<br />
5704
+ * `"unloaded"`: The data has been deleted.<br />
5705
+ * `"errored"`: Tile data was not loaded because of an error.<br />
5706
+ * `"expired"`: Tile data was previously loaded, but has expired per its HTTP headers
5707
+ * and is in the process of refreshing.
5708
5708
  */
5709
5709
  state: "loading" | "loaded" | "reloading" | "unloaded" | "errored" | "expired";
5710
5710
  }
@@ -5837,14 +5837,14 @@ declare namespace atlas {
5837
5837
  * An array of Shape and Feature objects that the mouse event occurred on.
5838
5838
  * Shape objects are editable, while Feature objects are not editable
5839
5839
  * and either reside in a VectorTileSource or represent a cluster point.
5840
- * Clusters have the following properties:
5841
- * <p>cluster: `boolean` - Indicates that the point is a cluster.
5840
+ * Clusters have the following properties:<br />
5841
+ * `cluster`: `boolean` - Indicates that the point is a cluster.
5842
5842
  * This will be set to true if Point object represents a cluster.
5843
5843
  * All other point objects are unlikely to have this value unless
5844
- * a property with this same name was added to the Point property data from your app.</p>
5845
- * <p>cluster_id: `string` - A unique id for the cluster.</p>
5846
- * <p>point_count: `number` - The number of points inside the cluster.</p>
5847
- * <p>point_count_abbreviated: `string` - An abbreviated string version of the point count. i.e. `"10K"`</p>
5844
+ * a property with this same name was added to the Point property data from your app.<br />
5845
+ * `cluster_id`: `string` - A unique id for the cluster.<br />
5846
+ * `point_count`: `number` - The number of points inside the cluster.<br />
5847
+ * `point_count_abbreviated`: `string` - An abbreviated string version of the point count. i.e. `"10K"`
5848
5848
  */
5849
5849
  shapes?: Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape>;
5850
5850
  /**