Render - Get Map Static Image
Slouží k vykreslení uživatelem definovaného obdélníkového obrázku obsahujícího oddíl mapy pomocí úrovně přiblížení v rozsahu od 0 do 20.
Podporovaný rozsah rozlišení obrázku mapy je 1x1 až 8192x8192. Pokud se rozhodujete, kdy použít službu statických obrázků přes službu mapových dlaždic, měli byste zvážit, jak chcete s vykreslenou mapou pracovat. Pokud bude obsah mapy relativně neměnný, je statická mapa dobrou volbou. Pokud chcete podporovat hodně přiblížení, posouvání a změny obsahu mapy, bude lepší volbou služba mapových dlaždic.
Služba také poskytuje funkci Image Composition pro získání statického obrázku zpět s dalšími daty, jako jsou: připínáky a překryvy geometrie s následujícími funkcemi.
- Určení více stylů připínáčků
- Vykreslovat typy geometrie kruhu, lomené čáry a mnohoúhelníku.
Podrobné příklady najdete v návodu .
Poznámka : Rozhraní API musí být zadán parametr center nebo bbox .
Podporované rozsahy Lat a Lon při použití parametru bbox jsou následující:
Úroveň přiblížení | Max Lon Range | Maximální rozsah lat |
---|---|---|
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=2022-08-01
GET https://atlas.microsoft.com/map/static/png?api-version=2022-08-01&layer={layer}&style={style}&zoom={zoom}¢er={center}&bbox={bbox}&height={height}&width={width}&language={language}&view={view}&pins={pins}&path={path}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
format
|
path | True |
Požadovaný formát odpovědi Možná hodnota: png. |
||||||||||||||||||||||||||||
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. Aktuální verze je 2022-08-01 |
|||||||||||||||||||||||||||
bbox
|
query |
number[] |
Ohraničující rámeček. Použitá projekce - EPSG:3857. Formát: minLon, minLat, maxLon, maxLat. Poznámka: Požadované parametry jsou bbox nebo center. Vzájemně se vylučují. Neměl by se používat s výškou ani šířkou. Maximální povolené rozsahy pro Lat a Lon jsou definovány pro každou úroveň přiblížení v tabulce v horní části této stránky. |
||||||||||||||||||||||||||||
center
|
query |
number[] |
Souřadnice středového bodu. Formát: 'lon,lat'. Použitá projekce
Poznámka: Požadované parametry jsou střed nebo bbox. Vzájemně se vylučují. |
||||||||||||||||||||||||||||
height
|
query |
integer int32 |
Výška výsledného obrázku v pixelech Rozsah je 1 až 8192. Výchozí hodnota je 512. Neměl by se používat s bboxem. |
||||||||||||||||||||||||||||
language
|
query |
string |
Jazyk, ve kterém se mají vrátit výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk. Podrobnosti najdete v části Podporované jazyky . |
||||||||||||||||||||||||||||
layer
|
query |
Byla požadována vrstva mapy. Pokud je vrstva nastavená na popisky nebo hybridní, měl by být formát png. |
|||||||||||||||||||||||||||||
path
|
query |
string[] |
Styl cesty a umístění. Pomocí tohoto parametru můžete do obrázku volitelně přidat čáry, mnohoúhelníky nebo kruhy. Styl cesty popisuje vzhled čáry a výplně. (Nezapomeňte správně zakódovat hodnoty adresy URL tohoto parametru, protože bude obsahovat vyhrazené znaky, jako jsou například kanály a interpunkční znaména.) Parametr path se podporuje ve skladové položce účtu Azure Maps počínaje S1. Více instancí parametru path umožňuje zadat více geometrií s jejich styly. Počet parametrů na požadavek je omezený na 10 a počet umístění je omezený na 100 na cestu. Pokud chcete vykreslit kruh s poloměrem 100 metrů a středovým bodem na zeměpisné šířce 45°S a délkou 122°W pomocí výchozího stylu, přidejte parametr řetězce dotazu.
Všimněte si, že zeměpisná délka předchází zeměpisné šířce. Po kódování adresy URL to bude vypadat takto:
Všechny zde uvedené příklady pro přehlednost zobrazují parametr path bez kódování adresy URL. Pokud chcete vykreslit čáru, oddělte každé umístění znakem svislé čáry. Například použijte
Chcete-li vykreslit mnohoúhelník, musí být poslední umístění rovno počátečnímu umístění. Například použijte
Hodnoty zeměpisné délky a šířky pro umístění čar a mnohoúhelníků můžou být v rozsahu -360 až 360, aby bylo možné vykreslovat geometrie překračující anti-poledník. Modifikátory styluVzhled cesty můžete upravit přidáním modifikátorů stylu. Ty se přidají před umístění. Modifikátory stylu mají název se dvěma písmeny. Tyto zkrácené názvy pomáhají zkrátit délku adresy URL. Pokud chcete změnit barvu obrysu, použijte modifikátor stylu lc a zadejte barvu pomocí barevného formátu HTML/CSS RGB, což je šestimístné šestnáctkové číslo (třímístný formulář není podporován). Pokud chcete například použít tmavě růžovou barvu, kterou byste zadali jako #FF1493 v šablonách stylů CSS, použijte
Kombinací několika modifikátorů stylu lze vytvořit složitější vizuální styl.
Souhrn modifikátoru stylu
|
||||||||||||||||||||||||||||
pins
|
query |
string[] |
Styl a instance připínáčků. Tento parametr použijte k volitelnému přidání připínáčků do image. Styl připínáčku popisuje vzhled připínáčků a instance určují souřadnice připínáčků a volitelné popisky pro každý kolík. (Nezapomeňte správně zakódovat hodnoty adresy URL tohoto parametru, protože bude obsahovat vyhrazené znaky, jako jsou například kanály a interpunkční znaména.) Skladová položka S0 účtu Azure Maps podporuje pouze jednu instanci parametru pins. Jiné skladové položky umožňují více instancím parametru pins zadat více stylů připnutí. Pokud chcete vykreslit připínáčko při zeměpisné šířce 45°N a délce 122°W pomocí výchozího integrovaného stylu připnutí, přidejte parametr řetězce dotazu.
Všimněte si, že zeměpisná délka předchází zeměpisné šířce. Po kódování adresy URL to bude vypadat takto:
Ve všech zde uvedených příkladech se kvůli přehlednosti zobrazuje parametr pins bez kódování adresy URL. Pokud chcete vykreslit špendlík na více místech, oddělte každé umístění znakem svislé čáry. Například použijte
Skladová položka S0 Azure Maps účtu umožňuje pouze pět připínáčků. Jiné skladové položky účtů toto omezení nemají. Modifikátory styluVzhled špendlíků můžete upravit přidáním modifikátorů stylu. Ty se přidají za styl, ale před umístění a popisky. Modifikátory stylu mají název se dvěma písmeny. Tyto zkrácené názvy pomáhají zkrátit délku adresy URL. Pokud chcete změnit barvu připínáku, použijte modifikátor stylu "co" a zadejte barvu pomocí barevného formátu HTML/CSS RGB, což je šestimístné šestnáctkové číslo (třímístná forma není podporována). Pokud chcete například použít tmavě růžovou barvu, kterou byste zadali jako #FF1493 v šablonách stylů CSS, použijte
Popisky připínáčkůPokud chcete přidat popisek do špendlíků, vložte ho do jednoduchých uvozovek těsně před souřadnice. Pokud chcete například označit tři špendlíky hodnotami 1, 2 a 3, použijte
Existuje integrovaný styl připínáku s názvem "none", který nezobrazuje obrázek připínáčkem. Tuto možnost můžete použít, pokud chcete zobrazit popisky bez připnutí obrázku. Třeba
Pokud chcete změnit barvu popisků připínáčku, použijte modifikátor stylu barvy popisku lc. Pokud chcete například použít růžové připínáky s černými popisky, použijte
Pokud chcete změnit velikost popisků, použijte modifikátor stylu velikosti popisku ls. Velikost popisku představuje přibližnou výšku textu popisku v pixelech. Pokud například chcete zvětšit velikost popisku na 12, použijte
Popisky jsou na středu připínáčku "ukotvení popisku". Umístění ukotvení je předdefinované pro předdefinované připínáky a je ve středu horní části vlastních připínáčků (viz níže). Pokud chcete přepsat ukotvení popisku, použijte modifikátor stylu "la" a zadejte souřadnice X a Y pixelů pro ukotvení. Tyto souřadnice jsou relativní vzhledem k levému hornímu rohu obrázku připínáčku. Kladné hodnoty X posunou ukotvení doprava a kladné hodnoty Y posunou ukotvení dolů. Pokud chcete například umístit ukotvení popisků o 10 pixelů doprava a 4 pixely nad levý horní roh obrázku připínáčku, použijte
Vlastní připínákyPokud chcete použít vlastní obrázek připínáčku, jako název stylu připnutí použijte slovo "vlastní" a za informacemi o umístění a popisku zadejte adresu URL. Pomocí dvou znaků svislé roury označte, že jste dokončili zadávání umístění a že začínáte adresu URL. Třeba
Po kódování adresy URL by to vypadalo takto:
Ve výchozím nastavení se vlastní obrázky připínáčku nakreslují na střed souřadnic špendlíku. Obvykle to není ideální, protože zakrývá místo, které se snažíte zvýraznit. Pokud chcete přepsat umístění ukotvení obrázku připnutí, použijte modifikátor stylu "an". Používá se stejný formát jako modifikátor stylu ukotvení popisku "la". Pokud má například obrázek vlastního špendlíku špičku špendlíku v levém horním rohu obrázku, můžete na toto místo nastavit ukotvení pomocí
Poznámka: Pokud použijete modifikátor barvy "co" s vlastním obrázkem připínáku, zadaná barva nahradí kanály RGB pixelů v obrázku, ale ponechá alfa (neprůhledný) kanál beze změny. To se obvykle provádí pouze pomocí vlastního obrázku plné barvy. Škálování, rotace a neprůhlednostPřipínáky a jejich popisky můžete zvětšit nebo zmenšit pomocí modifikátoru stylu "sc". Jedná se o hodnotu větší než nula. Hodnota 1 je standardní měřítko. Hodnoty větší než 1 zvětší připnutí a hodnoty menší než 1 je zmenší. Pokud například chcete nakreslit připínáky o 50 % větší než obvykle, použijte
Připínáky a jejich popisky můžete otáčet pomocí modifikátoru stylu otáčení ro. Jedná se o několik stupňů otočení po směru hodinových ručiček. Záporné číslo použijte k otočení proti směru hodinových ručiček. Pokud chcete například otočit připínáky o 90 stupňů po směru hodinových ručiček a zdvojnásobit jejich velikost, použijte
Zadáním modifikátoru stylu alfa "al" můžete připínáky a jejich popisky částečně zprůhlednit. Jedná se o číslo mezi 0 a 1, které označuje neprůhlednost připínáčků. Díky nule jsou zcela průhledné (a nejsou viditelné) a hodnota 1 je zcela neprůhledná (což je výchozí nastavení). Pokud například chcete, aby připínáky a jejich popisky byly neprůstiskné z 67 %, použijte
Souhrn modifikátoru stylu
|
||||||||||||||||||||||||||||
style
|
query |
Styl mapování, který se má vrátit. Možné hodnoty jsou hlavní a tmavé. |
|||||||||||||||||||||||||||||
view
|
query |
Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení. |
|||||||||||||||||||||||||||||
width
|
query |
integer int32 |
Šířka výsledného obrázku v pixelech Rozsah je 1 až 8192. Výchozí hodnota je 512. Neměl by se používat s bboxem. |
||||||||||||||||||||||||||||
zoom
|
query |
integer int32 |
Požadovaná úroveň přiblížení mapy. Hodnota přiblížení musí být v rozsahu 0–20 (včetně). Výchozí hodnota je 12. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
object |
Tento obrázek se vrátí z úspěšného volání Get Map Static Image. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string |
Other Status Codes |
Došlo k neočekávané chybě. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
Zabezpečení
AADToken
Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.
Poznámky
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
Je Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID.
* Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.
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
Jedná se o sdílený klíč, který se zřizuje při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto klíčem má každá aplikace autorizaci pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystavené.
U veřejně vystavených aplikací doporučujeme použít přístup mezi servery Azure Maps rozhraní REST API, kde je možné tento klíč bezpečně uložit.
Type:
apiKey
In:
header
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto tokenem má každá aplikace autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečeným způsobem než sdílený klíč.
U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.
Type:
apiKey
In:
header
Příklady
Successful Static Image Request
Sample Request
GET https://atlas.microsoft.com/map/static/png?api-version=2022-08-01&layer=basic&style=main&zoom=2&bbox=1.355233,42.982261,24.980233,56.526017
Sample Response
Content-Type: image/png
"{file}"
Definice
Name | Description |
---|---|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Localized |
Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení. |
Map |
Styl mapování, který se má vrátit. Možné hodnoty jsou hlavní a tmavé. |
Raster |
Požadovaný formát odpovědi Možná hodnota: png. |
Static |
Byla požadována vrstva mapy. Pokud je vrstva nastavená na popisky nebo hybridní, měl by být formát png. |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
LocalizedMapView
Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN.
Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.
Name | Typ | Description |
---|---|---|
AE |
string |
Spojené arabské emiráty (arabské zobrazení) |
AR |
string |
Argentina (argentinský pohled) |
Auto |
string |
Vrátí mapová data na základě IP adresy požadavku. |
BH |
string |
Bahrajn (arabské zobrazení) |
IN |
string |
Indie (indické zobrazení) |
IQ |
string |
Irák (arabské zobrazení) |
JO |
string |
Jordánsko (arabské zobrazení) |
KW |
string |
Kuvajt (arabské zobrazení) |
LB |
string |
Libanon (arabské zobrazení) |
MA |
string |
Maroko (marocké zobrazení) |
OM |
string |
Omán (arabské zobrazení) |
PK |
string |
Pákistán (pákistánské zobrazení) |
PS |
string |
Palestinská samospráva (arabské zobrazení) |
QA |
string |
Katar (arabské zobrazení) |
SA |
string |
Saúdská Arábie (arabské zobrazení) |
SY |
string |
Sýrie (arabské zobrazení) |
Unified |
string |
Sjednocené zobrazení (ostatní) |
YE |
string |
Jemen (arabské zobrazení) |
MapImageStyle
Styl mapování, který se má vrátit. Možné hodnoty jsou hlavní a tmavé.
Name | Typ | Description |
---|---|---|
dark |
string |
Tmavě šedá verze hlavního stylu Azure Maps |
main |
string |
Azure Maps hlavní styl |
RasterTileFormat
Požadovaný formát odpovědi Možná hodnota: png.
Name | Typ | Description |
---|---|---|
png |
string |
Obrázek ve formátu PNG. Podporuje úrovně přiblížení 0 až 18. |
StaticMapLayer
Byla požadována vrstva mapy. Pokud je vrstva nastavená na popisky nebo hybridní, měl by být formát png.
Name | Typ | Description |
---|---|---|
basic |
string |
Vrátí obrázek obsahující všechny prvky mapy, včetně mnohoúhelníku, ohraničení, silnic a popisků. |
hybrid |
string |
Vrátí obrázek obsahující ohraničení, cesty a popisky a dá se překryt na jiných dlaždicích (například satelitních snímků) a vytvořit tak hybridní dlaždice. |
labels |
string |
Vrátí obrázek pouze informací o popisku mapy. |