@azure-rest/maps-render 1.0.0-beta.3 → 2.0.0-alpha.20240926.2
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/README.md +38 -33
- package/dist/index.js +24 -28
- package/dist/index.js.map +1 -1
- package/dist-esm/src/createMultiCollection.js +1 -1
- package/dist-esm/src/createMultiCollection.js.map +1 -1
- package/dist-esm/src/createPathQuery.js +2 -2
- package/dist-esm/src/createPathQuery.js.map +1 -1
- package/dist-esm/src/createPinsQuery.js +1 -1
- package/dist-esm/src/createPinsQuery.js.map +1 -1
- package/dist-esm/src/generated/clientDefinitions.js +1 -1
- package/dist-esm/src/generated/clientDefinitions.js.map +1 -1
- package/dist-esm/src/generated/index.js +1 -1
- package/dist-esm/src/generated/index.js.map +1 -1
- package/dist-esm/src/generated/isUnexpected.js +6 -5
- package/dist-esm/src/generated/isUnexpected.js.map +1 -1
- package/dist-esm/src/generated/mapsRenderClient.js +9 -14
- package/dist-esm/src/generated/mapsRenderClient.js.map +1 -1
- package/dist-esm/src/generated/outputModels.js +1 -1
- package/dist-esm/src/generated/outputModels.js.map +1 -1
- package/dist-esm/src/generated/parameters.js +1 -1
- package/dist-esm/src/generated/parameters.js.map +1 -1
- package/dist-esm/src/generated/responses.js +1 -1
- package/dist-esm/src/generated/responses.js.map +1 -1
- package/dist-esm/src/index.js +1 -1
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/mapsRender.js +3 -3
- package/dist-esm/src/mapsRender.js.map +1 -1
- package/dist-esm/src/positionToTileXY.js +1 -1
- package/dist-esm/src/positionToTileXY.js.map +1 -1
- package/package.json +32 -31
- package/review/maps-render.api.md +3 -3
- package/types/maps-render-rest.d.ts +174 -211
|
@@ -178,41 +178,36 @@ export declare interface ErrorResponseOutput {
|
|
|
178
178
|
|
|
179
179
|
export declare interface GetCopyrightCaption {
|
|
180
180
|
/**
|
|
181
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
182
181
|
*
|
|
183
|
-
*
|
|
184
|
-
* service. In addition to basic copyright for the whole map, API is serving
|
|
185
|
-
* specific groups of copyrights for some countries/regions.
|
|
182
|
+
* The `Get Copyright Caption` API is an HTTP GET request designed to serve copyright information to be used with tiles requested from the Render service. In addition to a basic copyright for the whole map, it can serve specific groups of copyrights for some countries/regions.
|
|
186
183
|
*
|
|
187
|
-
* As an alternative to copyrights for map request,
|
|
188
|
-
* for displaying the map provider information on the map.
|
|
184
|
+
* As an alternative to copyrights for map request, it can also return captions for displaying provider information on the map.
|
|
189
185
|
*/
|
|
190
186
|
get(options?: RenderGetCopyrightCaptionParameters): StreamableMethod<RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse>;
|
|
191
187
|
}
|
|
192
188
|
|
|
193
189
|
export declare interface GetCopyrightForTile {
|
|
194
190
|
/**
|
|
195
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
196
191
|
*
|
|
197
|
-
*
|
|
198
|
-
*
|
|
192
|
+
* To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/azure-maps/zoom-levels-and-tile-grid).
|
|
193
|
+
*
|
|
194
|
+
* Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.
|
|
199
195
|
*/
|
|
200
196
|
get(options: RenderGetCopyrightForTileParameters): StreamableMethod<RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse>;
|
|
201
197
|
}
|
|
202
198
|
|
|
203
199
|
export declare interface GetCopyrightForWorld {
|
|
204
200
|
/**
|
|
205
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
206
201
|
*
|
|
207
|
-
*
|
|
208
|
-
*
|
|
202
|
+
* Returns the copyright information for the world. To obtain the default copyright information for the whole world, don't specify a tile or bounding box.
|
|
203
|
+
*
|
|
204
|
+
* Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.
|
|
209
205
|
*/
|
|
210
206
|
get(options?: RenderGetCopyrightForWorldParameters): StreamableMethod<RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse>;
|
|
211
207
|
}
|
|
212
208
|
|
|
213
209
|
export declare interface GetCopyrightFromBoundingBox {
|
|
214
210
|
/**
|
|
215
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
216
211
|
*
|
|
217
212
|
* Returns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates
|
|
218
213
|
*/
|
|
@@ -221,80 +216,73 @@ export declare interface GetCopyrightFromBoundingBox {
|
|
|
221
216
|
|
|
222
217
|
export declare interface GetMapAttribution {
|
|
223
218
|
/**
|
|
224
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
225
219
|
*
|
|
226
|
-
* The Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.
|
|
220
|
+
* The `Get Map Attribution` API allows users to request map copyright attribution information for a section of a tileset.
|
|
227
221
|
*/
|
|
228
222
|
get(options: RenderGetMapAttributionParameters): StreamableMethod<RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse>;
|
|
229
223
|
}
|
|
230
224
|
|
|
231
225
|
export declare interface GetMapStateTile {
|
|
232
226
|
/**
|
|
233
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
234
227
|
*
|
|
235
|
-
* Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling
|
|
228
|
+
* Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).
|
|
236
229
|
*/
|
|
237
230
|
get(options: RenderGetMapStateTileParameters): StreamableMethod<RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse>;
|
|
238
231
|
}
|
|
239
232
|
|
|
240
233
|
export declare interface GetMapStaticImage {
|
|
241
234
|
/**
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
* The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice.
|
|
235
|
+
* This rendering API produces static, rasterized map views of a user-defined area. It's suitable for lightweight web applications, when the desired user experience doesn't require interactive map controls, or when bandwidth is limited. This API is also useful for embedding maps in applications outside of the browser, in backend services, report generation, or desktop applications.
|
|
245
236
|
*
|
|
246
|
-
*
|
|
237
|
+
* This API includes parameters for basic data visualization:
|
|
247
238
|
*
|
|
248
|
-
* -
|
|
249
|
-
* - Render circle,
|
|
239
|
+
* - Labeled pushpins in multiple styles.
|
|
240
|
+
* - Render circle, path, and polygon geometry types.
|
|
250
241
|
*
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
* _Note_ : Either **center** or **bbox** parameter must be supplied to the
|
|
254
|
-
* API.
|
|
242
|
+
* For more information and detailed examples, see [Render custom data on a raster map](/azure/azure-maps/how-to-render-custom-data).
|
|
255
243
|
* <br><br>
|
|
256
|
-
* The
|
|
244
|
+
* The dimensions of the bbox parameter are constrained, depending on the zoom level. This ensures the resulting image has an appropriate level of detail.
|
|
257
245
|
* <br><br>
|
|
258
246
|
*
|
|
259
|
-
* |Zoom Level | Max Lon Range | Max Lat Range|
|
|
260
|
-
*
|
|
261
|
-
* |0 | 360.0
|
|
262
|
-
* |1 | 360.0
|
|
263
|
-
* |2
|
|
264
|
-
* |3
|
|
265
|
-
* |4
|
|
266
|
-
* |5 |
|
|
267
|
-
* |6
|
|
268
|
-
* |7
|
|
269
|
-
* |8
|
|
270
|
-
* |9
|
|
271
|
-
* |10
|
|
272
|
-
* |11
|
|
273
|
-
* |12
|
|
274
|
-
* |13
|
|
275
|
-
* |14
|
|
276
|
-
* |15
|
|
277
|
-
* |16
|
|
278
|
-
* |17
|
|
279
|
-
* |18
|
|
280
|
-
* |19
|
|
281
|
-
* |20
|
|
247
|
+
* |Zoom Level | Min Lon Range | Max Lon Range | Min Lat Range| Max Lat Range|
|
|
248
|
+
* |:----------|:----------------|:----------------|:----------------|:-------------|
|
|
249
|
+
* |0 | 56.25 | 360.0 | 30.1105585173 | 180.0 |
|
|
250
|
+
* |1 | 28.125 | 360.0 | 14.87468995 | 180.0 |
|
|
251
|
+
* |2 | 14.063 | 351.5625 | 7.4130741851 | 137.9576312246 |
|
|
252
|
+
* |3 | 7.03125 | 175.78125 | 3.7034501005 | 73.6354071932 |
|
|
253
|
+
* |4 | 3.515625 | 87.890625 | 1.8513375155 | 35.4776115315 |
|
|
254
|
+
* |5 | 1.7578125 | 43.9453125 | 0.925620264 | 17.4589959239 |
|
|
255
|
+
* |6 | 0.87890625 | 21.97265625 | 0.4628040687 | 8.6907788223 |
|
|
256
|
+
* |7 | 0.439453125 | 10.986328125 | 0.2314012764 | 4.3404320789 |
|
|
257
|
+
* |8 | 0.2197265625 | 5.4931640625 | 0.1157005434 | 2.1695927024 |
|
|
258
|
+
* |9 | 0.1098632812 | 2.7465820312 | 0.0578502599 | 1.0847183194 |
|
|
259
|
+
* |10 | 0.0549316406 | 1.3732910156 | 0.0289251285 | 0.5423494021 |
|
|
260
|
+
* |11 | 0.0274658203 | 0.6866455078 | 0.014462564 | 0.2711734813 |
|
|
261
|
+
* |12 | 0.0137329102 | 0.3433227539 | 0.007231282 | 0.1355865882 |
|
|
262
|
+
* |13 | 0.0068664551 | 0.171661377 | 0.003615641 | 0.067793275 |
|
|
263
|
+
* |14 | 0.0034332275 | 0.0858306885 | 0.0018078205 | 0.0338966351 |
|
|
264
|
+
* |15 | 0.0017166138 | 0.0429153442 | 0.0009039102 | 0.0169483173 |
|
|
265
|
+
* |16 | 0.0008583069 | 0.0214576721 | 0.0004519551 | 0.0084741586 |
|
|
266
|
+
* |17 | 0.0004291534 | 0.0107288361 | 0.0002259776 | 0.0042370793 |
|
|
267
|
+
* |18 | 0.0002145767 | 0.005364418 | 0.0001129888 | 0.0021185396 |
|
|
268
|
+
* |19 | 0.0001072884 | 0.002682209 | 5.64944E-05 | 0.0010592698 |
|
|
269
|
+
* |20 | 5.36442E-05 | 0.0013411045 | 2.82472E-05 | 0.0005296349 |
|
|
270
|
+
*
|
|
271
|
+
* _Note_ : Either **center** or **bbox** parameter must be supplied to the API.
|
|
282
272
|
*/
|
|
283
273
|
get(options?: RenderGetMapStaticImageParameters): StreamableMethod<RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse>;
|
|
284
274
|
}
|
|
285
275
|
|
|
286
276
|
export declare interface GetMapTile {
|
|
287
277
|
/**
|
|
288
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
289
278
|
*
|
|
290
|
-
* The Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.
|
|
279
|
+
* The `Get Map Tiles` API in an HTTP GET request that allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control ([Web SDK](/azure/azure-maps/about-azure-maps#web-sdk)) and [Android SDK](/azure/azure-maps/about-azure-maps#android-sdk).
|
|
291
280
|
*/
|
|
292
281
|
get(options: RenderGetMapTileParameters): StreamableMethod<RenderGetMapTile200Response | RenderGetMapTileDefaultResponse>;
|
|
293
282
|
}
|
|
294
283
|
|
|
295
284
|
export declare interface GetMapTileset {
|
|
296
285
|
/**
|
|
297
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
298
286
|
*
|
|
299
287
|
* The Get Map Tileset API allows users to request metadata for a tileset.
|
|
300
288
|
*/
|
|
@@ -523,14 +511,10 @@ export declare interface RegionCopyrightsOutput {
|
|
|
523
511
|
}
|
|
524
512
|
|
|
525
513
|
/**
|
|
526
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
527
514
|
*
|
|
528
|
-
*
|
|
529
|
-
* service. In addition to basic copyright for the whole map, API is serving
|
|
530
|
-
* specific groups of copyrights for some countries/regions.
|
|
515
|
+
* The `Get Copyright Caption` API is an HTTP GET request designed to serve copyright information to be used with tiles requested from the Render service. In addition to a basic copyright for the whole map, it can serve specific groups of copyrights for some countries/regions.
|
|
531
516
|
*
|
|
532
|
-
* As an alternative to copyrights for map request,
|
|
533
|
-
* for displaying the map provider information on the map.
|
|
517
|
+
* As an alternative to copyrights for map request, it can also return captions for displaying provider information on the map.
|
|
534
518
|
*/
|
|
535
519
|
export declare interface RenderGetCopyrightCaption200Response extends HttpResponse {
|
|
536
520
|
status: "200";
|
|
@@ -538,14 +522,10 @@ export declare interface RenderGetCopyrightCaption200Response extends HttpRespon
|
|
|
538
522
|
}
|
|
539
523
|
|
|
540
524
|
/**
|
|
541
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
542
525
|
*
|
|
543
|
-
*
|
|
544
|
-
* service. In addition to basic copyright for the whole map, API is serving
|
|
545
|
-
* specific groups of copyrights for some countries/regions.
|
|
526
|
+
* The `Get Copyright Caption` API is an HTTP GET request designed to serve copyright information to be used with tiles requested from the Render service. In addition to a basic copyright for the whole map, it can serve specific groups of copyrights for some countries/regions.
|
|
546
527
|
*
|
|
547
|
-
* As an alternative to copyrights for map request,
|
|
548
|
-
* for displaying the map provider information on the map.
|
|
528
|
+
* As an alternative to copyrights for map request, it can also return captions for displaying provider information on the map.
|
|
549
529
|
*/
|
|
550
530
|
export declare interface RenderGetCopyrightCaptionDefaultResponse extends HttpResponse {
|
|
551
531
|
status: string;
|
|
@@ -555,10 +535,10 @@ export declare interface RenderGetCopyrightCaptionDefaultResponse extends HttpRe
|
|
|
555
535
|
export declare type RenderGetCopyrightCaptionParameters = RequestParameters;
|
|
556
536
|
|
|
557
537
|
/**
|
|
558
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
559
538
|
*
|
|
560
|
-
*
|
|
561
|
-
*
|
|
539
|
+
* To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/azure-maps/zoom-levels-and-tile-grid).
|
|
540
|
+
*
|
|
541
|
+
* Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.
|
|
562
542
|
*/
|
|
563
543
|
export declare interface RenderGetCopyrightForTile200Response extends HttpResponse {
|
|
564
544
|
status: "200";
|
|
@@ -566,10 +546,10 @@ export declare interface RenderGetCopyrightForTile200Response extends HttpRespon
|
|
|
566
546
|
}
|
|
567
547
|
|
|
568
548
|
/**
|
|
569
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
570
549
|
*
|
|
571
|
-
*
|
|
572
|
-
*
|
|
550
|
+
* To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/azure-maps/zoom-levels-and-tile-grid).
|
|
551
|
+
*
|
|
552
|
+
* Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.
|
|
573
553
|
*/
|
|
574
554
|
export declare interface RenderGetCopyrightForTileDefaultResponse extends HttpResponse {
|
|
575
555
|
status: string;
|
|
@@ -586,7 +566,7 @@ export declare interface RenderGetCopyrightForTileQueryParamProperties {
|
|
|
586
566
|
/**
|
|
587
567
|
* Zoom level for the desired tile.
|
|
588
568
|
*
|
|
589
|
-
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/
|
|
569
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
590
570
|
*/
|
|
591
571
|
zoom: number;
|
|
592
572
|
/**
|
|
@@ -606,10 +586,10 @@ export declare interface RenderGetCopyrightForTileQueryParamProperties {
|
|
|
606
586
|
}
|
|
607
587
|
|
|
608
588
|
/**
|
|
609
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
610
589
|
*
|
|
611
|
-
*
|
|
612
|
-
*
|
|
590
|
+
* Returns the copyright information for the world. To obtain the default copyright information for the whole world, don't specify a tile or bounding box.
|
|
591
|
+
*
|
|
592
|
+
* Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.
|
|
613
593
|
*/
|
|
614
594
|
export declare interface RenderGetCopyrightForWorld200Response extends HttpResponse {
|
|
615
595
|
status: "200";
|
|
@@ -617,10 +597,10 @@ export declare interface RenderGetCopyrightForWorld200Response extends HttpRespo
|
|
|
617
597
|
}
|
|
618
598
|
|
|
619
599
|
/**
|
|
620
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
621
600
|
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
601
|
+
* Returns the copyright information for the world. To obtain the default copyright information for the whole world, don't specify a tile or bounding box.
|
|
602
|
+
*
|
|
603
|
+
* Copyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.
|
|
624
604
|
*/
|
|
625
605
|
export declare interface RenderGetCopyrightForWorldDefaultResponse extends HttpResponse {
|
|
626
606
|
status: string;
|
|
@@ -639,7 +619,6 @@ export declare interface RenderGetCopyrightForWorldQueryParamProperties {
|
|
|
639
619
|
}
|
|
640
620
|
|
|
641
621
|
/**
|
|
642
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
643
622
|
*
|
|
644
623
|
* Returns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates
|
|
645
624
|
*/
|
|
@@ -649,7 +628,6 @@ export declare interface RenderGetCopyrightFromBoundingBox200Response extends Ht
|
|
|
649
628
|
}
|
|
650
629
|
|
|
651
630
|
/**
|
|
652
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
653
631
|
*
|
|
654
632
|
* Returns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates
|
|
655
633
|
*/
|
|
@@ -674,9 +652,8 @@ export declare interface RenderGetCopyrightFromBoundingBoxQueryParamProperties {
|
|
|
674
652
|
}
|
|
675
653
|
|
|
676
654
|
/**
|
|
677
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
678
655
|
*
|
|
679
|
-
* The Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.
|
|
656
|
+
* The `Get Map Attribution` API allows users to request map copyright attribution information for a section of a tileset.
|
|
680
657
|
*/
|
|
681
658
|
export declare interface RenderGetMapAttribution200Response extends HttpResponse {
|
|
682
659
|
status: "200";
|
|
@@ -684,9 +661,8 @@ export declare interface RenderGetMapAttribution200Response extends HttpResponse
|
|
|
684
661
|
}
|
|
685
662
|
|
|
686
663
|
/**
|
|
687
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
688
664
|
*
|
|
689
|
-
* The Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.
|
|
665
|
+
* The `Get Map Attribution` API allows users to request map copyright attribution information for a section of a tileset.
|
|
690
666
|
*/
|
|
691
667
|
export declare interface RenderGetMapAttributionDefaultResponse extends HttpResponse {
|
|
692
668
|
status: string;
|
|
@@ -700,7 +676,7 @@ export declare interface RenderGetMapAttributionQueryParam {
|
|
|
700
676
|
}
|
|
701
677
|
|
|
702
678
|
export declare interface RenderGetMapAttributionQueryParamProperties {
|
|
703
|
-
/** A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/
|
|
679
|
+
/** A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. */
|
|
704
680
|
tilesetId: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident";
|
|
705
681
|
/** Zoom level for the desired map attribution. */
|
|
706
682
|
zoom: number;
|
|
@@ -714,9 +690,8 @@ export declare interface RenderGetMapStateTile200Headers {
|
|
|
714
690
|
}
|
|
715
691
|
|
|
716
692
|
/**
|
|
717
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
718
693
|
*
|
|
719
|
-
* Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling
|
|
694
|
+
* Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).
|
|
720
695
|
*/
|
|
721
696
|
export declare interface RenderGetMapStateTile200Response extends HttpResponse {
|
|
722
697
|
status: "200";
|
|
@@ -726,9 +701,8 @@ export declare interface RenderGetMapStateTile200Response extends HttpResponse {
|
|
|
726
701
|
}
|
|
727
702
|
|
|
728
703
|
/**
|
|
729
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
730
704
|
*
|
|
731
|
-
* Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling
|
|
705
|
+
* Fetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).
|
|
732
706
|
*/
|
|
733
707
|
export declare interface RenderGetMapStateTileDefaultResponse extends HttpResponse {
|
|
734
708
|
status: string;
|
|
@@ -745,7 +719,7 @@ export declare interface RenderGetMapStateTileQueryParamProperties {
|
|
|
745
719
|
/**
|
|
746
720
|
* Zoom level for the desired tile.
|
|
747
721
|
*
|
|
748
|
-
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/
|
|
722
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
749
723
|
*/
|
|
750
724
|
zoom: number;
|
|
751
725
|
/**
|
|
@@ -770,46 +744,43 @@ export declare interface RenderGetMapStaticImage200Headers {
|
|
|
770
744
|
}
|
|
771
745
|
|
|
772
746
|
/**
|
|
773
|
-
*
|
|
774
|
-
*
|
|
775
|
-
* The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice.
|
|
747
|
+
* This rendering API produces static, rasterized map views of a user-defined area. It's suitable for lightweight web applications, when the desired user experience doesn't require interactive map controls, or when bandwidth is limited. This API is also useful for embedding maps in applications outside of the browser, in backend services, report generation, or desktop applications.
|
|
776
748
|
*
|
|
777
|
-
*
|
|
749
|
+
* This API includes parameters for basic data visualization:
|
|
778
750
|
*
|
|
779
|
-
* -
|
|
780
|
-
* - Render circle,
|
|
751
|
+
* - Labeled pushpins in multiple styles.
|
|
752
|
+
* - Render circle, path, and polygon geometry types.
|
|
781
753
|
*
|
|
782
|
-
*
|
|
783
|
-
*
|
|
784
|
-
* _Note_ : Either **center** or **bbox** parameter must be supplied to the
|
|
785
|
-
* API.
|
|
754
|
+
* For more information and detailed examples, see [Render custom data on a raster map](/azure/azure-maps/how-to-render-custom-data).
|
|
786
755
|
* <br><br>
|
|
787
|
-
* The
|
|
756
|
+
* The dimensions of the bbox parameter are constrained, depending on the zoom level. This ensures the resulting image has an appropriate level of detail.
|
|
788
757
|
* <br><br>
|
|
789
758
|
*
|
|
790
|
-
* |Zoom Level | Max Lon Range | Max Lat Range|
|
|
791
|
-
*
|
|
792
|
-
* |0 | 360.0
|
|
793
|
-
* |1 | 360.0
|
|
794
|
-
* |2
|
|
795
|
-
* |3
|
|
796
|
-
* |4
|
|
797
|
-
* |5 |
|
|
798
|
-
* |6
|
|
799
|
-
* |7
|
|
800
|
-
* |8
|
|
801
|
-
* |9
|
|
802
|
-
* |10
|
|
803
|
-
* |11
|
|
804
|
-
* |12
|
|
805
|
-
* |13
|
|
806
|
-
* |14
|
|
807
|
-
* |15
|
|
808
|
-
* |16
|
|
809
|
-
* |17
|
|
810
|
-
* |18
|
|
811
|
-
* |19
|
|
812
|
-
* |20
|
|
759
|
+
* |Zoom Level | Min Lon Range | Max Lon Range | Min Lat Range| Max Lat Range|
|
|
760
|
+
* |:----------|:----------------|:----------------|:----------------|:-------------|
|
|
761
|
+
* |0 | 56.25 | 360.0 | 30.1105585173 | 180.0 |
|
|
762
|
+
* |1 | 28.125 | 360.0 | 14.87468995 | 180.0 |
|
|
763
|
+
* |2 | 14.063 | 351.5625 | 7.4130741851 | 137.9576312246 |
|
|
764
|
+
* |3 | 7.03125 | 175.78125 | 3.7034501005 | 73.6354071932 |
|
|
765
|
+
* |4 | 3.515625 | 87.890625 | 1.8513375155 | 35.4776115315 |
|
|
766
|
+
* |5 | 1.7578125 | 43.9453125 | 0.925620264 | 17.4589959239 |
|
|
767
|
+
* |6 | 0.87890625 | 21.97265625 | 0.4628040687 | 8.6907788223 |
|
|
768
|
+
* |7 | 0.439453125 | 10.986328125 | 0.2314012764 | 4.3404320789 |
|
|
769
|
+
* |8 | 0.2197265625 | 5.4931640625 | 0.1157005434 | 2.1695927024 |
|
|
770
|
+
* |9 | 0.1098632812 | 2.7465820312 | 0.0578502599 | 1.0847183194 |
|
|
771
|
+
* |10 | 0.0549316406 | 1.3732910156 | 0.0289251285 | 0.5423494021 |
|
|
772
|
+
* |11 | 0.0274658203 | 0.6866455078 | 0.014462564 | 0.2711734813 |
|
|
773
|
+
* |12 | 0.0137329102 | 0.3433227539 | 0.007231282 | 0.1355865882 |
|
|
774
|
+
* |13 | 0.0068664551 | 0.171661377 | 0.003615641 | 0.067793275 |
|
|
775
|
+
* |14 | 0.0034332275 | 0.0858306885 | 0.0018078205 | 0.0338966351 |
|
|
776
|
+
* |15 | 0.0017166138 | 0.0429153442 | 0.0009039102 | 0.0169483173 |
|
|
777
|
+
* |16 | 0.0008583069 | 0.0214576721 | 0.0004519551 | 0.0084741586 |
|
|
778
|
+
* |17 | 0.0004291534 | 0.0107288361 | 0.0002259776 | 0.0042370793 |
|
|
779
|
+
* |18 | 0.0002145767 | 0.005364418 | 0.0001129888 | 0.0021185396 |
|
|
780
|
+
* |19 | 0.0001072884 | 0.002682209 | 5.64944E-05 | 0.0010592698 |
|
|
781
|
+
* |20 | 5.36442E-05 | 0.0013411045 | 2.82472E-05 | 0.0005296349 |
|
|
782
|
+
*
|
|
783
|
+
* _Note_ : Either **center** or **bbox** parameter must be supplied to the API.
|
|
813
784
|
*/
|
|
814
785
|
export declare interface RenderGetMapStaticImage200Response extends HttpResponse {
|
|
815
786
|
status: "200";
|
|
@@ -819,46 +790,43 @@ export declare interface RenderGetMapStaticImage200Response extends HttpResponse
|
|
|
819
790
|
}
|
|
820
791
|
|
|
821
792
|
/**
|
|
822
|
-
*
|
|
793
|
+
* This rendering API produces static, rasterized map views of a user-defined area. It's suitable for lightweight web applications, when the desired user experience doesn't require interactive map controls, or when bandwidth is limited. This API is also useful for embedding maps in applications outside of the browser, in backend services, report generation, or desktop applications.
|
|
823
794
|
*
|
|
824
|
-
*
|
|
795
|
+
* This API includes parameters for basic data visualization:
|
|
825
796
|
*
|
|
826
|
-
*
|
|
797
|
+
* - Labeled pushpins in multiple styles.
|
|
798
|
+
* - Render circle, path, and polygon geometry types.
|
|
827
799
|
*
|
|
828
|
-
*
|
|
829
|
-
* - Render circle, polyline and polygon geometry types.
|
|
830
|
-
*
|
|
831
|
-
* Please see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.
|
|
832
|
-
*
|
|
833
|
-
* _Note_ : Either **center** or **bbox** parameter must be supplied to the
|
|
834
|
-
* API.
|
|
800
|
+
* For more information and detailed examples, see [Render custom data on a raster map](/azure/azure-maps/how-to-render-custom-data).
|
|
835
801
|
* <br><br>
|
|
836
|
-
* The
|
|
802
|
+
* The dimensions of the bbox parameter are constrained, depending on the zoom level. This ensures the resulting image has an appropriate level of detail.
|
|
837
803
|
* <br><br>
|
|
838
804
|
*
|
|
839
|
-
* |Zoom Level | Max Lon Range | Max Lat Range|
|
|
840
|
-
*
|
|
841
|
-
* |0 | 360.0
|
|
842
|
-
* |1 | 360.0
|
|
843
|
-
* |2
|
|
844
|
-
* |3
|
|
845
|
-
* |4
|
|
846
|
-
* |5 |
|
|
847
|
-
* |6
|
|
848
|
-
* |7
|
|
849
|
-
* |8
|
|
850
|
-
* |9
|
|
851
|
-
* |10
|
|
852
|
-
* |11
|
|
853
|
-
* |12
|
|
854
|
-
* |13
|
|
855
|
-
* |14
|
|
856
|
-
* |15
|
|
857
|
-
* |16
|
|
858
|
-
* |17
|
|
859
|
-
* |18
|
|
860
|
-
* |19
|
|
861
|
-
* |20
|
|
805
|
+
* |Zoom Level | Min Lon Range | Max Lon Range | Min Lat Range| Max Lat Range|
|
|
806
|
+
* |:----------|:----------------|:----------------|:----------------|:-------------|
|
|
807
|
+
* |0 | 56.25 | 360.0 | 30.1105585173 | 180.0 |
|
|
808
|
+
* |1 | 28.125 | 360.0 | 14.87468995 | 180.0 |
|
|
809
|
+
* |2 | 14.063 | 351.5625 | 7.4130741851 | 137.9576312246 |
|
|
810
|
+
* |3 | 7.03125 | 175.78125 | 3.7034501005 | 73.6354071932 |
|
|
811
|
+
* |4 | 3.515625 | 87.890625 | 1.8513375155 | 35.4776115315 |
|
|
812
|
+
* |5 | 1.7578125 | 43.9453125 | 0.925620264 | 17.4589959239 |
|
|
813
|
+
* |6 | 0.87890625 | 21.97265625 | 0.4628040687 | 8.6907788223 |
|
|
814
|
+
* |7 | 0.439453125 | 10.986328125 | 0.2314012764 | 4.3404320789 |
|
|
815
|
+
* |8 | 0.2197265625 | 5.4931640625 | 0.1157005434 | 2.1695927024 |
|
|
816
|
+
* |9 | 0.1098632812 | 2.7465820312 | 0.0578502599 | 1.0847183194 |
|
|
817
|
+
* |10 | 0.0549316406 | 1.3732910156 | 0.0289251285 | 0.5423494021 |
|
|
818
|
+
* |11 | 0.0274658203 | 0.6866455078 | 0.014462564 | 0.2711734813 |
|
|
819
|
+
* |12 | 0.0137329102 | 0.3433227539 | 0.007231282 | 0.1355865882 |
|
|
820
|
+
* |13 | 0.0068664551 | 0.171661377 | 0.003615641 | 0.067793275 |
|
|
821
|
+
* |14 | 0.0034332275 | 0.0858306885 | 0.0018078205 | 0.0338966351 |
|
|
822
|
+
* |15 | 0.0017166138 | 0.0429153442 | 0.0009039102 | 0.0169483173 |
|
|
823
|
+
* |16 | 0.0008583069 | 0.0214576721 | 0.0004519551 | 0.0084741586 |
|
|
824
|
+
* |17 | 0.0004291534 | 0.0107288361 | 0.0002259776 | 0.0042370793 |
|
|
825
|
+
* |18 | 0.0002145767 | 0.005364418 | 0.0001129888 | 0.0021185396 |
|
|
826
|
+
* |19 | 0.0001072884 | 0.002682209 | 5.64944E-05 | 0.0010592698 |
|
|
827
|
+
* |20 | 5.36442E-05 | 0.0013411045 | 2.82472E-05 | 0.0005296349 |
|
|
828
|
+
*
|
|
829
|
+
* _Note_ : Either **center** or **bbox** parameter must be supplied to the API.
|
|
862
830
|
*/
|
|
863
831
|
export declare interface RenderGetMapStaticImageDefaultResponse extends HttpResponse {
|
|
864
832
|
status: string;
|
|
@@ -872,38 +840,37 @@ export declare interface RenderGetMapStaticImageQueryParam {
|
|
|
872
840
|
}
|
|
873
841
|
|
|
874
842
|
export declare interface RenderGetMapStaticImageQueryParamProperties {
|
|
875
|
-
/** Map
|
|
876
|
-
|
|
877
|
-
/**
|
|
878
|
-
|
|
879
|
-
/** Desired zoom level of the map.
|
|
843
|
+
/** Map style to be returned. Possible values are microsoft.base.road, microsoft.base.darkgrey, and microsoft.imagery. Default value is set to be microsoft.base.road. For more information, see [Render TilesetId](https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tileset?view=rest-maps-2023-06-01&tabs=HTTP#tilesetid). */
|
|
844
|
+
tilesetId?: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident";
|
|
845
|
+
/** Optional Value, indicating no traffic flow overlaid on the image result. Possible values are microsoft.traffic.relative.main and none. Default value is none, indicating no traffic flow returned. If traffic related tilesetId is provided, will return map image with corresponding traffic layer. For more information, see [Render TilesetId](https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tileset?view=rest-maps-2023-06-01&tabs=HTTP#tilesetid). */
|
|
846
|
+
trafficLayer?: "microsoft.traffic.relative.main" | "none";
|
|
847
|
+
/** Desired zoom level of the map. Support zoom value range from 0-20 (inclusive) for tilesetId being microsoft.base.road or microsoft.base.darkgrey. Support zoom value range from 0-19 (inclusive) for tilesetId being microsoft.imagery. Default value is 12.<br><br>For more information, see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid). */
|
|
880
848
|
zoom?: number;
|
|
881
849
|
/**
|
|
882
|
-
* Coordinates of the center point. Format: 'lon,lat'.
|
|
883
|
-
* - EPSG:3857. Longitude range: -180 to 180. Latitude range: -85 to 85.
|
|
850
|
+
* Coordinates of the center point in double. Format: 'lon,lat'. Longitude range: -180 to 180. Latitude range: -90 to 90.
|
|
884
851
|
*
|
|
885
852
|
* Note: Either center or bbox are required parameters. They are
|
|
886
853
|
* mutually exclusive.
|
|
887
854
|
*/
|
|
888
855
|
center?: Array<number>;
|
|
889
856
|
/**
|
|
890
|
-
*
|
|
891
|
-
* maxLon, maxLat'.
|
|
857
|
+
* A bounding box is defined by two latitudes and two longitudes that represent the four sides of a rectangular area on the Earth. Format : 'minLon, minLat,
|
|
858
|
+
* maxLon, maxLat' (in double).
|
|
892
859
|
*
|
|
893
860
|
* Note: Either bbox or center are required
|
|
894
|
-
* parameters. They are mutually exclusive.
|
|
861
|
+
* parameters. They are mutually exclusive. bbox shouldn’t be used with
|
|
895
862
|
* height or width.
|
|
896
863
|
*
|
|
897
|
-
* The maximum allowed ranges for Lat and Lon are defined for each zoom level
|
|
864
|
+
* The maximum and minimum allowed ranges for Lat and Lon are defined for each zoom level
|
|
898
865
|
* in the table at the top of this page.
|
|
899
866
|
*/
|
|
900
867
|
bbox?: Array<number>;
|
|
901
868
|
/**
|
|
902
|
-
* Height of the resulting image in pixels. Range
|
|
869
|
+
* Height of the resulting image in pixels. Range from 80 to 1500. Default
|
|
903
870
|
* is 512. It shouldn’t be used with bbox.
|
|
904
871
|
*/
|
|
905
872
|
height?: number;
|
|
906
|
-
/** Width of the resulting image in pixels. Range
|
|
873
|
+
/** Width of the resulting image in pixels. Range from 80 to 2000. Default is 512. It should not be used with bbox. */
|
|
907
874
|
width?: number;
|
|
908
875
|
/**
|
|
909
876
|
* Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.
|
|
@@ -920,11 +887,11 @@ export declare interface RenderGetMapStaticImageQueryParamProperties {
|
|
|
920
887
|
/**
|
|
921
888
|
* Pushpin style and instances. Use this parameter to optionally add pushpins to the image.
|
|
922
889
|
* The pushpin style describes the appearance of the pushpins, and the instances specify
|
|
923
|
-
* the coordinates of the pushpins and optional labels for each pin. (Be sure to properly URL-encode values of this
|
|
890
|
+
* the coordinates of the pushpins (in double) and optional labels for each pin. (Be sure to properly URL-encode values of this
|
|
924
891
|
* parameter since it will contain reserved characters such as pipes and punctuation.)
|
|
925
892
|
*
|
|
926
|
-
* The Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs
|
|
927
|
-
* allow
|
|
893
|
+
* The Azure Maps account S0 SKU only supports a single instance of the pins parameter and the number of locations is limited to 5 per pin. Other SKUs
|
|
894
|
+
* allow up to 25 instances of the pins parameter to specify multiple pin styles, and the number of locations is limited to 50 per pin.
|
|
928
895
|
*
|
|
929
896
|
* To render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the
|
|
930
897
|
* querystring parameter
|
|
@@ -959,12 +926,12 @@ export declare interface RenderGetMapStaticImageQueryParamProperties {
|
|
|
959
926
|
*
|
|
960
927
|
* ### Pushpin Labels
|
|
961
928
|
*
|
|
962
|
-
* To add a label to the pins, put the label in single quotes just before the coordinates. For example, to label
|
|
929
|
+
* To add a label to the pins, put the label in single quotes just before the coordinates. Avoid using special character such as `|` or `||` in label. For example, to label
|
|
963
930
|
* three pins with the values '1', '2', and '3', use
|
|
964
931
|
*
|
|
965
932
|
* `pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`
|
|
966
933
|
*
|
|
967
|
-
* There is a built
|
|
934
|
+
* There is a built-in pushpin style called 'none' that does not display a pushpin image. You can use this if
|
|
968
935
|
* you want to display labels without any pin image. For example,
|
|
969
936
|
*
|
|
970
937
|
* `pins=none||'A'-122 45|'B'-119.5 43.2`
|
|
@@ -991,7 +958,7 @@ export declare interface RenderGetMapStaticImageQueryParamProperties {
|
|
|
991
958
|
* ### Custom Pushpins
|
|
992
959
|
*
|
|
993
960
|
* To use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the
|
|
994
|
-
* location and label information. Use two pipe characters to indicate that you're done specifying locations and are
|
|
961
|
+
* location and label information. The maximum allowed size for a customized label image is 65,536 pixels. Use two pipe characters to indicate that you're done specifying locations and are
|
|
995
962
|
* starting the URL. For example,
|
|
996
963
|
*
|
|
997
964
|
* `pins=custom||-122 45||http://contoso.com/pushpins/red.png`
|
|
@@ -1035,23 +1002,23 @@ export declare interface RenderGetMapStaticImageQueryParamProperties {
|
|
|
1035
1002
|
*
|
|
1036
1003
|
* ### Style Modifier Summary
|
|
1037
1004
|
*
|
|
1038
|
-
* Modifier | Description
|
|
1039
|
-
*
|
|
1040
|
-
* al | Alpha (opacity) | 0 to 1
|
|
1041
|
-
* an | Pin anchor
|
|
1042
|
-
* co | Pin color
|
|
1043
|
-
* la | Label anchor
|
|
1044
|
-
* lc | Label color
|
|
1045
|
-
* ls | Label size | Greater than 0
|
|
1046
|
-
* ro | Rotation
|
|
1047
|
-
* sc | Scale
|
|
1005
|
+
* Modifier | Description | Type | Range
|
|
1006
|
+
* :--------:|---------------|--------|----------
|
|
1007
|
+
* al | Alpha (opacity) | float | 0 to 1
|
|
1008
|
+
* an | Pin anchor | <int32, int32> | *
|
|
1009
|
+
* co | Pin color | string | 000000 to FFFFFF
|
|
1010
|
+
* la | Label anchor | <int32, int32> | *
|
|
1011
|
+
* lc | Label color | string | 000000 to FFFFFF
|
|
1012
|
+
* ls | Label size | float | Greater than 0
|
|
1013
|
+
* ro | Rotation | float | -360 to 360
|
|
1014
|
+
* sc | Scale | float | Greater than 0
|
|
1048
1015
|
*
|
|
1049
1016
|
* * X and Y coordinates can be anywhere within pin image or a margin around it.
|
|
1050
1017
|
* The margin size is the minimum of the pin width and height.
|
|
1051
1018
|
*/
|
|
1052
1019
|
pins?: string;
|
|
1053
1020
|
/**
|
|
1054
|
-
* Path style and locations. Use this parameter to optionally add lines, polygons or circles to the image.
|
|
1021
|
+
* Path style and locations (in double). Use this parameter to optionally add lines, polygons or circles to the image.
|
|
1055
1022
|
* The path style describes the appearance of the line and fill. (Be sure to properly URL-encode values of this
|
|
1056
1023
|
* parameter since it will contain reserved characters such as pipes and punctuation.)
|
|
1057
1024
|
*
|
|
@@ -1075,11 +1042,11 @@ export declare interface RenderGetMapStaticImageQueryParamProperties {
|
|
|
1075
1042
|
*
|
|
1076
1043
|
* `path=||-122 45|-119.5 43.2|-121.67 47.12`
|
|
1077
1044
|
*
|
|
1078
|
-
*
|
|
1045
|
+
* A polygon is specified with a closed path, where the first and last points are equal. For example, use
|
|
1079
1046
|
*
|
|
1080
1047
|
* `path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45`
|
|
1081
1048
|
*
|
|
1082
|
-
* Longitude
|
|
1049
|
+
* Longitude value for locations of lines and polygons can be in the range from -360 to 360 to allow for rendering of geometries crossing the anti-meridian.
|
|
1083
1050
|
*
|
|
1084
1051
|
* ### Style Modifiers
|
|
1085
1052
|
*
|
|
@@ -1093,20 +1060,20 @@ export declare interface RenderGetMapStaticImageQueryParamProperties {
|
|
|
1093
1060
|
*
|
|
1094
1061
|
* `path=lcFF1493||-122 45|-119.5 43.2`
|
|
1095
1062
|
*
|
|
1096
|
-
* Multiple style modifiers may be combined
|
|
1063
|
+
* Multiple style modifiers may be combined to create a more complex visual style.
|
|
1097
1064
|
*
|
|
1098
1065
|
* `lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6`
|
|
1099
1066
|
*
|
|
1100
1067
|
* ### Style Modifier Summary
|
|
1101
1068
|
*
|
|
1102
|
-
* Modifier | Description
|
|
1103
|
-
*
|
|
1104
|
-
* lc | Line color
|
|
1105
|
-
* fc | Fill color
|
|
1106
|
-
* la
|
|
1107
|
-
* fa
|
|
1108
|
-
* lw
|
|
1109
|
-
* ra | Circle radius (meters) | Greater than 0
|
|
1069
|
+
* Modifier | Description | Type | Range
|
|
1070
|
+
* :--------:|---------------|--------|----------
|
|
1071
|
+
* lc | Line color | string | 000000 to FFFFFF
|
|
1072
|
+
* fc | Fill color | string | 000000 to FFFFFF
|
|
1073
|
+
* la | Line alpha (opacity) | float | 0 to 1
|
|
1074
|
+
* fa | Fill alpha (opacity) | float | 0 to 1
|
|
1075
|
+
* lw | Line width |int32 | (0, 50]
|
|
1076
|
+
* ra | Circle radius (meters) | float | Greater than 0
|
|
1110
1077
|
*/
|
|
1111
1078
|
path?: string;
|
|
1112
1079
|
}
|
|
@@ -1117,9 +1084,8 @@ export declare interface RenderGetMapTile200Headers {
|
|
|
1117
1084
|
}
|
|
1118
1085
|
|
|
1119
1086
|
/**
|
|
1120
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
1121
1087
|
*
|
|
1122
|
-
* The Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.
|
|
1088
|
+
* The `Get Map Tiles` API in an HTTP GET request that allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control ([Web SDK](/azure/azure-maps/about-azure-maps#web-sdk)) and [Android SDK](/azure/azure-maps/about-azure-maps#android-sdk).
|
|
1123
1089
|
*/
|
|
1124
1090
|
export declare interface RenderGetMapTile200Response extends HttpResponse {
|
|
1125
1091
|
status: "200";
|
|
@@ -1129,9 +1095,8 @@ export declare interface RenderGetMapTile200Response extends HttpResponse {
|
|
|
1129
1095
|
}
|
|
1130
1096
|
|
|
1131
1097
|
/**
|
|
1132
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
1133
1098
|
*
|
|
1134
|
-
* The Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.
|
|
1099
|
+
* The `Get Map Tiles` API in an HTTP GET request that allows users to request map tiles in vector or raster formats typically to be integrated into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default, Azure Maps uses vector tiles for its web map control ([Web SDK](/azure/azure-maps/about-azure-maps#web-sdk)) and [Android SDK](/azure/azure-maps/about-azure-maps#android-sdk).
|
|
1135
1100
|
*/
|
|
1136
1101
|
export declare interface RenderGetMapTileDefaultResponse extends HttpResponse {
|
|
1137
1102
|
status: string;
|
|
@@ -1145,12 +1110,12 @@ export declare interface RenderGetMapTileQueryParam {
|
|
|
1145
1110
|
}
|
|
1146
1111
|
|
|
1147
1112
|
export declare interface RenderGetMapTileQueryParamProperties {
|
|
1148
|
-
/** A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/
|
|
1113
|
+
/** A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. */
|
|
1149
1114
|
tilesetId: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident";
|
|
1150
1115
|
/**
|
|
1151
1116
|
* Zoom level for the desired tile.
|
|
1152
1117
|
*
|
|
1153
|
-
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/
|
|
1118
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
1154
1119
|
*/
|
|
1155
1120
|
zoom: number;
|
|
1156
1121
|
/**
|
|
@@ -1189,7 +1154,6 @@ export declare interface RenderGetMapTileQueryParamProperties {
|
|
|
1189
1154
|
}
|
|
1190
1155
|
|
|
1191
1156
|
/**
|
|
1192
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
1193
1157
|
*
|
|
1194
1158
|
* The Get Map Tileset API allows users to request metadata for a tileset.
|
|
1195
1159
|
*/
|
|
@@ -1199,7 +1163,6 @@ export declare interface RenderGetMapTileset200Response extends HttpResponse {
|
|
|
1199
1163
|
}
|
|
1200
1164
|
|
|
1201
1165
|
/**
|
|
1202
|
-
* **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).
|
|
1203
1166
|
*
|
|
1204
1167
|
* The Get Map Tileset API allows users to request metadata for a tileset.
|
|
1205
1168
|
*/
|
|
@@ -1215,7 +1178,7 @@ export declare interface RenderGetMapTilesetQueryParam {
|
|
|
1215
1178
|
}
|
|
1216
1179
|
|
|
1217
1180
|
export declare interface RenderGetMapTilesetQueryParamProperties {
|
|
1218
|
-
/** A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/
|
|
1181
|
+
/** A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. */
|
|
1219
1182
|
tilesetId: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident";
|
|
1220
1183
|
}
|
|
1221
1184
|
|
|
@@ -1230,8 +1193,8 @@ export declare interface Routes {
|
|
|
1230
1193
|
(path: "/map/statetile"): GetMapStateTile;
|
|
1231
1194
|
/** Resource for '/map/copyright/caption/\{format\}' has methods for the following verbs: get */
|
|
1232
1195
|
(path: "/map/copyright/caption/{format}", format: "json" | "xml"): GetCopyrightCaption;
|
|
1233
|
-
/** Resource for '/map/static
|
|
1234
|
-
(path: "/map/static
|
|
1196
|
+
/** Resource for '/map/static' has methods for the following verbs: get */
|
|
1197
|
+
(path: "/map/static"): GetMapStaticImage;
|
|
1235
1198
|
/** Resource for '/map/copyright/bounding/\{format\}' has methods for the following verbs: get */
|
|
1236
1199
|
(path: "/map/copyright/bounding/{format}", format: "json" | "xml"): GetCopyrightFromBoundingBox;
|
|
1237
1200
|
/** Resource for '/map/copyright/tile/\{format\}' has methods for the following verbs: get */
|