azure-maps-control 3.2.0 → 3.3.0
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.
- package/dist/atlas-core-bare-snr-min.js +1 -1
- package/dist/atlas-core-bare-snr.js +419 -277
- package/dist/atlas-core-bare.js +419 -277
- package/dist/atlas-core-bare.min.js +1 -1
- package/dist/atlas-core-snr.js +842 -534
- package/dist/atlas-core.js +842 -534
- package/dist/atlas-core.min.js +3 -3
- package/dist/atlas-esm.js +842 -534
- package/dist/atlas-esm.min.js +3 -3
- package/dist/atlas.css +45 -6
- package/dist/atlas.js +842 -534
- package/dist/atlas.min.css +1 -1
- package/dist/atlas.min.js +3 -3
- package/package.json +98 -98
- package/thirdpartynotices.txt +0 -0
- package/typings/index.d.ts +485 -475
package/typings/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
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,34 @@ 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
|
+
/**
|
|
999
|
+
* Gets the options of the layer.
|
|
1000
|
+
*/
|
|
1001
|
+
abstract getOptions (): LayerOptions;
|
|
1002
|
+
/**
|
|
1003
|
+
* Sets the options of the layer.
|
|
1004
|
+
* @param options The new options of the layer.
|
|
1005
|
+
*/
|
|
1006
|
+
abstract setOptions (options: LayerOptions): void;
|
|
998
1007
|
}
|
|
999
1008
|
|
|
1000
1009
|
/**
|
|
@@ -1008,23 +1017,23 @@ declare namespace atlas {
|
|
|
1008
1017
|
* @param id The id of the layer. If not specified a random one will be generated.
|
|
1009
1018
|
* @param options The options of the line layer.
|
|
1010
1019
|
*/
|
|
1011
|
-
constructor(source: string | atlas.source.Source, id?: string, options?: HeatMapLayerOptions);
|
|
1020
|
+
constructor (source: string | atlas.source.Source, id?: string, options?: HeatMapLayerOptions);
|
|
1012
1021
|
|
|
1013
1022
|
/**
|
|
1014
1023
|
* Gets the options of the heat map layer.
|
|
1015
1024
|
*/
|
|
1016
|
-
getOptions(): HeatMapLayerOptions;
|
|
1025
|
+
getOptions (): HeatMapLayerOptions;
|
|
1017
1026
|
|
|
1018
1027
|
/**
|
|
1019
1028
|
* Gets the source provided when creating the layer.
|
|
1020
1029
|
*/
|
|
1021
|
-
getSource(): string | atlas.source.Source;
|
|
1030
|
+
getSource (): string | atlas.source.Source;
|
|
1022
1031
|
|
|
1023
1032
|
/**
|
|
1024
1033
|
* Sets the options of the heat map layer.
|
|
1025
1034
|
* @param newOptions The new options of the heat map layer.
|
|
1026
1035
|
*/
|
|
1027
|
-
setOptions(options: HeatMapLayerOptions): void;
|
|
1036
|
+
setOptions (options: HeatMapLayerOptions): void;
|
|
1028
1037
|
|
|
1029
1038
|
}
|
|
1030
1039
|
|
|
@@ -1037,26 +1046,26 @@ declare namespace atlas {
|
|
|
1037
1046
|
* @param options The options for the tile layer.
|
|
1038
1047
|
* @param id The id of the layer. If not specified a random one will be generated.
|
|
1039
1048
|
*/
|
|
1040
|
-
constructor(options: ImageLayerOptions, id?: string);
|
|
1049
|
+
constructor (options: ImageLayerOptions, id?: string);
|
|
1041
1050
|
/**
|
|
1042
1051
|
* Gets the options of the tile layer.
|
|
1043
1052
|
*/
|
|
1044
|
-
getOptions(): ImageLayerOptions;
|
|
1053
|
+
getOptions (): ImageLayerOptions;
|
|
1045
1054
|
/**
|
|
1046
1055
|
* Sets the options of the tile layer.
|
|
1047
1056
|
* @param newOptions The new options of the tile layer.
|
|
1048
1057
|
*/
|
|
1049
|
-
setOptions(options: ImageLayerOptions): void;
|
|
1058
|
+
setOptions (options: ImageLayerOptions): void;
|
|
1050
1059
|
/**
|
|
1051
1060
|
* Calculates the approximate positions that align with the provided pixels from the source image.
|
|
1052
1061
|
* @param pixels the provided pixels from the source image used to calculate the positions
|
|
1053
1062
|
*/
|
|
1054
|
-
getPositions(pixels: Pixel[]): Promise<atlas.data.Position[]>;
|
|
1063
|
+
getPositions (pixels: Pixel[]): Promise<atlas.data.Position[]>;
|
|
1055
1064
|
/**
|
|
1056
1065
|
* Calculates the approximate pixels on the source image that align with the provided positions.
|
|
1057
1066
|
* @param positions the provided positions from the source image used to calculate the pixels
|
|
1058
1067
|
*/
|
|
1059
|
-
getPixels(positions: atlas.data.Position[]): Promise<Pixel[]>;
|
|
1068
|
+
getPixels (positions: atlas.data.Position[]): Promise<Pixel[]>;
|
|
1060
1069
|
/**
|
|
1061
1070
|
* Calculates coordinates for a rotated image layer when provided with the bounding box edges and rotation value.
|
|
1062
1071
|
* 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 +1075,7 @@ declare namespace atlas {
|
|
|
1066
1075
|
* @param west The west edge of the bounding box.
|
|
1067
1076
|
* @param rotation Clockwise rotation in degrees
|
|
1068
1077
|
*/
|
|
1069
|
-
static getCoordinatesFromEdges(north: number, south: number, east: number, west: number, rotation?: number): atlas.data.Position[];
|
|
1078
|
+
static getCoordinatesFromEdges (north: number, south: number, east: number, west: number, rotation?: number): atlas.data.Position[];
|
|
1070
1079
|
/**
|
|
1071
1080
|
* Calculates coordinates for a rotated image layer when provided with the bounding box edges and rotation value.
|
|
1072
1081
|
* 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 +1085,7 @@ declare namespace atlas {
|
|
|
1076
1085
|
* @param west The west edge of the bounding box.
|
|
1077
1086
|
* @param rotation Clockwise rotation in degrees
|
|
1078
1087
|
*/
|
|
1079
|
-
static getCoordinatesFromEdges(north: number, south: number, east: number, west: number, rotation?: number): atlas.data.Position[];
|
|
1088
|
+
static getCoordinatesFromEdges (north: number, south: number, east: number, west: number, rotation?: number): atlas.data.Position[];
|
|
1080
1089
|
}
|
|
1081
1090
|
|
|
1082
1091
|
/**
|
|
@@ -1091,20 +1100,20 @@ declare namespace atlas {
|
|
|
1091
1100
|
* @param id The id of the layer. If not specified a random one will be generated.
|
|
1092
1101
|
* @param options The options of the line layer.
|
|
1093
1102
|
*/
|
|
1094
|
-
constructor(source: string | atlas.source.Source, id?: string, options?: LineLayerOptions);
|
|
1103
|
+
constructor (source: string | atlas.source.Source, id?: string, options?: LineLayerOptions);
|
|
1095
1104
|
/**
|
|
1096
1105
|
* Gets the options of the line layer.
|
|
1097
1106
|
*/
|
|
1098
|
-
getOptions(): LineLayerOptions;
|
|
1107
|
+
getOptions (): LineLayerOptions;
|
|
1099
1108
|
/**
|
|
1100
1109
|
* Gets the source provided when creating the layer.
|
|
1101
1110
|
*/
|
|
1102
|
-
getSource(): string | atlas.source.Source;
|
|
1111
|
+
getSource (): string | atlas.source.Source;
|
|
1103
1112
|
/**
|
|
1104
1113
|
* Sets the options of the line layer.
|
|
1105
1114
|
* @param options The new options of the line layer.
|
|
1106
1115
|
*/
|
|
1107
|
-
setOptions(options: LineLayerOptions): void;
|
|
1116
|
+
setOptions (options: LineLayerOptions): void;
|
|
1108
1117
|
}
|
|
1109
1118
|
|
|
1110
1119
|
/**
|
|
@@ -1118,20 +1127,20 @@ declare namespace atlas {
|
|
|
1118
1127
|
* @param id The id of the layer. If not specified a random one will be generated.
|
|
1119
1128
|
* @param options The options of the polygon extrusion layer.
|
|
1120
1129
|
*/
|
|
1121
|
-
constructor(source: string | atlas.source.Source, id?: string, options?: PolygonExtrusionLayerOptions);
|
|
1130
|
+
constructor (source: string | atlas.source.Source, id?: string, options?: PolygonExtrusionLayerOptions);
|
|
1122
1131
|
/**
|
|
1123
1132
|
* Gets the options of the polygon layer.
|
|
1124
1133
|
*/
|
|
1125
|
-
getOptions(): PolygonExtrusionLayerOptions;
|
|
1134
|
+
getOptions (): PolygonExtrusionLayerOptions;
|
|
1126
1135
|
/**
|
|
1127
1136
|
* Gets the source provided when creating the layer.
|
|
1128
1137
|
*/
|
|
1129
|
-
getSource(): string | atlas.source.Source;
|
|
1138
|
+
getSource (): string | atlas.source.Source;
|
|
1130
1139
|
/**
|
|
1131
1140
|
* Sets the options of the polygon layer.
|
|
1132
1141
|
* @param newOptions The new options of the polygon layer.
|
|
1133
1142
|
*/
|
|
1134
|
-
setOptions(options: PolygonExtrusionLayerOptions): void;
|
|
1143
|
+
setOptions (options: PolygonExtrusionLayerOptions): void;
|
|
1135
1144
|
}
|
|
1136
1145
|
|
|
1137
1146
|
/**
|
|
@@ -1145,17 +1154,17 @@ declare namespace atlas {
|
|
|
1145
1154
|
* @param id The id of the layer. If not specified a random one will be generated.
|
|
1146
1155
|
* @param options The options of the polygon layer.
|
|
1147
1156
|
*/
|
|
1148
|
-
constructor(source: string | atlas.source.Source, id?: string, options?: PolygonLayerOptions);
|
|
1157
|
+
constructor (source: string | atlas.source.Source, id?: string, options?: PolygonLayerOptions);
|
|
1149
1158
|
|
|
1150
1159
|
/**
|
|
1151
1160
|
* Gets the options of the polygon layer.
|
|
1152
1161
|
*/
|
|
1153
|
-
getOptions(): PolygonLayerOptions;
|
|
1162
|
+
getOptions (): PolygonLayerOptions;
|
|
1154
1163
|
|
|
1155
1164
|
/**
|
|
1156
1165
|
* Gets the source provided when creating the layer.
|
|
1157
1166
|
*/
|
|
1158
|
-
getSource(): string | atlas.source.Source;
|
|
1167
|
+
getSource (): string | atlas.source.Source;
|
|
1159
1168
|
|
|
1160
1169
|
/**
|
|
1161
1170
|
* Sets the options of the polygon layer.
|
|
@@ -1163,7 +1172,7 @@ declare namespace atlas {
|
|
|
1163
1172
|
* To set `fillColor`, make sure `fillPattern` is set to `undefined`.
|
|
1164
1173
|
* @param newOptions The new options of the polygon layer.
|
|
1165
1174
|
*/
|
|
1166
|
-
setOptions(options: PolygonLayerOptions): void;
|
|
1175
|
+
setOptions (options: PolygonLayerOptions): void;
|
|
1167
1176
|
|
|
1168
1177
|
}
|
|
1169
1178
|
|
|
@@ -1178,20 +1187,20 @@ declare namespace atlas {
|
|
|
1178
1187
|
* @param id The id of the layer. If not specified a random one will be generated.
|
|
1179
1188
|
* @param options The options of the polygon layer.
|
|
1180
1189
|
*/
|
|
1181
|
-
constructor(source: string | atlas.source.Source, id?: string, options?: SymbolLayerOptions);
|
|
1190
|
+
constructor (source: string | atlas.source.Source, id?: string, options?: SymbolLayerOptions);
|
|
1182
1191
|
/**
|
|
1183
1192
|
* Gets the options of the symbol layer.
|
|
1184
1193
|
*/
|
|
1185
|
-
getOptions(): SymbolLayerOptions;
|
|
1194
|
+
getOptions (): SymbolLayerOptions;
|
|
1186
1195
|
/**
|
|
1187
1196
|
* Gets the source provided when creating the layer.
|
|
1188
1197
|
*/
|
|
1189
|
-
getSource(): string | atlas.source.Source;
|
|
1198
|
+
getSource (): string | atlas.source.Source;
|
|
1190
1199
|
/**
|
|
1191
1200
|
* Sets the options of the symbol layer.
|
|
1192
1201
|
* @param newOptions The new options of the polygon layer.
|
|
1193
1202
|
*/
|
|
1194
|
-
setOptions(options: SymbolLayerOptions): void;
|
|
1203
|
+
setOptions (options: SymbolLayerOptions): void;
|
|
1195
1204
|
}
|
|
1196
1205
|
|
|
1197
1206
|
/**
|
|
@@ -1203,16 +1212,16 @@ declare namespace atlas {
|
|
|
1203
1212
|
* @param options The options for the tile layer.
|
|
1204
1213
|
* @param id The id of the layer. If not specified a random one will be generated.
|
|
1205
1214
|
*/
|
|
1206
|
-
constructor(options?: TileLayerOptions, id?: string);
|
|
1215
|
+
constructor (options?: TileLayerOptions, id?: string);
|
|
1207
1216
|
/**
|
|
1208
1217
|
* Gets the options of the tile layer.
|
|
1209
1218
|
*/
|
|
1210
|
-
getOptions(): TileLayerOptions;
|
|
1219
|
+
getOptions (): TileLayerOptions;
|
|
1211
1220
|
/**
|
|
1212
1221
|
* Sets the options of the tile layer.
|
|
1213
1222
|
* @param newOptions The new options of the tile layer.
|
|
1214
1223
|
*/
|
|
1215
|
-
setOptions(options: TileLayerOptions): void;
|
|
1224
|
+
setOptions (options: TileLayerOptions): void;
|
|
1216
1225
|
}
|
|
1217
1226
|
|
|
1218
1227
|
/**
|
|
@@ -1224,16 +1233,16 @@ declare namespace atlas {
|
|
|
1224
1233
|
* @param id The id of the layer. If not specified a random one will be generated.
|
|
1225
1234
|
* @param options The options of the WebGL layer.
|
|
1226
1235
|
*/
|
|
1227
|
-
constructor(id?: string, options?: WebGLLayerOptions);
|
|
1236
|
+
constructor (id?: string, options?: WebGLLayerOptions);
|
|
1228
1237
|
/**
|
|
1229
1238
|
* Gets the options of the WebGL layer.
|
|
1230
1239
|
*/
|
|
1231
|
-
getOptions(): WebGLLayerOptions;
|
|
1240
|
+
getOptions (): WebGLLayerOptions;
|
|
1232
1241
|
/**
|
|
1233
1242
|
* Sets the options of the WebGL layer.
|
|
1234
1243
|
* @param options The new options of the WebGL layer.
|
|
1235
1244
|
*/
|
|
1236
|
-
setOptions(options: WebGLLayerOptions): void;
|
|
1245
|
+
setOptions (options: WebGLLayerOptions): void;
|
|
1237
1246
|
}
|
|
1238
1247
|
}
|
|
1239
1248
|
|
|
@@ -1262,7 +1271,7 @@ declare namespace atlas {
|
|
|
1262
1271
|
* @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
1272
|
* @param options the options for the data source.
|
|
1264
1273
|
*/
|
|
1265
|
-
constructor(id?: string, options?: DataSourceOptions);
|
|
1274
|
+
constructor (id?: string, options?: DataSourceOptions);
|
|
1266
1275
|
/**
|
|
1267
1276
|
* Adds shapes to the data source.
|
|
1268
1277
|
* GeoJSON objects will be wrapped within a Shape class to make them easier to manage.
|
|
@@ -1270,80 +1279,80 @@ declare namespace atlas {
|
|
|
1270
1279
|
* @param data
|
|
1271
1280
|
* @param index
|
|
1272
1281
|
*/
|
|
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;
|
|
1282
|
+
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
1283
|
/**
|
|
1275
1284
|
* Removes all data in the data source.
|
|
1276
1285
|
*/
|
|
1277
|
-
clear(): void;
|
|
1286
|
+
clear (): void;
|
|
1278
1287
|
/**
|
|
1279
1288
|
* Cleans up any resources this object is consuming.
|
|
1280
1289
|
*/
|
|
1281
|
-
dispose(): void;
|
|
1290
|
+
dispose (): void;
|
|
1282
1291
|
/**
|
|
1283
1292
|
* Calculates a zoom level at which the cluster will start expanding or break apart.
|
|
1284
1293
|
* @param clusterId
|
|
1285
1294
|
*/
|
|
1286
|
-
getClusterExpansionZoom(clusterId: number): Promise<number>;
|
|
1295
|
+
getClusterExpansionZoom (clusterId: number): Promise<number>;
|
|
1287
1296
|
/**
|
|
1288
1297
|
* Retrieves the children of the given cluster on the next zoom level. This may be a combination of shapes and sub-clusters.
|
|
1289
1298
|
* The sub-clusters will be features with properties matching ClusteredProperties.
|
|
1290
1299
|
* @param clusterId
|
|
1291
1300
|
*/
|
|
1292
|
-
getClusterChildren(clusterId: number): Promise<Array<atlas.data.Feature<atlas.data.Geometry, ClusteredProperties | any> | Shape>>;
|
|
1301
|
+
getClusterChildren (clusterId: number): Promise<Array<atlas.data.Feature<atlas.data.Geometry, ClusteredProperties | any> | Shape>>;
|
|
1293
1302
|
/**
|
|
1294
1303
|
* Retrieves shapes that are within the cluster.
|
|
1295
1304
|
* @param clusterId
|
|
1296
1305
|
* @param limit The maximum number of features to return. Set to Infinity to return all shapes.
|
|
1297
1306
|
* @param offset The number of shapes to skip. Allows you to page through the shapes in the cluster.
|
|
1298
1307
|
*/
|
|
1299
|
-
getClusterLeaves(clusterId: number, limit: number, offset: number): Promise<Array<atlas.data.Feature<atlas.data.Geometry, any> | Shape>>;
|
|
1308
|
+
getClusterLeaves (clusterId: number, limit: number, offset: number): Promise<Array<atlas.data.Feature<atlas.data.Geometry, any> | Shape>>;
|
|
1300
1309
|
/**
|
|
1301
1310
|
* Gets the options used by the data source.
|
|
1302
1311
|
*/
|
|
1303
|
-
getOptions(): DataSourceOptions;
|
|
1312
|
+
getOptions (): DataSourceOptions;
|
|
1304
1313
|
/**
|
|
1305
1314
|
* Returns all shapes that are in the DataSource.
|
|
1306
1315
|
*/
|
|
1307
|
-
getShapes(): Shape[];
|
|
1316
|
+
getShapes (): Shape[];
|
|
1308
1317
|
/**
|
|
1309
1318
|
* Downloads a GeoJSON document and imports its data into the data source.
|
|
1310
1319
|
* The GeoJSON document must be on the same domain or accessible using CORS.
|
|
1311
1320
|
* @param url
|
|
1312
1321
|
*/
|
|
1313
|
-
importDataFromUrl(url: string): Promise<void>;
|
|
1322
|
+
importDataFromUrl (url: string): Promise<void>;
|
|
1314
1323
|
/**
|
|
1315
1324
|
* Retrieves a shape with the specified id.
|
|
1316
1325
|
* If no shape with the specified id is contained in the data source, null will be return.
|
|
1317
1326
|
* @param id The id of the shape to return.
|
|
1318
1327
|
*/
|
|
1319
|
-
getShapeById(id: string | number): Shape;
|
|
1328
|
+
getShapeById (id: string | number): Shape;
|
|
1320
1329
|
/**
|
|
1321
1330
|
* Removes one or more shapes from the data source.
|
|
1322
1331
|
* If a string is passed in, it is assumed to be an id.
|
|
1323
1332
|
* If a number is passed in, removes the shape at that index.
|
|
1324
1333
|
* @param shape The shape(s), shape id(s), or feature(s) to be removed
|
|
1325
1334
|
*/
|
|
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;
|
|
1335
|
+
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
1336
|
/**
|
|
1328
1337
|
* Removes one or more shapes from the datasource based on its id.
|
|
1329
1338
|
* @param shape shape id
|
|
1330
1339
|
*/
|
|
1331
|
-
removeById(id: number | string | Array<number | string>): void;
|
|
1340
|
+
removeById (id: number | string | Array<number | string>): void;
|
|
1332
1341
|
/**
|
|
1333
1342
|
* Sets the data source options.
|
|
1334
1343
|
* The data source will retain its current values for any option not specified in the supplied options.
|
|
1335
1344
|
* @param options the DataSourceOptions to be set
|
|
1336
1345
|
*/
|
|
1337
|
-
setOptions(options: DataSourceOptions): void;
|
|
1346
|
+
setOptions (options: DataSourceOptions): void;
|
|
1338
1347
|
/**
|
|
1339
1348
|
* Overwrites all shapes in the data source with the new array of shapes.
|
|
1340
1349
|
* @param shape the new shapes to update
|
|
1341
1350
|
*/
|
|
1342
|
-
setShapes(shape: atlas.data.FeatureCollection | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>): void;
|
|
1351
|
+
setShapes (shape: atlas.data.FeatureCollection | Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>): void;
|
|
1343
1352
|
/**
|
|
1344
1353
|
* Returns a GeoJSON FeatureCollection which contains all the shape data that is in the data source.
|
|
1345
1354
|
*/
|
|
1346
|
-
toJson(): atlas.data.FeatureCollection;
|
|
1355
|
+
toJson (): atlas.data.FeatureCollection;
|
|
1347
1356
|
private _addToSources;
|
|
1348
1357
|
private _removeFromSources;
|
|
1349
1358
|
private _updateShapesMap;
|
|
@@ -1362,11 +1371,11 @@ declare namespace atlas {
|
|
|
1362
1371
|
export abstract class Source<T extends SourceEvents = SourceEvents> extends atlas.internal.EventEmitter<T> {
|
|
1363
1372
|
private id;
|
|
1364
1373
|
protected map: Map;
|
|
1365
|
-
constructor(id?: string);
|
|
1374
|
+
constructor (id?: string);
|
|
1366
1375
|
/**
|
|
1367
1376
|
* Gets the id of the data source
|
|
1368
1377
|
*/
|
|
1369
|
-
getId(): string;
|
|
1378
|
+
getId (): string;
|
|
1370
1379
|
}
|
|
1371
1380
|
|
|
1372
1381
|
/**
|
|
@@ -1374,17 +1383,17 @@ declare namespace atlas {
|
|
|
1374
1383
|
* Vector tile sources can be used with; SymbolLayer, LineLayer, PolygonLayer, BubbleLayer, HeatmapLayer and VectorTileLayer.
|
|
1375
1384
|
*/
|
|
1376
1385
|
export class VectorTileSource extends Source {
|
|
1377
|
-
constructor(id?: string, options?: VectorTileSourceOptions);
|
|
1386
|
+
constructor (id?: string, options?: VectorTileSourceOptions);
|
|
1378
1387
|
/**
|
|
1379
1388
|
* Gets the options of the VectorTileSource.
|
|
1380
1389
|
*/
|
|
1381
|
-
getOptions(): VectorTileSourceOptions;
|
|
1390
|
+
getOptions (): VectorTileSourceOptions;
|
|
1382
1391
|
/**
|
|
1383
1392
|
* Returns all GeoJSON features that are in the VectorTileSource and which satisfy the specified filter expression.
|
|
1384
1393
|
* @param sourceLayer Required if the source is a VectorTileSource. Specifies the layer within the VectorTileSource to query.
|
|
1385
1394
|
* @param filter A filter that will limit the query.
|
|
1386
1395
|
*/
|
|
1387
|
-
getShape(sourceLayer: string, filter?: Expression): Array<atlas.data.Feature<atlas.data.Geometry, any>>;
|
|
1396
|
+
getShape (sourceLayer: string, filter?: Expression): Array<atlas.data.Feature<atlas.data.Geometry, any>>;
|
|
1388
1397
|
}
|
|
1389
1398
|
|
|
1390
1399
|
/**
|
|
@@ -1414,21 +1423,21 @@ declare namespace atlas {
|
|
|
1414
1423
|
* @param source A set of reference points from the source reference system to transform from.
|
|
1415
1424
|
* @param target A set of reference points from the target reference system to transform to.
|
|
1416
1425
|
*/
|
|
1417
|
-
constructor(source: number[][], target: number[][]);
|
|
1426
|
+
constructor (source: number[][], target: number[][]);
|
|
1418
1427
|
/**
|
|
1419
1428
|
* Converts an array of points from the source reference system to the target reference system.
|
|
1420
1429
|
* @param sourcePoints An array of points from the source reference system to transform.
|
|
1421
1430
|
* @param decimals Number of decimal places to round the results off to.
|
|
1422
1431
|
* @returns An array of points that have been transformed to the target reference system.
|
|
1423
1432
|
*/
|
|
1424
|
-
toTarget(sourcePoints: number[][], decimals?: number): number[][];
|
|
1433
|
+
toTarget (sourcePoints: number[][], decimals?: number): number[][];
|
|
1425
1434
|
/**
|
|
1426
1435
|
* Converts an array of points from the target reference system to the source reference system.
|
|
1427
1436
|
* @param targetPoints An array of points from the target reference system to transform.
|
|
1428
1437
|
* @param decimals Number of decimal places to round the results off to.
|
|
1429
1438
|
* @returns An array of points that have been transformed to the source reference system.
|
|
1430
1439
|
*/
|
|
1431
|
-
toSource(targetPoints: number[][], decimals?: number): number[][];
|
|
1440
|
+
toSource (targetPoints: number[][], decimals?: number): number[][];
|
|
1432
1441
|
}
|
|
1433
1442
|
/**
|
|
1434
1443
|
* Units of measurement for areas.
|
|
@@ -1625,7 +1634,7 @@ declare namespace atlas {
|
|
|
1625
1634
|
* @param bounds The BoundingBox to convert to a Polygon.
|
|
1626
1635
|
* @returns A polygon representation of the BoundingBox.
|
|
1627
1636
|
*/
|
|
1628
|
-
export function boundingBoxToPolygon(bounds: atlas.data.BoundingBox): atlas.data.Polygon;
|
|
1637
|
+
export function boundingBoxToPolygon (bounds: atlas.data.BoundingBox): atlas.data.Polygon;
|
|
1629
1638
|
/**
|
|
1630
1639
|
* Converts a distance from one distance units to another. Supported units: miles, nauticalMiles, yards, meters, kilometers, feet
|
|
1631
1640
|
* @param distance A number that represents a distance to convert.
|
|
@@ -1634,7 +1643,7 @@ declare namespace atlas {
|
|
|
1634
1643
|
* @param decimals Specifies the number of decimal places to round the result to. If undefined, no rounding will occur.
|
|
1635
1644
|
* @returns A distance in the new units.
|
|
1636
1645
|
*/
|
|
1637
|
-
export function convertDistance(distance: number, fromUnits: string | DistanceUnits, toUnits: string | DistanceUnits, decimals?: number): number;
|
|
1646
|
+
export function convertDistance (distance: number, fromUnits: string | DistanceUnits, toUnits: string | DistanceUnits, decimals?: number): number;
|
|
1638
1647
|
/**
|
|
1639
1648
|
* Calculates an array of positions that form a cardinal spline between the specified array of positions.
|
|
1640
1649
|
* @param positions The array of positions to calculate the spline through.
|
|
@@ -1643,7 +1652,7 @@ declare namespace atlas {
|
|
|
1643
1652
|
* @param close A boolean indicating if the spline should be a closed ring or not. Default: false
|
|
1644
1653
|
* @returns An array of positions that form a cardinal spline between the specified array of positions.
|
|
1645
1654
|
*/
|
|
1646
|
-
export function getCardinalSpline(positions: atlas.data.Position[], tension?: number, nodeSize?: number, close?: boolean): atlas.data.Position[];
|
|
1655
|
+
export function getCardinalSpline (positions: atlas.data.Position[], tension?: number, nodeSize?: number, close?: boolean): atlas.data.Position[];
|
|
1647
1656
|
/**
|
|
1648
1657
|
* Calculates a destination position based on a starting position, a heading, a distance, and a distance unit type.
|
|
1649
1658
|
* @param origin Position that the destination is relative to.
|
|
@@ -1652,7 +1661,7 @@ declare namespace atlas {
|
|
|
1652
1661
|
* @param units Unit of distance measurement. Default is meters.
|
|
1653
1662
|
* @returns A position that is the specified distance away from the origin.
|
|
1654
1663
|
*/
|
|
1655
|
-
export function getDestination(origin: atlas.data.Position | atlas.data.Point, heading: number, distance: number, units?: string | DistanceUnits): atlas.data.Position;
|
|
1664
|
+
export function getDestination (origin: atlas.data.Position | atlas.data.Point, heading: number, distance: number, units?: string | DistanceUnits): atlas.data.Position;
|
|
1656
1665
|
/**
|
|
1657
1666
|
* Calculate the distance between two position objects on the surface of the earth using the Haversine formula.
|
|
1658
1667
|
* @param origin First position to calculate distance between.
|
|
@@ -1660,41 +1669,41 @@ declare namespace atlas {
|
|
|
1660
1669
|
* @param units Unit of distance measurement. Default is meters.
|
|
1661
1670
|
* @returns The shortest distance between two positions in the specified units.
|
|
1662
1671
|
*/
|
|
1663
|
-
export function getDistanceTo(origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point, units?: string | DistanceUnits): number;
|
|
1672
|
+
export function getDistanceTo (origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point, units?: string | DistanceUnits): number;
|
|
1664
1673
|
/**
|
|
1665
1674
|
* Retrieves the radius of the earth in a specific distance unit for WGS84.
|
|
1666
1675
|
* @param units Unit of distance measurement. Default: meters
|
|
1667
1676
|
* @returns A number that represents the radius of the earth in a specific distance unit.
|
|
1668
1677
|
*/
|
|
1669
|
-
export function getEarthRadius(units?: string | DistanceUnits): number;
|
|
1678
|
+
export function getEarthRadius (units?: string | DistanceUnits): number;
|
|
1670
1679
|
/**
|
|
1671
1680
|
* Takes an array of positions objects and fills in the space between them with accurately positioned positions to form an approximated Geodesic path.
|
|
1672
1681
|
* @param path Array of position objects that form a path to fill in.
|
|
1673
1682
|
* @param nodeSize Number of nodes to insert between each position. Default: 15
|
|
1674
1683
|
* @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
1684
|
*/
|
|
1676
|
-
export function getGeodesicPath(path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[];
|
|
1685
|
+
export function getGeodesicPath (path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[];
|
|
1677
1686
|
/**
|
|
1678
1687
|
* 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
1688
|
* @param path Array of position objects that form a path to fill in.
|
|
1680
1689
|
* @param nodeSize Number of nodes to insert between each position. Default: 15
|
|
1681
1690
|
* @returns An array of paths that form geodesic paths, Comparing to getGeodesicPath, sub-paths will always contain longitude in -180 to 180 range
|
|
1682
1691
|
*/
|
|
1683
|
-
export function getGeodesicPaths(path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[][]
|
|
1692
|
+
export function getGeodesicPaths (path: atlas.data.LineString | atlas.data.Position[], nodeSize?: number): atlas.data.Position[][];
|
|
1684
1693
|
/**
|
|
1685
1694
|
* Calculates the heading from one position object to another.
|
|
1686
1695
|
* @param origin Point of origin.
|
|
1687
1696
|
* @param destination Destination to calculate relative heading to.
|
|
1688
1697
|
* @returns A heading in degrees between 0 and 360. 0 degrees points due North.
|
|
1689
1698
|
*/
|
|
1690
|
-
export function getHeading(origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point): number;
|
|
1699
|
+
export function getHeading (origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point): number;
|
|
1691
1700
|
/**
|
|
1692
1701
|
* Calculates the distance between all position objects in an array.
|
|
1693
1702
|
* @param path The array of position objects that make up the path to calculate the length of.
|
|
1694
1703
|
* @param units Unit of distance measurement. Default: meters
|
|
1695
1704
|
* @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
1705
|
*/
|
|
1697
|
-
export function getLengthOfPath(path: atlas.data.LineString | atlas.data.Position[], units?: string | DistanceUnits): number;
|
|
1706
|
+
export function getLengthOfPath (path: atlas.data.LineString | atlas.data.Position[], units?: string | DistanceUnits): number;
|
|
1698
1707
|
/**
|
|
1699
1708
|
* 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
1709
|
* than the length of the path, the last position of the path will be returned.
|
|
@@ -1703,7 +1712,7 @@ declare namespace atlas {
|
|
|
1703
1712
|
* @param units Unit of distance measurement. Default is meters.
|
|
1704
1713
|
* @returns A position object that is the specified distance away from the start of the path when following the path.
|
|
1705
1714
|
*/
|
|
1706
|
-
export function getPositionAlongPath(path: atlas.data.LineString | atlas.data.Position[], distance: number, units?: string | DistanceUnits): atlas.data.Position;
|
|
1715
|
+
export function getPositionAlongPath (path: atlas.data.LineString | atlas.data.Position[], distance: number, units?: string | DistanceUnits): atlas.data.Position;
|
|
1707
1716
|
/**
|
|
1708
1717
|
* Calculates an array of position objects that are an equal distance away from a central point to create a regular polygon.
|
|
1709
1718
|
* @param origin Center of the regular polygon.
|
|
@@ -1713,7 +1722,7 @@ declare namespace atlas {
|
|
|
1713
1722
|
* @param offset An offset to rotate the polygon. When 0 the first position will align with North.
|
|
1714
1723
|
* @returns An array of position objects that form a regular polygon.
|
|
1715
1724
|
*/
|
|
1716
|
-
export function getRegularPolygonPath(origin: atlas.data.Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): atlas.data.Position[];
|
|
1725
|
+
export function getRegularPolygonPath (origin: atlas.data.Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): atlas.data.Position[];
|
|
1717
1726
|
/**
|
|
1718
1727
|
* 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
1728
|
* @param origin Center of the regular polygon.
|
|
@@ -1723,7 +1732,7 @@ declare namespace atlas {
|
|
|
1723
1732
|
* @param offset An offset to rotate the polygon. When 0 the first position will align with North.
|
|
1724
1733
|
* @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
1734
|
*/
|
|
1726
|
-
export function getRegularPolygonPaths(origin: Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): Position[][]
|
|
1735
|
+
export function getRegularPolygonPaths (origin: Position | atlas.data.Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): Position[][];
|
|
1727
1736
|
/**
|
|
1728
1737
|
* Calculates a position object that is a fractional distance between two position objects.
|
|
1729
1738
|
* @param origin First position to calculate mid-point between.
|
|
@@ -1731,30 +1740,30 @@ declare namespace atlas {
|
|
|
1731
1740
|
* @param fraction The fractional parameter to calculate a mid-point for. Default 0.5.
|
|
1732
1741
|
* @returns A position that lies a fraction of the distance between two position objects, relative to the first position object.
|
|
1733
1742
|
*/
|
|
1734
|
-
export function interpolate(origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point, fraction?: number): atlas.data.Position;
|
|
1743
|
+
export function interpolate (origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point, fraction?: number): atlas.data.Position;
|
|
1735
1744
|
/**
|
|
1736
1745
|
* Normalizes a latitude value between -90 and 90 degrees.
|
|
1737
1746
|
* @param lat The latitude value to normalize.
|
|
1738
1747
|
*/
|
|
1739
|
-
export function normalizeLatitude(lat: number): number;
|
|
1748
|
+
export function normalizeLatitude (lat: number): number;
|
|
1740
1749
|
/**
|
|
1741
1750
|
* Normalizes a longitude value between -180 and 180 degrees.
|
|
1742
1751
|
* @param lng The longitude value to normalize.
|
|
1743
1752
|
*/
|
|
1744
|
-
export function normalizeLongitude(lng: number): number;
|
|
1753
|
+
export function normalizeLongitude (lng: number): number;
|
|
1745
1754
|
/**
|
|
1746
1755
|
* Takes an array of positions and rotates them around a given position for the specified angle of rotation.
|
|
1747
1756
|
* @param positions An array of positions to be rotated.
|
|
1748
1757
|
* @param origin The position to rotate the positions around.
|
|
1749
1758
|
* @param angle The amount to rotate the array of positions in degrees clockwise.
|
|
1750
1759
|
*/
|
|
1751
|
-
export function rotatePositions(positions: atlas.data.Position[], origin: atlas.data.Position | atlas.data.Point, angle: number): atlas.data.Position[];
|
|
1760
|
+
export function rotatePositions (positions: atlas.data.Position[], origin: atlas.data.Position | atlas.data.Point, angle: number): atlas.data.Position[];
|
|
1752
1761
|
/**
|
|
1753
1762
|
* Calculates the pixel accurate heading from one position to another based on the Mercator map projection. This heading is visually accurate.
|
|
1754
1763
|
* @param origin
|
|
1755
1764
|
* @param destination
|
|
1756
1765
|
*/
|
|
1757
|
-
export function getPixelHeading(origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point): number;
|
|
1766
|
+
export function getPixelHeading (origin: atlas.data.Position | atlas.data.Point, destination: atlas.data.Position | atlas.data.Point): number;
|
|
1758
1767
|
/**
|
|
1759
1768
|
* Converts an array of global Mercator pixel coordinates into an array of geospatial positions at a specified zoom level.
|
|
1760
1769
|
* Global pixel coordinates are relative to the top left corner of the map [-180, 90].
|
|
@@ -1762,14 +1771,14 @@ declare namespace atlas {
|
|
|
1762
1771
|
* @param zoom Zoom level.
|
|
1763
1772
|
* @returns An array of positions.
|
|
1764
1773
|
*/
|
|
1765
|
-
export function mercatorPixelsToPositions(pixels: Pixel[], zoom: number): atlas.data.Position[];
|
|
1774
|
+
export function mercatorPixelsToPositions (pixels: Pixel[], zoom: number): atlas.data.Position[];
|
|
1766
1775
|
/**
|
|
1767
1776
|
* Converts an array of positions into an array of global Mercator pixel coordinates at a specified zoom level.
|
|
1768
1777
|
* @param positions Array of positions.
|
|
1769
1778
|
* @param zoom Zoom level.
|
|
1770
1779
|
* @returns Array of global Mercator pixels.
|
|
1771
1780
|
*/
|
|
1772
|
-
export function mercatorPositionsToPixels(positions: atlas.data.Position[], zoom: number): Pixel[];
|
|
1781
|
+
export function mercatorPositionsToPixels (positions: atlas.data.Position[], zoom: number): Pixel[];
|
|
1773
1782
|
/**
|
|
1774
1783
|
* Converts an acceleration value from one unit to another.
|
|
1775
1784
|
* Supported units:
|
|
@@ -1781,7 +1790,7 @@ declare namespace atlas {
|
|
|
1781
1790
|
* @param decimals The number of decimal places to round the result to.
|
|
1782
1791
|
* @returns An acceleration value convertered from one unit to another.
|
|
1783
1792
|
*/
|
|
1784
|
-
export function convertAcceleration(acceleration: number, fromUnits: string | AccelerationUnits, toUnits: string | AccelerationUnits, decimals?: number): number;
|
|
1793
|
+
export function convertAcceleration (acceleration: number, fromUnits: string | AccelerationUnits, toUnits: string | AccelerationUnits, decimals?: number): number;
|
|
1785
1794
|
/**
|
|
1786
1795
|
* Converts an area value from one unit to another.
|
|
1787
1796
|
* Supported units: squareMeters, acres, hectares, squareFeet, squareYards, squareMiles, squareKilometers
|
|
@@ -1791,7 +1800,7 @@ declare namespace atlas {
|
|
|
1791
1800
|
* @param decimals The number of decimal places to round the result to.
|
|
1792
1801
|
* @returns An area value convertered from one unit to another.
|
|
1793
1802
|
*/
|
|
1794
|
-
export function convertArea(area: number, fromUnits: string, toUnits: string, decimals?: number): number;
|
|
1803
|
+
export function convertArea (area: number, fromUnits: string, toUnits: string, decimals?: number): number;
|
|
1795
1804
|
/**
|
|
1796
1805
|
* Converts a speed value from one unit to another.
|
|
1797
1806
|
* Supported units:
|
|
@@ -1802,7 +1811,7 @@ declare namespace atlas {
|
|
|
1802
1811
|
* @param decimals The number of decimal places to round the result to.
|
|
1803
1812
|
* @returns A speed value convertered from one unit to another.
|
|
1804
1813
|
*/
|
|
1805
|
-
export function convertSpeed(speed: number, fromUnits: string | SpeedUnits, toUnits: string | SpeedUnits, decimals?: number): number;
|
|
1814
|
+
export function convertSpeed (speed: number, fromUnits: string | SpeedUnits, toUnits: string | SpeedUnits, decimals?: number): number;
|
|
1806
1815
|
/**
|
|
1807
1816
|
* Converts a timespan value from one unit to another.
|
|
1808
1817
|
* Supported units:
|
|
@@ -1813,7 +1822,7 @@ declare namespace atlas {
|
|
|
1813
1822
|
* @param decimals The number of decimal places to round the result to.
|
|
1814
1823
|
* @returns A time value convertered from one unit to another.
|
|
1815
1824
|
*/
|
|
1816
|
-
export function convertTimespan(timespan: number, fromUnits: string | TimeUnits, toUnits: string | TimeUnits, decimals?: number): number;
|
|
1825
|
+
export function convertTimespan (timespan: number, fromUnits: string | TimeUnits, toUnits: string | TimeUnits, decimals?: number): number;
|
|
1817
1826
|
/**
|
|
1818
1827
|
* Calculates an acceleration based on an initial speed, travel distance and timespan. Formula: a = 2*(d - v*t)/t^2
|
|
1819
1828
|
* @param initialSpeed The initial speed.
|
|
@@ -1826,7 +1835,7 @@ declare namespace atlas {
|
|
|
1826
1835
|
* @param decimals The number of decimal places to round the result to.
|
|
1827
1836
|
* @returns An acceleration based on an initial speed, travel distance and timespan.
|
|
1828
1837
|
*/
|
|
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;
|
|
1838
|
+
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
1839
|
/**
|
|
1831
1840
|
* Calculates an acceleration based on an initial speed, final speed and timespan. Formula: a = 2* (v2 - v1)/t
|
|
1832
1841
|
* @param initialSpeed The initial speed.
|
|
@@ -1838,7 +1847,7 @@ declare namespace atlas {
|
|
|
1838
1847
|
* @param decimals The number of decimal places to round the result to.
|
|
1839
1848
|
* @returns An acceleration based on an initial speed, final speed and timespan.
|
|
1840
1849
|
*/
|
|
1841
|
-
export function getAccelerationFromSpeeds(initialSpeed: number, finalSpeed: number, timespan: number, speedUnits?: string | SpeedUnits, timeUnits?: string | TimeUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number;
|
|
1850
|
+
export function getAccelerationFromSpeeds (initialSpeed: number, finalSpeed: number, timespan: number, speedUnits?: string | SpeedUnits, timeUnits?: string | TimeUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number;
|
|
1842
1851
|
/**
|
|
1843
1852
|
* Calculates an acceleration between two point features that have a timestamp property and optionally a speed property.
|
|
1844
1853
|
* 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 +1861,7 @@ declare namespace atlas {
|
|
|
1852
1861
|
* @param decimals The number of decimal places to round the result to.
|
|
1853
1862
|
* @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
1863
|
*/
|
|
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;
|
|
1864
|
+
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
1865
|
/**
|
|
1857
1866
|
* Calculates the approximate area of a geometry in the specified units
|
|
1858
1867
|
* @param coordinates The coordinates of the polyon ring.
|
|
@@ -1861,7 +1870,7 @@ declare namespace atlas {
|
|
|
1861
1870
|
* @param decimals The number of decimal places to round the result to.
|
|
1862
1871
|
* @returns The area of a geometry in the specified units.
|
|
1863
1872
|
*/
|
|
1864
|
-
export function getArea(data: atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape, areaUnits?: AreaUnits, decimals?: number): number;
|
|
1873
|
+
export function getArea (data: atlas.data.Geometry | atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape, areaUnits?: AreaUnits, decimals?: number): number;
|
|
1865
1874
|
/**
|
|
1866
1875
|
* Calculates the average speed of travel between two points based on the provided amount of time.
|
|
1867
1876
|
* @param origin The initial point in which the speed is calculated from.
|
|
@@ -1872,7 +1881,7 @@ declare namespace atlas {
|
|
|
1872
1881
|
* @param decimals The number of decimal places to round the result to.
|
|
1873
1882
|
* @returns The average speed of travel between two points based on the provided amount of time.
|
|
1874
1883
|
*/
|
|
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;
|
|
1884
|
+
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
1885
|
/**
|
|
1877
1886
|
* Calculates the average speed of travel between two point features that have a property containing a timestamp.
|
|
1878
1887
|
* The timestamp can be;
|
|
@@ -1889,7 +1898,7 @@ declare namespace atlas {
|
|
|
1889
1898
|
* @param decimals The number of decimal places to round the result to.
|
|
1890
1899
|
* @returns The speed in the specified units or NaN if valid timestamps are not found.
|
|
1891
1900
|
*/
|
|
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;
|
|
1901
|
+
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
1902
|
/**
|
|
1894
1903
|
* Calculates the timespan between two dates or timestamps.
|
|
1895
1904
|
* Timestamps can be;
|
|
@@ -1904,7 +1913,7 @@ declare namespace atlas {
|
|
|
1904
1913
|
* @param units The units to return the time value in. If not specified seconds are used.
|
|
1905
1914
|
* @returns A timespan between two dates or timestamps. Returns NaN if unable to parse timestamps.
|
|
1906
1915
|
*/
|
|
1907
|
-
export function getTimespan(startTime: Date | string | number, endTime: Date | string | number, units?: TimeUnits, decimals?: number): number;
|
|
1916
|
+
export function getTimespan (startTime: Date | string | number, endTime: Date | string | number, units?: TimeUnits, decimals?: number): number;
|
|
1908
1917
|
/**
|
|
1909
1918
|
* Calculates the distance traveled for a specified timespan, speed and optionally an acceleration.
|
|
1910
1919
|
* Formula: d = v*t + 0.5*a*t^2
|
|
@@ -1918,7 +1927,7 @@ declare namespace atlas {
|
|
|
1918
1927
|
* @param decimals The number of decimal places to round the result to.
|
|
1919
1928
|
* @returns The distance traveled for a specified timespan, speed and optionally an acceleration.
|
|
1920
1929
|
*/
|
|
1921
|
-
export function getTravelDistance(distanceUnits: string, timespan: number, speed: number, acceleration?: number, timeUnits?: string | TimeUnits, speedUnits?: string | SpeedUnits, accelerationUnits?: string, decimals?: number): number;
|
|
1930
|
+
export function getTravelDistance (distanceUnits: string, timespan: number, speed: number, acceleration?: number, timeUnits?: string | TimeUnits, speedUnits?: string | SpeedUnits, accelerationUnits?: string, decimals?: number): number;
|
|
1922
1931
|
/**
|
|
1923
1932
|
* Parses a timestamp into a JavaScript Date object.
|
|
1924
1933
|
* Timestamps can be;
|
|
@@ -1931,32 +1940,32 @@ declare namespace atlas {
|
|
|
1931
1940
|
* @param timestamp The timestamp value to parse.
|
|
1932
1941
|
* @returns A Date object that represents the timestamp or null if the timestamp could not be parsed.
|
|
1933
1942
|
*/
|
|
1934
|
-
export function parseTimestamp(timestamp: Date | string | number): Date;
|
|
1943
|
+
export function parseTimestamp (timestamp: Date | string | number): Date;
|
|
1935
1944
|
/**
|
|
1936
1945
|
* Calculates a Convex Hull from an array of positions, geometries or features.
|
|
1937
1946
|
* @param data The array of positions, geometries or features to calculate a convex hull for.
|
|
1938
1947
|
* @returns A Convex Hull from an array of positions, geometries or features.
|
|
1939
1948
|
*/
|
|
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;
|
|
1949
|
+
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
1950
|
/**
|
|
1942
1951
|
* Retrieves an array of all positions in the provided geometry, feature or array of geometries/features.
|
|
1943
1952
|
* @param data The geometries or features to retrieve the positions from.
|
|
1944
1953
|
* @returns An array of all positions in the provided geometry, feature or array of geometries/features.
|
|
1945
1954
|
*/
|
|
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[];
|
|
1955
|
+
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
1956
|
/**
|
|
1948
1957
|
* 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
1958
|
* @param data The data object to extract the position from.
|
|
1950
1959
|
* @returns The position of an object that is a position, point, or point feature. Returns null if invalid data passed in.
|
|
1951
1960
|
*/
|
|
1952
|
-
export function getPosition(data: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any> | atlas.Shape): atlas.data.Position;
|
|
1961
|
+
export function getPosition (data: atlas.data.Position | atlas.data.Point | atlas.data.Feature<atlas.data.Point, any> | atlas.Shape): atlas.data.Position;
|
|
1953
1962
|
/**
|
|
1954
1963
|
* Gets an array of evenly spaced positions along a path.
|
|
1955
1964
|
* @param path The path to get the positions from.
|
|
1956
1965
|
* @param numPositions The number of positions to get.
|
|
1957
1966
|
* @returns An array of evenly spaced positions along a path.
|
|
1958
1967
|
*/
|
|
1959
|
-
export function getPositionsAlongPath(path: atlas.data.LineString | atlas.data.Position[], numPositions: number): atlas.data.Position[];
|
|
1968
|
+
export function getPositionsAlongPath (path: atlas.data.LineString | atlas.data.Position[], numPositions: number): atlas.data.Position[];
|
|
1960
1969
|
/**
|
|
1961
1970
|
* Gets a point with heading a specified distance along a path.
|
|
1962
1971
|
* @param path The path to get the point from.
|
|
@@ -1964,7 +1973,7 @@ declare namespace atlas {
|
|
|
1964
1973
|
* @param units The distance units.
|
|
1965
1974
|
* @returns A point with heading a specified distance along a path.
|
|
1966
1975
|
*/
|
|
1967
|
-
export function getPointWithHeadingAlongPath(path: atlas.data.LineString | atlas.data.Position[], distance: number, units?: string | DistanceUnits): atlas.data.Feature<atlas.data.Point, {
|
|
1976
|
+
export function getPointWithHeadingAlongPath (path: atlas.data.LineString | atlas.data.Position[], distance: number, units?: string | DistanceUnits): atlas.data.Feature<atlas.data.Point, {
|
|
1968
1977
|
heading: number;
|
|
1969
1978
|
}>;
|
|
1970
1979
|
/**
|
|
@@ -1973,7 +1982,7 @@ declare namespace atlas {
|
|
|
1973
1982
|
* @param numPoints The number of points to get.
|
|
1974
1983
|
* @returns An array of evenly spaced points with headings along a path.
|
|
1975
1984
|
*/
|
|
1976
|
-
export function getPointsWithHeadingsAlongPath(path: atlas.data.LineString | atlas.data.Position[], numPoints: number): Array<atlas.data.Feature<atlas.data.Point, {
|
|
1985
|
+
export function getPointsWithHeadingsAlongPath (path: atlas.data.LineString | atlas.data.Position[], numPoints: number): Array<atlas.data.Feature<atlas.data.Point, {
|
|
1977
1986
|
heading: number;
|
|
1978
1987
|
}>>;
|
|
1979
1988
|
/**
|
|
@@ -1988,7 +1997,7 @@ declare namespace atlas {
|
|
|
1988
1997
|
* @param decimals The number of decimal places to round the result to.
|
|
1989
1998
|
* @returns
|
|
1990
1999
|
*/
|
|
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, {
|
|
2000
|
+
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
2001
|
distance: number;
|
|
1993
2002
|
}>;
|
|
1994
2003
|
|
|
@@ -1998,7 +2007,7 @@ declare namespace atlas {
|
|
|
1998
2007
|
* @param tolerance A tolerance to use in the simplification.
|
|
1999
2008
|
* @returns A new array of the simplified set of points.
|
|
2000
2009
|
*/
|
|
2001
|
-
export function simplify(points: (Position | Pixel)[], tolerance: number): (Position | Pixel)[];
|
|
2010
|
+
export function simplify (points: (Position | Pixel)[], tolerance: number): (Position | Pixel)[];
|
|
2002
2011
|
|
|
2003
2012
|
/**
|
|
2004
2013
|
* 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 +2015,7 @@ declare namespace atlas {
|
|
|
2006
2015
|
* @param path Array of position objects or linestring to denormalize
|
|
2007
2016
|
* @returns A denormalized array of position objects, path crossing antimeridian will contain longitude outside of -180 to 180 range.
|
|
2008
2017
|
*/
|
|
2009
|
-
export function getPathDenormalizedAtAntimerian(path: atlas.data.LineString | Position[]): Position[];
|
|
2018
|
+
export function getPathDenormalizedAtAntimerian (path: atlas.data.LineString | Position[]): Position[];
|
|
2010
2019
|
|
|
2011
2020
|
/**
|
|
2012
2021
|
* Split path on antimeridian into multiple paths.
|
|
@@ -2014,7 +2023,7 @@ declare namespace atlas {
|
|
|
2014
2023
|
* @param path Array of position objects or linestring to split
|
|
2015
2024
|
* @returns A path split into multiple paths by antimeridian.
|
|
2016
2025
|
*/
|
|
2017
|
-
export function getPathSplitByAntimeridian(path: atlas.data.LineString | Position[]): Position[][];
|
|
2026
|
+
export function getPathSplitByAntimeridian (path: atlas.data.LineString | Position[]): Position[][];
|
|
2018
2027
|
}
|
|
2019
2028
|
|
|
2020
2029
|
/**
|
|
@@ -2050,109 +2059,109 @@ declare namespace atlas {
|
|
|
2050
2059
|
* @param container The id of the element where the map should be displayed.
|
|
2051
2060
|
* @param options Options for the initial display and interactability with the map.
|
|
2052
2061
|
*/
|
|
2053
|
-
constructor(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions));
|
|
2062
|
+
constructor (container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions));
|
|
2054
2063
|
/**
|
|
2055
2064
|
* Returns true if the map has been disposed.
|
|
2056
2065
|
*/
|
|
2057
|
-
get isDisposed(): boolean;
|
|
2066
|
+
get isDisposed (): boolean;
|
|
2058
2067
|
/**
|
|
2059
2068
|
* Returns the HTMLCanvasElement that the map is drawn to.
|
|
2060
2069
|
*/
|
|
2061
|
-
getCanvas(): HTMLCanvasElement;
|
|
2070
|
+
getCanvas (): HTMLCanvasElement;
|
|
2062
2071
|
/**
|
|
2063
2072
|
* Returns the HTMLElement that contains the map's HTMLCanvasElement. The map's events (e.g. panning and zooming)
|
|
2064
2073
|
* are attached to this element.
|
|
2065
2074
|
*/
|
|
2066
|
-
getCanvasContainer(): HTMLElement;
|
|
2075
|
+
getCanvasContainer (): HTMLElement;
|
|
2067
2076
|
/**
|
|
2068
2077
|
* Returns the HTMLElement that contains the map.
|
|
2069
2078
|
*/
|
|
2070
|
-
getMapContainer(): HTMLElement;
|
|
2079
|
+
getMapContainer (): HTMLElement;
|
|
2071
2080
|
/**
|
|
2072
2081
|
* Returns the service options with which the map control was initialized.
|
|
2073
2082
|
*/
|
|
2074
|
-
getServiceOptions(): ServiceOptions;
|
|
2083
|
+
getServiceOptions (): ServiceOptions;
|
|
2075
2084
|
/**
|
|
2076
2085
|
* Set the service options.
|
|
2077
2086
|
*/
|
|
2078
|
-
setServiceOptions(options: ServiceOptions): void;
|
|
2087
|
+
setServiceOptions (options: ServiceOptions): void;
|
|
2079
2088
|
/**
|
|
2080
2089
|
* Set the camera of the map control with an animated transition. Any options not specified will default to their
|
|
2081
2090
|
* current values.
|
|
2082
2091
|
* @param options The options for setting the map's camera and for the animation of any view change.
|
|
2083
2092
|
*/
|
|
2084
|
-
setCamera(options?: (CameraOptions | (CameraBoundsOptions & { pitch?: number, bearing?: number })) & AnimationOptions): void;
|
|
2093
|
+
setCamera (options?: (CameraOptions | (CameraBoundsOptions & { pitch?: number, bearing?: number })) & AnimationOptions): void;
|
|
2085
2094
|
/**
|
|
2086
2095
|
* Returns the camera's current properties.
|
|
2087
2096
|
*/
|
|
2088
|
-
getCamera(): CameraOptions & CameraBoundsOptions;
|
|
2097
|
+
getCamera (): CameraOptions & CameraBoundsOptions;
|
|
2089
2098
|
/**
|
|
2090
2099
|
* Set the map control's style options. Any options not specified will default to their current values.
|
|
2091
2100
|
* @param options The options for setting the style of the map control.
|
|
2092
2101
|
* @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
2102
|
*/
|
|
2094
|
-
setStyle(options?: StyleOptions, diff?: boolean): void;
|
|
2103
|
+
setStyle (options?: StyleOptions, diff?: boolean): void;
|
|
2095
2104
|
/**
|
|
2096
2105
|
* Returns the map control's current style settings.
|
|
2097
2106
|
*/
|
|
2098
|
-
getStyle(): StyleOptions;
|
|
2107
|
+
getStyle (): StyleOptions;
|
|
2099
2108
|
/**
|
|
2100
2109
|
* Set the map control's user interaction handlers. Any options not specified will default to their current values.
|
|
2101
2110
|
* @param options The options for enabling/disabling the user interaction handlers.
|
|
2102
2111
|
*/
|
|
2103
|
-
setUserInteraction(options?: UserInteractionOptions): void;
|
|
2112
|
+
setUserInteraction (options?: UserInteractionOptions): void;
|
|
2104
2113
|
/**
|
|
2105
2114
|
* Return the map control's current user interaction handler settings.
|
|
2106
2115
|
*/
|
|
2107
|
-
getUserInteraction(): UserInteractionOptions;
|
|
2116
|
+
getUserInteraction (): UserInteractionOptions;
|
|
2108
2117
|
/**
|
|
2109
2118
|
* Set the traffic options for the map. Any options not specified will default to their current values.
|
|
2110
2119
|
* @param options The options for defining the map's traffic display.
|
|
2111
2120
|
*/
|
|
2112
|
-
setTraffic(options?: TrafficOptions): void;
|
|
2121
|
+
setTraffic (options?: TrafficOptions): void;
|
|
2113
2122
|
/**
|
|
2114
2123
|
* Return the map control's current traffic settings.
|
|
2115
2124
|
*/
|
|
2116
|
-
getTraffic(): TrafficOptions;
|
|
2125
|
+
getTraffic (): TrafficOptions;
|
|
2117
2126
|
/**
|
|
2118
2127
|
* Removes all sources, layers, markers, and popups from the map.
|
|
2119
2128
|
* User added images are preserved.
|
|
2120
2129
|
*/
|
|
2121
|
-
clear(): void;
|
|
2130
|
+
clear (): void;
|
|
2122
2131
|
/**
|
|
2123
2132
|
* Clean up the map's resources. Map will not function correctly after calling this method.
|
|
2124
2133
|
*/
|
|
2125
|
-
dispose(): void;
|
|
2134
|
+
dispose (): void;
|
|
2126
2135
|
/**
|
|
2127
2136
|
* Resize the map according to the dimensions of its container element.
|
|
2128
2137
|
* @param eventData Optional additional properties to be added to event objects of events triggered by this method.
|
|
2129
2138
|
*/
|
|
2130
|
-
resize(eventData?: any): void;
|
|
2139
|
+
resize (eventData?: any): void;
|
|
2131
2140
|
/**
|
|
2132
2141
|
* Resizes the map's container element then the map itself.
|
|
2133
2142
|
* @param height The height for the map and its container element. A number input is assumed to be in pixels.
|
|
2134
2143
|
* @param width The width for the map and its container element. A number input is assumed to be in pixels.
|
|
2135
2144
|
* @param eventData Optional additional properties to be added to event objects of events triggered by this method.
|
|
2136
2145
|
*/
|
|
2137
|
-
resize(height: number | string, width: number | string, eventData?: any): void;
|
|
2146
|
+
resize (height: number | string, width: number | string, eventData?: any): void;
|
|
2138
2147
|
/**
|
|
2139
2148
|
* Converts an array of Pixel objects to an array of geographic Positions objects on the map.
|
|
2140
2149
|
* @param pixels The pixels to be converted.
|
|
2141
2150
|
*/
|
|
2142
|
-
pixelsToPositions(pixels: Pixel[]): atlas.data.Position[];
|
|
2151
|
+
pixelsToPositions (pixels: Pixel[]): atlas.data.Position[];
|
|
2143
2152
|
/**
|
|
2144
2153
|
* Converts an array of Positions objects to an array of Pixel objects relative to the map container.
|
|
2145
2154
|
* @param positions The positions to be converted.
|
|
2146
2155
|
*/
|
|
2147
|
-
positionsToPixels(positions: atlas.data.Position[]): Pixel[];
|
|
2156
|
+
positionsToPixels (positions: atlas.data.Position[]): Pixel[];
|
|
2148
2157
|
/**
|
|
2149
2158
|
* Returns a boolean indicating if all tiles in the current viewport for all sources have loaded or not.
|
|
2150
2159
|
*/
|
|
2151
|
-
areTilesLoaded(): boolean;
|
|
2160
|
+
areTilesLoaded (): boolean;
|
|
2152
2161
|
/**
|
|
2153
2162
|
* Stops any animated transition that is currently underway.
|
|
2154
2163
|
*/
|
|
2155
|
-
stop(): void;
|
|
2164
|
+
stop (): void;
|
|
2156
2165
|
/**
|
|
2157
2166
|
* Trigger the rendering of a single frame.
|
|
2158
2167
|
* Use this method with WebGL layers to repaint the map when the layer's
|
|
@@ -2160,18 +2169,18 @@ declare namespace atlas {
|
|
|
2160
2169
|
* Calling this multiple times before the next frame is rendered will still
|
|
2161
2170
|
* result in only a single frame being rendered.
|
|
2162
2171
|
*/
|
|
2163
|
-
triggerRepaint(): void;
|
|
2172
|
+
triggerRepaint (): void;
|
|
2164
2173
|
/**
|
|
2165
2174
|
* Loads a 3D terrain mesh, based on a "raster-dem" source.
|
|
2166
2175
|
*
|
|
2167
2176
|
* @param elevationSource elevation tile source
|
|
2168
2177
|
* @param exaggeration the elevation exaggeration factor
|
|
2169
2178
|
*/
|
|
2170
|
-
enableElevation(elevationSource: string | atlas.source.ElevationTileSource, exaggeration?: number): void;
|
|
2179
|
+
enableElevation (elevationSource: string | atlas.source.ElevationTileSource, exaggeration?: number): void;
|
|
2171
2180
|
/**
|
|
2172
2181
|
* Disables the 3D terrain mesh.
|
|
2173
2182
|
*/
|
|
2174
|
-
disableElevation(): void;
|
|
2183
|
+
disableElevation (): void;
|
|
2175
2184
|
/**
|
|
2176
2185
|
* The callback used when styleOptions.autoResize is true.
|
|
2177
2186
|
*/
|
|
@@ -2204,24 +2213,24 @@ declare namespace atlas {
|
|
|
2204
2213
|
* @param x The horizontal pixel offset.
|
|
2205
2214
|
* @param y The vertical pixel offset.
|
|
2206
2215
|
*/
|
|
2207
|
-
constructor(x: number, y: number);
|
|
2216
|
+
constructor (x: number, y: number);
|
|
2208
2217
|
/**
|
|
2209
2218
|
* Generates a Pixel object from an object that contains coordinate information.
|
|
2210
2219
|
* The object is scanned for x and y properties using a case insensitive test.
|
|
2211
2220
|
* @param data The object to extract coordinate information from.
|
|
2212
2221
|
* @returns A Pixel object that represents the provided data information.
|
|
2213
2222
|
*/
|
|
2214
|
-
static fromData(data: object): Pixel;
|
|
2223
|
+
static fromData (data: object): Pixel;
|
|
2215
2224
|
/**
|
|
2216
2225
|
* Return the x coordinate of the specified pixel.
|
|
2217
2226
|
* @param pixel The pixel to get the x coordinate of.
|
|
2218
2227
|
*/
|
|
2219
|
-
static getX(pixel: Pixel): number;
|
|
2228
|
+
static getX (pixel: Pixel): number;
|
|
2220
2229
|
/**
|
|
2221
2230
|
* Return the y coordinate of the specified pixel.
|
|
2222
2231
|
* @param pixel The pixel to get the y coordinate of.
|
|
2223
2232
|
*/
|
|
2224
|
-
static getY(pixel: Pixel): number;
|
|
2233
|
+
static getY (pixel: Pixel): number;
|
|
2225
2234
|
/**
|
|
2226
2235
|
* Calculates a destination pixel given an origin pixel,
|
|
2227
2236
|
* a heading relative to the y-axis (0 = north) with clockwise-rotation,
|
|
@@ -2230,20 +2239,20 @@ declare namespace atlas {
|
|
|
2230
2239
|
* @param heading The heading at which to move away from the origin pixel.
|
|
2231
2240
|
* @param distance The distance to move from the origin pixel.
|
|
2232
2241
|
*/
|
|
2233
|
-
static getDestination(origin: Pixel, heading: number, distance: number): Pixel;
|
|
2242
|
+
static getDestination (origin: Pixel, heading: number, distance: number): Pixel;
|
|
2234
2243
|
/**
|
|
2235
2244
|
* Calculates the distance between two pixels.
|
|
2236
2245
|
* Returned value is in screen pixel units.
|
|
2237
2246
|
* @param p1 The first pixel.
|
|
2238
2247
|
* @param p2 The second pixel.
|
|
2239
2248
|
*/
|
|
2240
|
-
static getDistance(p1: Pixel, p2: Pixel): number;
|
|
2249
|
+
static getDistance (p1: Pixel, p2: Pixel): number;
|
|
2241
2250
|
/**
|
|
2242
2251
|
* Calculates the heading between two pixels. The heading value is relative to the y-axis (0 = north) with clockwise-rotation.
|
|
2243
2252
|
* @param origin The pixel the heading will point away from.
|
|
2244
2253
|
* @param destination The pixel the heading will point toward.
|
|
2245
2254
|
*/
|
|
2246
|
-
static getHeading(origin: Pixel, destination: Pixel): number;
|
|
2255
|
+
static getHeading (origin: Pixel, destination: Pixel): number;
|
|
2247
2256
|
}
|
|
2248
2257
|
|
|
2249
2258
|
export interface PopupEvents {
|
|
@@ -2274,31 +2283,31 @@ declare namespace atlas {
|
|
|
2274
2283
|
* Constructs a Popup object and initializes it with the specified options.
|
|
2275
2284
|
* @param options The options for the popup.
|
|
2276
2285
|
*/
|
|
2277
|
-
constructor(options?: PopupOptions);
|
|
2286
|
+
constructor (options?: PopupOptions);
|
|
2278
2287
|
/**
|
|
2279
2288
|
* Sets the options for the popup.
|
|
2280
2289
|
* @param options The options for the popup.
|
|
2281
2290
|
* @deprecated Use setOptions(...) instead.
|
|
2282
2291
|
*/
|
|
2283
|
-
setPopupOptions(options?: PopupOptions): void;
|
|
2292
|
+
setPopupOptions (options?: PopupOptions): void;
|
|
2284
2293
|
/**
|
|
2285
2294
|
* Sets the options for the popup.
|
|
2286
2295
|
* @param options The options for the popup.
|
|
2287
2296
|
*/
|
|
2288
|
-
setOptions(options?: PopupOptions): void;
|
|
2297
|
+
setOptions (options?: PopupOptions): void;
|
|
2289
2298
|
/**
|
|
2290
2299
|
* Returns the options for the popup.
|
|
2291
2300
|
* @deprecated Use getOptions() instead.
|
|
2292
2301
|
*/
|
|
2293
|
-
getPopupOptions(): PopupOptions;
|
|
2302
|
+
getPopupOptions (): PopupOptions;
|
|
2294
2303
|
/**
|
|
2295
2304
|
* Returns the options for the popup.
|
|
2296
2305
|
*/
|
|
2297
|
-
getOptions(): PopupOptions;
|
|
2306
|
+
getOptions (): PopupOptions;
|
|
2298
2307
|
/**
|
|
2299
2308
|
* Returns popup container element.
|
|
2300
2309
|
*/
|
|
2301
|
-
getPopupContainer(): HTMLElement
|
|
2310
|
+
getPopupContainer (): HTMLElement;
|
|
2302
2311
|
/**
|
|
2303
2312
|
* Attaches the popup to the HTML document in a hidden state.
|
|
2304
2313
|
* @param map The map.
|
|
@@ -2488,7 +2497,7 @@ declare namespace atlas {
|
|
|
2488
2497
|
* @param prop The properties object generate the popup content from.
|
|
2489
2498
|
* @param template The template to apply.
|
|
2490
2499
|
*/
|
|
2491
|
-
static applyTemplate(prop: Properties, template?: PopupTemplate): HTMLElement;
|
|
2500
|
+
static applyTemplate (prop: Properties, template?: PopupTemplate): HTMLElement;
|
|
2492
2501
|
/** Regular expression for content property placeholders. */
|
|
2493
2502
|
private static readonly _placeholderRx;
|
|
2494
2503
|
/** Regular expression for external URLs. */
|
|
@@ -2553,7 +2562,7 @@ declare namespace atlas {
|
|
|
2553
2562
|
* @param key The property name key.
|
|
2554
2563
|
* @param value The value of the property.
|
|
2555
2564
|
*/
|
|
2556
|
-
static _ignoreProperty(key: string, value: any): boolean;
|
|
2565
|
+
static _ignoreProperty (key: string, value: any): boolean;
|
|
2557
2566
|
}
|
|
2558
2567
|
|
|
2559
2568
|
export interface ShapeEvents {
|
|
@@ -2572,69 +2581,69 @@ declare namespace atlas {
|
|
|
2572
2581
|
* @param data: a Feature which contains a Geometry object and properties.
|
|
2573
2582
|
* If the feature does not have an id, a unique id value will be assigned to it.
|
|
2574
2583
|
*/
|
|
2575
|
-
constructor(data: atlas.data.Feature<atlas.data.Geometry, any>);
|
|
2584
|
+
constructor (data: atlas.data.Feature<atlas.data.Geometry, any>);
|
|
2576
2585
|
/**
|
|
2577
2586
|
* Constructs a Shape object and initializes it with the specified Geometry, ID, and properties.
|
|
2578
2587
|
* @param data a Geometry object
|
|
2579
2588
|
* @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
2589
|
* @param properties User defined properties for the shape.
|
|
2581
2590
|
*/
|
|
2582
|
-
constructor(data: atlas.data.Geometry, id?: string | number, properties?: any);
|
|
2591
|
+
constructor (data: atlas.data.Geometry, id?: string | number, properties?: any);
|
|
2583
2592
|
/**
|
|
2584
2593
|
* Adds or updates an existing property value in the shape.
|
|
2585
2594
|
* @param key
|
|
2586
2595
|
* @param value
|
|
2587
2596
|
*/
|
|
2588
|
-
addProperty(key: string, value: any): void;
|
|
2597
|
+
addProperty (key: string, value: any): void;
|
|
2589
2598
|
/**
|
|
2590
2599
|
* Gets the bounding box of the shape
|
|
2591
2600
|
*/
|
|
2592
|
-
getBounds(): atlas.data.BoundingBox;
|
|
2601
|
+
getBounds (): atlas.data.BoundingBox;
|
|
2593
2602
|
/**
|
|
2594
2603
|
* Gets the coordinates of the shape.
|
|
2595
2604
|
*/
|
|
2596
|
-
getCoordinates(): atlas.data.Position | atlas.data.Position[] | atlas.data.Position[][] | atlas.data.Position[][][];
|
|
2605
|
+
getCoordinates (): atlas.data.Position | atlas.data.Position[] | atlas.data.Position[][] | atlas.data.Position[][][];
|
|
2597
2606
|
/**
|
|
2598
2607
|
* If the shape is a circle, this gets its coordinates. Otherwise returns null.
|
|
2599
2608
|
*/
|
|
2600
|
-
getCircleCoordinates(): atlas.data.Position[];
|
|
2609
|
+
getCircleCoordinates (): atlas.data.Position[];
|
|
2601
2610
|
/**
|
|
2602
2611
|
* Gets the id of the shape.
|
|
2603
2612
|
*/
|
|
2604
|
-
getId(): string | number;
|
|
2613
|
+
getId (): string | number;
|
|
2605
2614
|
/**
|
|
2606
2615
|
* Gets the properties of the shape.
|
|
2607
2616
|
*/
|
|
2608
|
-
getProperties(): any;
|
|
2617
|
+
getProperties (): any;
|
|
2609
2618
|
/**
|
|
2610
2619
|
* Returns a string indicating the type of geometry this shape contains.
|
|
2611
2620
|
*/
|
|
2612
|
-
getType(): string;
|
|
2621
|
+
getType (): string;
|
|
2613
2622
|
/**
|
|
2614
2623
|
* Indicates if the contained shape is a Circle, defined by the extended GeoJSON specification supported by Azure Maps.
|
|
2615
2624
|
* [Extended Spec]{@link https://docs.microsoft.com/en-us/azure/azure-maps/extend-geojson}
|
|
2616
2625
|
*/
|
|
2617
|
-
isCircle(): boolean;
|
|
2626
|
+
isCircle (): boolean;
|
|
2618
2627
|
/**
|
|
2619
2628
|
* Indicates if the contained shape is a Rectangle, defined by the extended GeoJSON specification supported by Azure Maps.
|
|
2620
2629
|
* [Extended Spec]{@link https://docs.microsoft.com/en-us/azure/azure-maps/extend-geojson}
|
|
2621
2630
|
*/
|
|
2622
|
-
isRectangle(): boolean;
|
|
2631
|
+
isRectangle (): boolean;
|
|
2623
2632
|
/**
|
|
2624
2633
|
* Updates the coordinates of the shape
|
|
2625
2634
|
* @param coords Point: Position, LineString: Position[], Polygon: Position[][],
|
|
2626
2635
|
* MultiPoint: Position[], MultiLineString: Position[][], MultiPolygon: Position[][]
|
|
2627
2636
|
*/
|
|
2628
|
-
setCoordinates(coords: atlas.data.Position | atlas.data.Position[] | atlas.data.Position[][] | atlas.data.Position[][][]): void;
|
|
2637
|
+
setCoordinates (coords: atlas.data.Position | atlas.data.Position[] | atlas.data.Position[][] | atlas.data.Position[][][]): void;
|
|
2629
2638
|
/**
|
|
2630
2639
|
* Sets the properties on the shape. Overwrites all existing properties.
|
|
2631
2640
|
* @param properties
|
|
2632
2641
|
*/
|
|
2633
|
-
setProperties(properties: any): void;
|
|
2642
|
+
setProperties (properties: any): void;
|
|
2634
2643
|
/**
|
|
2635
2644
|
* Returns a GeoJSON feature that represents the shape.
|
|
2636
2645
|
*/
|
|
2637
|
-
toJson(): atlas.data.Feature<atlas.data.Geometry, any>;
|
|
2646
|
+
toJson (): atlas.data.Feature<atlas.data.Geometry, any>;
|
|
2638
2647
|
/**
|
|
2639
2648
|
* Check if the shape's wrapped feature is a circle form the extended GeoJSON spec.
|
|
2640
2649
|
* If so it will calculate a polygon feature that approximates the specified circle.
|
|
@@ -2677,24 +2686,24 @@ declare namespace atlas {
|
|
|
2677
2686
|
* Constructs a new HtmlMarker.
|
|
2678
2687
|
* @param options The options for the HtmlMarker.
|
|
2679
2688
|
*/
|
|
2680
|
-
constructor(options?: HtmlMarkerOptions);
|
|
2689
|
+
constructor (options?: HtmlMarkerOptions);
|
|
2681
2690
|
/**
|
|
2682
2691
|
* Gets the HTML marker options.
|
|
2683
2692
|
*/
|
|
2684
|
-
getOptions(): HtmlMarkerOptions;
|
|
2693
|
+
getOptions (): HtmlMarkerOptions;
|
|
2685
2694
|
/**
|
|
2686
2695
|
* Returns the underlying `Marker`'s HTML element.
|
|
2687
2696
|
*/
|
|
2688
|
-
getElement(): HTMLElement;
|
|
2697
|
+
getElement (): HTMLElement;
|
|
2689
2698
|
/**
|
|
2690
2699
|
* Sets the options of the marker.
|
|
2691
2700
|
* @param options The options for the marker.
|
|
2692
2701
|
*/
|
|
2693
|
-
setOptions(options: HtmlMarkerOptions): void;
|
|
2702
|
+
setOptions (options: HtmlMarkerOptions): void;
|
|
2694
2703
|
/**
|
|
2695
2704
|
* Toggles the popup attached to the marker.
|
|
2696
2705
|
*/
|
|
2697
|
-
togglePopup(): void;
|
|
2706
|
+
togglePopup (): void;
|
|
2698
2707
|
/**
|
|
2699
2708
|
* Builds the Mapbox marker that this HtmlMarker will wrap.
|
|
2700
2709
|
* @private
|
|
@@ -2747,54 +2756,54 @@ declare namespace atlas {
|
|
|
2747
2756
|
* Gets the default authentication options that were provided.
|
|
2748
2757
|
* If not previously set all properties will be undefined.
|
|
2749
2758
|
*/
|
|
2750
|
-
export function getAuthenticationOptions(): AuthenticationOptions;
|
|
2759
|
+
export function getAuthenticationOptions (): AuthenticationOptions;
|
|
2751
2760
|
/**
|
|
2752
2761
|
* Gets the default domain that was provided.
|
|
2753
2762
|
* If not previously set the default value is `"atlas.microsoft.com"`.
|
|
2754
2763
|
*/
|
|
2755
|
-
export function getDomain(): string;
|
|
2764
|
+
export function getDomain (): string;
|
|
2756
2765
|
/**
|
|
2757
2766
|
* Gets the default language that was provided.
|
|
2758
2767
|
* If not previously set the default value is `"NGT"`.
|
|
2759
2768
|
*/
|
|
2760
|
-
export function getLanguage(): string;
|
|
2769
|
+
export function getLanguage (): string;
|
|
2761
2770
|
/**
|
|
2762
2771
|
* Gets the Maximum number of images (raster tiles, sprites, icons) to load in parallel
|
|
2763
2772
|
*/
|
|
2764
|
-
export function getMaxParallelImageRequests(): number;
|
|
2773
|
+
export function getMaxParallelImageRequests (): number;
|
|
2765
2774
|
/**
|
|
2766
2775
|
* Gets the default session id that was provided.
|
|
2767
2776
|
* If not previously set the default value is a random UUID.
|
|
2768
2777
|
*/
|
|
2769
|
-
export function getSessionId(): string;
|
|
2778
|
+
export function getSessionId (): string;
|
|
2770
2779
|
/**
|
|
2771
2780
|
* Gets the default Azure Maps subscription key that was provided.
|
|
2772
2781
|
*/
|
|
2773
|
-
export function getSubscriptionKey(): string;
|
|
2782
|
+
export function getSubscriptionKey (): string;
|
|
2774
2783
|
/**
|
|
2775
2784
|
* @deprecated use atlas.getView() instead
|
|
2776
2785
|
*/
|
|
2777
|
-
export function getUserRegion(): string;
|
|
2786
|
+
export function getUserRegion (): string;
|
|
2778
2787
|
/**
|
|
2779
2788
|
* Gets the default view setting of the map control.
|
|
2780
2789
|
* If not previously set the default value is `undefined`.
|
|
2781
2790
|
*/
|
|
2782
|
-
export function getView(): string;
|
|
2791
|
+
export function getView (): string;
|
|
2783
2792
|
/**
|
|
2784
2793
|
* Current API version number based on build number.
|
|
2785
2794
|
*/
|
|
2786
|
-
export function getVersion(): string;
|
|
2795
|
+
export function getVersion (): string;
|
|
2787
2796
|
/**
|
|
2788
2797
|
* Gets the worker count that will get created.
|
|
2789
2798
|
*/
|
|
2790
|
-
export function getWorkerCount(): number;
|
|
2799
|
+
export function getWorkerCount (): number;
|
|
2791
2800
|
/**
|
|
2792
2801
|
* Checks to see if the user's browser is supported by the map control.
|
|
2793
2802
|
* @param failIfMajorPerformanceCaveat If true the function will return false
|
|
2794
2803
|
* if the performance of the map control would be dramatically worse than expected
|
|
2795
2804
|
* (e.g. a software WebGL renderer would be used).
|
|
2796
2805
|
*/
|
|
2797
|
-
export function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean;
|
|
2806
|
+
export function isSupported (failIfMajorPerformanceCaveat?: boolean): boolean;
|
|
2798
2807
|
/**
|
|
2799
2808
|
* Sets your authentication options as the default options in the atlas namespace
|
|
2800
2809
|
* which is used by the map control and any modules that make requests to the Azure maps services.
|
|
@@ -2802,7 +2811,7 @@ declare namespace atlas {
|
|
|
2802
2811
|
* setAuthenticationOptions hasn't previously been called it will automatically be called by the Map constructor.
|
|
2803
2812
|
* @param options The new default authentication options.
|
|
2804
2813
|
*/
|
|
2805
|
-
export function setAuthenticationOptions(options: AuthenticationOptions): void;
|
|
2814
|
+
export function setAuthenticationOptions (options: AuthenticationOptions): void;
|
|
2806
2815
|
/**
|
|
2807
2816
|
* Sets the default domain used by the map and service modules unless the
|
|
2808
2817
|
* domain is explicitly specified when using those parts of the API.
|
|
@@ -2811,7 +2820,7 @@ declare namespace atlas {
|
|
|
2811
2820
|
* If the protocol is not specified `https` is assumed.
|
|
2812
2821
|
* @param domain The new default domain.
|
|
2813
2822
|
*/
|
|
2814
|
-
export function setDomain(domain: string): void;
|
|
2823
|
+
export function setDomain (domain: string): void;
|
|
2815
2824
|
/**
|
|
2816
2825
|
* Sets the default language used by the map and service modules unless the
|
|
2817
2826
|
* language is explicitly specified when using those parts of the API.
|
|
@@ -2819,13 +2828,13 @@ declare namespace atlas {
|
|
|
2819
2828
|
* setLanguage hasn't previously been called it will automatically be called by the Map constructor.
|
|
2820
2829
|
* @param language The new default language.
|
|
2821
2830
|
*/
|
|
2822
|
-
export function setLanguage(language: string): void;
|
|
2831
|
+
export function setLanguage (language: string): void;
|
|
2823
2832
|
/**
|
|
2824
2833
|
* Sets Maximum number of images (raster tiles, sprites, icons) to load in parallel,
|
|
2825
2834
|
* which affects performance in raster-heavy maps. 16 by default.
|
|
2826
2835
|
* @param maxParallelImageRequests Maximum number of images to load in parallel.
|
|
2827
2836
|
*/
|
|
2828
|
-
export function setMaxParallelImageRequests(maxParallelImageRequests: number): void;
|
|
2837
|
+
export function setMaxParallelImageRequests (maxParallelImageRequests: number): void;
|
|
2829
2838
|
/**
|
|
2830
2839
|
* Sets the default session id used by the map and service modules unless the
|
|
2831
2840
|
* session id is explicitly specified when using those parts of the API.
|
|
@@ -2833,7 +2842,7 @@ declare namespace atlas {
|
|
|
2833
2842
|
* setSessionId hasn't previously been called it will automatically be called by the Map constructor.
|
|
2834
2843
|
* @param id The new default session id.
|
|
2835
2844
|
*/
|
|
2836
|
-
export function setSessionId(id: string): void;
|
|
2845
|
+
export function setSessionId (id: string): void;
|
|
2837
2846
|
/**
|
|
2838
2847
|
* Sets your Azure Maps subscription key as the default subscription key in the atlas namespace
|
|
2839
2848
|
* which is used by the map control and any modules that make requests to the Azure maps services.
|
|
@@ -2841,41 +2850,41 @@ declare namespace atlas {
|
|
|
2841
2850
|
* setSubscriptionKey hasn't previously been called it will automatically be called by the Map constructor.
|
|
2842
2851
|
* @param key The new default subscription key.
|
|
2843
2852
|
*/
|
|
2844
|
-
export function setSubscriptionKey(key: string): void;
|
|
2853
|
+
export function setSubscriptionKey (key: string): void;
|
|
2845
2854
|
/**
|
|
2846
2855
|
* @deprecated use atlas.setView(view: string) instead.
|
|
2847
2856
|
*/
|
|
2848
|
-
export function setUserRegion(userRegion: string): void;
|
|
2857
|
+
export function setUserRegion (userRegion: string): void;
|
|
2849
2858
|
/**
|
|
2850
2859
|
* 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
2860
|
* Please see the supported [Views]{@link https://aka.ms/AzureMapsLocalizationViews }.
|
|
2852
2861
|
* 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
2862
|
* @param view The new default view
|
|
2854
2863
|
*/
|
|
2855
|
-
export function setView(view: string): void;
|
|
2864
|
+
export function setView (view: string): void;
|
|
2856
2865
|
/**
|
|
2857
2866
|
* Sets number of web workers instantiated on a page.
|
|
2858
2867
|
* By default, it is set to half the number of CPU cores (capped at 6).
|
|
2859
2868
|
* @param workerCount worker count.
|
|
2860
2869
|
*/
|
|
2861
|
-
export function setWorkerCount(workerCount: number): void;
|
|
2870
|
+
export function setWorkerCount (workerCount: number): void;
|
|
2862
2871
|
/**
|
|
2863
2872
|
* Adds an image template to the atlas namespace.
|
|
2864
2873
|
* @param templateName The name of the template.
|
|
2865
2874
|
* @param template The SVG template to add. Supports {color}, {secondaryColor}, {scale}, {text}.
|
|
2866
2875
|
* @param override Specifies if it should override existing templates if one with the same name already exists.
|
|
2867
2876
|
*/
|
|
2868
|
-
export function addImageTemplate(templateName: string, template: string, override: boolean): void;
|
|
2877
|
+
export function addImageTemplate (templateName: string, template: string, override: boolean): void;
|
|
2869
2878
|
/**
|
|
2870
2879
|
* Retrieves an SVG template by name.
|
|
2871
2880
|
* @param templateName The name of the template to retrieve.
|
|
2872
2881
|
* @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
2882
|
*/
|
|
2874
|
-
export function getImageTemplate(templateName: string, scale?: number): string;
|
|
2883
|
+
export function getImageTemplate (templateName: string, scale?: number): string;
|
|
2875
2884
|
/**
|
|
2876
2885
|
* Retrieves an array of names for all image templates that are available in the atlas namespace.
|
|
2877
2886
|
*/
|
|
2878
|
-
export function getAllImageTemplateNames(): string[];
|
|
2887
|
+
export function getAllImageTemplateNames (): string[];
|
|
2879
2888
|
/**
|
|
2880
2889
|
* Initializes resources like WebWorkers that can be shared across maps to lower load
|
|
2881
2890
|
* times in some situations. `atlas.setWorkerCount`, if being
|
|
@@ -2893,14 +2902,14 @@ declare namespace atlas {
|
|
|
2893
2902
|
* would navigate between various views that can cause Map instances to constantly be
|
|
2894
2903
|
* created and destroyed.
|
|
2895
2904
|
*/
|
|
2896
|
-
export function prewarm(): void;
|
|
2905
|
+
export function prewarm (): void;
|
|
2897
2906
|
/**
|
|
2898
2907
|
* Clears up resources that have previously been created by `atlas.prewarm()`.
|
|
2899
2908
|
* Note that this is typically not necessary. You should only call this function
|
|
2900
2909
|
* if you expect the user of your app to not return to a Map view at any point
|
|
2901
2910
|
* in your application.
|
|
2902
2911
|
*/
|
|
2903
|
-
export function clearPrewarmedResources(): void;
|
|
2912
|
+
export function clearPrewarmedResources (): void;
|
|
2904
2913
|
/**
|
|
2905
2914
|
* Options used when rendering Point objects in a BubbleLayer.
|
|
2906
2915
|
*/
|
|
@@ -2953,9 +2962,9 @@ declare namespace atlas {
|
|
|
2953
2962
|
*/
|
|
2954
2963
|
strokeWidth?: number | DataDrivenPropertyValueSpecification<number>;
|
|
2955
2964
|
/**
|
|
2956
|
-
* Specifies the orientation of circle when map is pitched
|
|
2957
|
-
*
|
|
2958
|
-
*
|
|
2965
|
+
* Specifies the orientation of circle when map is pitched.<br />
|
|
2966
|
+
* `"map"`: The circle is aligned to the plane of the map.<br />
|
|
2967
|
+
* `"viewport"`: The circle is aligned to the plane of the viewport.<br />
|
|
2959
2968
|
* Default: `"viewport"`
|
|
2960
2969
|
* @default "viewport"
|
|
2961
2970
|
*/
|
|
@@ -2982,16 +2991,16 @@ declare namespace atlas {
|
|
|
2982
2991
|
*/
|
|
2983
2992
|
allowOverlap?: boolean;
|
|
2984
2993
|
/**
|
|
2985
|
-
* Specifies which part of the icon is placed closest to the icons anchor position on the map
|
|
2986
|
-
*
|
|
2987
|
-
*
|
|
2988
|
-
*
|
|
2989
|
-
*
|
|
2990
|
-
*
|
|
2991
|
-
*
|
|
2992
|
-
*
|
|
2993
|
-
*
|
|
2994
|
-
*
|
|
2994
|
+
* Specifies which part of the icon is placed closest to the icons anchor position on the map.<br />
|
|
2995
|
+
* `"center"`: The center of the icon is placed closest to the anchor.<br />
|
|
2996
|
+
* `"left"`: The left side of the icon is placed closest to the anchor.<br />
|
|
2997
|
+
* `"right"`: The right side of the icon is placed closest to the anchor.<br />
|
|
2998
|
+
* `"top"`: The top of the icon is placed closest to the anchor.<br />
|
|
2999
|
+
* `"bottom"`: The bottom of the icon is placed closest to the anchor.<br />
|
|
3000
|
+
* `"top-left"`: The top left corner of the icon is placed closest to the anchor.<br />
|
|
3001
|
+
* `"top-right"`: The top right corner of the icon is placed closest to the anchor.<br />
|
|
3002
|
+
* `"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.<br />
|
|
3003
|
+
* `"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.<br />
|
|
2995
3004
|
* Default `"bottom"`.
|
|
2996
3005
|
* @default "bottom"
|
|
2997
3006
|
*/
|
|
@@ -3036,10 +3045,10 @@ declare namespace atlas {
|
|
|
3036
3045
|
*/
|
|
3037
3046
|
padding?: number | DataDrivenPropertyValueSpecification<number>;
|
|
3038
3047
|
/**
|
|
3039
|
-
* Specifies the orientation of the icon when the map is pitched
|
|
3040
|
-
*
|
|
3041
|
-
*
|
|
3042
|
-
*
|
|
3048
|
+
* Specifies the orientation of the icon when the map is pitched.<br />
|
|
3049
|
+
* `"auto"`: Automatically matches the value of `rotationAlignment`.<br />
|
|
3050
|
+
* `"map"`: The icon is aligned to the plane of the map.<br />
|
|
3051
|
+
* `"viewport"`: The icon is aligned to the plane of the viewport<br />
|
|
3043
3052
|
* Default `"auto"`
|
|
3044
3053
|
* @default "auto"
|
|
3045
3054
|
*/
|
|
@@ -3052,12 +3061,12 @@ declare namespace atlas {
|
|
|
3052
3061
|
rotation?: number | DataDrivenPropertyValueSpecification<number>;
|
|
3053
3062
|
/**
|
|
3054
3063
|
* In combination with the placement property of a SymbolLayerOptions
|
|
3055
|
-
* this determines the rotation behavior of icons
|
|
3056
|
-
*
|
|
3057
|
-
* When placement is "line" this is equivalent to "map"
|
|
3058
|
-
*
|
|
3059
|
-
* When placement is "line" aligns the icons' x-axes with the line
|
|
3060
|
-
*
|
|
3064
|
+
* this determines the rotation behavior of icons.<br />
|
|
3065
|
+
* `"auto"`: When placement is "point" this is equivalent to "viewport".
|
|
3066
|
+
* When placement is "line" this is equivalent to "map".<br />
|
|
3067
|
+
* `"map"`: When placement is "point" aligns icons east-west.
|
|
3068
|
+
* When placement is "line" aligns the icons' x-axes with the line.<br />
|
|
3069
|
+
* `"viewport"`: Icons' x-axes will align with the x-axis of the viewport.<br />
|
|
3061
3070
|
* Default `"auto"`.
|
|
3062
3071
|
* @default "auto"
|
|
3063
3072
|
*/
|
|
@@ -3196,24 +3205,24 @@ declare namespace atlas {
|
|
|
3196
3205
|
*/
|
|
3197
3206
|
sourceLayer?: string;
|
|
3198
3207
|
/**
|
|
3199
|
-
* Specifies how the ends of the lines are rendered
|
|
3200
|
-
*
|
|
3201
|
-
*
|
|
3202
|
-
* at a radius of one-half of the lines width and centered on the endpoint of the line
|
|
3203
|
-
*
|
|
3204
|
-
* at a distance of one-half of the line width
|
|
3208
|
+
* Specifies how the ends of the lines are rendered.<br />
|
|
3209
|
+
* `"butt"`: A cap with a squared-off end which is drawn to the exact endpoint of the line.<br />
|
|
3210
|
+
* `"round"`: A cap with a rounded end which is drawn beyond the endpoint of the line
|
|
3211
|
+
* at a radius of one-half of the lines width and centered on the endpoint of the line.<br />
|
|
3212
|
+
* `"square"`: A cap with a squared-off end which is drawn beyond the endpoint of the line
|
|
3213
|
+
* at a distance of one-half of the line width.<br />
|
|
3205
3214
|
* Default `"round"`.
|
|
3206
3215
|
* @default "round"
|
|
3207
3216
|
*/
|
|
3208
3217
|
lineCap?: "butt" | "round" | "square";
|
|
3209
3218
|
/**
|
|
3210
|
-
* Specifies how the joints in the lines are rendered
|
|
3211
|
-
*
|
|
3212
|
-
* at a distance of one-half of the lines width
|
|
3213
|
-
*
|
|
3214
|
-
* at a radius of one-half of the lines width and centered on the endpoint of the line
|
|
3215
|
-
*
|
|
3216
|
-
* beyond the endpoint of the path until they meet
|
|
3219
|
+
* Specifies how the joints in the lines are rendered.<br />
|
|
3220
|
+
* `"bevel"`: A join with a squared-off end which is drawn beyond the endpoint of the line
|
|
3221
|
+
* at a distance of one-half of the lines width.<br />
|
|
3222
|
+
* `"round"`: A join with a rounded end which is drawn beyond the endpoint of the line
|
|
3223
|
+
* at a radius of one-half of the lines width and centered on the endpoint of the line.<br />
|
|
3224
|
+
* `"miter"`: A join with a sharp, angled corner which is drawn with the outer sides
|
|
3225
|
+
* beyond the endpoint of the path until they meet.<br />
|
|
3217
3226
|
* Default `"round"`.
|
|
3218
3227
|
* @default "round"
|
|
3219
3228
|
*/
|
|
@@ -3264,9 +3273,9 @@ declare namespace atlas {
|
|
|
3264
3273
|
*/
|
|
3265
3274
|
translate?: Pixel;
|
|
3266
3275
|
/**
|
|
3267
|
-
* Specifies the frame of reference for `translate
|
|
3268
|
-
*
|
|
3269
|
-
*
|
|
3276
|
+
* Specifies the frame of reference for `translate`.<br />
|
|
3277
|
+
* `"map"`: Lines are translated relative to the map.<br />
|
|
3278
|
+
* `"viewport"`: Lines are translated relative to the viewport<br />
|
|
3270
3279
|
* Default: `"map"`
|
|
3271
3280
|
* @default "map"
|
|
3272
3281
|
*/
|
|
@@ -3385,9 +3394,9 @@ declare namespace atlas {
|
|
|
3385
3394
|
*/
|
|
3386
3395
|
translate?: Pixel;
|
|
3387
3396
|
/**
|
|
3388
|
-
* Specifies the frame of reference for `translate
|
|
3389
|
-
*
|
|
3390
|
-
*
|
|
3397
|
+
* Specifies the frame of reference for `translate`.<br />
|
|
3398
|
+
* `"map"`: Polygons are translated relative to the map.<br />
|
|
3399
|
+
* `"viewport"`: Polygons are translated relative to the viewport.<br />
|
|
3391
3400
|
* Default: `"map"`
|
|
3392
3401
|
* @default "map"
|
|
3393
3402
|
*/
|
|
@@ -3463,12 +3472,12 @@ declare namespace atlas {
|
|
|
3463
3472
|
*/
|
|
3464
3473
|
textOptions?: TextOptions;
|
|
3465
3474
|
/**
|
|
3466
|
-
* Specifies the label placement relative to its geometry
|
|
3467
|
-
*
|
|
3468
|
-
*
|
|
3469
|
-
* Can only be used on LineString and Polygon geometries
|
|
3470
|
-
*
|
|
3471
|
-
* Can only be used on `LineString` and `Polygon` geometries
|
|
3475
|
+
* Specifies the label placement relative to its geometry.<br />
|
|
3476
|
+
* `"point"`: The label is placed at the point where the geometry is located.<br />
|
|
3477
|
+
* `"line"`: The label is placed along the line of the geometry.
|
|
3478
|
+
* Can only be used on LineString and Polygon geometries.<br />
|
|
3479
|
+
* `"line-center"`: The label is placed at the center of the line of the geometry.
|
|
3480
|
+
* Can only be used on `LineString` and `Polygon` geometries <br />
|
|
3472
3481
|
* Default `"point"`.
|
|
3473
3482
|
* @default "point"
|
|
3474
3483
|
*/
|
|
@@ -3483,12 +3492,12 @@ declare namespace atlas {
|
|
|
3483
3492
|
/**
|
|
3484
3493
|
* Determines whether overlapping symbols in the same layer are rendered in the order
|
|
3485
3494
|
* 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
|
-
*
|
|
3488
|
-
*
|
|
3489
|
-
* if `ignorePlacement` is `false
|
|
3490
|
-
*
|
|
3491
|
-
* same order as the source data
|
|
3495
|
+
* To control the order and prioritization of symbols otherwise, use `sortKey`.<br />
|
|
3496
|
+
* `"auto"`: Sorts symbols by `sortKey` if set. Otherwise behaves like `"viewport-y"`.<br />
|
|
3497
|
+
* `"viewport-y"`: Sorts symbols by their y position if `allowOverlap` is `true` or
|
|
3498
|
+
* if `ignorePlacement` is `false`.<br />
|
|
3499
|
+
* `"source"`: Sorts symbols by `sortKey` if set. Otherwise, symbols are rendered in the
|
|
3500
|
+
* same order as the source data.<br />
|
|
3492
3501
|
* Default `"auto"`
|
|
3493
3502
|
* @default "auto"
|
|
3494
3503
|
*/
|
|
@@ -3513,16 +3522,16 @@ declare namespace atlas {
|
|
|
3513
3522
|
*/
|
|
3514
3523
|
allowOverlap?: boolean;
|
|
3515
3524
|
/**
|
|
3516
|
-
* Specifies which part of the icon is placed closest to the icons anchor position on the map
|
|
3517
|
-
*
|
|
3518
|
-
*
|
|
3519
|
-
*
|
|
3520
|
-
*
|
|
3521
|
-
*
|
|
3522
|
-
*
|
|
3523
|
-
*
|
|
3524
|
-
*
|
|
3525
|
-
*
|
|
3525
|
+
* Specifies which part of the icon is placed closest to the icons anchor position on the map.<br />
|
|
3526
|
+
* `"center"`: The center of the icon is placed closest to the anchor.<br />
|
|
3527
|
+
* `"left"`: The left side of the icon is placed closest to the anchor.<br />
|
|
3528
|
+
* `"right"`: The right side of the icon is placed closest to the anchor.<br />
|
|
3529
|
+
* `"top"`: The top of the icon is placed closest to the anchor.<br />
|
|
3530
|
+
* `"bottom"`: The bottom of the icon is placed closest to the anchor.<br />
|
|
3531
|
+
* `"top-left"`: The top left corner of the icon is placed closest to the anchor.<br />
|
|
3532
|
+
* `"top-right"`: The top right corner of the icon is placed closest to the anchor.<br />
|
|
3533
|
+
* `"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.<br />
|
|
3534
|
+
* `"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.<br />
|
|
3526
3535
|
* Default `"center"`.
|
|
3527
3536
|
* @default "center"
|
|
3528
3537
|
*/
|
|
@@ -3552,11 +3561,11 @@ declare namespace atlas {
|
|
|
3552
3561
|
*/
|
|
3553
3562
|
ignorePlacement?: boolean;
|
|
3554
3563
|
/**
|
|
3555
|
-
* Text justification options
|
|
3556
|
-
*
|
|
3557
|
-
*
|
|
3558
|
-
*
|
|
3559
|
-
*
|
|
3564
|
+
* Text justification options.<br />
|
|
3565
|
+
* `"auto"`: The text is aligned towards the anchor position.<br />
|
|
3566
|
+
* `"left"`: The text is aligned to the left.<br />
|
|
3567
|
+
* `"center"`: The text is centered.<br />
|
|
3568
|
+
* `"right"`: The text is aligned to the right.<br />
|
|
3560
3569
|
* Default `"center"`.
|
|
3561
3570
|
* @default "center"
|
|
3562
3571
|
*/
|
|
@@ -3584,10 +3593,10 @@ declare namespace atlas {
|
|
|
3584
3593
|
*/
|
|
3585
3594
|
padding?: number | PropertyValueSpecification<number>;
|
|
3586
3595
|
/**
|
|
3587
|
-
* Specifies the orientation of the text when the map is pitched
|
|
3588
|
-
*
|
|
3589
|
-
*
|
|
3590
|
-
*
|
|
3596
|
+
* Specifies the orientation of the text when the map is pitched.<br />
|
|
3597
|
+
* `"auto"`: Automatically matches the value of `rotationAlignment`.<br />
|
|
3598
|
+
* `"map"`: The text is aligned to the plane of the map.<br />
|
|
3599
|
+
* `"viewport"`: The text is aligned to the plane of the viewport.<br />
|
|
3591
3600
|
* Default: `"auto"`
|
|
3592
3601
|
* @default "auto"
|
|
3593
3602
|
*/
|
|
@@ -3607,13 +3616,13 @@ declare namespace atlas {
|
|
|
3607
3616
|
rotation?: number | DataDrivenPropertyValueSpecification<number>;
|
|
3608
3617
|
/**
|
|
3609
3618
|
* In combination with the `placement` property of the `SymbolLayerOptions`,
|
|
3610
|
-
* specifies the rotation behavior of the individual glyphs forming the text
|
|
3611
|
-
*
|
|
3612
|
-
* When the `placement` is set to `"line"` this is equivalent to `"map"
|
|
3613
|
-
*
|
|
3614
|
-
* When the `placement` is set to `"line"`, aligns text x-axes with the line
|
|
3615
|
-
*
|
|
3616
|
-
* regardless of the value of `placement
|
|
3619
|
+
* specifies the rotation behavior of the individual glyphs forming the text.<br />
|
|
3620
|
+
* `"auto"`: When the `placement` is set to `"point"`, this is equivalent to `"map"`.
|
|
3621
|
+
* When the `placement` is set to `"line"` this is equivalent to `"map"`.<br />
|
|
3622
|
+
* `"map"`: When the `placement` is set to `"point"`, aligns text east-west.
|
|
3623
|
+
* When the `placement` is set to `"line"`, aligns text x-axes with the line.<br />
|
|
3624
|
+
* `"viewport"`: Produces glyphs whose x-axes are aligned with the x-axis of the viewport,
|
|
3625
|
+
* regardless of the value of `placement`.<br />
|
|
3617
3626
|
* Default: `"auto"`
|
|
3618
3627
|
* @default "auto"
|
|
3619
3628
|
*/
|
|
@@ -3623,16 +3632,16 @@ declare namespace atlas {
|
|
|
3623
3632
|
* labels on the map. The renderer will attempt to place the label at each location,
|
|
3624
3633
|
* in order, before moving onto the next label. Use `justify: "auto"` to choose text
|
|
3625
3634
|
* justification based on anchor position. To apply an offset use the `radialOffset` or
|
|
3626
|
-
* two-dimensional `offset` options
|
|
3627
|
-
*
|
|
3628
|
-
*
|
|
3629
|
-
*
|
|
3630
|
-
*
|
|
3631
|
-
*
|
|
3632
|
-
*
|
|
3633
|
-
*
|
|
3634
|
-
*
|
|
3635
|
-
*
|
|
3635
|
+
* two-dimensional `offset` options.<br />
|
|
3636
|
+
* `"center"`: The center of the icon is placed closest to the anchor.<br />
|
|
3637
|
+
* `"left"`: The left side of the icon is placed closest to the anchor.<br />
|
|
3638
|
+
* `"right"`: The right side of the icon is placed closest to the anchor.<br />
|
|
3639
|
+
* `"top"`: The top of the icon is placed closest to the anchor.<br />
|
|
3640
|
+
* `"bottom"`: The bottom of the icon is placed closest to the anchor.<br />
|
|
3641
|
+
* `"top-left"`: The top left corner of the icon is placed closest to the anchor.<br />
|
|
3642
|
+
* `"top-right"`: The top right corner of the icon is placed closest to the anchor.<br />
|
|
3643
|
+
* `"bottom-left"`: The bottom left corner of the icon is placed closest to the anchor.<br />
|
|
3644
|
+
* `"bottom-right"`: The bottom right corner of the icon is placed closest to the anchor.<br />
|
|
3636
3645
|
* Default: `undefined`
|
|
3637
3646
|
* @default undefined
|
|
3638
3647
|
*/
|
|
@@ -3834,9 +3843,9 @@ declare namespace atlas {
|
|
|
3834
3843
|
*/
|
|
3835
3844
|
export interface StyleControlOptions extends Options {
|
|
3836
3845
|
/**
|
|
3837
|
-
* The layout to display the styles in
|
|
3838
|
-
*
|
|
3839
|
-
*
|
|
3846
|
+
* The layout to display the styles in.<br />
|
|
3847
|
+
* `"icons"`: A row of clickable icons for each style.<br />
|
|
3848
|
+
* `"list"`: A scrollable list with the icons and names for each style.<br />
|
|
3840
3849
|
* Default `"icons"`
|
|
3841
3850
|
* @default "icons"
|
|
3842
3851
|
*/
|
|
@@ -3886,13 +3895,12 @@ declare namespace atlas {
|
|
|
3886
3895
|
|
|
3887
3896
|
export interface TrafficControlOptions extends Options {
|
|
3888
3897
|
/**
|
|
3889
|
-
* The type of traffic flow to display
|
|
3890
|
-
*
|
|
3891
|
-
*
|
|
3892
|
-
*
|
|
3893
|
-
*
|
|
3894
|
-
* false to stop displaying the traffic flow
|
|
3895
|
-
* default `"relative"``
|
|
3898
|
+
* The type of traffic flow to display:<br />
|
|
3899
|
+
* `"none"` is to display no traffic flow data<br />
|
|
3900
|
+
* `"relative"` is the speed of the road relative to free-flow<br />
|
|
3901
|
+
* @deprecated `"absolute"` is the absolute speed of the road<br />
|
|
3902
|
+
* @deprecated `"relative-delay"` displays relative speed only where they differ from free-flow;
|
|
3903
|
+
* false to stop displaying the traffic flow.<br />
|
|
3896
3904
|
* @default "relative"
|
|
3897
3905
|
*/
|
|
3898
3906
|
flow?: "none" | "relative" | "absolute" | "relative-delay";
|
|
@@ -3929,10 +3937,10 @@ declare namespace atlas {
|
|
|
3929
3937
|
*/
|
|
3930
3938
|
duration?: number;
|
|
3931
3939
|
/**
|
|
3932
|
-
* The type of animation
|
|
3933
|
-
*
|
|
3934
|
-
*
|
|
3935
|
-
*
|
|
3940
|
+
* The type of animation.<br />
|
|
3941
|
+
* `"jump"` is an immediate change.<br />
|
|
3942
|
+
* `"ease"` is a gradual change of the camera's settings.<br />
|
|
3943
|
+
* `"fly"` is a gradual change of the camera's settings following an arc resembling flight.<br />
|
|
3936
3944
|
* Default `"jump"`.
|
|
3937
3945
|
* @default "jump"
|
|
3938
3946
|
*/
|
|
@@ -4016,6 +4024,7 @@ declare namespace atlas {
|
|
|
4016
4024
|
pitch?: number;
|
|
4017
4025
|
/**
|
|
4018
4026
|
* 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`.
|
|
4027
|
+
* Setting `minZoom` below 1 may result in an empty map when the zoom level is less than 1.
|
|
4019
4028
|
* `default 1`
|
|
4020
4029
|
* @default 1
|
|
4021
4030
|
*/
|
|
@@ -4158,7 +4167,8 @@ declare namespace atlas {
|
|
|
4158
4167
|
*/
|
|
4159
4168
|
generateId?: boolean | undefined;
|
|
4160
4169
|
/**
|
|
4161
|
-
* A property to
|
|
4170
|
+
* A specified property name to be used as a feature ID (for feature state).
|
|
4171
|
+
* This can either be a property name or an object in the form `{<sourceLayer>: <propertyName>}`.
|
|
4162
4172
|
*/
|
|
4163
4173
|
promoteId?: { [key: string]: string } | string | undefined;
|
|
4164
4174
|
/**
|
|
@@ -4228,9 +4238,9 @@ declare namespace atlas {
|
|
|
4228
4238
|
|
|
4229
4239
|
export interface ElevationTileSourceOptions extends RasterTileSourceOptions {
|
|
4230
4240
|
/**
|
|
4231
|
-
* DEM tiles encoding format. Supported: `mapbox` or `terrarium
|
|
4232
|
-
*
|
|
4233
|
-
*
|
|
4241
|
+
* DEM tiles encoding format. Supported: `mapbox` or `terrarium`.<br />
|
|
4242
|
+
* `"terrarium": Terrarium format PNG tiles. See https://aws.amazon.com/es/public-datasets/terrain/ for more info.<br />
|
|
4243
|
+
* `"mapbox": Mapbox Terrain RGB tiles. See https://www.mapbox.com/help/access-elevation-data/#mapbox-terrain-rgb for more info.<br />
|
|
4234
4244
|
* default `mapbox`
|
|
4235
4245
|
* @default mapbox
|
|
4236
4246
|
*/
|
|
@@ -4376,15 +4386,15 @@ declare namespace atlas {
|
|
|
4376
4386
|
export interface LightOptions extends Options {
|
|
4377
4387
|
/**
|
|
4378
4388
|
* Specifies wether extruded geometries are lit relative to the map or viewport.
|
|
4379
|
-
* Supported values
|
|
4380
|
-
*
|
|
4381
|
-
*
|
|
4389
|
+
* Supported values:<br />
|
|
4390
|
+
* `"map"`: The position of the light source is aligned to the rotation of the map.<br />
|
|
4391
|
+
* `"viewport"`: The position fo the light source is aligned to the rotation of the viewport.<br />
|
|
4382
4392
|
* Default: `"map"`
|
|
4383
4393
|
* @default "map"
|
|
4384
4394
|
*/
|
|
4385
4395
|
anchor?: "map" | "viewport";
|
|
4386
4396
|
/**
|
|
4387
|
-
* Color tint for lighting extruded geometries
|
|
4397
|
+
* Color tint for lighting extruded geometries.
|
|
4388
4398
|
* Default: `"#FFFFFF"`
|
|
4389
4399
|
* @default "#FFFFFF"
|
|
4390
4400
|
*/
|
|
@@ -4521,13 +4531,13 @@ declare namespace atlas {
|
|
|
4521
4531
|
*/
|
|
4522
4532
|
export interface TrafficOptions extends Options {
|
|
4523
4533
|
/**
|
|
4524
|
-
|
|
4525
|
-
|
|
4526
|
-
|
|
4527
|
-
|
|
4528
|
-
|
|
4529
|
-
|
|
4530
|
-
|
|
4534
|
+
* The type of traffic flow to display:<br />
|
|
4535
|
+
* `"none"` is to display no traffic flow data<br />
|
|
4536
|
+
* `"relative"` is the speed of the road relative to free-flow<br />
|
|
4537
|
+
* @deprecated `"absolute"` is the absolute speed of the road<br />
|
|
4538
|
+
* @deprecated `"relative-delay"` displays relative speed only where they differ from free-flow;
|
|
4539
|
+
* false to stop displaying the traffic flow.<br />
|
|
4540
|
+
* default `"none"`
|
|
4531
4541
|
* @default "none"
|
|
4532
4542
|
*/
|
|
4533
4543
|
flow?: "none" | "relative" | "absolute" | "relative-delay";
|
|
@@ -5061,281 +5071,281 @@ declare namespace atlas {
|
|
|
5061
5071
|
* @param eventType The data event name.
|
|
5062
5072
|
* @param callback The event handler callback.
|
|
5063
5073
|
*/
|
|
5064
|
-
add(eventType: "data" | "sourcedata" | "styledata", callback: (e: MapDataEvent) => void): void;
|
|
5074
|
+
add (eventType: "data" | "sourcedata" | "styledata", callback: (e: MapDataEvent) => void): void;
|
|
5065
5075
|
/**
|
|
5066
5076
|
* Adds an event to the map.
|
|
5067
5077
|
* @param eventType The error event name.
|
|
5068
5078
|
* @param callback The event handler callback.
|
|
5069
5079
|
*/
|
|
5070
|
-
add(eventType: "error", callback: (e: MapErrorEvent) => void): void;
|
|
5080
|
+
add (eventType: "error", callback: (e: MapErrorEvent) => void): void;
|
|
5071
5081
|
/**
|
|
5072
5082
|
* Adds a touch event to the map.
|
|
5073
5083
|
* @param eventType The touch event name.
|
|
5074
5084
|
* @param callback The event handler callback.
|
|
5075
5085
|
*/
|
|
5076
|
-
add(eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", callback: (e: MapTouchEvent) => void): void;
|
|
5086
|
+
add (eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", callback: (e: MapTouchEvent) => void): void;
|
|
5077
5087
|
/**
|
|
5078
5088
|
* Adds a mouse event to the map.
|
|
5079
5089
|
* @param eventType The mouse event name.
|
|
5080
5090
|
* @param callback The event handler callback.
|
|
5081
5091
|
*/
|
|
5082
|
-
add(eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "contextmenu", callback: (e: MapMouseEvent) => void): void;
|
|
5092
|
+
add (eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "contextmenu", callback: (e: MapMouseEvent) => void): void;
|
|
5083
5093
|
/**
|
|
5084
5094
|
* Adds a style image missing event to the map.
|
|
5085
5095
|
* @param eventType The style image missing event name.
|
|
5086
5096
|
* @param callback The event handler callback.
|
|
5087
5097
|
*/
|
|
5088
|
-
add(eventType: "styleimagemissing", callback: (e: string) => void): void;
|
|
5098
|
+
add (eventType: "styleimagemissing", callback: (e: string) => void): void;
|
|
5089
5099
|
/**
|
|
5090
5100
|
* Adds a wheel event to the map.
|
|
5091
5101
|
* @param eventType The wheel event name.
|
|
5092
5102
|
* @param callback The event handler callback.
|
|
5093
5103
|
*/
|
|
5094
|
-
add(eventType: "stylechanged", callback: (e: StyleChangedEvent) => void): void;
|
|
5104
|
+
add (eventType: "stylechanged", callback: (e: StyleChangedEvent) => void): void;
|
|
5095
5105
|
/**
|
|
5096
5106
|
* Adds a mapConfiguration change event to the map.
|
|
5097
5107
|
* @param eventType A mapConfiguration changed event name
|
|
5098
5108
|
* @param callback The event handler callback
|
|
5099
5109
|
*/
|
|
5100
|
-
add(eventType: "mapconfigurationchanged", callback: (e: MapConfiguration) => void): void;
|
|
5110
|
+
add (eventType: "mapconfigurationchanged", callback: (e: MapConfiguration) => void): void;
|
|
5101
5111
|
/**
|
|
5102
5112
|
* Adds a wheel event to the map.
|
|
5103
5113
|
* @param eventType The wheel event name.
|
|
5104
5114
|
* @param callback The event handler callback.
|
|
5105
5115
|
*/
|
|
5106
|
-
add(eventType: "wheel", callback: (e: MapMouseWheelEvent) => void): void;
|
|
5116
|
+
add (eventType: "wheel", callback: (e: MapMouseWheelEvent) => void): void;
|
|
5107
5117
|
/**
|
|
5108
5118
|
* Adds an event to the map.
|
|
5109
5119
|
* @param eventType The event name.
|
|
5110
5120
|
* @param callback The event handler callback.
|
|
5111
5121
|
*/
|
|
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;
|
|
5122
|
+
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
5123
|
/**
|
|
5114
5124
|
* Adds an event to the map.
|
|
5115
5125
|
* @param eventType The event name.
|
|
5116
5126
|
* @param callback The event handler callback.
|
|
5117
5127
|
*/
|
|
5118
|
-
add(eventType: "layeradded" | "layerremoved", callback: (e: atlas.layer.Layer) => void): void;
|
|
5128
|
+
add (eventType: "layeradded" | "layerremoved", callback: (e: atlas.layer.Layer) => void): void;
|
|
5119
5129
|
/**
|
|
5120
5130
|
* Adds an event to the map.
|
|
5121
5131
|
* @param eventType The event name.
|
|
5122
5132
|
* @param callback The event handler callback.
|
|
5123
5133
|
*/
|
|
5124
|
-
add(eventType: "sourceadded" | "sourceremoved", callback: (e: atlas.source.Source) => void): void;
|
|
5134
|
+
add (eventType: "sourceadded" | "sourceremoved", callback: (e: atlas.source.Source) => void): void;
|
|
5125
5135
|
/**
|
|
5126
5136
|
* Adds an event to the DataSource(s).
|
|
5127
5137
|
* @param eventType The event name.
|
|
5128
5138
|
* @param target The DataSource(s) to add the event for.
|
|
5129
5139
|
* @param callback The event handler callback.
|
|
5130
5140
|
*/
|
|
5131
|
-
add(eventType: "datasourceupdated", target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: atlas.source.DataSource) => void): void;
|
|
5141
|
+
add (eventType: "datasourceupdated", target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: atlas.source.DataSource) => void): void;
|
|
5132
5142
|
/**
|
|
5133
5143
|
* Adds an event to the DataSource(s).
|
|
5134
5144
|
* @param eventType The event name.
|
|
5135
5145
|
* @param target The DataSource(s) to add the event for.
|
|
5136
5146
|
* @param callback The event handler callback.
|
|
5137
5147
|
*/
|
|
5138
|
-
add(eventType: "dataadded" | "dataremoved", target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: Shape[]) => void): void;
|
|
5148
|
+
add (eventType: "dataadded" | "dataremoved", target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: Shape[]) => void): void;
|
|
5139
5149
|
/**
|
|
5140
5150
|
* Adds an event to the HtmlMarker(s).
|
|
5141
5151
|
* @param eventType The event name.
|
|
5142
5152
|
* @param target The HtmlMarker(s) to add the event for.
|
|
5143
5153
|
* @param callback The event handler callback.
|
|
5144
5154
|
*/
|
|
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;
|
|
5155
|
+
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
5156
|
/**
|
|
5147
5157
|
* Adds a touch event to the Layer(s).
|
|
5148
5158
|
* @param eventType The event name.
|
|
5149
5159
|
* @param target The Layer(s) to add the event for.
|
|
5150
5160
|
* @param callback The event handler callback.
|
|
5151
5161
|
*/
|
|
5152
|
-
add(eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapTouchEvent) => void): void;
|
|
5162
|
+
add (eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapTouchEvent) => void): void;
|
|
5153
5163
|
/**
|
|
5154
5164
|
* Adds an event to the Layer(s).
|
|
5155
5165
|
* @param eventType The event name.
|
|
5156
5166
|
* @param target The Layer(s) to add the event for.
|
|
5157
5167
|
* @param callback The event handler callback.
|
|
5158
5168
|
*/
|
|
5159
|
-
add(eventType: "layeradded" | "layerremoved", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: atlas.layer.Layer) => void): void;
|
|
5169
|
+
add (eventType: "layeradded" | "layerremoved", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: atlas.layer.Layer) => void): void;
|
|
5160
5170
|
/**
|
|
5161
5171
|
* Adds a mouse event to the Layer(s).
|
|
5162
5172
|
* @param eventType The event name.
|
|
5163
5173
|
* @param target The Layer(s) to add the event for.
|
|
5164
5174
|
* @param callback The event handler callback.
|
|
5165
5175
|
*/
|
|
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;
|
|
5176
|
+
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
5177
|
/**
|
|
5168
5178
|
* Adds a wheel event to the Layer(s).
|
|
5169
5179
|
* @param eventType The event name.
|
|
5170
5180
|
* @param target The Layer(s) to add the event for.
|
|
5171
5181
|
* @param callback The event handler callback.
|
|
5172
5182
|
*/
|
|
5173
|
-
add(eventType: "wheel", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapMouseWheelEvent) => void): void;
|
|
5183
|
+
add (eventType: "wheel", target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: MapMouseWheelEvent) => void): void;
|
|
5174
5184
|
/**
|
|
5175
5185
|
* Adds an event to the Popup(s).
|
|
5176
5186
|
* @param eventType The event name.
|
|
5177
5187
|
* @param target The Popup(s) to add the event for.
|
|
5178
5188
|
* @param callback The event handler callback.
|
|
5179
5189
|
*/
|
|
5180
|
-
add(eventType: "drag" | "dragend" | "dragstart" | "open" | "close", target: Popup | Popup[], callback: (e: TargetedEvent) => void): void;
|
|
5190
|
+
add (eventType: "drag" | "dragend" | "dragstart" | "open" | "close", target: Popup | Popup[], callback: (e: TargetedEvent) => void): void;
|
|
5181
5191
|
/**
|
|
5182
5192
|
* Adds an event to the StyleControl
|
|
5183
5193
|
* @param eventType The event name.
|
|
5184
5194
|
* @param target The StyleControl to add the event for.
|
|
5185
5195
|
* @param callback The event handler callback.
|
|
5186
5196
|
*/
|
|
5187
|
-
add(eventType: "styleselected", target: atlas.control.StyleControl, callback: (e: string) => void): void;
|
|
5197
|
+
add (eventType: "styleselected", target: atlas.control.StyleControl, callback: (e: string) => void): void;
|
|
5188
5198
|
/**
|
|
5189
5199
|
* Adds an event to the Shape(s).
|
|
5190
5200
|
* @param eventType The event name.
|
|
5191
5201
|
* @param target The Shape(s) to add the event for.
|
|
5192
5202
|
* @param callback The event handler callback.
|
|
5193
5203
|
*/
|
|
5194
|
-
add(eventType: "shapechanged", target: Shape | Shape[], callback: (e: Shape) => void): void;
|
|
5204
|
+
add (eventType: "shapechanged", target: Shape | Shape[], callback: (e: Shape) => void): void;
|
|
5195
5205
|
/**
|
|
5196
5206
|
* Adds an event to the Source(s).
|
|
5197
5207
|
* @param eventType The event name.
|
|
5198
5208
|
* @param target The Source(s) to add the event for.
|
|
5199
5209
|
* @param callback The event handler callback.
|
|
5200
5210
|
*/
|
|
5201
|
-
add(eventType: "sourceadded" | "sourceremoved", target: atlas.source.Source | atlas.source.Source[], callback: (e: atlas.source.Source) => void): void;
|
|
5211
|
+
add (eventType: "sourceadded" | "sourceremoved", target: atlas.source.Source | atlas.source.Source[], callback: (e: atlas.source.Source) => void): void;
|
|
5202
5212
|
/**
|
|
5203
5213
|
* Adds a data event to the map.
|
|
5204
5214
|
* @param eventType The data event name.
|
|
5205
5215
|
* @param callback The event handler callback.
|
|
5206
5216
|
*/
|
|
5207
|
-
addOnce(eventType: "data" | "sourcedata" | "styledata", callback: (e: MapDataEvent) => void): void;
|
|
5217
|
+
addOnce (eventType: "data" | "sourcedata" | "styledata", callback: (e: MapDataEvent) => void): void;
|
|
5208
5218
|
/**
|
|
5209
5219
|
* Adds an event to the map.
|
|
5210
5220
|
* @param eventType The error event name.
|
|
5211
5221
|
* @param callback The event handler callback.
|
|
5212
5222
|
*/
|
|
5213
|
-
addOnce(eventType: "error", callback: (e: MapErrorEvent) => void): void;
|
|
5223
|
+
addOnce (eventType: "error", callback: (e: MapErrorEvent) => void): void;
|
|
5214
5224
|
/**
|
|
5215
5225
|
* Adds a touch event to the map.
|
|
5216
5226
|
* @param eventType The touch event name.
|
|
5217
5227
|
* @param callback The event handler callback.
|
|
5218
5228
|
*/
|
|
5219
|
-
addOnce(eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", callback: (e: MapTouchEvent) => void): void;
|
|
5229
|
+
addOnce (eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", callback: (e: MapTouchEvent) => void): void;
|
|
5220
5230
|
/**
|
|
5221
5231
|
* Adds an event to the map.
|
|
5222
5232
|
* @param eventType The event name.
|
|
5223
5233
|
* @param callback The event handler callback.
|
|
5224
5234
|
*/
|
|
5225
|
-
addOnce(eventType: "layeradded" | "layerremoved", callback: (e: atlas.layer.Layer) => void): void;
|
|
5235
|
+
addOnce (eventType: "layeradded" | "layerremoved", callback: (e: atlas.layer.Layer) => void): void;
|
|
5226
5236
|
/**
|
|
5227
5237
|
* Adds a mouse event to the map.
|
|
5228
5238
|
* @param eventType The mouse event name.
|
|
5229
5239
|
* @param callback The event handler callback.
|
|
5230
5240
|
*/
|
|
5231
|
-
addOnce(eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "contextmenu", callback: (e: MapMouseEvent) => void): void;
|
|
5241
|
+
addOnce (eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "contextmenu", callback: (e: MapMouseEvent) => void): void;
|
|
5232
5242
|
/**
|
|
5233
5243
|
* Adds an event to the map.
|
|
5234
5244
|
* @param eventType The event name.
|
|
5235
5245
|
* @param callback The event handler callback.
|
|
5236
5246
|
*/
|
|
5237
|
-
addOnce(eventType: "sourceadded" | "sourceremoved", callback: (e: atlas.source.Source) => void): void;
|
|
5247
|
+
addOnce (eventType: "sourceadded" | "sourceremoved", callback: (e: atlas.source.Source) => void): void;
|
|
5238
5248
|
/**
|
|
5239
5249
|
* Adds a style image missing event to the map.
|
|
5240
5250
|
* @param eventType The style image missing event name.
|
|
5241
5251
|
* @param callback The event handler callback.
|
|
5242
5252
|
*/
|
|
5243
|
-
addOnce(eventType: "styleimagemissing", callback: (e: string) => void): void;
|
|
5253
|
+
addOnce (eventType: "styleimagemissing", callback: (e: string) => void): void;
|
|
5244
5254
|
/**
|
|
5245
5255
|
* Adds a wheel event to the map.
|
|
5246
5256
|
* @param eventType The wheel event name.
|
|
5247
5257
|
* @param callback The event handler callback.
|
|
5248
5258
|
*/
|
|
5249
|
-
addOnce(eventType: "stylechanged", callback: (e: StyleChangedEvent) => void): void;
|
|
5259
|
+
addOnce (eventType: "stylechanged", callback: (e: StyleChangedEvent) => void): void;
|
|
5250
5260
|
/**
|
|
5251
5261
|
* Adds a wheel event to the map.
|
|
5252
5262
|
* @param eventType The wheel event name.
|
|
5253
5263
|
* @param callback The event handler callback.
|
|
5254
5264
|
*/
|
|
5255
|
-
addOnce(eventType: "wheel", callback: (e: MapMouseWheelEvent) => void): void;
|
|
5265
|
+
addOnce (eventType: "wheel", callback: (e: MapMouseWheelEvent) => void): void;
|
|
5256
5266
|
/**
|
|
5257
5267
|
* Adds an event to the map.
|
|
5258
5268
|
* @param eventType The event name.
|
|
5259
5269
|
* @param callback The event handler callback.
|
|
5260
5270
|
*/
|
|
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;
|
|
5271
|
+
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
5272
|
/**
|
|
5263
5273
|
* Adds an event to the DataSource.
|
|
5264
5274
|
* @param eventType The event name.
|
|
5265
5275
|
* @param target The DataSource to add the event for.
|
|
5266
5276
|
* @param callback The event handler callback.
|
|
5267
5277
|
*/
|
|
5268
|
-
addOnce(eventType: "datasourceupdated", target: atlas.source.DataSource, callback: (e: atlas.source.DataSource) => void): void;
|
|
5278
|
+
addOnce (eventType: "datasourceupdated", target: atlas.source.DataSource, callback: (e: atlas.source.DataSource) => void): void;
|
|
5269
5279
|
/**
|
|
5270
5280
|
* Adds an event to the DataSource.
|
|
5271
5281
|
* @param eventType The event name.
|
|
5272
5282
|
* @param target The DataSource to add the event for.
|
|
5273
5283
|
* @param callback The event handler callback.
|
|
5274
5284
|
*/
|
|
5275
|
-
addOnce(eventType: "dataadded" | "dataremoved", target: atlas.source.DataSource, callback: (e: Shape[]) => void): void;
|
|
5285
|
+
addOnce (eventType: "dataadded" | "dataremoved", target: atlas.source.DataSource, callback: (e: Shape[]) => void): void;
|
|
5276
5286
|
/**
|
|
5277
5287
|
* Adds an event to the HtmlMarker.
|
|
5278
5288
|
* @param eventType The event name.
|
|
5279
5289
|
* @param target The HtmlMarker to add the event for.
|
|
5280
5290
|
* @param callback The event handler callback.
|
|
5281
5291
|
*/
|
|
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;
|
|
5292
|
+
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
5293
|
/**
|
|
5284
5294
|
* Adds a touch event to the Layer.
|
|
5285
5295
|
* @param eventType The touch event name.
|
|
5286
5296
|
* @param target The Layer to add the event for.
|
|
5287
5297
|
* @param callback The event handler callback.
|
|
5288
5298
|
*/
|
|
5289
|
-
addOnce(eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", target: atlas.layer.Layer, callback: (e: MapTouchEvent) => void): void;
|
|
5299
|
+
addOnce (eventType: "touchstart" | "touchend" | "touchmove" | "touchcancel", target: atlas.layer.Layer, callback: (e: MapTouchEvent) => void): void;
|
|
5290
5300
|
/**
|
|
5291
5301
|
* Adds a touch event to the Layer.
|
|
5292
5302
|
* @param eventType The touch event name.
|
|
5293
5303
|
* @param target The Layer to add the event for.
|
|
5294
5304
|
* @param callback The event handler callback.
|
|
5295
5305
|
*/
|
|
5296
|
-
addOnce(eventType: "layeradded" | "layerremoved", target: atlas.layer.Layer, callback: (e: atlas.layer.Layer) => void): void;
|
|
5306
|
+
addOnce (eventType: "layeradded" | "layerremoved", target: atlas.layer.Layer, callback: (e: atlas.layer.Layer) => void): void;
|
|
5297
5307
|
/**
|
|
5298
5308
|
* Adds a mouse event to the Layer.
|
|
5299
5309
|
* @param eventType The mouse event name.
|
|
5300
5310
|
* @param target The Layer to add the event for.
|
|
5301
5311
|
* @param callback The event handler callback.
|
|
5302
5312
|
*/
|
|
5303
|
-
addOnce(eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "mouseenter" | "mouseleave" | "contextmenu", target: atlas.layer.Layer, callback: (e: MapMouseEvent) => void): void;
|
|
5313
|
+
addOnce (eventType: "mousedown" | "mouseup" | "mouseover" | "mousemove" | "click" | "dblclick" | "mouseout" | "mouseenter" | "mouseleave" | "contextmenu", target: atlas.layer.Layer, callback: (e: MapMouseEvent) => void): void;
|
|
5304
5314
|
/**
|
|
5305
5315
|
* Adds a wheel event to the Layer.
|
|
5306
5316
|
* @param eventType The wheel event name.
|
|
5307
5317
|
* @param target The Layer to add the event for.
|
|
5308
5318
|
* @param callback The event handler callback.
|
|
5309
5319
|
*/
|
|
5310
|
-
addOnce(eventType: "wheel", target: atlas.layer.Layer, callback: (e: MapMouseWheelEvent) => void): void;
|
|
5320
|
+
addOnce (eventType: "wheel", target: atlas.layer.Layer, callback: (e: MapMouseWheelEvent) => void): void;
|
|
5311
5321
|
/**
|
|
5312
5322
|
* Adds an event to the Popup.
|
|
5313
5323
|
* @param eventType The event name.
|
|
5314
5324
|
* @param target The Popup to add the event for.
|
|
5315
5325
|
* @param callback The event handler callback.
|
|
5316
5326
|
*/
|
|
5317
|
-
addOnce(eventType: "drag" | "dragend" | "dragstart" | "open" | "close", target: Popup, callback: (e: TargetedEvent) => void): void;
|
|
5327
|
+
addOnce (eventType: "drag" | "dragend" | "dragstart" | "open" | "close", target: Popup, callback: (e: TargetedEvent) => void): void;
|
|
5318
5328
|
/**
|
|
5319
5329
|
* Adds an event to the StyleControl
|
|
5320
5330
|
* @param eventType The event name.
|
|
5321
5331
|
* @param target The StyleControl to add the event for.
|
|
5322
5332
|
* @param callback The event handler callback.
|
|
5323
5333
|
*/
|
|
5324
|
-
addOnce(eventType: "styleselected", target: atlas.control.StyleControl, callback: (e: string) => void): void;
|
|
5334
|
+
addOnce (eventType: "styleselected", target: atlas.control.StyleControl, callback: (e: string) => void): void;
|
|
5325
5335
|
/**
|
|
5326
5336
|
* Adds an event to the Shape.
|
|
5327
5337
|
* @param eventType The event name.
|
|
5328
5338
|
* @param target The Shape to add the event for.
|
|
5329
5339
|
* @param callback The event handler callback.
|
|
5330
5340
|
*/
|
|
5331
|
-
addOnce(eventType: "shapechanged", target: Shape, callback: (e: Shape) => void): void;
|
|
5341
|
+
addOnce (eventType: "shapechanged", target: Shape, callback: (e: Shape) => void): void;
|
|
5332
5342
|
/**
|
|
5333
5343
|
* Adds an event to the Source.
|
|
5334
5344
|
* @param eventType The event name.
|
|
5335
5345
|
* @param target The Source to add the event for.
|
|
5336
5346
|
* @param callback The event handler callback.
|
|
5337
5347
|
*/
|
|
5338
|
-
addOnce(eventType: "sourceadded" | "sourceremoved", target: atlas.source.Source, callback: (e: atlas.source.Source) => void): void;
|
|
5348
|
+
addOnce (eventType: "sourceadded" | "sourceremoved", target: atlas.source.Source, callback: (e: atlas.source.Source) => void): void;
|
|
5339
5349
|
/**
|
|
5340
5350
|
* Adds a listener to a single layer. Will add the event listeners to the layer's underlying Mapbox layers too.
|
|
5341
5351
|
* @private
|
|
@@ -5352,7 +5362,7 @@ declare namespace atlas {
|
|
|
5352
5362
|
* @param eventType The name of the event to invoke.
|
|
5353
5363
|
* @param args The data to be passed to the callbacks.
|
|
5354
5364
|
*/
|
|
5355
|
-
invoke(eventType: string, args: any): any;
|
|
5365
|
+
invoke (eventType: string, args: any): any;
|
|
5356
5366
|
/**
|
|
5357
5367
|
* Invokes an event of the target.
|
|
5358
5368
|
* This causes all event handlers on the target with the specified event name to be called.
|
|
@@ -5360,7 +5370,7 @@ declare namespace atlas {
|
|
|
5360
5370
|
* @param target The target to invoke the event on. Supported target types are Layer, HtmlMarker, and Popup.
|
|
5361
5371
|
* @param args The data to be passed to the callbacks. The data can be `null` but cannot be `undefined`.
|
|
5362
5372
|
*/
|
|
5363
|
-
invoke(eventType: string, target: any, args: any): any;
|
|
5373
|
+
invoke (eventType: string, target: any, args: any): any;
|
|
5364
5374
|
/**
|
|
5365
5375
|
* Invokes all listeners for the given event and layer.
|
|
5366
5376
|
* @param eventType The event type to invoke.
|
|
@@ -5374,56 +5384,56 @@ declare namespace atlas {
|
|
|
5374
5384
|
* @param eventType The event name.
|
|
5375
5385
|
* @param callback The event handler callback.
|
|
5376
5386
|
*/
|
|
5377
|
-
remove(eventType: string, callback: (e: void | atlas.layer.Layer | MapEvent | MapDataEvent | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.source.Source | string | MapConfiguration) => void): void;
|
|
5387
|
+
remove (eventType: string, callback: (e: void | atlas.layer.Layer | MapEvent | MapDataEvent | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.source.Source | string | MapConfiguration) => void): void;
|
|
5378
5388
|
/**
|
|
5379
5389
|
* Removes an event listener from the DataSource(s).
|
|
5380
5390
|
* @param eventType The event name.
|
|
5381
5391
|
* @param target The DataSource(s) to remove the event for.
|
|
5382
5392
|
* @param callback The event handler callback.
|
|
5383
5393
|
*/
|
|
5384
|
-
remove(eventType: string, target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: atlas.source.DataSource | Shape[]) => void): void;
|
|
5394
|
+
remove (eventType: string, target: atlas.source.DataSource | atlas.source.DataSource[], callback: (e: atlas.source.DataSource | Shape[]) => void): void;
|
|
5385
5395
|
/**
|
|
5386
5396
|
* Removes an event listener from the HtmlMarker(s).
|
|
5387
5397
|
* @param eventType The event name.
|
|
5388
5398
|
* @param target The HtmlMarker(s) to remove the event for.
|
|
5389
5399
|
* @param callback The event handler callback.
|
|
5390
5400
|
*/
|
|
5391
|
-
remove(eventType: string, target: HtmlMarker | HtmlMarker[], callback: (e: TargetedEvent) => void): void;
|
|
5401
|
+
remove (eventType: string, target: HtmlMarker | HtmlMarker[], callback: (e: TargetedEvent) => void): void;
|
|
5392
5402
|
/**
|
|
5393
5403
|
* Removes an event listener from the Layer(s).
|
|
5394
5404
|
* @param eventType The event name.
|
|
5395
5405
|
* @param target The Layer(s) to remove the event for.
|
|
5396
5406
|
* @param callback The event handler callback.
|
|
5397
5407
|
*/
|
|
5398
|
-
remove(eventType: string, target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: void | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.layer.Layer) => void): void;
|
|
5408
|
+
remove (eventType: string, target: atlas.layer.Layer | atlas.layer.Layer[], callback: (e: void | MapMouseEvent | MapTouchEvent | MapMouseWheelEvent | atlas.layer.Layer) => void): void;
|
|
5399
5409
|
/**
|
|
5400
5410
|
* Removes an event listener from the Popup(s).
|
|
5401
5411
|
* @param eventType The event name.
|
|
5402
5412
|
* @param target The Popup(s) to remove the event for.
|
|
5403
5413
|
* @param callback The event handler callback.
|
|
5404
5414
|
*/
|
|
5405
|
-
remove(eventType: string, target: Popup | Popup[], callback: (e: TargetedEvent) => void): void;
|
|
5415
|
+
remove (eventType: string, target: Popup | Popup[], callback: (e: TargetedEvent) => void): void;
|
|
5406
5416
|
/**
|
|
5407
5417
|
* Removes an event to the StyleControl
|
|
5408
5418
|
* @param eventType The event name.
|
|
5409
5419
|
* @param target The StyleControl to add the event for.
|
|
5410
5420
|
* @param callback The event handler callback.
|
|
5411
5421
|
*/
|
|
5412
|
-
remove(eventType: string, target: atlas.control.StyleControl, callback: (e: string) => void): void;
|
|
5422
|
+
remove (eventType: string, target: atlas.control.StyleControl, callback: (e: string) => void): void;
|
|
5413
5423
|
/**
|
|
5414
5424
|
* Removes an event listener from the Shape(s).
|
|
5415
5425
|
* @param eventType The event name.
|
|
5416
5426
|
* @param target The Shapes(s) to remove the event for.
|
|
5417
5427
|
* @param callback The event handler callback.
|
|
5418
5428
|
*/
|
|
5419
|
-
remove(eventType: string, target: Shape | Shape[], callback: (e: Shape) => void): void;
|
|
5429
|
+
remove (eventType: string, target: Shape | Shape[], callback: (e: Shape) => void): void;
|
|
5420
5430
|
/**
|
|
5421
5431
|
* Removes an event listener from the Source(s).
|
|
5422
5432
|
* @param eventType The event name.
|
|
5423
5433
|
* @param target The Source(s) to remove the event for.
|
|
5424
5434
|
* @param callback The event handler callback.
|
|
5425
5435
|
*/
|
|
5426
|
-
remove(eventType: string, target: atlas.source.Source | atlas.source.Source[], callback: (e: atlas.source.Source) => void): void;
|
|
5436
|
+
remove (eventType: string, target: atlas.source.Source | atlas.source.Source[], callback: (e: atlas.source.Source) => void): void;
|
|
5427
5437
|
}
|
|
5428
5438
|
|
|
5429
5439
|
/**
|
|
@@ -5560,20 +5570,20 @@ declare namespace atlas {
|
|
|
5560
5570
|
*/
|
|
5561
5571
|
move(layer: string | atlas.layer.Layer, before?: string | atlas.layer.Layer): void;
|
|
5562
5572
|
/**
|
|
5563
|
-
|
|
5564
|
-
|
|
5565
|
-
|
|
5566
|
-
|
|
5567
|
-
|
|
5568
|
-
|
|
5569
|
-
|
|
5570
|
-
|
|
5571
|
-
|
|
5572
|
-
|
|
5573
|
-
|
|
5574
|
-
|
|
5575
|
-
|
|
5576
|
-
|
|
5573
|
+
* Retrieve all Shapes and GeoJSON features that are visible on the map that are in a DataSource or VectorTileSource.
|
|
5574
|
+
* Shape objects are editable, while Feature objects are not editable and either reside in a VectorTileSource or represent a cluster point.
|
|
5575
|
+
* Clusters have the following properties:<br />
|
|
5576
|
+
* `cluster`: `boolean` - Indicates that the point is a cluster.
|
|
5577
|
+
* This will be set to true if Point object represents a cluster.
|
|
5578
|
+
* All other point objects are unlikely to have this value unless
|
|
5579
|
+
* a property with this same name was added to the Point property data from your app.<br />
|
|
5580
|
+
* `cluster_id`: `string` - A unique id for the cluster.<br />
|
|
5581
|
+
* `point_count`: `number` - The number of points inside the cluster.<br />
|
|
5582
|
+
* `point_count_abbreviated`: `string` - An abbreviated string version of the point count. i.e. `"10K"`<br />
|
|
5583
|
+
* Features/Shapes that are not visible or who's layer zoom range does not include the current zoom level will not be returned.
|
|
5584
|
+
* Symbol features/Shapes that have been hidden due to text or icon collisions are not included.
|
|
5585
|
+
* Features/Shapes from all other layers are included even if they have no contribution to the map rendering, e.g. alpha set to zero.
|
|
5586
|
+
* The topmost rendered features/shapes appears first in the returned array and subsequent features are sorted in descending z-order.
|
|
5577
5587
|
* @param geometry A Position, Point, or BoundingBox that returned features must intersect. If not specified the whole visible world is used.
|
|
5578
5588
|
* @param layers An array of layers or their ids to limit the query to.
|
|
5579
5589
|
* @param filter A expression to filter the returned features by.
|
|
@@ -5697,14 +5707,14 @@ declare namespace atlas {
|
|
|
5697
5707
|
*/
|
|
5698
5708
|
size: number;
|
|
5699
5709
|
/**
|
|
5700
|
-
* The state of the tile
|
|
5701
|
-
*
|
|
5702
|
-
*
|
|
5703
|
-
*
|
|
5704
|
-
*
|
|
5705
|
-
*
|
|
5706
|
-
*
|
|
5707
|
-
* and is in the process of refreshing
|
|
5710
|
+
* The state of the tile.<br />
|
|
5711
|
+
* `"loading"`: Tile data is in the process of loading.<br />
|
|
5712
|
+
* `"loaded"`: Tile data has been loaded.<br />
|
|
5713
|
+
* `"reloading"`: Tile data has been loaded and is being updated.<br />
|
|
5714
|
+
* `"unloaded"`: The data has been deleted.<br />
|
|
5715
|
+
* `"errored"`: Tile data was not loaded because of an error.<br />
|
|
5716
|
+
* `"expired"`: Tile data was previously loaded, but has expired per its HTTP headers
|
|
5717
|
+
* and is in the process of refreshing.
|
|
5708
5718
|
*/
|
|
5709
5719
|
state: "loading" | "loaded" | "reloading" | "unloaded" | "errored" | "expired";
|
|
5710
5720
|
}
|
|
@@ -5837,14 +5847,14 @@ declare namespace atlas {
|
|
|
5837
5847
|
* An array of Shape and Feature objects that the mouse event occurred on.
|
|
5838
5848
|
* Shape objects are editable, while Feature objects are not editable
|
|
5839
5849
|
* and either reside in a VectorTileSource or represent a cluster point.
|
|
5840
|
-
* Clusters have the following properties
|
|
5841
|
-
*
|
|
5850
|
+
* Clusters have the following properties:<br />
|
|
5851
|
+
* `cluster`: `boolean` - Indicates that the point is a cluster.
|
|
5842
5852
|
* This will be set to true if Point object represents a cluster.
|
|
5843
5853
|
* 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
|
|
5845
|
-
*
|
|
5846
|
-
*
|
|
5847
|
-
*
|
|
5854
|
+
* a property with this same name was added to the Point property data from your app.<br />
|
|
5855
|
+
* `cluster_id`: `string` - A unique id for the cluster.<br />
|
|
5856
|
+
* `point_count`: `number` - The number of points inside the cluster.<br />
|
|
5857
|
+
* `point_count_abbreviated`: `string` - An abbreviated string version of the point count. i.e. `"10K"`
|
|
5848
5858
|
*/
|
|
5849
5859
|
shapes?: Array<atlas.data.Feature<atlas.data.Geometry, any> | atlas.Shape>;
|
|
5850
5860
|
/**
|