RenderGetMapImageOptionalParams interface

境界ボックス。 使用されるプロジェクション - EPSG:3857。 形式: 'minLon、minLat、maxLon、maxLat' 注: bbox または center は必須パラメーターです。 これらは相互に排他的です。 高さまたは幅で使用しないでください。

Lat と Lon に許可される最大範囲は、このページの上部にあるテーブルのズーム レベルごとに定義されます。

bbox?: string

プロパティ値

中心点の座標。 形式: 'lon,lat' 使用されるプロジェクション

• EPSG:3857。 経度の範囲: -180 から 180。 緯度の範囲: -85 から 85。 注: center または bbox は必須パラメーターです。 これらは相互に排他的です。

center?: string

プロパティ値

結果の画像の高さ (ピクセル単位)。 範囲は 1 ~ 8192 です。 既定値は 512 です。 bbox では使用しないでください。

height?: number

プロパティ値

検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、「 サポートされている言語 」を参照してください。

language?: string

プロパティ値

要求されたマップ レイヤー。 レイヤーがラベルまたはハイブリッドに設定されている場合、形式は png にする必要があります。 使用できる値は、'basic'、'hybrid'、'labels' です。

layer?: StaticMapLayer

プロパティ値

パスのスタイルと場所。 必要に応じて、線、多角形、または円を画像に追加するには、このパラメーターを使用します。 パス スタイルは、線と塗りつぶしの外観を表します。 (パイプや句読点などの予約文字が含まれるため、このパラメーターの値を正しく URL エンコードしてください)。Path パラメーターは、S1 以降Azure Mapsアカウント SKU でサポートされています。 path パラメーターの複数のインスタンスを使用すると、スタイルを使用して複数のジオメトリを指定できます。 要求あたりのパラメーターの数は 10 に制限され、場所の数はパスあたり 100 に制限されます。

既定のスタイルを使用して緯度 45°N と経度 122°W で半径 100 メートルと中心点を持つ円をレンダリングするには、querystring パラメーターを追加します。

path=ra100||-122 45

経度は緯度より前に来る点に注意してください。 URL エンコードの後、これは次のようになります

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

ここでのすべての例では、わかりやすくするために、URL エンコードなしの path パラメーターを示します。

線をレンダリングするには、各位置をパイプ文字で区切ります。 たとえば、次を使用します。

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 の範囲に設定して、対子午線を横切るジオメトリをレンダリングできます。

スタイル修飾子

スタイル修飾子を追加することで、パスの外観を変更できます。 これらは、場所の前に追加されます。 スタイル修飾子はそれぞれ 2 文字の名前を持ちます。 これらの省略名は、URL の長さを短くするために使用されます。

アウトラインの色を変更するには、'lc' スタイル修飾子を使用し、6 桁の 16 進数である HTML/CSS RGB カラー形式を使用して色を指定します (3 桁の形式はサポートされていません)。 たとえば、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

Azure Maps Data Storage からのパスの場所の取得

S0 以外のすべてのAzure Maps アカウント SKU について、パスの場所の情報は、Azure Maps Data Storage から取得できます。 パスの場所を含む GeoJSON ドキュメントをアップロードすると、Data Storage サービスは、path パラメーター内のデータを参照するために使用できる一意のデータ ID (UDID) を返します。

アップロードされた GeoJSON ドキュメントのポイント ジオメトリをパスの場所として使用するには、path パラメーターの locations セクションで UDID を指定します。 たとえば、オブジェクトに適用された

path=||udid-29dc105a-dee7-409f-a3f9-22b066ae4713

Data Storage のパスの場所と path パラメーターで指定された場所を混在させることはできません。

スタイル修飾子の概要

path?: string[]

プロパティ値

プッシュピン のスタイルとインスタンス。 このパラメーターを使用して、必要に応じてイメージに画鄒を追加します。 プッシュピン スタイルは、プッシュピンの外観を表し、インスタンスは各ピンのプッシュピンと省略可能なラベルの座標を指定します。 (パイプや句読点などの予約文字が含まれるため、このパラメーターの値を正しく URL エンコードしてください)。Azure Maps アカウント S0 SKU では、pin パラメーターの 1 つのインスタンスのみがサポートされます。 その他の SKU を使用すると、pin パラメーターの複数のインスタンスで複数のピン スタイルを指定できます。

既定の組み込みのプッシュピン スタイルを使用して緯度 45°N と経度 122°W でプッシュピンをレンダリングするには、querystring パラメーターを追加します

pins=default||-122 45

経度は緯度より前に来る点に注意してください。 URL エンコードの後、これは次のようになります

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

ここでの例はすべて、わかりやすくするために、URL エンコードなしの pin パラメーターを示しています。

複数の場所にピンをレンダリングするには、各位置をパイプ文字で区切ります。 たとえば、次を使用します。

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

S0 Azure Maps アカウント SKU では、5 つのプッシュピンのみが許可されます。 他のアカウント SKU には、この制限はありません。

スタイル修飾子

ピンの外観を変更するには、スタイル修飾子を追加します。 これらは、スタイルの後、場所とラベルの前に追加されます。 スタイル修飾子はそれぞれ 2 文字の名前を持ちます。 これらの省略名は、URL の長さを短くするために使用されます。

プッシュピンの色を変更するには、'co' スタイル修飾子を使用し、6 桁の 16 進数である HTML/CSS RGB カラー形式を使用して色を指定します (3 桁の形式はサポートされていません)。 たとえば、CSS で #FF1493 として指定する濃いピンク色を使用するには、

pins=default|coFF1493||-122 45

画鄒ラベル

ピンにラベルを追加するには、座標の直前にラベルを単一引用符で囲みます。 たとえば、3 つのピンに値 '1'、'2'、および '3' のラベルを付ける場合は、

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

プッシュピンイメージを表示しない'none'という組み込みのプッシュピンスタイルがあります。 これは、ピン 画像なしでラベルを表示する場合に使用できます。 たとえば、オブジェクトに適用された

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

ラベルは、画鋲 'label anchor' の中央に配置されます。 アンカーの場所は、組み込みのプッシュピン用に事前に定義されており、カスタム プッシュピンの上部中央にあります (下記参照)。 ラベル アンカーをオーバーライドするには、'la' スタイル修飾子を使用し、アンカーの X と Y のピクセル座標を指定します。 これらの座標は、画鄒画像の左上隅を基準にしています。 正の X 値を指定するとアンカーが右に移動し、正の Y 値を指定するとアンカーが下方向に移動します。 たとえば、ラベル アンカーを右に 10 ピクセル、画鋲画像の左上隅の 4 ピクセル上に配置するには、

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

カスタム プッシュピン

カスタム プッシュピン イメージを使用するには、ピン スタイル名として "custom" という単語を使用し、場所とラベル情報の後に URL を指定します。 2 つのパイプ文字を使用して、場所の指定が完了し、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 チャネルを置き換えますが、アルファ (不透明度) チャネルは変更されません。 これは通常、単色のカスタム イメージでのみ行われます。

Azure Maps Data Storage からプッシュピンを取得する

S0 以外のすべてのAzure Maps アカウント SKU について、Azure Maps Data Storage からプッシュピン イメージと位置情報を取得できます。 ピンの場所を含むプッシュピン イメージまたは GeoJSON ドキュメントをアップロードすると、Data Storage サービスは、pin パラメーター内のデータを参照するために使用できる一意のデータ ID (UDID) を返します。

Azure Maps Data Storage からカスタム プッシュピン イメージを使用するには、プッシュピン スタイルの名前として、"udid-" というプレフィックスが付いた UDID を指定します。 たとえば、オブジェクトに適用された

pins=udid-fe22c504-3a81-4fcd-adc6-a3507ce866c1||-122 45

アップロードした GeoJSON ドキュメントのポイント ジオメトリをピンの場所として使用するには、pin パラメーターの locations セクションで UDID を指定します。 たとえば、オブジェクトに適用された

pins=default||udid-29dc105a-dee7-409f-a3f9-22b066ae4713

ポイント ジオメトリとマルチポイント ジオメトリ、geometry コレクションのポイントとマルチポイント、フィーチャのポイント ジオメトリのみが使用されることに注意してください。 ラインストリングジオメトリとポリゴンジオメトリは無視されます。 ポイントがフィーチャから取得され、フィーチャーに "label" という名前の文字列プロパティがある場合、そのプロパティの値がピンのラベルとして使用されます。

データ ストレージのピン位置と、pin パラメーターで指定されたピンの場所を混在させることができます。 パイプで区切られたピンの場所には、経度と緯度、または UDID を指定できます。 たとえば、オブジェクトに適用された

pins=default||-122 45|udid-29dc105a-dee7-409f-a3f9-22b066ae4713|-119 43

スケール、回転、不透明度

'sc' スケール スタイル修飾子を使用して、プッシュピンとそのラベルを大きくまたは小さくすることができます。 これは 0 より大きい値です。 1 の値が標準のスケールです。 1 より大きい値にするとピンが大きくなり、1 より小さい値にすると小さくなります。 たとえば、通常よりも 50% 大きい画鍖を描画するには、

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

'ro' 回転スタイル修飾子を使用して、プッシュピンとそのラベルを回転させることができます。 これは時計回りの回転の角度です。 負の数値を使用して反時計回りに回転します。 たとえば、プッシュピンを時計回りに 90 度回転し、そのサイズを 2 倍にするには、

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

'al' アルファ スタイル修飾子を指定することで、プッシュピンとそのラベルを部分的に透明にすることができます。 これは、画鄁の不透明度を示す 0 ~ 1 の間の数値です。 ゼロを指定すると、完全に透明になり (表示されません)、1 は完全に不透明になります (既定値)。 たとえば、プッシュピンとそのラベルを 67% だけ不透明にするには、

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

スタイル修飾子の概要

• X 座標と Y 座標は、ピン 画像内の任意の場所、またはその周囲の余白にすることができます。 余白のサイズは、ピンの幅と高さの最小値です。

pins?: string[]

プロパティ値

返されるマップ スタイル。 現在、使用できるスタイルのみがメインされています。 使用可能な値は次のとおりです: 'メイン'

style?: Style

プロパティ値

View パラメーターは、マップに表示される境界線やラベルなど、Azure Maps サービスを介して返される地政学的に紛争のあるコンテンツのセットを指定します。 View パラメーター ("ユーザー リージョン パラメーター" とも呼ばれます) には、その国/地域の正しいマップが表示されます。 既定では、View パラメーターは、要求で定義していない場合でも "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。 詳細については、「 サポートされているビュー」 を参照し、使用可能なビューを参照してください。

view?: string

プロパティ値

結果の画像の幅 (ピクセル単位)。 範囲は 1 ~ 8192 です。 既定値は 512 です。 bbox では使用しないでください。

width?: number

プロパティ値

マップの目的のズーム レベル。 ズーム値は、0 から 20 (両端を含む) の範囲である必要があります。 既定値は 12 です。

詳細については、「 ズーム レベルとタイル グリッド 」を参照してください。

zoom?: number

プロパティ値

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

継承元 RequestOptionsBase.abortSignal

{object}[customHeaders]要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。

customHeaders?: [key: string]: string

プロパティ値

継承元 RequestOptionsBase.customHeaders

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

継承元 RequestOptionsBase.onDownloadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

継承元 RequestOptionsBase.onUploadProgress

要求が自動的に終了するまでの時間 (ミリ秒)。

timeout?: number

プロパティ値

継承元 RequestOptionsBase.timeout