@azure-rest/maps-render 2.0.0-beta.1 → 2.0.0-beta.3
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/CHANGELOG.md +53 -0
- package/LICENSE +4 -4
- package/README.md +48 -34
- package/dist/browser/createMultiCollection.d.ts +7 -0
- package/dist/browser/createMultiCollection.d.ts.map +1 -0
- package/dist/browser/createPathQuery.d.ts +117 -0
- package/dist/browser/createPathQuery.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/createPathQuery.js +42 -25
- package/dist/browser/createPathQuery.js.map +1 -0
- package/dist/browser/createPinsQuery.d.ts +102 -0
- package/dist/browser/createPinsQuery.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/createPinsQuery.js +44 -25
- package/dist/browser/createPinsQuery.js.map +1 -0
- package/dist/browser/generated/clientDefinitions.d.ts +131 -0
- package/dist/browser/generated/clientDefinitions.d.ts.map +1 -0
- package/dist/browser/generated/clientDefinitions.js +4 -0
- package/dist/browser/generated/clientDefinitions.js.map +1 -0
- package/dist/browser/generated/index.d.ts +9 -0
- package/dist/browser/generated/index.d.ts.map +1 -0
- package/dist/browser/generated/index.js +11 -0
- package/dist/browser/generated/index.js.map +1 -0
- package/dist/browser/generated/isUnexpected.d.ts +11 -0
- package/dist/browser/generated/isUnexpected.d.ts.map +1 -0
- package/dist/browser/generated/isUnexpected.js +78 -0
- package/dist/browser/generated/isUnexpected.js.map +1 -0
- package/dist/browser/generated/logger.d.ts +2 -0
- package/dist/browser/generated/logger.d.ts.map +1 -0
- package/dist/browser/generated/logger.js +5 -0
- package/dist/browser/generated/logger.js.map +1 -0
- package/dist/browser/generated/mapsRenderClient.d.ts +15 -0
- package/dist/browser/generated/mapsRenderClient.d.ts.map +1 -0
- package/dist/browser/generated/mapsRenderClient.js +44 -0
- package/dist/browser/generated/mapsRenderClient.js.map +1 -0
- package/dist/browser/generated/outputModels.d.ts +93 -0
- package/dist/browser/generated/outputModels.d.ts.map +1 -0
- package/dist/browser/generated/outputModels.js +4 -0
- package/dist/browser/generated/outputModels.js.map +1 -0
- package/dist/browser/generated/parameters.d.ts +384 -0
- package/dist/browser/generated/parameters.d.ts.map +1 -0
- package/dist/browser/generated/parameters.js +4 -0
- package/dist/browser/generated/parameters.js.map +1 -0
- package/dist/browser/generated/responses.d.ts +248 -0
- package/dist/browser/generated/responses.d.ts.map +1 -0
- package/dist/browser/generated/responses.js +4 -0
- package/dist/browser/generated/responses.js.map +1 -0
- package/dist/browser/index.d.ts +7 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +9 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/mapsRender.d.ts +53 -0
- package/dist/browser/mapsRender.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/mapsRender.js +1 -1
- package/dist/browser/mapsRender.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/positionToTileXY.d.ts +47 -0
- package/dist/browser/positionToTileXY.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/positionToTileXY.js +24 -3
- package/dist/browser/positionToTileXY.js.map +1 -0
- package/dist/commonjs/createMultiCollection.d.ts +7 -0
- package/dist/commonjs/createMultiCollection.d.ts.map +1 -0
- package/dist/commonjs/createMultiCollection.js +16 -0
- package/dist/commonjs/createMultiCollection.js.map +1 -0
- package/dist/commonjs/createPathQuery.d.ts +117 -0
- package/dist/commonjs/createPathQuery.d.ts.map +1 -0
- package/dist/commonjs/createPathQuery.js +117 -0
- package/dist/commonjs/createPathQuery.js.map +1 -0
- package/dist/commonjs/createPinsQuery.d.ts +102 -0
- package/dist/commonjs/createPinsQuery.d.ts.map +1 -0
- package/dist/commonjs/createPinsQuery.js +96 -0
- package/dist/commonjs/createPinsQuery.js.map +1 -0
- package/dist/commonjs/generated/clientDefinitions.d.ts +131 -0
- package/dist/commonjs/generated/clientDefinitions.d.ts.map +1 -0
- package/dist/commonjs/generated/clientDefinitions.js +5 -0
- package/dist/commonjs/generated/clientDefinitions.js.map +1 -0
- package/dist/commonjs/generated/index.d.ts +9 -0
- package/dist/commonjs/generated/index.d.ts.map +1 -0
- package/dist/commonjs/generated/index.js +14 -0
- package/dist/commonjs/generated/index.js.map +1 -0
- package/dist/commonjs/generated/isUnexpected.d.ts +11 -0
- package/dist/commonjs/generated/isUnexpected.d.ts.map +1 -0
- package/dist/commonjs/generated/isUnexpected.js +81 -0
- package/dist/commonjs/generated/isUnexpected.js.map +1 -0
- package/dist/commonjs/generated/logger.d.ts +2 -0
- package/dist/commonjs/generated/logger.d.ts.map +1 -0
- package/dist/commonjs/generated/logger.js +8 -0
- package/dist/commonjs/generated/logger.js.map +1 -0
- package/dist/commonjs/generated/mapsRenderClient.d.ts +15 -0
- package/dist/commonjs/generated/mapsRenderClient.d.ts.map +1 -0
- package/dist/commonjs/generated/mapsRenderClient.js +47 -0
- package/dist/commonjs/generated/mapsRenderClient.js.map +1 -0
- package/dist/commonjs/generated/outputModels.d.ts +93 -0
- package/dist/commonjs/generated/outputModels.d.ts.map +1 -0
- package/dist/commonjs/generated/outputModels.js +5 -0
- package/dist/commonjs/generated/outputModels.js.map +1 -0
- package/dist/commonjs/generated/parameters.d.ts +384 -0
- package/dist/commonjs/generated/parameters.d.ts.map +1 -0
- package/dist/commonjs/generated/parameters.js +5 -0
- package/dist/commonjs/generated/parameters.js.map +1 -0
- package/dist/commonjs/generated/responses.d.ts +248 -0
- package/dist/commonjs/generated/responses.d.ts.map +1 -0
- package/dist/commonjs/generated/responses.js +5 -0
- package/dist/commonjs/generated/responses.js.map +1 -0
- package/dist/commonjs/index.d.ts +7 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +12 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/mapsRender.d.ts +53 -0
- package/dist/commonjs/mapsRender.d.ts.map +1 -0
- package/dist/commonjs/mapsRender.js +44 -0
- package/dist/commonjs/mapsRender.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/positionToTileXY.d.ts +47 -0
- package/dist/commonjs/positionToTileXY.d.ts.map +1 -0
- package/dist/commonjs/positionToTileXY.js +68 -0
- package/dist/commonjs/positionToTileXY.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/esm/createMultiCollection.d.ts +7 -0
- package/dist/esm/createMultiCollection.d.ts.map +1 -0
- package/dist/esm/createMultiCollection.js +13 -0
- package/dist/esm/createMultiCollection.js.map +1 -0
- package/dist/esm/createPathQuery.d.ts +117 -0
- package/dist/esm/createPathQuery.d.ts.map +1 -0
- package/dist/esm/createPathQuery.js +114 -0
- package/dist/esm/createPathQuery.js.map +1 -0
- package/dist/esm/createPinsQuery.d.ts +102 -0
- package/dist/esm/createPinsQuery.d.ts.map +1 -0
- package/dist/esm/createPinsQuery.js +93 -0
- package/dist/esm/createPinsQuery.js.map +1 -0
- package/dist/esm/generated/clientDefinitions.d.ts +131 -0
- package/dist/esm/generated/clientDefinitions.d.ts.map +1 -0
- package/dist/esm/generated/clientDefinitions.js +4 -0
- package/dist/esm/generated/clientDefinitions.js.map +1 -0
- package/dist/esm/generated/index.d.ts +9 -0
- package/dist/esm/generated/index.d.ts.map +1 -0
- package/dist/esm/generated/index.js +11 -0
- package/dist/esm/generated/index.js.map +1 -0
- package/dist/esm/generated/isUnexpected.d.ts +11 -0
- package/dist/esm/generated/isUnexpected.d.ts.map +1 -0
- package/dist/esm/generated/isUnexpected.js +78 -0
- package/dist/esm/generated/isUnexpected.js.map +1 -0
- package/dist/esm/generated/logger.d.ts +2 -0
- package/dist/esm/generated/logger.d.ts.map +1 -0
- package/dist/esm/generated/logger.js +5 -0
- package/dist/esm/generated/logger.js.map +1 -0
- package/dist/esm/generated/mapsRenderClient.d.ts +15 -0
- package/dist/esm/generated/mapsRenderClient.d.ts.map +1 -0
- package/dist/esm/generated/mapsRenderClient.js +44 -0
- package/dist/esm/generated/mapsRenderClient.js.map +1 -0
- package/dist/esm/generated/outputModels.d.ts +93 -0
- package/dist/esm/generated/outputModels.d.ts.map +1 -0
- package/dist/esm/generated/outputModels.js +4 -0
- package/dist/esm/generated/outputModels.js.map +1 -0
- package/dist/esm/generated/parameters.d.ts +384 -0
- package/dist/esm/generated/parameters.d.ts.map +1 -0
- package/dist/esm/generated/parameters.js +4 -0
- package/dist/esm/generated/parameters.js.map +1 -0
- package/dist/esm/generated/responses.d.ts +248 -0
- package/dist/esm/generated/responses.d.ts.map +1 -0
- package/dist/esm/generated/responses.js +4 -0
- package/dist/esm/generated/responses.js.map +1 -0
- package/dist/esm/index.d.ts +7 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +9 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/mapsRender.d.ts +53 -0
- package/dist/esm/mapsRender.d.ts.map +1 -0
- package/dist/esm/mapsRender.js +40 -0
- package/dist/esm/mapsRender.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/positionToTileXY.d.ts +47 -0
- package/dist/esm/positionToTileXY.d.ts.map +1 -0
- package/dist/esm/positionToTileXY.js +65 -0
- package/dist/esm/positionToTileXY.js.map +1 -0
- package/dist/react-native/createMultiCollection.d.ts +7 -0
- package/dist/react-native/createMultiCollection.d.ts.map +1 -0
- package/dist/react-native/createMultiCollection.js +13 -0
- package/dist/react-native/createMultiCollection.js.map +1 -0
- package/dist/react-native/createPathQuery.d.ts +117 -0
- package/dist/react-native/createPathQuery.d.ts.map +1 -0
- package/dist/react-native/createPathQuery.js +114 -0
- package/dist/react-native/createPathQuery.js.map +1 -0
- package/dist/react-native/createPinsQuery.d.ts +102 -0
- package/dist/react-native/createPinsQuery.d.ts.map +1 -0
- package/dist/react-native/createPinsQuery.js +93 -0
- package/dist/react-native/createPinsQuery.js.map +1 -0
- package/dist/react-native/generated/clientDefinitions.d.ts +131 -0
- package/dist/react-native/generated/clientDefinitions.d.ts.map +1 -0
- package/dist/react-native/generated/clientDefinitions.js +4 -0
- package/dist/react-native/generated/clientDefinitions.js.map +1 -0
- package/dist/react-native/generated/index.d.ts +9 -0
- package/dist/react-native/generated/index.d.ts.map +1 -0
- package/dist/react-native/generated/index.js +11 -0
- package/dist/react-native/generated/index.js.map +1 -0
- package/dist/react-native/generated/isUnexpected.d.ts +11 -0
- package/dist/react-native/generated/isUnexpected.d.ts.map +1 -0
- package/dist/react-native/generated/isUnexpected.js +78 -0
- package/dist/react-native/generated/isUnexpected.js.map +1 -0
- package/dist/react-native/generated/logger.d.ts +2 -0
- package/dist/react-native/generated/logger.d.ts.map +1 -0
- package/dist/react-native/generated/logger.js +5 -0
- package/dist/react-native/generated/logger.js.map +1 -0
- package/dist/react-native/generated/mapsRenderClient.d.ts +15 -0
- package/dist/react-native/generated/mapsRenderClient.d.ts.map +1 -0
- package/dist/react-native/generated/mapsRenderClient.js +44 -0
- package/dist/react-native/generated/mapsRenderClient.js.map +1 -0
- package/dist/react-native/generated/outputModels.d.ts +93 -0
- package/dist/react-native/generated/outputModels.d.ts.map +1 -0
- package/dist/react-native/generated/outputModels.js +4 -0
- package/dist/react-native/generated/outputModels.js.map +1 -0
- package/dist/react-native/generated/parameters.d.ts +384 -0
- package/dist/react-native/generated/parameters.d.ts.map +1 -0
- package/dist/react-native/generated/parameters.js +4 -0
- package/dist/react-native/generated/parameters.js.map +1 -0
- package/dist/react-native/generated/responses.d.ts +248 -0
- package/dist/react-native/generated/responses.d.ts.map +1 -0
- package/dist/react-native/generated/responses.js +4 -0
- package/dist/react-native/generated/responses.js.map +1 -0
- package/dist/react-native/index.d.ts +7 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +9 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/mapsRender.d.ts +53 -0
- package/dist/react-native/mapsRender.d.ts.map +1 -0
- package/dist/react-native/mapsRender.js +40 -0
- package/dist/react-native/mapsRender.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/positionToTileXY.d.ts +47 -0
- package/dist/react-native/positionToTileXY.d.ts.map +1 -0
- package/dist/react-native/positionToTileXY.js +65 -0
- package/dist/react-native/positionToTileXY.js.map +1 -0
- package/package.json +86 -72
- package/dist/index.js +0 -404
- package/dist/index.js.map +0 -1
- package/dist-esm/src/createPathQuery.js.map +0 -1
- package/dist-esm/src/createPinsQuery.js.map +0 -1
- package/dist-esm/src/index.js +0 -9
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/mapsRender.js.map +0 -1
- package/dist-esm/src/positionToTileXY.js.map +0 -1
- package/types/maps-render-rest.d.ts +0 -1212
- /package/{dist-esm/src → dist/browser}/createMultiCollection.js +0 -0
- /package/{dist-esm/src → dist/browser}/createMultiCollection.js.map +0 -0
- /package/review/{maps-render.api.md → maps-render-node.api.md} +0 -0
|
@@ -0,0 +1,384 @@
|
|
|
1
|
+
import { RequestParameters } from "@azure-rest/core-client";
|
|
2
|
+
export interface RenderGetMapTileQueryParamProperties {
|
|
3
|
+
/** 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. */
|
|
4
|
+
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";
|
|
5
|
+
/**
|
|
6
|
+
* Zoom level for the desired tile.
|
|
7
|
+
*
|
|
8
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
9
|
+
*/
|
|
10
|
+
zoom: number;
|
|
11
|
+
/**
|
|
12
|
+
* X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].
|
|
13
|
+
*
|
|
14
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
15
|
+
*/
|
|
16
|
+
x: number;
|
|
17
|
+
/**
|
|
18
|
+
* Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].
|
|
19
|
+
*
|
|
20
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
21
|
+
*/
|
|
22
|
+
y: number;
|
|
23
|
+
/**
|
|
24
|
+
* The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.
|
|
25
|
+
*
|
|
26
|
+
* * microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.
|
|
27
|
+
* * microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.
|
|
28
|
+
*/
|
|
29
|
+
timeStamp?: Date | string;
|
|
30
|
+
/** The size of the returned map tile in pixels. */
|
|
31
|
+
tileSize?: "256" | "512";
|
|
32
|
+
/**
|
|
33
|
+
* 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.
|
|
34
|
+
*
|
|
35
|
+
* Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
|
|
36
|
+
*/
|
|
37
|
+
language?: string;
|
|
38
|
+
/**
|
|
39
|
+
* The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. 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. Example: view=IN.
|
|
40
|
+
*
|
|
41
|
+
* Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.
|
|
42
|
+
*/
|
|
43
|
+
view?: "AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified";
|
|
44
|
+
}
|
|
45
|
+
export interface RenderGetMapTileQueryParam {
|
|
46
|
+
queryParameters: RenderGetMapTileQueryParamProperties;
|
|
47
|
+
}
|
|
48
|
+
export type RenderGetMapTileParameters = RenderGetMapTileQueryParam & RequestParameters;
|
|
49
|
+
export interface RenderGetMapTilesetQueryParamProperties {
|
|
50
|
+
/** 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. */
|
|
51
|
+
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";
|
|
52
|
+
}
|
|
53
|
+
export interface RenderGetMapTilesetQueryParam {
|
|
54
|
+
queryParameters: RenderGetMapTilesetQueryParamProperties;
|
|
55
|
+
}
|
|
56
|
+
export type RenderGetMapTilesetParameters = RenderGetMapTilesetQueryParam & RequestParameters;
|
|
57
|
+
export interface RenderGetMapAttributionQueryParamProperties {
|
|
58
|
+
/** 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. */
|
|
59
|
+
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";
|
|
60
|
+
/** Zoom level for the desired map attribution. */
|
|
61
|
+
zoom: number;
|
|
62
|
+
/** The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`. */
|
|
63
|
+
bounds: Array<number>;
|
|
64
|
+
}
|
|
65
|
+
export interface RenderGetMapAttributionQueryParam {
|
|
66
|
+
queryParameters: RenderGetMapAttributionQueryParamProperties;
|
|
67
|
+
}
|
|
68
|
+
export type RenderGetMapAttributionParameters = RenderGetMapAttributionQueryParam & RequestParameters;
|
|
69
|
+
export interface RenderGetMapStateTileQueryParamProperties {
|
|
70
|
+
/**
|
|
71
|
+
* Zoom level for the desired tile.
|
|
72
|
+
*
|
|
73
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
74
|
+
*/
|
|
75
|
+
zoom: number;
|
|
76
|
+
/**
|
|
77
|
+
* X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].
|
|
78
|
+
*
|
|
79
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
80
|
+
*/
|
|
81
|
+
x: number;
|
|
82
|
+
/**
|
|
83
|
+
* Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].
|
|
84
|
+
*
|
|
85
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
86
|
+
*/
|
|
87
|
+
y: number;
|
|
88
|
+
/** The stateset id. */
|
|
89
|
+
statesetId: string;
|
|
90
|
+
}
|
|
91
|
+
export interface RenderGetMapStateTileQueryParam {
|
|
92
|
+
queryParameters: RenderGetMapStateTileQueryParamProperties;
|
|
93
|
+
}
|
|
94
|
+
export type RenderGetMapStateTileParameters = RenderGetMapStateTileQueryParam & RequestParameters;
|
|
95
|
+
export type RenderGetCopyrightCaptionParameters = RequestParameters;
|
|
96
|
+
export interface RenderGetMapStaticImageQueryParamProperties {
|
|
97
|
+
/** 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). */
|
|
98
|
+
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";
|
|
99
|
+
/** 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). */
|
|
100
|
+
trafficLayer?: "microsoft.traffic.relative.main" | "none";
|
|
101
|
+
/** 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). */
|
|
102
|
+
zoom?: number;
|
|
103
|
+
/**
|
|
104
|
+
* Coordinates of the center point in double. Format: 'lon,lat'. Longitude range: -180 to 180. Latitude range: -90 to 90.
|
|
105
|
+
*
|
|
106
|
+
* Note: Either center or bbox are required parameters. They are
|
|
107
|
+
* mutually exclusive.
|
|
108
|
+
*/
|
|
109
|
+
center?: Array<number>;
|
|
110
|
+
/**
|
|
111
|
+
* 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,
|
|
112
|
+
* maxLon, maxLat' (in double).
|
|
113
|
+
*
|
|
114
|
+
* Note: Either bbox or center are required
|
|
115
|
+
* parameters. They are mutually exclusive. bbox shouldn’t be used with
|
|
116
|
+
* height or width.
|
|
117
|
+
*
|
|
118
|
+
* The maximum and minimum allowed ranges for Lat and Lon are defined for each zoom level
|
|
119
|
+
* in the table at the top of this page.
|
|
120
|
+
*/
|
|
121
|
+
bbox?: Array<number>;
|
|
122
|
+
/**
|
|
123
|
+
* Height of the resulting image in pixels. Range from 80 to 1500. Default
|
|
124
|
+
* is 512. It shouldn’t be used with bbox.
|
|
125
|
+
*/
|
|
126
|
+
height?: number;
|
|
127
|
+
/** Width of the resulting image in pixels. Range from 80 to 2000. Default is 512. It should not be used with bbox. */
|
|
128
|
+
width?: number;
|
|
129
|
+
/**
|
|
130
|
+
* 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.
|
|
131
|
+
*
|
|
132
|
+
* Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.
|
|
133
|
+
*/
|
|
134
|
+
language?: string;
|
|
135
|
+
/**
|
|
136
|
+
* The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. 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. Example: view=IN.
|
|
137
|
+
*
|
|
138
|
+
* Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.
|
|
139
|
+
*/
|
|
140
|
+
view?: "AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified";
|
|
141
|
+
/**
|
|
142
|
+
* Pushpin style and instances. Use this parameter to optionally add pushpins to the image.
|
|
143
|
+
* The pushpin style describes the appearance of the pushpins, and the instances specify
|
|
144
|
+
* the coordinates of the pushpins (in double) and optional labels for each pin. (Be sure to properly URL-encode values of this
|
|
145
|
+
* parameter since it will contain reserved characters such as pipes and punctuation.)
|
|
146
|
+
*
|
|
147
|
+
* 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
|
|
148
|
+
* 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.
|
|
149
|
+
*
|
|
150
|
+
* To render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the
|
|
151
|
+
* querystring parameter
|
|
152
|
+
*
|
|
153
|
+
* `pins=default||-122 45`
|
|
154
|
+
*
|
|
155
|
+
* Note that the longitude comes before the latitude.
|
|
156
|
+
* After URL encoding this will look like
|
|
157
|
+
*
|
|
158
|
+
* `pins=default%7C%7C-122+45`
|
|
159
|
+
*
|
|
160
|
+
* All of the examples here show the pins
|
|
161
|
+
* parameter without URL encoding, for clarity.
|
|
162
|
+
*
|
|
163
|
+
* To render a pin at multiple locations, separate each location with a pipe character. For example, use
|
|
164
|
+
*
|
|
165
|
+
* `pins=default||-122 45|-119.5 43.2|-121.67 47.12`
|
|
166
|
+
*
|
|
167
|
+
* The S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.
|
|
168
|
+
*
|
|
169
|
+
* ### Style Modifiers
|
|
170
|
+
*
|
|
171
|
+
* You can modify the appearance of the pins by adding style modifiers. These are added after the style but before
|
|
172
|
+
* the locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help
|
|
173
|
+
* reduce the length of the URL.
|
|
174
|
+
*
|
|
175
|
+
* To change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color
|
|
176
|
+
* format which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use
|
|
177
|
+
* a deep pink color which you would specify as #FF1493 in CSS, use
|
|
178
|
+
*
|
|
179
|
+
* `pins=default|coFF1493||-122 45`
|
|
180
|
+
*
|
|
181
|
+
* ### Pushpin Labels
|
|
182
|
+
*
|
|
183
|
+
* 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
|
|
184
|
+
* three pins with the values '1', '2', and '3', use
|
|
185
|
+
*
|
|
186
|
+
* `pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`
|
|
187
|
+
*
|
|
188
|
+
* There is a built-in pushpin style called 'none' that does not display a pushpin image. You can use this if
|
|
189
|
+
* you want to display labels without any pin image. For example,
|
|
190
|
+
*
|
|
191
|
+
* `pins=none||'A'-122 45|'B'-119.5 43.2`
|
|
192
|
+
*
|
|
193
|
+
* To change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink
|
|
194
|
+
* pushpins with black labels, use
|
|
195
|
+
*
|
|
196
|
+
* `pins=default|coFF1493|lc000000||-122 45`
|
|
197
|
+
*
|
|
198
|
+
* To change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate
|
|
199
|
+
* height of the label text in pixels. For example, to increase the label size to 12, use
|
|
200
|
+
*
|
|
201
|
+
* `pins=default|ls12||'A'-122 45|'B'-119 43`
|
|
202
|
+
*
|
|
203
|
+
* The labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and
|
|
204
|
+
* is at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier
|
|
205
|
+
* and provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the
|
|
206
|
+
* pushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,
|
|
207
|
+
* to position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,
|
|
208
|
+
* use
|
|
209
|
+
*
|
|
210
|
+
* `pins=default|la10 -4||'A'-122 45|'B'-119 43`
|
|
211
|
+
*
|
|
212
|
+
* ### Custom Pushpins
|
|
213
|
+
*
|
|
214
|
+
* To use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the
|
|
215
|
+
* 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
|
|
216
|
+
* starting the URL. For example,
|
|
217
|
+
*
|
|
218
|
+
* `pins=custom||-122 45||http://contoso.com/pushpins/red.png`
|
|
219
|
+
*
|
|
220
|
+
* After URL encoding, this would look like
|
|
221
|
+
*
|
|
222
|
+
* `pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`
|
|
223
|
+
*
|
|
224
|
+
* By default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures
|
|
225
|
+
* the location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'
|
|
226
|
+
* style modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom
|
|
227
|
+
* pin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by
|
|
228
|
+
* using
|
|
229
|
+
*
|
|
230
|
+
* `pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`
|
|
231
|
+
*
|
|
232
|
+
* Note: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB
|
|
233
|
+
* channels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually
|
|
234
|
+
* only be done with a solid-color custom image.
|
|
235
|
+
*
|
|
236
|
+
* ### Scale, Rotation, and Opacity
|
|
237
|
+
*
|
|
238
|
+
* You can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a
|
|
239
|
+
* value greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and
|
|
240
|
+
* values smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use
|
|
241
|
+
*
|
|
242
|
+
* `pins=default|sc1.5||-122 45`
|
|
243
|
+
*
|
|
244
|
+
* You can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees
|
|
245
|
+
* of clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins
|
|
246
|
+
* 90 degrees clockwise and double their size, use
|
|
247
|
+
*
|
|
248
|
+
* `pins=default|ro90|sc2||-122 45`
|
|
249
|
+
*
|
|
250
|
+
* You can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.
|
|
251
|
+
* This is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent
|
|
252
|
+
* (and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins
|
|
253
|
+
* and their labels only 67% opaque, use
|
|
254
|
+
*
|
|
255
|
+
* `pins=default|al.67||-122 45`
|
|
256
|
+
*
|
|
257
|
+
* ### Style Modifier Summary
|
|
258
|
+
*
|
|
259
|
+
* Modifier | Description | Type | Range
|
|
260
|
+
* :--------:|---------------|--------|----------
|
|
261
|
+
* al | Alpha (opacity) | float | 0 to 1
|
|
262
|
+
* an | Pin anchor | <int32, int32> | *
|
|
263
|
+
* co | Pin color | string | 000000 to FFFFFF
|
|
264
|
+
* la | Label anchor | <int32, int32> | *
|
|
265
|
+
* lc | Label color | string | 000000 to FFFFFF
|
|
266
|
+
* ls | Label size | float | Greater than 0
|
|
267
|
+
* ro | Rotation | float | -360 to 360
|
|
268
|
+
* sc | Scale | float | Greater than 0
|
|
269
|
+
*
|
|
270
|
+
* * X and Y coordinates can be anywhere within pin image or a margin around it.
|
|
271
|
+
* The margin size is the minimum of the pin width and height.
|
|
272
|
+
*/
|
|
273
|
+
pins?: string;
|
|
274
|
+
/**
|
|
275
|
+
* Path style and locations (in double). Use this parameter to optionally add lines, polygons or circles to the image.
|
|
276
|
+
* The path style describes the appearance of the line and fill. (Be sure to properly URL-encode values of this
|
|
277
|
+
* parameter since it will contain reserved characters such as pipes and punctuation.)
|
|
278
|
+
*
|
|
279
|
+
* Path parameter is supported in Azure Maps account SKU starting with S1. Multiple instances of the path parameter
|
|
280
|
+
* allow to specify multiple geometries with their styles. Number of parameters per request is limited to 10 and
|
|
281
|
+
* number of locations is limited to 100 per path.
|
|
282
|
+
*
|
|
283
|
+
* To render a circle with radius 100 meters and center point at latitude 45°N and longitude 122°W using the default style, add the
|
|
284
|
+
* querystring parameter
|
|
285
|
+
*
|
|
286
|
+
* `path=ra100||-122 45`
|
|
287
|
+
*
|
|
288
|
+
* Note that the longitude comes before the latitude.
|
|
289
|
+
* After URL encoding this will look like
|
|
290
|
+
*
|
|
291
|
+
* `path=ra100%7C%7C-122+45`
|
|
292
|
+
*
|
|
293
|
+
* All of the examples here show the path parameter without URL encoding, for clarity.
|
|
294
|
+
*
|
|
295
|
+
* To render a line, separate each location with a pipe character. For example, use
|
|
296
|
+
*
|
|
297
|
+
* `path=||-122 45|-119.5 43.2|-121.67 47.12`
|
|
298
|
+
*
|
|
299
|
+
* A polygon is specified with a closed path, where the first and last points are equal. For example, use
|
|
300
|
+
*
|
|
301
|
+
* `path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45`
|
|
302
|
+
*
|
|
303
|
+
* 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.
|
|
304
|
+
*
|
|
305
|
+
* ### Style Modifiers
|
|
306
|
+
*
|
|
307
|
+
* You can modify the appearance of the path by adding style modifiers. These are added before the locations.
|
|
308
|
+
* Style modifiers each have a two-letter name. These abbreviated names are used to help reduce the length
|
|
309
|
+
* of the URL.
|
|
310
|
+
*
|
|
311
|
+
* To change the color of the outline, use the 'lc' style modifier and specify the color using the HTML/CSS RGB color
|
|
312
|
+
* format which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use
|
|
313
|
+
* a deep pink color which you would specify as #FF1493 in CSS, use
|
|
314
|
+
*
|
|
315
|
+
* `path=lcFF1493||-122 45|-119.5 43.2`
|
|
316
|
+
*
|
|
317
|
+
* Multiple style modifiers may be combined to create a more complex visual style.
|
|
318
|
+
*
|
|
319
|
+
* `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`
|
|
320
|
+
*
|
|
321
|
+
* ### Style Modifier Summary
|
|
322
|
+
*
|
|
323
|
+
* Modifier | Description | Type | Range
|
|
324
|
+
* :--------:|---------------|--------|----------
|
|
325
|
+
* lc | Line color | string | 000000 to FFFFFF
|
|
326
|
+
* fc | Fill color | string | 000000 to FFFFFF
|
|
327
|
+
* la | Line alpha (opacity) | float | 0 to 1
|
|
328
|
+
* fa | Fill alpha (opacity) | float | 0 to 1
|
|
329
|
+
* lw | Line width |int32 | (0, 50]
|
|
330
|
+
* ra | Circle radius (meters) | float | Greater than 0
|
|
331
|
+
*/
|
|
332
|
+
path?: string;
|
|
333
|
+
}
|
|
334
|
+
export interface RenderGetMapStaticImageQueryParam {
|
|
335
|
+
queryParameters?: RenderGetMapStaticImageQueryParamProperties;
|
|
336
|
+
}
|
|
337
|
+
export type RenderGetMapStaticImageParameters = RenderGetMapStaticImageQueryParam & RequestParameters;
|
|
338
|
+
export interface RenderGetCopyrightFromBoundingBoxQueryParamProperties {
|
|
339
|
+
/** Minimum coordinates (south-west point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228 */
|
|
340
|
+
mincoordinates: Array<number>;
|
|
341
|
+
/** Maximum coordinates (north-east point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228 */
|
|
342
|
+
maxcoordinates: Array<number>;
|
|
343
|
+
/** Yes/no value to exclude textual data from response. Only images and country/region names will be in response. */
|
|
344
|
+
text?: "yes" | "no";
|
|
345
|
+
}
|
|
346
|
+
export interface RenderGetCopyrightFromBoundingBoxQueryParam {
|
|
347
|
+
queryParameters: RenderGetCopyrightFromBoundingBoxQueryParamProperties;
|
|
348
|
+
}
|
|
349
|
+
export type RenderGetCopyrightFromBoundingBoxParameters = RenderGetCopyrightFromBoundingBoxQueryParam & RequestParameters;
|
|
350
|
+
export interface RenderGetCopyrightForTileQueryParamProperties {
|
|
351
|
+
/**
|
|
352
|
+
* Zoom level for the desired tile.
|
|
353
|
+
*
|
|
354
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
355
|
+
*/
|
|
356
|
+
zoom: number;
|
|
357
|
+
/**
|
|
358
|
+
* X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].
|
|
359
|
+
*
|
|
360
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
361
|
+
*/
|
|
362
|
+
x: number;
|
|
363
|
+
/**
|
|
364
|
+
* Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].
|
|
365
|
+
*
|
|
366
|
+
* Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.
|
|
367
|
+
*/
|
|
368
|
+
y: number;
|
|
369
|
+
/** Yes/no value to exclude textual data from response. Only images and country/region names will be in response. */
|
|
370
|
+
text?: "yes" | "no";
|
|
371
|
+
}
|
|
372
|
+
export interface RenderGetCopyrightForTileQueryParam {
|
|
373
|
+
queryParameters: RenderGetCopyrightForTileQueryParamProperties;
|
|
374
|
+
}
|
|
375
|
+
export type RenderGetCopyrightForTileParameters = RenderGetCopyrightForTileQueryParam & RequestParameters;
|
|
376
|
+
export interface RenderGetCopyrightForWorldQueryParamProperties {
|
|
377
|
+
/** Yes/no value to exclude textual data from response. Only images and country/region names will be in response. */
|
|
378
|
+
text?: "yes" | "no";
|
|
379
|
+
}
|
|
380
|
+
export interface RenderGetCopyrightForWorldQueryParam {
|
|
381
|
+
queryParameters?: RenderGetCopyrightForWorldQueryParamProperties;
|
|
382
|
+
}
|
|
383
|
+
export type RenderGetCopyrightForWorldParameters = RenderGetCopyrightForWorldQueryParam & RequestParameters;
|
|
384
|
+
//# sourceMappingURL=parameters.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../src/generated/parameters.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D,MAAM,WAAW,oCAAoC;IACnD,seAAse;IACte,SAAS,EACL,gBAAgB,GAChB,uBAAuB,GACvB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,yBAAyB,GACzB,4BAA4B,GAC5B,gCAAgC,GAChC,4BAA4B,GAC5B,gCAAgC,GAChC,mBAAmB,GACnB,8BAA8B,GAC9B,iCAAiC,GACjC,4BAA4B,GAC5B,iCAAiC,GACjC,4BAA4B,GAC5B,iCAAiC,GACjC,iCAAiC,GACjC,yBAAyB,GACzB,8BAA8B,GAC9B,gCAAgC,GAChC,4BAA4B,CAAC;IACjC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;;;;OAKG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B,mDAAmD;IACnD,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EACD,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,MAAM,GACN,SAAS,CAAC;CACf;AAED,MAAM,WAAW,0BAA0B;IACzC,eAAe,EAAE,oCAAoC,CAAC;CACvD;AAED,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GACjE,iBAAiB,CAAC;AAEpB,MAAM,WAAW,uCAAuC;IACtD,seAAse;IACte,SAAS,EACL,gBAAgB,GAChB,uBAAuB,GACvB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,yBAAyB,GACzB,4BAA4B,GAC5B,gCAAgC,GAChC,4BAA4B,GAC5B,gCAAgC,GAChC,mBAAmB,GACnB,8BAA8B,GAC9B,iCAAiC,GACjC,4BAA4B,GAC5B,iCAAiC,GACjC,4BAA4B,GAC5B,iCAAiC,GACjC,iCAAiC,GACjC,yBAAyB,GACzB,8BAA8B,GAC9B,gCAAgC,GAChC,4BAA4B,CAAC;CAClC;AAED,MAAM,WAAW,6BAA6B;IAC5C,eAAe,EAAE,uCAAuC,CAAC;CAC1D;AAED,MAAM,MAAM,6BAA6B,GAAG,6BAA6B,GACvE,iBAAiB,CAAC;AAEpB,MAAM,WAAW,2CAA2C;IAC1D,seAAse;IACte,SAAS,EACL,gBAAgB,GAChB,uBAAuB,GACvB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,yBAAyB,GACzB,4BAA4B,GAC5B,gCAAgC,GAChC,4BAA4B,GAC5B,gCAAgC,GAChC,mBAAmB,GACnB,8BAA8B,GAC9B,iCAAiC,GACjC,4BAA4B,GAC5B,iCAAiC,GACjC,4BAA4B,GAC5B,iCAAiC,GACjC,iCAAiC,GACjC,yBAAyB,GACzB,8BAA8B,GAC9B,gCAAgC,GAChC,4BAA4B,CAAC;IACjC,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,0aAA0a;IAC1a,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,iCAAiC;IAChD,eAAe,EAAE,2CAA2C,CAAC;CAC9D;AAED,MAAM,MAAM,iCAAiC,GAC3C,iCAAiC,GAAG,iBAAiB,CAAC;AAExD,MAAM,WAAW,yCAAyC;IACxD;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IACV,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C,eAAe,EAAE,yCAAyC,CAAC;CAC5D;AAED,MAAM,MAAM,+BAA+B,GAAG,+BAA+B,GAC3E,iBAAiB,CAAC;AACpB,MAAM,MAAM,mCAAmC,GAAG,iBAAiB,CAAC;AAEpE,MAAM,WAAW,2CAA2C;IAC1D,8UAA8U;IAC9U,SAAS,CAAC,EACN,gBAAgB,GAChB,uBAAuB,GACvB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,yBAAyB,GACzB,4BAA4B,GAC5B,gCAAgC,GAChC,4BAA4B,GAC5B,gCAAgC,GAChC,mBAAmB,GACnB,8BAA8B,GAC9B,iCAAiC,GACjC,4BAA4B,GAC5B,iCAAiC,GACjC,4BAA4B,GAC5B,iCAAiC,GACjC,iCAAiC,GACjC,yBAAyB,GACzB,8BAA8B,GAC9B,gCAAgC,GAChC,4BAA4B,CAAC;IACjC,+cAA+c;IAC/c,YAAY,CAAC,EAAE,iCAAiC,GAAG,MAAM,CAAC;IAC1D,qZAAqZ;IACrZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACvB;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sHAAsH;IACtH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EACD,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,MAAM,GACN,SAAS,CAAC;IACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iCAAiC;IAChD,eAAe,CAAC,EAAE,2CAA2C,CAAC;CAC/D;AAED,MAAM,MAAM,iCAAiC,GAC3C,iCAAiC,GAAG,iBAAiB,CAAC;AAExD,MAAM,WAAW,qDAAqD;IACpE,4HAA4H;IAC5H,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9B,4HAA4H;IAC5H,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9B,oHAAoH;IACpH,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,2CAA2C;IAC1D,eAAe,EAAE,qDAAqD,CAAC;CACxE;AAED,MAAM,MAAM,2CAA2C,GACrD,2CAA2C,GAAG,iBAAiB,CAAC;AAElE,MAAM,WAAW,6CAA6C;IAC5D;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IACV;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IACV,oHAAoH;IACpH,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,mCAAmC;IAClD,eAAe,EAAE,6CAA6C,CAAC;CAChE;AAED,MAAM,MAAM,mCAAmC,GAC7C,mCAAmC,GAAG,iBAAiB,CAAC;AAE1D,MAAM,WAAW,8CAA8C;IAC7D,oHAAoH;IACpH,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,oCAAoC;IACnD,eAAe,CAAC,EAAE,8CAA8C,CAAC;CAClE;AAED,MAAM,MAAM,oCAAoC,GAC9C,oCAAoC,GAAG,iBAAiB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parameters.js","sourceRoot":"","sources":["../../../src/generated/parameters.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { RequestParameters } from \"@azure-rest/core-client\";\n\nexport interface RenderGetMapTileQueryParamProperties {\n /** 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. */\n tilesetId:\n | \"microsoft.base\"\n | \"microsoft.base.labels\"\n | \"microsoft.base.hybrid\"\n | \"microsoft.terra.main\"\n | \"microsoft.base.road\"\n | \"microsoft.base.darkgrey\"\n | \"microsoft.base.labels.road\"\n | \"microsoft.base.labels.darkgrey\"\n | \"microsoft.base.hybrid.road\"\n | \"microsoft.base.hybrid.darkgrey\"\n | \"microsoft.imagery\"\n | \"microsoft.weather.radar.main\"\n | \"microsoft.weather.infrared.main\"\n | \"microsoft.traffic.absolute\"\n | \"microsoft.traffic.absolute.main\"\n | \"microsoft.traffic.relative\"\n | \"microsoft.traffic.relative.main\"\n | \"microsoft.traffic.relative.dark\"\n | \"microsoft.traffic.delay\"\n | \"microsoft.traffic.delay.main\"\n | \"microsoft.traffic.reduced.main\"\n | \"microsoft.traffic.incident\";\n /**\n * Zoom level for the desired tile.\n *\n * Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.\n */\n zoom: number;\n /**\n * X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n *\n * Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.\n */\n x: number;\n /**\n * Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n *\n * Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.\n */\n y: number;\n /**\n * The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n *\n * * microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n * * microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.\n */\n timeStamp?: Date | string;\n /** The size of the returned map tile in pixels. */\n tileSize?: \"256\" | \"512\";\n /**\n * 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.\n *\n * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.\n */\n language?: string;\n /**\n * The View parameter (also called the \"user region\" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. 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. Example: view=IN.\n *\n * Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.\n */\n view?:\n | \"AE\"\n | \"AR\"\n | \"BH\"\n | \"IN\"\n | \"IQ\"\n | \"JO\"\n | \"KW\"\n | \"LB\"\n | \"MA\"\n | \"OM\"\n | \"PK\"\n | \"PS\"\n | \"QA\"\n | \"SA\"\n | \"SY\"\n | \"YE\"\n | \"Auto\"\n | \"Unified\";\n}\n\nexport interface RenderGetMapTileQueryParam {\n queryParameters: RenderGetMapTileQueryParamProperties;\n}\n\nexport type RenderGetMapTileParameters = RenderGetMapTileQueryParam &\n RequestParameters;\n\nexport interface RenderGetMapTilesetQueryParamProperties {\n /** 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. */\n tilesetId:\n | \"microsoft.base\"\n | \"microsoft.base.labels\"\n | \"microsoft.base.hybrid\"\n | \"microsoft.terra.main\"\n | \"microsoft.base.road\"\n | \"microsoft.base.darkgrey\"\n | \"microsoft.base.labels.road\"\n | \"microsoft.base.labels.darkgrey\"\n | \"microsoft.base.hybrid.road\"\n | \"microsoft.base.hybrid.darkgrey\"\n | \"microsoft.imagery\"\n | \"microsoft.weather.radar.main\"\n | \"microsoft.weather.infrared.main\"\n | \"microsoft.traffic.absolute\"\n | \"microsoft.traffic.absolute.main\"\n | \"microsoft.traffic.relative\"\n | \"microsoft.traffic.relative.main\"\n | \"microsoft.traffic.relative.dark\"\n | \"microsoft.traffic.delay\"\n | \"microsoft.traffic.delay.main\"\n | \"microsoft.traffic.reduced.main\"\n | \"microsoft.traffic.incident\";\n}\n\nexport interface RenderGetMapTilesetQueryParam {\n queryParameters: RenderGetMapTilesetQueryParamProperties;\n}\n\nexport type RenderGetMapTilesetParameters = RenderGetMapTilesetQueryParam &\n RequestParameters;\n\nexport interface RenderGetMapAttributionQueryParamProperties {\n /** 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. */\n tilesetId:\n | \"microsoft.base\"\n | \"microsoft.base.labels\"\n | \"microsoft.base.hybrid\"\n | \"microsoft.terra.main\"\n | \"microsoft.base.road\"\n | \"microsoft.base.darkgrey\"\n | \"microsoft.base.labels.road\"\n | \"microsoft.base.labels.darkgrey\"\n | \"microsoft.base.hybrid.road\"\n | \"microsoft.base.hybrid.darkgrey\"\n | \"microsoft.imagery\"\n | \"microsoft.weather.radar.main\"\n | \"microsoft.weather.infrared.main\"\n | \"microsoft.traffic.absolute\"\n | \"microsoft.traffic.absolute.main\"\n | \"microsoft.traffic.relative\"\n | \"microsoft.traffic.relative.main\"\n | \"microsoft.traffic.relative.dark\"\n | \"microsoft.traffic.delay\"\n | \"microsoft.traffic.delay.main\"\n | \"microsoft.traffic.reduced.main\"\n | \"microsoft.traffic.incident\";\n /** Zoom level for the desired map attribution. */\n zoom: number;\n /** The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`. */\n bounds: Array<number>;\n}\n\nexport interface RenderGetMapAttributionQueryParam {\n queryParameters: RenderGetMapAttributionQueryParamProperties;\n}\n\nexport type RenderGetMapAttributionParameters =\n RenderGetMapAttributionQueryParam & RequestParameters;\n\nexport interface RenderGetMapStateTileQueryParamProperties {\n /**\n * Zoom level for the desired tile.\n *\n * Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.\n */\n zoom: number;\n /**\n * X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n *\n * Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.\n */\n x: number;\n /**\n * Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n *\n * Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.\n */\n y: number;\n /** The stateset id. */\n statesetId: string;\n}\n\nexport interface RenderGetMapStateTileQueryParam {\n queryParameters: RenderGetMapStateTileQueryParamProperties;\n}\n\nexport type RenderGetMapStateTileParameters = RenderGetMapStateTileQueryParam &\n RequestParameters;\nexport type RenderGetCopyrightCaptionParameters = RequestParameters;\n\nexport interface RenderGetMapStaticImageQueryParamProperties {\n /** 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). */\n tilesetId?:\n | \"microsoft.base\"\n | \"microsoft.base.labels\"\n | \"microsoft.base.hybrid\"\n | \"microsoft.terra.main\"\n | \"microsoft.base.road\"\n | \"microsoft.base.darkgrey\"\n | \"microsoft.base.labels.road\"\n | \"microsoft.base.labels.darkgrey\"\n | \"microsoft.base.hybrid.road\"\n | \"microsoft.base.hybrid.darkgrey\"\n | \"microsoft.imagery\"\n | \"microsoft.weather.radar.main\"\n | \"microsoft.weather.infrared.main\"\n | \"microsoft.traffic.absolute\"\n | \"microsoft.traffic.absolute.main\"\n | \"microsoft.traffic.relative\"\n | \"microsoft.traffic.relative.main\"\n | \"microsoft.traffic.relative.dark\"\n | \"microsoft.traffic.delay\"\n | \"microsoft.traffic.delay.main\"\n | \"microsoft.traffic.reduced.main\"\n | \"microsoft.traffic.incident\";\n /** 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). */\n trafficLayer?: \"microsoft.traffic.relative.main\" | \"none\";\n /** 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). */\n zoom?: number;\n /**\n * Coordinates of the center point in double. Format: 'lon,lat'. Longitude range: -180 to 180. Latitude range: -90 to 90.\n *\n * Note: Either center or bbox are required parameters. They are\n * mutually exclusive.\n */\n center?: Array<number>;\n /**\n * 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,\n * maxLon, maxLat' (in double).\n *\n * Note: Either bbox or center are required\n * parameters. They are mutually exclusive. bbox shouldn’t be used with\n * height or width.\n *\n * The maximum and minimum allowed ranges for Lat and Lon are defined for each zoom level\n * in the table at the top of this page.\n */\n bbox?: Array<number>;\n /**\n * Height of the resulting image in pixels. Range from 80 to 1500. Default\n * is 512. It shouldn’t be used with bbox.\n */\n height?: number;\n /** Width of the resulting image in pixels. Range from 80 to 2000. Default is 512. It should not be used with bbox. */\n width?: number;\n /**\n * 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.\n *\n * Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.\n */\n language?: string;\n /**\n * The View parameter (also called the \"user region\" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. 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. Example: view=IN.\n *\n * Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.\n */\n view?:\n | \"AE\"\n | \"AR\"\n | \"BH\"\n | \"IN\"\n | \"IQ\"\n | \"JO\"\n | \"KW\"\n | \"LB\"\n | \"MA\"\n | \"OM\"\n | \"PK\"\n | \"PS\"\n | \"QA\"\n | \"SA\"\n | \"SY\"\n | \"YE\"\n | \"Auto\"\n | \"Unified\";\n /**\n * Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\n * The pushpin style describes the appearance of the pushpins, and the instances specify\n * the coordinates of the pushpins (in double) and optional labels for each pin. (Be sure to properly URL-encode values of this\n * parameter since it will contain reserved characters such as pipes and punctuation.)\n *\n * 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\n * 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.\n *\n * To render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\n * querystring parameter\n *\n * `pins=default||-122 45`\n *\n * Note that the longitude comes before the latitude.\n * After URL encoding this will look like\n *\n * `pins=default%7C%7C-122+45`\n *\n * All of the examples here show the pins\n * parameter without URL encoding, for clarity.\n *\n * To render a pin at multiple locations, separate each location with a pipe character. For example, use\n *\n * `pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n *\n * The S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n *\n * ### Style Modifiers\n *\n * You can modify the appearance of the pins by adding style modifiers. These are added after the style but before\n * the locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\n * reduce the length of the URL.\n *\n * To change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\n * format which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\n * a deep pink color which you would specify as #FF1493 in CSS, use\n *\n * `pins=default|coFF1493||-122 45`\n *\n * ### Pushpin Labels\n *\n * 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\n * three pins with the values '1', '2', and '3', use\n *\n * `pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n *\n * There is a built-in pushpin style called 'none' that does not display a pushpin image. You can use this if\n * you want to display labels without any pin image. For example,\n *\n * `pins=none||'A'-122 45|'B'-119.5 43.2`\n *\n * To change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\n * pushpins with black labels, use\n *\n * `pins=default|coFF1493|lc000000||-122 45`\n *\n * To change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\n * height of the label text in pixels. For example, to increase the label size to 12, use\n *\n * `pins=default|ls12||'A'-122 45|'B'-119 43`\n *\n * The labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\n * is at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\n * and provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\n * pushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\n * to position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\n * use\n *\n * `pins=default|la10 -4||'A'-122 45|'B'-119 43`\n *\n * ### Custom Pushpins\n *\n * To use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\n * 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\n * starting the URL. For example,\n *\n * `pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n *\n * After URL encoding, this would look like\n *\n * `pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n *\n * By default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\n * the location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\n * style modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\n * pin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\n * using\n *\n * `pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n *\n * Note: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB\n * channels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\n * only be done with a solid-color custom image.\n *\n * ### Scale, Rotation, and Opacity\n *\n * You can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\n * value greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\n * values smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n *\n * `pins=default|sc1.5||-122 45`\n *\n * You can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\n * of clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n * 90 degrees clockwise and double their size, use\n *\n * `pins=default|ro90|sc2||-122 45`\n *\n * You can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\n * This is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n * (and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\n * and their labels only 67% opaque, use\n *\n * `pins=default|al.67||-122 45`\n *\n * ### Style Modifier Summary\n *\n * Modifier | Description | Type | Range\n * :--------:|---------------|--------|----------\n * al | Alpha (opacity) | float | 0 to 1\n * an | Pin anchor | <int32, int32> | *\n * co | Pin color | string | 000000 to FFFFFF\n * la | Label anchor | <int32, int32> | *\n * lc | Label color | string | 000000 to FFFFFF\n * ls | Label size | float | Greater than 0\n * ro | Rotation | float | -360 to 360\n * sc | Scale | float | Greater than 0\n *\n * * X and Y coordinates can be anywhere within pin image or a margin around it.\n * The margin size is the minimum of the pin width and height.\n */\n pins?: string;\n /**\n * Path style and locations (in double). Use this parameter to optionally add lines, polygons or circles to the image.\n * The path style describes the appearance of the line and fill. (Be sure to properly URL-encode values of this\n * parameter since it will contain reserved characters such as pipes and punctuation.)\n *\n * Path parameter is supported in Azure Maps account SKU starting with S1. Multiple instances of the path parameter\n * allow to specify multiple geometries with their styles. Number of parameters per request is limited to 10 and\n * number of locations is limited to 100 per path.\n *\n * To render a circle with radius 100 meters and center point at latitude 45°N and longitude 122°W using the default style, add the\n * querystring parameter\n *\n * `path=ra100||-122 45`\n *\n * Note that the longitude comes before the latitude.\n * After URL encoding this will look like\n *\n * `path=ra100%7C%7C-122+45`\n *\n * All of the examples here show the path parameter without URL encoding, for clarity.\n *\n * To render a line, separate each location with a pipe character. For example, use\n *\n * `path=||-122 45|-119.5 43.2|-121.67 47.12`\n *\n * A polygon is specified with a closed path, where the first and last points are equal. For example, use\n *\n * `path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45`\n *\n * 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.\n *\n * ### Style Modifiers\n *\n * You can modify the appearance of the path by adding style modifiers. These are added before the locations.\n * Style modifiers each have a two-letter name. These abbreviated names are used to help reduce the length\n * of the URL.\n *\n * To change the color of the outline, use the 'lc' style modifier and specify the color using the HTML/CSS RGB color\n * format which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\n * a deep pink color which you would specify as #FF1493 in CSS, use\n *\n * `path=lcFF1493||-122 45|-119.5 43.2`\n *\n * Multiple style modifiers may be combined to create a more complex visual style.\n *\n * `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`\n *\n * ### Style Modifier Summary\n *\n * Modifier | Description | Type | Range\n * :--------:|---------------|--------|----------\n * lc | Line color | string | 000000 to FFFFFF\n * fc | Fill color | string | 000000 to FFFFFF\n * la | Line alpha (opacity) | float | 0 to 1\n * fa | Fill alpha (opacity) | float | 0 to 1\n * lw | Line width |int32 | (0, 50]\n * ra | Circle radius (meters) | float | Greater than 0\n */\n path?: string;\n}\n\nexport interface RenderGetMapStaticImageQueryParam {\n queryParameters?: RenderGetMapStaticImageQueryParamProperties;\n}\n\nexport type RenderGetMapStaticImageParameters =\n RenderGetMapStaticImageQueryParam & RequestParameters;\n\nexport interface RenderGetCopyrightFromBoundingBoxQueryParamProperties {\n /** Minimum coordinates (south-west point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228 */\n mincoordinates: Array<number>;\n /** Maximum coordinates (north-east point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228 */\n maxcoordinates: Array<number>;\n /** Yes/no value to exclude textual data from response. Only images and country/region names will be in response. */\n text?: \"yes\" | \"no\";\n}\n\nexport interface RenderGetCopyrightFromBoundingBoxQueryParam {\n queryParameters: RenderGetCopyrightFromBoundingBoxQueryParamProperties;\n}\n\nexport type RenderGetCopyrightFromBoundingBoxParameters =\n RenderGetCopyrightFromBoundingBoxQueryParam & RequestParameters;\n\nexport interface RenderGetCopyrightForTileQueryParamProperties {\n /**\n * Zoom level for the desired tile.\n *\n * Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.\n */\n zoom: number;\n /**\n * X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n *\n * Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.\n */\n x: number;\n /**\n * Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n *\n * Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.\n */\n y: number;\n /** Yes/no value to exclude textual data from response. Only images and country/region names will be in response. */\n text?: \"yes\" | \"no\";\n}\n\nexport interface RenderGetCopyrightForTileQueryParam {\n queryParameters: RenderGetCopyrightForTileQueryParamProperties;\n}\n\nexport type RenderGetCopyrightForTileParameters =\n RenderGetCopyrightForTileQueryParam & RequestParameters;\n\nexport interface RenderGetCopyrightForWorldQueryParamProperties {\n /** Yes/no value to exclude textual data from response. Only images and country/region names will be in response. */\n text?: \"yes\" | \"no\";\n}\n\nexport interface RenderGetCopyrightForWorldQueryParam {\n queryParameters?: RenderGetCopyrightForWorldQueryParamProperties;\n}\n\nexport type RenderGetCopyrightForWorldParameters =\n RenderGetCopyrightForWorldQueryParam & RequestParameters;\n"]}
|