Render - Get Map Static Image
Этот API отрисовки создает статические, растровые представления карты определяемой пользователем области. Он подходит для упрощенных веб-приложений, если требуемое взаимодействие с пользователем не требует элементов управления интерактивными картами или если пропускная способность ограничена. Этот API также полезен для внедрения карт в приложения за пределами браузера, в внутренних службах, создании отчетов или классических приложениях.
Этот API включает параметры для базовой визуализации данных:
- Помеченные отжимы в нескольких стилях.
- Типы геометрии кругов, путей и многоугольников.
Дополнительные сведения и подробные примеры см. в визуализации пользовательских данных на карте растрового.
Размеры параметра bbox ограничены в зависимости от уровня масштабирования. Это гарантирует, что полученный образ имеет соответствующий уровень детализации.
|Уровень Zoom | Хребет Мин Лон | Диапазон Max Lon | Min Lat Range| Диапазон Max Lat|
|:----------|:----------------|:----------------|:----------------|:-------------| |0 | 56.25 | 360.0 | 30.1105585173 | 180.0 | |1 | 28.125 | 360.0 | 14.87468995 | 180.0 | |2 | 14.063 | 351.5625 | 7.4130741851 | 137.9576312246 | |3 | 7.03125 | 175.78125 | 3.7034501005 | 73.6354071932 | |4 | 3.515625 | 87.890625 | 1.8513375155 | 35.4776115315 | |5 | 1.7578125 | 43.9453125 | 0.925620264 | 17.4589959239 | |6 | 0.87890625 | 21.97265625 | 0.4628040687 | 8.6907788223 | |7 | 0.439453125 | 10.986328125 | 0.2314012764 | 4.3404320789 | |8 | 0.2197265625 | 5.4931640625 | 0.1157005434 | 2.1695927024 | |9 | 0.1098632812 | 2.7465820312 | 0.0578502599 | 1.0847183194 | |10 | 0.0549316406 | 1.3732910156 | 0.0289251285 | 0.5423494021 | |11 | 0.0274658203 | 0.6866455078 | 0.014462564 | 0.2711734813 | |12 | 0.0137329102 | 0.3433227539 | 0.007231282 | 0.1355865882 | |13 | 0.0068664551 | 0,171661377 | 0.003615641 | 0.067793275 | |14 | 0.0034332275 | 0.0858306885 | 0.0018078205 | 0.0338966351 | |15 | 0.0017166138 | 0.0429153442 | 0.0009039102 | 0.0169483173 | |16 | 0.0008583069 | 0.0214576721 | 0.0004519551 | 0.0084741586 | |17 | 0.0004291534 | 0.0107288361 | 0.0002259776 | 0.0042370793 | |18 | 0.0002145767 | 0.005364418 | 0.0001129888 | 0.0021185396 | |19 | 0.0001072884 | 0.002682209 | 5.64944E-05 | 0.0010592698 | |20 | 5.36442E-05 | 0.0013411045 | 2.82472E-05 | 0.0005296349 |
GET {endpoint}/map/static?api-version=2024-04-01
GET {endpoint}/map/static?api-version=2024-04-01&tilesetId={tilesetId}&trafficLayer={trafficLayer}&zoom={zoom}¢er={center}&bbox={bbox}&height={height}&width={width}&language={language}&view={view}&pins={pins}&path={path}
Параметры URI
| Имя | В | Обязательно | Тип | Описание | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|||||||||||||||||||||||||||||||||||||
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
||||||||||||||||||||||||||||||||||||
|
bbox
|
query |
number[] |
Ограничивающий прямоугольник определяется двумя широтами и двумя долготами, представляющими четыре стороны прямоугольной области на Земле. Формат: minLon, minLat, maxLon, maxLat, maxLat (в double). Примечание. Для параметра bbox или center требуются параметры. Они являются взаимоисключающими. bbox не следует использовать с высотой или шириной. Максимальные и минимальные допустимые диапазоны для Lat и Lon определяются для каждого уровня масштабирования таблицы в верхней части этой страницы. |
|||||||||||||||||||||||||||||||||||||
|
center
|
query |
number[] |
Координаты центральной точки в двойном формате. Формат: "lon,lat". Диапазон долготы: -180 до 180. Диапазон широты: -90 до 90. Примечание. В центре или в папке bbox необходимы параметры. Они являются взаимоисключающими. |
|||||||||||||||||||||||||||||||||||||
|
height
|
query |
integer (int32) minimum: 80maximum: 1500 |
Высота полученного изображения в пикселях. Диапазон от 80 до 1500. Значение по умолчанию — 512. Его не следует использовать с bbox. |
|||||||||||||||||||||||||||||||||||||
|
language
|
query |
string |
Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в поддерживаемых языках. |
|||||||||||||||||||||||||||||||||||||
|
path
|
query |
string[] |
Стиль пути и расположения (в двойном формате). Используйте этот параметр для добавления строк, многоугольников или кругов к изображению. Стиль пути описывает внешний вид строки и заливки. (Не забудьте правильно закодировать значения URL-адреса этого параметра, так как он будет содержать зарезервированные символы, такие как каналы и знаки препинания.) Параметр пути поддерживается в SKU аккаунта Azure Maps, начиная с S1. Несколько экземпляров параметра пути позволяют указать несколько геометрий со своими стилями. Количество параметров для каждого запроса ограничено 10, а количество расположений ограничено 100 на путь. Чтобы отрисовка круга с радиусом 100 метров и центральной точкой в широте 45°N и долготе 122°W с помощью стиля по умолчанию, добавьте параметр querystring
Обратите внимание, что долгота приходит до широты. После кодирования URL-адресов это будет выглядеть следующим образом.
Все приведенные здесь примеры показывают параметр пути без кодирования URL-адресов для ясности. Чтобы отрисовка строки, разделяйте каждое расположение символом канала. Например, используйте
Многоугольник указывается с закрытым путем, где первые и последние точки равны. Например, используйте
Значение долготы для расположений линий и многоугольников может находиться в диапазоне от -360 до 360, чтобы обеспечить отрисовку геометрий, пересекающих анти-меридиан. Модификаторы стиляВы можете изменить внешний вид пути, добавив модификаторы стиля. Они добавляются перед расположениями. Модификаторы стилей имеют двухбуквное имя. Эти сокращенные имена используются для уменьшения длины URL-адреса. Чтобы изменить цвет контура, используйте модификатор стиля "lc" и укажите цвет с помощью формата цвета HTML/CSS RGB, который является шестизначным шестнадцатеричным номером (трехзначная форма не поддерживается). Например, чтобы использовать глубокий розовый цвет, который можно указать как #FF1493 в CSS, используйте
Для создания более сложного визуального стиля можно объединить несколько модификаторов стилей.
Сводка модификатора стилей
|
|||||||||||||||||||||||||||||||||||||
|
pins
|
query |
string[] |
Стиль и экземпляры Pushpin. Используйте этот параметр, чтобы при необходимости добавить к изображению подложки. Стиль pushpin описывает внешний вид pushpins, а экземпляры указывают координаты pushpins (в двойном) и необязательные метки для каждого закрепления. (Не забудьте правильно закодировать значения URL-адреса этого параметра, так как он будет содержать зарезервированные символы, такие как каналы и знаки препинания.) Sku аккаунта Azure Maps S0 поддерживает только один экземпляр параметра pins, а количество точек ограничено 5 на вывод. Другие номера SKU позволяют использовать до 25 экземпляров параметра pins для указания нескольких стилей закреплений, а количество расположений ограничено 50 на закрепление. Чтобы отобразить отрисовку pushpin в широте 45°N и долготе 122°W с помощью встроенного стиля pushpin по умолчанию, добавьте параметр querystring
Обратите внимание, что долгота приходит до широты. После кодирования URL-адресов это будет выглядеть следующим образом.
Все примеры, приведенные здесь, показывают параметр закреплений без кодирования URL-адресов для ясности. Чтобы отобразить закрепление в нескольких расположениях, разделите каждое расположение символом канала. Например, используйте
Аккаунт S0 Azure Maps SKU поддерживает только пять кнопок. Другие номера SKU учетной записи не имеют этого ограничения. Модификаторы стиляВнешний вид контактов можно изменить, добавив модификаторы стиля. Они добавляются после стиля, но до расположений и меток. Модификаторы стилей имеют двухбуквное имя. Эти сокращенные имена используются для уменьшения длины URL-адреса. Чтобы изменить цвет pushpin, используйте модификатор стиля co и укажите цвет с помощью формата цвета HTML/CSS RGB, который является шестизначным шестнадцатеричным числом (трехзначная форма не поддерживается). Например, чтобы использовать глубокий розовый цвет, который можно указать как #FF1493 в CSS, используйте
Метки pushpinЧтобы добавить метку в закрепление, поместите метку в одинарные кавычки непосредственно перед координатами. Избегайте использования специального символа, например
Существует встроенный стиль pushpin с именем none, который не отображает изображение pushpin. Это можно использовать, если вы хотите отображать метки без какого-либо закрепления изображения. Например,
Чтобы изменить цвет меток pushpin, используйте модификатор цвета метки "lc". Например, чтобы использовать розовые отжимки с черными метками, используйте
Чтобы изменить размер меток, используйте модификатор размера метки ls. Размер метки представляет приблизительную высоту текста метки в пикселях. Например, чтобы увеличить размер метки до 12, используйте
Метки находятся в центре привязки "метка". Расположение привязки предопределено для встроенных pushpins и находится в верхнем центре пользовательских pushpins (см. ниже). Чтобы переопределить привязку метки, используя модификатор стиля "la" и укажите координаты пикселей X и Y для привязки. Эти координаты относятся к левому верхнему углу изображения подставки. Положительные значения X перемещают привязку справа и положительные значения Y перемещают привязку вниз. Например, чтобы разместить привязку метки 10 пикселей справа и 4 пикселя над верхним левым углом изображения pushpin, используйте
Пользовательские pushpinsЧтобы использовать пользовательское изображение pushpin, используйте слово custom в качестве имени стиля пин-кода, а затем укажите URL-адрес после сведений о расположении и метки. Максимальный допустимый размер для настраиваемого изображения метки составляет 65 536 пикселей. Используйте два символа канала, чтобы указать, что вы сделали задание расположений и запускаете URL-адрес. Например,
После кодирования URL-адресов это будет выглядеть следующим образом.
По умолчанию пользовательские изображения pushpin вырисовываются по центру в координатах пин-кода. Обычно это не идеально, так как он скрывает расположение, которое вы пытаетесь выделить. Чтобы переопределить расположение привязки изображения закрепления, используйте модификатор стиля an. В этом случае используется тот же формат, что и модификатор стиля привязки меток "la". Например, если на пользовательском изображении закреплений есть конечная точка в левом верхнем углу изображения, можно установить привязку на это место с помощью
Примечание. Если вы используете модификатор цвета co с пользовательским изображением pushpin, указанный цвет заменит rgb-каналы пикселей на изображении, но оставят альфа-канал (непрозрачность) без изменений. Обычно это можно сделать только с помощью пользовательского изображения сплошным цветом. Масштабирование, поворот и прозрачностьВы можете сделать pushpins и их метки более большими или меньшими с помощью модификатора стиля масштабирования sc. Это значение больше нуля. Значение 1 — это стандартный масштаб. Значения, превышающие 1, делают закрепление большими, а значения меньше 1 делают их меньше. Например, чтобы нарисовать отжимки 50% больше, чем обычно, используйте
С помощью модификатора стиля поворота "ro" можно повернуть отжимы и их метки. Это число градусов поворота по часовой стрелке. Используйте отрицательное число для поворота по часовой стрелке. Например, чтобы повернуть 90 градусов на 90 градусов по часовой стрелке и увеличить их размер, используйте
Вы можете сделать pushpins и их метки частично прозрачными, указав модификатор альфа-стиля al. Это число в диапазоне от 0 до 1, указывающее непрозрачность отжимания. Ноль делает их полностью прозрачными (и не видимыми) и 1 делает их полностью непрозрачными (это значение по умолчанию). Например, чтобы сделать pushpins и их метки только 67% непрозрачным, используйте
Сводка модификатора стилей
|
|||||||||||||||||||||||||||||||||||||
|
tileset
|
query |
Стиль карты, возвращаемый. Возможные значения: microsoft.base.road, microsoft.base.darkgrey и microsoft.imagery. Значение по умолчанию — microsoft.base.road. Дополнительные сведения см. в разделе Render TilesetId. |
||||||||||||||||||||||||||||||||||||||
|
traffic
|
query |
Необязательное значение, указывающее, что поток трафика не наложен на результат изображения. Возможные значения : microsoft.traffic.relative.main и нет. Значение по умолчанию отсутствует, указывающее, что поток трафика не возвращается. Если указан трафик, связанный с плиткойId, возвращает изображение карты с соответствующим уровнем трафика. Дополнительные сведения см. в разделе Render TilesetId. |
||||||||||||||||||||||||||||||||||||||
|
view
|
query |
Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая законы, касающиеся картографирования, страны/региона, где доступны карты, изображения и другие данные, а также сторонний контент, к которому вы уполномочены через Azure Maps. Пример: view=IN. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений. |
||||||||||||||||||||||||||||||||||||||
|
width
|
query |
integer (int32) minimum: 80maximum: 2000 |
Ширина полученного изображения в пикселях. Диапазон от 80 до 2000. Значение по умолчанию — 512. Его не следует использовать с bbox. |
|||||||||||||||||||||||||||||||||||||
|
zoom
|
query |
integer (int32) maximum: 20 |
Требуемый уровень масштабирования карты. Поддержка диапазона значений масштабирования от 0 до 20 (включительно) для tilesetId, являющегося microsoft.base.road или microsoft.base.darkgrey. Поддержка диапазона значений масштабирования от 0 до 19 (включительно) для tilesetId, являющегося microsoft.imagery.
Значение по умолчанию — 12. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| x-ms-client-id |
string |
Указывает аккаунт, предназначенный для использования с моделью безопасности Microsoft Entra ID. Этот уникальный идентификатор для Azure Maps аккаунта можно получить с управляющего плана Azure Maps Account API. Для получения дополнительной информации об использовании Microsoft Entra ID безопасности в Azure Maps см. раздел Управление аутентификацией в Azure Maps. |
|
| Accept |
Поле заголовка «Принять» можно использовать для указания предпочтений в отношении типов медиаданных ответа. Допустимые типы медиафайлов включают image/jpeg и image/png. Возвращает изображение в image/png, если не указан заголовок Accept. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
file |
Запрос выполнен успешно. Media Types: "image/png", "image/jpeg", "application/json" |
| Other Status Codes |
Непредвиденное сообщение об ошибке. Media Types: "image/png", "image/jpeg", "application/json" |
Безопасность
AadToken
Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Любой пользователь, группа или принципал сервиса может получить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений Azure Maps REST API.\n\nДля реализации сценариев рекомендуем ознакомиться с концепциями аутентификационные концепции. В заключение, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных контролировать доступ к определённым API и областям видимости.\n\n#### Примечания\n* Это определение безопасности требует использование заголовка x-ms-client-id для указания, к какому Azure Maps ресурсу приложение запрашивает доступ. Её можно получить через API управления Maps.\n* \nAuthorization URL специфичен для экземпляра публичного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. \n* \nУправление доступом на основе ролей Azure настраивается с плоскости управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n* \nИспользование Azure Maps Web SDK позволяет настраивать приложение на основе конфигурации для нескольких сценариев использования.\n* Для получения дополнительной информации о платформа удостоверений Майкрософт см. платформа удостоверений Майкрософт обзор.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, который создаётся при Создайте Azure Maps аккаунт в Azure-портале или с помощью PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ может использоваться как мастер-ключ на счете, на котором они выпущены.\n\n Для публично открытых приложений мы рекомендуем использовать подход confidential client applications для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.
Тип:
apiKey
В:
header
SAS Token
Это токен общего доступа, созданный из операции List SAS на ресурсе
Тип:
apiKey
В:
header
Примеры
Successful Static Image Request
Образец запроса
GET {endpoint}/map/static?api-version=2024-04-01&tilesetId=microsoft.base.road&zoom=10¢er=-122.177621,47.613079
Пример ответа
Content-Type: image/png
"{file}"
Определения
| Имя | Описание |
|---|---|
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Сведения об ошибке. |
|
Error |
Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.). |
|
Localized |
Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая законы, касающиеся картографирования, страны/региона, где доступны карты, изображения и другие данные, а также сторонний контент, к которому вы уполномочены через Azure Maps. Пример: view=IN. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений. |
|
Media |
Желаемый медиа-тип ответа. |
| Tileset |
Набор плиток — это коллекция растровых или векторных данных, разделенных на единую сетку квадратных плиток на предустановленных уровнях масштабирования. Каждый набор плиток имеет плиток использовать при выполнении запросов. Готовые к использованию тайлсеты, предоставленные Azure Maps, перечислены ниже. Например, microsoft.base. |
|
Traffic |
Значение, указывающее отсутствие потока трафика, наложено на результат изображения. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя | Тип | Описание |
|---|---|---|
| info |
Дополнительные сведения. |
|
| type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
LocalizedMapView
Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая законы, касающиеся картографирования, страны/региона, где доступны карты, изображения и другие данные, а также сторонний контент, к которому вы уполномочены через Azure Maps. Пример: view=IN.
Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.
| Значение | Описание |
|---|---|
| AE |
Объединенные Арабские Эмираты (арабское представление) |
| AR |
Аргентина (Аргентинский вид) |
| BH |
Бахрейн (арабский вид) |
| IN |
Индия (индийский вид) |
| IQ |
Ирак (арабское представление) |
| JO |
Иордания (арабское представление) |
| KW |
Кувейт (арабский вид) |
| LB |
Ливан (арабский вид) |
| MA |
Марокко (Марокко) |
| OM |
Оман (арабский вид) |
| PK |
Пакистан (пакистанский вид) |
| PS |
Палестинский орган (арабское представление) |
| QA |
Катар (арабский вид) |
| SA |
Саудовская Аравия (арабское представление) |
| SY |
Сирия (арабский вид) |
| US |
США of America |
| YE |
Йемен (арабское представление) |
| Auto |
Возвращает данные карты на основе IP-адреса запроса. |
| Unified |
Унифицированное представление (другие) |
MediaType
Желаемый медиа-тип ответа.
| Значение | Описание |
|---|---|
| image/png |
Возвращает изображение в формате png. |
| image/jpeg |
Возврат изображения в формате jpeg. |
Tileset
Набор плиток — это коллекция растровых или векторных данных, разделенных на единую сетку квадратных плиток на предустановленных уровнях масштабирования. Каждый набор плиток имеет плиток использовать при выполнении запросов. Готовые к использованию тайлсеты, предоставленные Azure Maps, перечислены ниже. Например, microsoft.base.
| Значение | Описание |
|---|---|
| microsoft.base.road |
microsoft.base.road |
| microsoft.base.darkgrey |
microsoft.base.darkgrey |
| microsoft.imagery |
microsoft.imagery |
TrafficTilesetId
Значение, указывающее отсутствие потока трафика, наложено на результат изображения.
| Значение | Описание |
|---|---|
| microsoft.traffic.relative.main |
Поддерживаемый трафик, связанный с tilesetId. |
| none |
Значение по умолчанию, без наложения потока трафика. |