RenderGetMapStaticImageQueryParamProperties interface
屬性
| bbox | 周框方塊是由兩個緯度和兩個經度所定義,代表地球上矩形區域的四側。 格式:'minLon、minLat、maxLon、maxLat' (雙精度浮點數)。 注意:bbox 或 center 都是必要參數。 它們是互斥的。 bbox 不應該與高度或寬度搭配使用。 Lat 和 Lon 的最大和最小允許範圍會針對此頁面頂端表格中的每個縮放層級定義。 |
||||||||||||||||||||||||||||||||||||
| center | 雙精度浮點中心點的座標。 格式:'lon,lat'。 經度範圍:-180 到 180。 緯度範圍:-90 至 90。 注意:中心或 bbox 都是必要參數。 它們是互斥的。 |
||||||||||||||||||||||||||||||||||||
| height | 產生的影像高度,以像素為單位。 範圍從80到1500。 預設值為512。 它不應該與 bbox 搭配使用。 |
||||||||||||||||||||||||||||||||||||
| language | 應該傳回搜尋結果的語言。 應該是其中一個支援的 IETF 語言標記,不區分大小寫。 當特定欄位無法使用指定語言的數據時,會使用預設語言。 如需詳細資訊,請參閱 支援的語言。 |
||||||||||||||||||||||||||||||||||||
| path | 路徑樣式和位置(雙精度浮點數)。 使用此參數選擇性地將線條、多邊形或圓形新增至影像。 路徑樣式描述線條和填滿的外觀。 (請務必正確使用此參數的 URL 編碼值,因為它會包含管道和標點符號等保留字元。 從 S1 開始,Azure 地圖服務帳戶 SKU 支援 Path 參數。 path 參數的多個實例允許使用其樣式指定多個幾何。 每個要求的參數數目限制為 10,且每個路徑的位置數目限制為 100。 若要使用默認樣式來轉譯半徑為 100 公尺且中心點為緯度 45°N 和經度 122°W 的圓圈,請新增 querystring 參數
請注意,經度是在緯度之前。 URL 編碼之後,看起來會像這樣
此處的所有範例都會顯示不含 URL 編碼的路徑參數,以清楚明瞭。 若要轉譯一行,請使用管道字元分隔每個位置。 例如,使用
多邊形是以封閉路徑指定,其中第一個和最後一個點相等。 例如,使用
線條和多邊形位置的經度值可以介於從 -360 到 360 的範圍內,以允許轉譯跨越反經線的幾何。 樣式修飾詞您可以藉由新增樣式修飾詞來修改路徑的外觀。 這些會在位置之前新增。 樣式修飾詞各有兩個字母的名稱。 這些縮寫名稱可用來協助減少 URL 的長度。 若要變更外框的色彩,請使用 『lc』 樣式修飾詞,並使用 HTML/CSS RGB 色彩格式指定色彩,這是六位數十六進位數位(不支援三位數表單)。 例如,若要使用深粉紅色色彩,您會在 CSS 中指定為 #FF1493,請使用
可以結合多個樣式修飾詞來建立更複雜的視覺樣式。
樣式修飾詞摘要
|
||||||||||||||||||||||||||||||||||||
| pins | 圖釘樣式和實例。 使用此參數選擇性地圖釘新增至映像。 圖釘樣式描述圖釘的外觀,而實例會指定圖釘的座標(雙精度浮點數),以及每個圖釘的選擇性標籤。 (請務必正確使用此參數的 URL 編碼值,因為它會包含管道和標點符號等保留字元。 Azure 地圖服務帳戶 S0 SKU 僅支援針腳參數的單一實例,而且每個針腳的位置數目限制為 5 個。 其他 SKU 最多允許 25 個針腳參數實例指定多個針腳樣式,而且每個針腳的位置數目限制為 50 個。 若要使用預設的內建圖釘樣式,在緯度 45°N 和經度 122°W 轉譯圖釘,請新增 querystring 參數
請注意,經度是在緯度之前。 URL 編碼之後,看起來會像這樣
此處的所有範例都會顯示沒有 URL 編碼的 pins 參數,以清楚明瞭。 若要在多個位置轉譯針腳,請使用管道字元分隔每個位置。 例如,使用
S0 Azure 地圖服務帳戶 SKU 只允許五個圖釘。 其他帳戶 SKU 沒有這項限制。 樣式修飾詞您可以藉由新增樣式修飾詞來修改釘選的外觀。 這些會在樣式之後新增,但在位置和標籤之前。 樣式修飾詞各有兩個字母的名稱。 這些縮寫名稱可用來協助減少 URL 的長度。 若要變更圖釘的色彩,請使用 『co』 樣式修飾詞,並使用 HTML/CSS RGB 色彩格式指定色彩,這是六位數十六進位數位(不支援三位數表單)。 例如,若要使用深粉紅色色彩,您會在 CSS 中指定為 #FF1493,請使用
圖釘卷標若要將標籤新增至釘選,請將標籤放在座標正前的單引號中。 避免在標籤中使用特殊字元,例如
內建圖釘樣式稱為「無」,不會顯示圖釘影像。 如果您想要顯示標籤,而不顯示任何釘選影像,可以使用此功能。 例如
若要變更圖釘卷標的色彩,請使用 『lc』 卷標色彩樣式修飾詞。 例如,若要搭配黑色標籤使用粉紅色圖釘,請使用
若要變更標籤的大小,請使用 'ls' 標籤大小樣式修飾詞。 標籤大小代表標籤文字的近似高度,以像素為單位。 例如,若要將標籤大小增加為12,請使用
卷標會置中於圖釘 「標籤點」。 錨點位置已針對內建圖釘預先定義,且位於自定義圖釘的頂端中心(請參閱下方)。 若要覆寫標籤點,請使用 『la』 樣式修飾詞,並提供錨點的 X 和 Y 圖元座標。 這些座標相對於圖釘影像的左上角。 正 X 值會將錨點向右移動,而正 Y 值會將錨點向下移動。 例如,若要將標籤錨定在圖釘影像左上角上方 10 像素和 4 圖元的位置,請使用
自訂圖釘若要使用自定義圖釘影像,請使用 『custom』 這個字作為釘選樣式名稱,然後在位置和標籤資訊後面指定 URL。 自定義標籤影像允許的大小上限為65,536圖元。 使用兩個管道字元來指出您已完成指定位置並啟動URL。 例如
URL 編碼之後,看起來會像這樣
根據預設,自定義圖釘影像會以釘選座標為中心繪製。 這通常不理想,因為它遮蔽了您嘗試反白顯示的位置。 若要覆寫釘選影像的錨點位置,請使用 『an』 樣式修飾詞。 這會使用與 『la』 標籤式修飾詞相同的格式。 例如,如果您的自定義釘選影像在影像左上角有釘選的提示,您可以使用 將錨點設定為該位置
注意:如果您使用自定義圖釘影像的 'co' 色彩修飾詞,指定的色彩將會取代影像中像素的 RGB 色板,但會讓 Alpha (不透明度) 通道保持不變。 這通常只會使用純色自定義影像來完成。 縮放、旋轉和不透明度您可以使用 'sc' 縮放樣式修飾詞,讓圖釘及其標籤變大或更小。 這是大於零的值。 值為 1 是標準小數位數。 大於 1 的值會讓針腳變大,而小於 1 的值會使其變小。 例如,若要繪製圖釘 50% 大於一般,請使用
您可以使用 『ro』 旋轉樣式修飾詞來旋轉圖釘及其標籤。 這是順時針旋轉的數度。 使用負數來逆時針旋轉。 例如,若要順時針旋轉圖釘 90 度,並加倍其大小,請使用
您可以指定 『al』 Alpha 樣式修飾詞,讓圖釘及其標籤部分透明。 這是介於 0 到 1 之間的數位,表示圖釘的不透明度。 零會讓它們完全透明(且不可見),1 則讓它們完全不透明(這是預設值)。 例如,若要將圖釘及其標籤設為 67% 不透明,請使用
樣式修飾詞摘要
|
||||||||||||||||||||||||||||||||||||
| tileset |
要傳回的地圖樣式。 可能的值為 microsoft.base.road、microsoft.base.darkgrey 和 microsoft.imagery。 默認值設定為 microsoft.base.road。 如需詳細資訊,請參閱 Render TilesetId。 |
||||||||||||||||||||||||||||||||||||
| traffic |
選擇性值,表示影像結果上未覆寫任何流量流量。 可能的值為 microsoft.traffic.relative.main 和 none。 默認值為 none,表示未傳回流量。 如果提供與流量相關的 tilesetId,將會傳回具有對應流量圖層的地圖影像。 如需詳細資訊,請參閱 Render TilesetId。 |
||||||||||||||||||||||||||||||||||||
| view | View 參數(也稱為「用戶區域」參數)可讓您針對地緣政治爭議區域顯示特定國家/地區的正確地圖。 不同的國家/地區對這類區域有不同的檢視,而 View 參數可讓應用程式符合您的應用程式將提供服務的國家/地區所需的檢視。 根據預設,即使您尚未在要求中定義 View 參數,仍會設定為 “Unified”。 您必須負責判斷使用者的位置,然後正確設定該位置的 View 參數。 或者,您可以選擇設定 'View=Auto',這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務中的 View 參數必須符合相關法律,包括地圖、地圖、影像和其他數據,以及您有權透過 Azure 地圖服務存取的第三方內容的國家/地區。 範例:view=IN。 如需詳細資訊,請參閱 支援的檢視,並查看可用的檢視。 |
||||||||||||||||||||||||||||||||||||
| width | 產生的影像寬度以像素為單位。 範圍從80到2000。 預設值為512。 它不應該與 bbox 搭配使用。 |
||||||||||||||||||||||||||||||||||||
| zoom | 地圖的所需縮放層級。 針對 tilesetId 為 microsoft.base.road 或 microsoft.base.darkgrey,支援從 0 到 20 的縮放值範圍。 支援 tilesetId 為 microsoft.imagery 的縮放值範圍從 0-19 不等。 預設值為 12。 |
屬性詳細資料
bbox
周框方塊是由兩個緯度和兩個經度所定義,代表地球上矩形區域的四側。 格式:'minLon、minLat、maxLon、maxLat' (雙精度浮點數)。
注意:bbox 或 center 都是必要參數。 它們是互斥的。 bbox 不應該與高度或寬度搭配使用。
Lat 和 Lon 的最大和最小允許範圍會針對此頁面頂端表格中的每個縮放層級定義。
bbox?: number[]
屬性值
number[]
center
雙精度浮點中心點的座標。 格式:'lon,lat'。 經度範圍:-180 到 180。 緯度範圍:-90 至 90。
注意:中心或 bbox 都是必要參數。 它們是互斥的。
center?: number[]
屬性值
number[]
height
產生的影像高度,以像素為單位。 範圍從80到1500。 預設值為512。 它不應該與 bbox 搭配使用。
height?: number
屬性值
number
language
應該傳回搜尋結果的語言。 應該是其中一個支援的 IETF 語言標記,不區分大小寫。 當特定欄位無法使用指定語言的數據時,會使用預設語言。
如需詳細資訊,請參閱 支援的語言。
language?: string
屬性值
string
path
路徑樣式和位置(雙精度浮點數)。 使用此參數選擇性地將線條、多邊形或圓形新增至影像。 路徑樣式描述線條和填滿的外觀。 (請務必正確使用此參數的 URL 編碼值,因為它會包含管道和標點符號等保留字元。
從 S1 開始,Azure 地圖服務帳戶 SKU 支援 Path 參數。 path 參數的多個實例允許使用其樣式指定多個幾何。 每個要求的參數數目限制為 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 色彩格式指定色彩,這是六位數十六進位數位(不支援三位數表單)。 例如,若要使用深粉紅色色彩,您會在 CSS 中指定為 #FF1493,請使用
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
樣式修飾詞摘要
| 修飾語 | 描述 | 類型 | 範圍 |
|---|---|---|---|
| 立法會 | 線條色彩 | 字串 | 000000 到FFFFFFFF |
| fc | 填滿色彩 | 字串 | 000000 到FFFFFFFF |
| 洛杉磯 | 線條 Alpha (不透明度) | float | 0 到 1 |
| 發 | 填滿 Alpha (不透明度) | float | 0 到 1 |
| lw | 線條寬度 | int32 | (0, 50] |
| ra | 圓半徑(公尺) | float | 大於 0 |
path?: string
屬性值
string
pins
圖釘樣式和實例。 使用此參數選擇性地圖釘新增至映像。 圖釘樣式描述圖釘的外觀,而實例會指定圖釘的座標(雙精度浮點數),以及每個圖釘的選擇性標籤。 (請務必正確使用此參數的 URL 編碼值,因為它會包含管道和標點符號等保留字元。
Azure 地圖服務帳戶 S0 SKU 僅支援針腳參數的單一實例,而且每個針腳的位置數目限制為 5 個。 其他 SKU 最多允許 25 個針腳參數實例指定多個針腳樣式,而且每個針腳的位置數目限制為 50 個。
若要使用預設的內建圖釘樣式,在緯度 45°N 和經度 122°W 轉譯圖釘,請新增 querystring 參數
pins=default||-122 45
請注意,經度是在緯度之前。 URL 編碼之後,看起來會像這樣
pins=default%7C%7C-122+45
此處的所有範例都會顯示沒有 URL 編碼的 pins 參數,以清楚明瞭。
若要在多個位置轉譯針腳,請使用管道字元分隔每個位置。 例如,使用
pins=default||-122 45|-119.5 43.2|-121.67 47.12
S0 Azure 地圖服務帳戶 SKU 只允許五個圖釘。 其他帳戶 SKU 沒有這項限制。
樣式修飾詞
您可以藉由新增樣式修飾詞來修改釘選的外觀。 這些會在樣式之後新增,但在位置和標籤之前。 樣式修飾詞各有兩個字母的名稱。 這些縮寫名稱可用來協助減少 URL 的長度。
若要變更圖釘的色彩,請使用 『co』 樣式修飾詞,並使用 HTML/CSS RGB 色彩格式指定色彩,這是六位數十六進位數位(不支援三位數表單)。 例如,若要使用深粉紅色色彩,您會在 CSS 中指定為 #FF1493,請使用
pins=default|coFF1493||-122 45
圖釘卷標
若要將標籤新增至釘選,請將標籤放在座標正前的單引號中。 避免在標籤中使用特殊字元,例如 | 或 ||。 例如,若要使用值 '1'、'2' 和 '3' 來標記三個針腳,請使用
pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12
內建圖釘樣式稱為「無」,不會顯示圖釘影像。 如果您想要顯示標籤,而不顯示任何釘選影像,可以使用此功能。 例如
pins=none||'A'-122 45|'B'-119.5 43.2
若要變更圖釘卷標的色彩,請使用 『lc』 卷標色彩樣式修飾詞。 例如,若要搭配黑色標籤使用粉紅色圖釘,請使用
pins=default|coFF1493|lc000000||-122 45
若要變更標籤的大小,請使用 'ls' 標籤大小樣式修飾詞。 標籤大小代表標籤文字的近似高度,以像素為單位。 例如,若要將標籤大小增加為12,請使用
pins=default|ls12||'A'-122 45|'B'-119 43
卷標會置中於圖釘 「標籤點」。 錨點位置已針對內建圖釘預先定義,且位於自定義圖釘的頂端中心(請參閱下方)。 若要覆寫標籤點,請使用 『la』 樣式修飾詞,並提供錨點的 X 和 Y 圖元座標。 這些座標相對於圖釘影像的左上角。 正 X 值會將錨點向右移動,而正 Y 值會將錨點向下移動。 例如,若要將標籤錨定在圖釘影像左上角上方 10 像素和 4 圖元的位置,請使用
pins=default|la10 -4||'A'-122 45|'B'-119 43
自訂圖釘
若要使用自定義圖釘影像,請使用 『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
根據預設,自定義圖釘影像會以釘選座標為中心繪製。 這通常不理想,因為它遮蔽了您嘗試反白顯示的位置。 若要覆寫釘選影像的錨點位置,請使用 『an』 樣式修飾詞。 這會使用與 『la』 標籤式修飾詞相同的格式。 例如,如果您的自定義釘選影像在影像左上角有釘選的提示,您可以使用 將錨點設定為該位置
pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png
注意:如果您使用自定義圖釘影像的 'co' 色彩修飾詞,指定的色彩將會取代影像中像素的 RGB 色板,但會讓 Alpha (不透明度) 通道保持不變。 這通常只會使用純色自定義影像來完成。
縮放、旋轉和不透明度
您可以使用 'sc' 縮放樣式修飾詞,讓圖釘及其標籤變大或更小。 這是大於零的值。 值為 1 是標準小數位數。 大於 1 的值會讓針腳變大,而小於 1 的值會使其變小。 例如,若要繪製圖釘 50% 大於一般,請使用
pins=default|sc1.5||-122 45
您可以使用 『ro』 旋轉樣式修飾詞來旋轉圖釘及其標籤。 這是順時針旋轉的數度。 使用負數來逆時針旋轉。 例如,若要順時針旋轉圖釘 90 度,並加倍其大小,請使用
pins=default|ro90|sc2||-122 45
您可以指定 『al』 Alpha 樣式修飾詞,讓圖釘及其標籤部分透明。 這是介於 0 到 1 之間的數位,表示圖釘的不透明度。 零會讓它們完全透明(且不可見),1 則讓它們完全不透明(這是預設值)。 例如,若要將圖釘及其標籤設為 67% 不透明,請使用
pins=default|al.67||-122 45
樣式修飾詞摘要
| 修飾語 | 描述 | 類型 | 範圍 |
|---|---|---|---|
| 鋁 | Alpha (不透明度) | float | 0 到 1 |
| 一 | 釘選錨點 | <int32、 int32> | * |
| co | 釘選色彩 | 字串 | 000000 到FFFFFFFF |
| 洛杉磯 | 標籤點 | <int32、 int32> | * |
| 立法會 | 標籤色彩 | 字串 | 000000 到FFFFFFFF |
| ls | 標籤大小 | float | 大於 0 |
| ro | 旋轉 | float | -360 到 360 |
| sc | 規模 | float | 大於 0 |
- X 和 Y 座標可以是釘選影像內的任何位置或其周圍的邊界。 邊界大小是針腳寬度和高度的最小值。
pins?: string
屬性值
string
tilesetId
要傳回的地圖樣式。 可能的值為 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.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"
trafficLayer
選擇性值,表示影像結果上未覆寫任何流量流量。 可能的值為 microsoft.traffic.relative.main 和 none。 默認值為 none,表示未傳回流量。 如果提供與流量相關的 tilesetId,將會傳回具有對應流量圖層的地圖影像。 如需詳細資訊,請參閱 Render TilesetId。
trafficLayer?: "microsoft.traffic.relative.main" | "none"
屬性值
"microsoft.traffic.relative.main" | "none"
view
View 參數(也稱為「用戶區域」參數)可讓您針對地緣政治爭議區域顯示特定國家/地區的正確地圖。 不同的國家/地區對這類區域有不同的檢視,而 View 參數可讓應用程式符合您的應用程式將提供服務的國家/地區所需的檢視。 根據預設,即使您尚未在要求中定義 View 參數,仍會設定為 “Unified”。 您必須負責判斷使用者的位置,然後正確設定該位置的 View 參數。 或者,您可以選擇設定 'View=Auto',這會根據要求的IP位址傳回地圖數據。 Azure 地圖服務中的 View 參數必須符合相關法律,包括地圖、地圖、影像和其他數據,以及您有權透過 Azure 地圖服務存取的第三方內容的國家/地區。 範例:view=IN。
如需詳細資訊,請參閱 支援的檢視,並查看可用的檢視。
view?: "AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified"
屬性值
"AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified"
width
產生的影像寬度以像素為單位。 範圍從80到2000。 預設值為512。 它不應該與 bbox 搭配使用。
width?: number
屬性值
number
zoom
地圖的所需縮放層級。 針對 tilesetId 為 microsoft.base.road 或 microsoft.base.darkgrey,支援從 0 到 20 的縮放值範圍。 支援 tilesetId 為 microsoft.imagery 的縮放值範圍從 0-19 不等。 預設值為 12。
如需詳細資訊,請參閱 縮放層級和磚網格線。
zoom?: number
屬性值
number