RenderGetMapStaticImageQueryParamProperties interface

Ограничивающий прямоугольник определяется двумя широтами и двумя долготами, представляющими четыре стороны прямоугольной области на Земле. Формат: minLon, minLat, maxLon, maxLat, maxLat (в double).

Примечание. Для параметра bbox или center требуются параметры. Они являются взаимоисключающими. bbox не следует использовать с высотой или шириной.

Максимальные и минимальные допустимые диапазоны для Lat и Lon определяются для каждого уровня масштабирования таблицы в верхней части этой страницы.

bbox?: number[]

Значение свойства

Координаты центральной точки в двойном формате. Формат: "lon,lat". Диапазон долготы: -180 до 180. Диапазон широты: -90 до 90.

Примечание. В центре или в папке bbox необходимы параметры. Они являются взаимоисключающими.

center?: number[]

Значение свойства

Высота полученного изображения в пикселях. Диапазон от 80 до 1500. Значение по умолчанию — 512. Его не следует использовать с bbox.

height?: number

Значение свойства

Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию.

Дополнительные сведения см. в поддерживаемых языках.

language?: string

Значение свойства

Стиль пути и расположения (в двойном формате). Используйте этот параметр для добавления строк, многоугольников или кругов к изображению. Стиль пути описывает внешний вид строки и заливки. (Не забудьте правильно закодировать значения URL-адреса этого параметра, так как он будет содержать зарезервированные символы, такие как каналы и знаки препинания.)

Параметр path поддерживается в номере SKU учетной записи Azure Maps, начиная с S1. Несколько экземпляров параметра пути позволяют указать несколько геометрий со своими стилями. Количество параметров для каждого запроса ограничено 10, а количество расположений ограничено 100 на путь.

Чтобы отрисовка круга с радиусом 100 метров и центральной точкой в широте 45°N и долготе 122°W с помощью стиля по умолчанию, добавьте параметр querystring

path=ra100||-122 45

Обратите внимание, что долгота приходит до широты. После кодирования URL-адресов это будет выглядеть следующим образом.

path=ra100%7C%7C-122+45

Все приведенные здесь примеры показывают параметр пути без кодирования URL-адресов для ясности.

Чтобы отрисовка строки, разделяйте каждое расположение символом канала. Например, используйте

path=||-122 45|-119.5 43.2|-121.67 47.12

Многоугольник указывается с закрытым путем, где первые и последние точки равны. Например, используйте

path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45

Значение долготы для расположений линий и многоугольников может находиться в диапазоне от -360 до 360, чтобы обеспечить отрисовку геометрий, пересекающих анти-меридиан.

Модификаторы стиля

Вы можете изменить внешний вид пути, добавив модификаторы стиля. Они добавляются перед расположениями. Модификаторы стилей имеют двухбуквное имя. Эти сокращенные имена используются для уменьшения длины URL-адреса.

Чтобы изменить цвет контура, используйте модификатор стиля "lc" и укажите цвет с помощью формата цвета HTML/CSS RGB, который является шестизначным шестнадцатеричным номером (трехзначная форма не поддерживается). Например, чтобы использовать глубокий розовый цвет, который можно указать как #FF1493 в CSS, используйте

path=lcFF1493||-122 45|-119.5 43.2

Для создания более сложного визуального стиля можно объединить несколько модификаторов стилей.

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

Сводка модификатора стилей

path?: string

Значение свойства

Стиль и экземпляры Pushpin. Используйте этот параметр, чтобы при необходимости добавить к изображению подложки. Стиль pushpin описывает внешний вид pushpins, а экземпляры указывают координаты pushpins (в двойном) и необязательные метки для каждого закрепления. (Не забудьте правильно закодировать значения URL-адреса этого параметра, так как он будет содержать зарезервированные символы, такие как каналы и знаки препинания.)

Номер SKU учетной записи Azure Maps поддерживает только один экземпляр параметра закреплений, а количество расположений ограничено 5 на пин-код. Другие номера SKU позволяют использовать до 25 экземпляров параметра pins для указания нескольких стилей закреплений, а количество расположений ограничено 50 на закрепление.

Чтобы отобразить отрисовку pushpin в широте 45°N и долготе 122°W с помощью встроенного стиля pushpin по умолчанию, добавьте параметр querystring

pins=default||-122 45

Обратите внимание, что долгота приходит до широты. После кодирования URL-адресов это будет выглядеть следующим образом.

pins=default%7C%7C-122+45

Все примеры, приведенные здесь, показывают параметр закреплений без кодирования URL-адресов для ясности.

Чтобы отобразить закрепление в нескольких расположениях, разделите каждое расположение символом канала. Например, используйте

pins=default||-122 45|-119.5 43.2|-121.67 47.12

Номер S0 учетной записи Azure Maps поддерживает только пять отвязок. Другие номера SKU учетной записи не имеют этого ограничения.

Модификаторы стиля

Внешний вид контактов можно изменить, добавив модификаторы стиля. Они добавляются после стиля, но до расположений и меток. Модификаторы стилей имеют двухбуквное имя. Эти сокращенные имена используются для уменьшения длины URL-адреса.

Чтобы изменить цвет pushpin, используйте модификатор стиля co и укажите цвет с помощью формата цвета HTML/CSS RGB, который является шестизначным шестнадцатеричным числом (трехзначная форма не поддерживается). Например, чтобы использовать глубокий розовый цвет, который можно указать как #FF1493 в CSS, используйте

pins=default|coFF1493||-122 45

Метки pushpin

Чтобы добавить метку в закрепление, поместите метку в одинарные кавычки непосредственно перед координатами. Избегайте использования специального символа, например | или || в метке. Например, чтобы пометить три закрепления со значениями "1", "2" и "3", используйте

pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12

Существует встроенный стиль pushpin с именем none, который не отображает изображение pushpin. Это можно использовать, если вы хотите отображать метки без какого-либо закрепления изображения. Например

pins=none||'A'-122 45|'B'-119.5 43.2

Чтобы изменить цвет меток pushpin, используйте модификатор цвета метки "lc". Например, чтобы использовать розовые отжимки с черными метками, используйте

pins=default|coFF1493|lc000000||-122 45

Чтобы изменить размер меток, используйте модификатор размера метки ls. Размер метки представляет приблизительную высоту текста метки в пикселях. Например, чтобы увеличить размер метки до 12, используйте

pins=default|ls12||'A'-122 45|'B'-119 43

Метки находятся в центре привязки "метка". Расположение привязки предопределено для встроенных pushpins и находится в верхнем центре пользовательских pushpins (см. ниже). Чтобы переопределить привязку метки, используя модификатор стиля "la" и укажите координаты пикселей X и Y для привязки. Эти координаты относятся к левому верхнему углу изображения подставки. Положительные значения X перемещают привязку справа и положительные значения Y перемещают привязку вниз. Например, чтобы разместить привязку метки 10 пикселей справа и 4 пикселя над верхним левым углом изображения pushpin, используйте

pins=default|la10 -4||'A'-122 45|'B'-119 43

Пользовательские pushpins

Чтобы использовать пользовательское изображение pushpin, используйте слово custom в качестве имени стиля пин-кода, а затем укажите URL-адрес после сведений о расположении и метки. Максимальный допустимый размер для настраиваемого изображения метки составляет 65 536 пикселей. Используйте два символа канала, чтобы указать, что вы сделали задание расположений и запускаете URL-адрес. Например

pins=custom||-122 45||http://contoso.com/pushpins/red.png

После кодирования URL-адресов это будет выглядеть следующим образом.

pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png

По умолчанию пользовательские изображения pushpin вырисовываются по центру в координатах пин-кода. Обычно это не идеально, так как он скрывает расположение, которое вы пытаетесь выделить. Чтобы переопределить расположение привязки изображения закрепления, используйте модификатор стиля an. В этом случае используется тот же формат, что и модификатор стиля привязки меток "la". Например, если на пользовательском изображении закреплений есть конечная точка в левом верхнем углу изображения, можно установить привязку на это место с помощью

pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png

Примечание. Если вы используете модификатор цвета co с пользовательским изображением pushpin, указанный цвет заменит rgb-каналы пикселей на изображении, но оставят альфа-канал (непрозрачность) без изменений. Обычно это можно сделать только с помощью пользовательского изображения сплошным цветом.

Масштабирование, поворот и прозрачность

Вы можете сделать pushpins и их метки более большими или меньшими с помощью модификатора стиля масштабирования sc. Это значение больше нуля. Значение 1 — это стандартный масштаб. Значения, превышающие 1, делают закрепление большими, а значения меньше 1 делают их меньше. Например, чтобы нарисовать отжимки 50% больше, чем обычно, используйте

pins=default|sc1.5||-122 45

С помощью модификатора стиля поворота "ro" можно повернуть отжимы и их метки. Это число градусов поворота по часовой стрелке. Используйте отрицательное число для поворота по часовой стрелке. Например, чтобы повернуть 90 градусов на 90 градусов по часовой стрелке и увеличить их размер, используйте

pins=default|ro90|sc2||-122 45

Вы можете сделать pushpins и их метки частично прозрачными, указав модификатор альфа-стиля al. Это число в диапазоне от 0 до 1, указывающее непрозрачность отжимания. Ноль делает их полностью прозрачными (и не видимыми) и 1 делает их полностью непрозрачными (это значение по умолчанию). Например, чтобы сделать pushpins и их метки только 67% непрозрачным, используйте

pins=default|al.67||-122 45

Сводка модификатора стилей

• Координаты X и Y могут находиться в любом месте изображения закрепления или поля вокруг него. Размер поля — это минимальное значение ширины и высоты закрепления.

pins?: string

Значение свойства

Стиль карты, возвращаемый. Возможные значения: microsoft.base.road, microsoft.base.darkgrey и microsoft.imagery. Значение по умолчанию — microsoft.base.road. Дополнительные сведения см. в разделе Render TilesetId.

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"

Значение свойства

Необязательное значение, указывающее, что поток трафика не наложен на результат изображения. Возможные значения : microsoft.traffic.relative.main и нет. Значение по умолчанию отсутствует, указывающее, что поток трафика не возвращается. Если указан трафик, связанный с плиткойId, возвращает изображение карты с соответствующим уровнем трафика. Дополнительные сведения см. в разделе Render TilesetId.

trafficLayer?: "microsoft.traffic.relative.main" | "none"

Значение свойства

Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, в том числе в отношении сопоставления страны или региона, где доступны карты, изображения и другое содержимое, которое вы авторизованы для доступа через Azure Maps. Пример: view=IN.

Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

view?: "AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified"

Значение свойства

Ширина полученного изображения в пикселях. Диапазон от 80 до 2000. Значение по умолчанию — 512. Его не следует использовать с bbox.

width?: number

Значение свойства

Требуемый уровень масштабирования карты. Поддержка диапазона значений масштабирования от 0 до 20 (включительно) для tilesetId, являющегося microsoft.base.road или microsoft.base.darkgrey. Поддержка диапазона значений масштабирования от 0 до 19 (включительно) для tilesetId, являющегося microsoft.imagery. Значение по умолчанию — 12.

Дополнительные сведения см. в уровнях масштабирования исетки плиток.

zoom?: number

Значение свойства