Render V2 - Get Map Static Image
Область применения: см. ценовые категории.
Служба статических изображений отрисовывает определяемое пользователем прямоугольное изображение, содержащее раздел карты с помощью уровня масштабирования от 0 до 20. Служба статических изображений отрисовывает определяемое пользователем прямоугольное изображение, содержащее раздел карты с помощью уровня масштабирования от 0 до 20. Поддерживаемый диапазон разрешения для изображения карты — от 1x1 до 8192x8192. Если вы решаете, когда следует использовать службу статического изображения поверх службы плиток карты, вам может потребоваться рассмотреть способ взаимодействия с отрисоченной картой. Если содержимое карты будет относительно неизменным, то статическое сопоставление является хорошим выбором. Если вы хотите поддерживать много масштабирования, сдвига и изменения содержимого карты, служба плиток карты будет лучшим выбором.
Служба также предоставляет функции композиции изображений, чтобы получить статическое изображение обратно с дополнительными данными, такими как; кнопки и геометрические наложения со следующими возможностями S0 и S1.
В S0 можно:
- Отрисовка до 5 отжимов, указанных в запросе
- Укажите один пользовательский образ для контактов, на которые ссылается запрос
- Добавление меток в вспышки
В S1 можно:
- Отрисовка pushpins с помощью службы данных Azure Maps
- Указание нескольких стилей pushpin
- Отрисовка кругов, многострочный и многоугольник геометрических типов.
- Отрисовка поддерживаемых типов геометрии GeoJSON, отправленных через службу данных Azure Maps
Подробные примеры см. в практическом руководстве .
Примечание.В API должен быть предоставлен центр или параметр bbox .
Поддерживаемые диапазоны Lat и Lon при использовании параметра bbox приведены ниже.
| Масштаб | Максимальный диапазон Лона | Максимальный диапазон латов |
|---|---|---|
| 0 | 360.0 | 170.0 |
| 1 | 360.0 | 170.0 |
| 2 | 360.0 | 170.0 |
| 3 | 360.0 | 170.0 |
| 4 | 360.0 | 170.0 |
| 5 | 180.0 | 85,0 |
| 6 | 90,0 | 42,5 |
| 7 | 45.0 | 21.25 |
| 8 | 22,5 | 10.625 |
| 9 | 11,25 | 5.3125 |
| 10 | 5.625 | 2.62625 |
| 11 | 2.8125 | 1.328125 |
| 12 | 1.40625 | 0.6640625 |
| 13 | 0.703125 | 0.33203125 |
| 14 | 0.3515625 | 0.166015625 |
| 15 | 0.17578125 | 0.0830078125 |
| 16 | 0.087890625 | 0.0415039063 |
| 17 | 0.0439453125 | 0.0207519531 |
| 18 | 0.0219726563 | 0.0103759766 |
| 19 | 0.0109863281 | 0.0051879883 |
| 20 | 0.0054931641 | 0.0025939941 |
GET https://atlas.microsoft.com/map/static/png?api-version=2.1
GET https://atlas.microsoft.com/map/static/png?api-version=2.1&layer={layer}&style={style}&zoom={zoom}¢er={center}&bbox={bbox}&height={height}&width={width}&language={language}&view={view}&pins={pins}&path={path}
Параметры URI
| Name | In | Required | Type | Description | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
format
|
path | True |
Требуемый формат ответа. Возможное значение: png. |
||||||||||||||||||||||||||||
|
api-version
|
query | True |
|
Номер версии API Azure Maps Текущая версия — 2.1 |
|||||||||||||||||||||||||||
|
bbox
|
query |
|
Ограничивающий прямоугольник. Использованная проекция — EPSG:3857. Формат: minLon, minLat, maxLon, maxLat. Примечание. Обязательные параметры — bbox или center. Они являются взаимоисключающими. Его не следует использовать с высотой или шириной. Максимально допустимые диапазоны для Lat и Lon определяются для каждого уровня масштабирования таблицы в верхней части этой страницы. |
||||||||||||||||||||||||||||
|
center
|
query |
|
Координаты центральной точки. Формат: "lon,lat". Использованная проекция
Примечание. Центр или поле bbox являются обязательными параметрами. Они являются взаимоисключающими. |
||||||||||||||||||||||||||||
|
height
|
query |
|
Высота полученного изображения в пикселях. Диапазон — от 1 до 8192. Значение по умолчанию — 512. Его не следует использовать с папкой bbox. |
||||||||||||||||||||||||||||
|
language
|
query |
|
Язык, в котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в разделе "Поддерживаемые языки ". |
||||||||||||||||||||||||||||
|
layer
|
query |
Запрошенный слой карты. Если для слоя заданы метки или гибридные метки, формат должен иметь формат PNG. |
|||||||||||||||||||||||||||||
|
path
|
query |
|
Стиль пути и расположения. Используйте этот параметр для дополнительного добавления линий, многоугольников или кругов к изображению. Стиль пути описывает внешний вид строки и заливки. (Не забудьте правильно кодировать значения URL-адреса этого параметра, так как он будет содержать зарезервированные символы, такие как каналы и знаки препинания.) Параметр Path поддерживается в номере SKU учетной записи Azure Maps начиная с S1. Несколько экземпляров параметра пути позволяют указать несколько геометрий со своими стилями. Количество параметров на запрос ограничено 10, а количество расположений ограничено 100 на путь. Чтобы отобразить круг с радиусом 100 метров и центральной точкой в широте 45°N и долготе 122°W с помощью стиля по умолчанию, добавьте параметр строки запроса.
Обратите внимание, что долгота приходит до широты. После кодирования URL-адреса будет выглядеть следующим образом:
Все приведенные здесь примеры показывают параметр пути без кодирования URL-адреса для ясности. Чтобы отобразить линию, разделите каждое расположение символом канала. Например, используйте
Для отрисовки многоугольника последнее расположение должно быть равно начальной точке. Например, используйте
Значения долготы и широты для расположений линий и многоугольников могут находиться в диапазоне от -360 до 360, чтобы обеспечить отрисовку геометрии, пересекающих антидидидиан. Модификаторы стиляВнешний вид пути можно изменить, добавив модификаторы стиля. Они добавляются перед расположениями. Модификаторы стиля имеют двухбуквенный имя. Эти сокращенные имена используются для уменьшения длины URL-адреса. Чтобы изменить цвет контура, используйте модификатор стиля "lc" и укажите цвет с помощью формата цвета HTML/CSS RGB, который является шестизначным шестнадцатеричным числом (трехзначная форма не поддерживается). Например, чтобы использовать глубокий розовый цвет, который можно указать как #FF1493 в CSS, используйте
Для создания более сложного визуального стиля можно объединить несколько модификаторов стиля.
Получение расположений пути из служба хранилища данных Azure MapsДля всех номеров SKU учетной записи Azure Maps, отличных от S0, сведения о расположении пути можно получить из служба хранилища данных Azure Maps. После отправки документа GeoJSON, содержащего расположения пути, служба data служба хранилища возвращает уникальный идентификатор данных (UDID), который можно использовать для ссылки на данные в параметре пути. Чтобы использовать геометрию точек из отправленного документа GeoJSON в качестве расположений пути, укажите UDID в разделе расположений параметра пути. Например,
Обратите внимание, что не разрешено смешивать расположения путей из data служба хранилища с расположениями, указанными в параметре пути. Сводка модификатора стиля
|
||||||||||||||||||||||||||||
|
pins
|
query |
|
Стиль и экземпляры pushpin. Используйте этот параметр, чтобы при необходимости добавить в образ отжимые кнопки. Стиль pushpin описывает внешний вид отжимов, а экземпляры указывают координаты отжимов и необязательные метки для каждого закрепления. (Не забудьте правильно кодировать значения URL-адреса этого параметра, так как он будет содержать зарезервированные символы, такие как каналы и знаки препинания.) Номер SKU S0 учетной записи Azure Maps поддерживает только один экземпляр параметра pins. Другие номера SKU позволяют нескольким экземплярам параметра контактов указывать несколько стилей контактов. Чтобы отрисовка pushpin на широте 45°N и долготе 122°W с помощью встроенного стиля pushpin по умолчанию, добавьте параметр querystring
Обратите внимание, что долгота приходит до широты. После кодирования URL-адреса будет выглядеть следующим образом:
Все приведенные здесь примеры показывают параметр закрепления без кодирования URL-адресов для ясности. Чтобы отобразить закрепление в нескольких расположениях, разделите каждое расположение символом канала. Например, используйте
S0 Azure Maps номер SKU учетной записи разрешает только пять отжимов. Другие номера SKU учетных записей не имеют этого ограничения. Модификаторы стиляВнешний вид вешек можно изменить, добавив модификаторы стиля. Они добавляются после стиля, но перед расположениями и метками. Модификаторы стиля имеют двухбуквенный имя. Эти сокращенные имена используются для уменьшения длины URL-адреса. Чтобы изменить цвет отступа, используйте модификатор стиля co и укажите цвет с помощью формата цвета HTML/CSS RGB, который является шестнадцатеричным числом шестизначного числа (трехзначная форма не поддерживается). Например, чтобы использовать глубокий розовый цвет, который можно указать как #FF1493 в CSS, используйте
Метки pushpinЧтобы добавить метку к контактам, поместите метку в одинарные кавычки непосредственно перед координатами. Например, чтобы пометить три закрепления значениями "1", "2" и "3", используйте
Существует встроенный стиль pushpin называется "none", который не отображает изображение pushpin. Это можно использовать, если вы хотите отображать метки без закрепления изображения. Например,
Чтобы изменить цвет подписей pushpin, используйте модификатор цветового стиля метки "lc". Например, чтобы использовать розовые отжимы с черными метками, используйте
Чтобы изменить размер меток, используйте модификатор размера метки ls. Размер метки представляет приблизительную высоту текста метки в пикселях. Например, чтобы увеличить размер метки до 12, используйте
Метки расположены по центру в конце кнопки "привязка метки". Расположение привязки предопределено для встроенных вспышки и находится в верхней части настраиваемых отжимов (см. ниже). Чтобы переопределить привязку метки, используйте модификатор стиля la и предоставьте координаты пикселей X и Y для привязки. Эти координаты относятся к левому верхнему углу изображения pushpin. Положительные значения X перемещают привязку справа, а положительные значения Y перемещают привязку вниз. Например, чтобы разместить привязку метки 10 пикселей вправо и 4 пикселя над верхним левым углом изображения pushpin, используйте
Пользовательские pushpinsЧтобы использовать пользовательское изображение pushpin, используйте слово custom в качестве имени стиля закрепления, а затем укажите URL-адрес после сведений о расположении и метки. Используйте два символа канала, чтобы указать, что вы закончите указывать расположения и начинаете URL-адрес. Например,
После кодирования URL-адресов это будет выглядеть так:
По умолчанию пользовательские изображения pushpin вырисовываются по центру по координатам закрепления. Обычно это не идеально, так как оно скрывает расположение, которое вы пытаетесь выделить. Чтобы переопределить расположение привязки изображения закрепления, используйте модификатор стиля an. Для этого используется тот же формат, что и модификатор стиля привязки метки "la". Например, если в пользовательском изображении закреплений есть кончик булавки в левом верхнем углу изображения, можно установить привязку к этой точке с помощью команды
Примечание. Если вы используете модификатор цвета co с пользовательским изображением pushpin, указанный цвет заменит RGB-каналы пикселей на изображении, но оставят канал альфа (непрозрачность) без изменений. Обычно это можно сделать только с помощью пользовательского изображения с сплошным цветом. Получение pushpins из Azure Maps данных служба хранилищаДля всех номеров SKU учетной записи Azure Maps, отличных от S0, сведения о расположении в pushpin можно получить из Azure Maps данных служба хранилища. После отправки документа GeoJSON, содержащего расположения контактов, служба data служба хранилища возвращает уникальный идентификатор данных (UDID), который можно использовать для ссылки на данные в параметре pins. Чтобы использовать геометрию точек из отправленного документа GeoJSON в качестве расположений контактов, укажите UDID в разделе расположений параметра pins. Например,
Обратите внимание, что будут использоваться только геометрия точек и многоточечных точек, точек и многоточий из коллекций геометрических объектов, а также геометрия точек из признаков. Линия и геометрия многоугольников будут игнорироваться. Если точка исходит от компонента, а у функции есть строковое свойство с именем "label", значение этого свойства будет использоваться в качестве метки для закрепления. Вы можете смешивать расположения контактов из служба хранилища данных и расположений контактов, указанных в параметре контактов. Любое из расположений контактов с разделителями канала может быть долготой и широтой или UDID. Например,
Масштабирование, поворот и прозрачностьВы можете увеличивать или уменьшать вешки и их метки с помощью модификатора стиля для масштабирования "sc". Это значение больше нуля. Значение 1 — это стандартный масштаб. Значения, превышающие 1, будут увеличивать кнопки, а меньше 1 будут их уменьшать. Например, чтобы нарисовать отжимы на 50 % больше, чем обычно, используйте
Вы можете повернуть отжимы и их метки с помощью модификатора стиля поворота ro. Это число градусов поворота по часовой стрелке. Используйте отрицательное число для поворота по часовой стрелке. Например, чтобы повернуть отжимы на 90 градусов по часовой стрелке и удвоить их размер, используйте
Вы можете сделать зажимы и их метки частично прозрачными, указав модификатор альфа-стиля al. Это число от 0 до 1, указывающее на непрозрачность отжимания. Ноль делает их полностью прозрачными (и не видимыми) и 1 делает их полностью непрозрачными (это значение по умолчанию). Например, чтобы сделать отжимы и их метки непрозрачными только на 67 %, используйте
Сводка модификатора стиля
|
||||||||||||||||||||||||||||
|
style
|
query |
Возвращаемый стиль карты. Возможные значения являются основными и темными. |
|||||||||||||||||||||||||||||
|
view
|
query |
Параметр View (также называемый параметром user region) позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны имеют различные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной, которую будет обслуживать ваше приложение. По умолчанию параметр View имеет значение Unified, даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны, где доступны карты, изображения и другое содержимое и сторонние материалы, к которым вы авторизованы для доступа через Azure Maps. Пример: view=IN. Дополнительные сведения и сведения о доступных представлениях см. в разделе "Поддерживаемые представления ". |
|||||||||||||||||||||||||||||
|
width
|
query |
|
Ширина полученного изображения в пикселях. Диапазон — от 1 до 8192. Значение по умолчанию — 512. Его не следует использовать с папкой bbox. |
||||||||||||||||||||||||||||
|
zoom
|
query |
|
Требуемый масштаб карты. Значение масштаба должно находиться в диапазоне от 0 до 20 (включительно). Значение по умолчанию — 12. |
Заголовок запроса
| Name | Required | Type | Description |
|---|---|---|---|
| x-ms-client-id |
|
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Azure AD. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Azure AD безопасности в Azure Maps см. в следующих статьях. |
Ответы
| Name | Type | Description |
|---|---|---|
| 200 OK |
|
Это изображение возвращается из успешного вызова статического изображения карты Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers
|
| Other Status Codes |
Произошла непредвиденная ошибка. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
Безопасность
AADToken
Это Azure Active Directory потоки OAuth2. При связывании с управлением доступом на основе ролей Azure можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким Azure Maps учетной записи ресурсов или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps REST API.
Для реализации сценариев рекомендуется просматривать основные понятия проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.
Примечания
- Это определение безопасности требует использования заголовка
x-ms-client-id, чтобы указать, к какой Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Карты.
Это Authorization URL зависит от экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory.
* Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
* Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
- В настоящее время Azure Active Directory версии 1.0 или версии 2.0 поддерживает рабочие, учебные заведения и гости, но не поддерживает личные учетные записи.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, подготовленный при создании ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого ключа любой приложению разрешен доступ ко всем REST API. Другими словами, в настоящее время эти ключи можно рассматривать как главные ключи для учетной записи, для которой они выданы.
Для общедоступных приложений мы рекомендуем использовать доступ между серверами Azure Maps REST API, где этот ключ можно безопасно хранить.
Type:
apiKey
In:
query
SAS Token
Это маркер подписанного URL-адреса создается из операции LIST SAS для ресурса Azure Maps через плоскость управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого маркера любое приложение имеет право на доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Иными словами, маркер SAS можно использовать, чтобы приложения могли управлять доступом более безопасным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты , чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Type:
apiKey
In:
header
Примеры
Successful Static Image Request
Sample Request
GET https://atlas.microsoft.com/map/static/png?api-version=2.1&layer=basic&style=main&zoom=2&bbox=1.355233,42.982261,24.980233,56.526017
Sample Response
Content-Type: image/png
"{file}"
Определения
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Сведения об ошибке. |
|
Error |
Сообщение об ошибке |
|
Localized |
Параметр View (также называемый параметром user region) позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны имеют различные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной, которую будет обслуживать ваше приложение. По умолчанию параметр View имеет значение Unified, даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны, где доступны карты, изображения и другое содержимое и сторонние материалы, к которым вы авторизованы для доступа через Azure Maps. Пример: view=IN. Дополнительные сведения и сведения о доступных представлениях см. в разделе "Поддерживаемые представления ". |
|
Map |
Возвращаемый стиль карты. Возможные значения являются основными и темными. |
|
Raster |
Требуемый формат ответа. Возможное значение: png. |
|
Static |
Запрошенный слой карты. Если для слоя заданы метки или гибридные метки, формат должен иметь формат PNG. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Name | Type | Description |
|---|---|---|
| info |
|
Дополнительные сведения. |
| type |
|
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
|
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
|
Сообщение об ошибке. |
| target |
|
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
| Name | Type | Description |
|---|---|---|
| error |
Объект ошибки. |
LocalizedMapView
Параметр View (также называемый параметром user region) позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны имеют различные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной, которую будет обслуживать ваше приложение. По умолчанию параметр View имеет значение Unified, даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны, где доступны карты, изображения и другое содержимое и сторонние материалы, к которым вы авторизованы для доступа через Azure Maps. Пример: view=IN.
Дополнительные сведения и сведения о доступных представлениях см. в разделе "Поддерживаемые представления ".
| Name | Type | Description |
|---|---|---|
| AE |
|
Объединенные Арабские Эмираты (арабское представление) |
| AR |
|
Аргентина (аргентинское представление) |
| Auto |
|
Данные карт возвращаются с учетом IP-адреса запроса. |
| BH |
|
Бахрейн (арабское представление) |
| IN |
|
Индия (индийское представление) |
| IQ |
|
Ирак (арабское представление) |
| JO |
|
Иордан (арабское представление) |
| KW |
|
Кувейт (арабское представление) |
| LB |
|
Ливан (арабское представление) |
| MA |
|
Марокко (марокканское представление) |
| OM |
|
Оман (арабское представление) |
| PK |
|
Пакистан (пакистанское представление) |
| PS |
|
Палестинская Автономия (арабское представление) |
| QA |
|
Катар (арабское представление) |
| SA |
|
Саудовская Аравия (арабское представление) |
| SY |
|
Сирия (арабское представление) |
| Unified |
|
Унифицированное представление (прочие) |
| YE |
|
Йемен (арабское представление) |
MapImageStyle
Возвращаемый стиль карты. Возможные значения являются основными и темными.
| Name | Type | Description |
|---|---|---|
| dark |
|
Темно-серая версия основного стиля Azure Maps |
| main |
|
Azure Maps основной стиль |
RasterTileFormat
Требуемый формат ответа. Возможное значение: png.
| Name | Type | Description |
|---|---|---|
| png |
|
Изображение в формате PNG. Поддерживает уровни масштабирования от 0 до 18. |
StaticMapLayer
Запрошенный слой карты. Если для слоя заданы метки или гибридные метки, формат должен иметь формат PNG.
| Name | Type | Description |
|---|---|---|
| basic |
|
Возвращает изображение, содержащее все функции карты, включая многоугольник, границы, дороги и метки. |
| hybrid |
|
Возвращает изображение, содержащее границы, дороги и метки, и может быть наложено на другие плитки (например, спутниковые снимки) для создания гибридных плиток. |
| labels |
|
Возвращает изображение только сведений о метки карты. |