Share via

RenderURL class

  • リファレンス
パッケージ:
azure-maps-rest

RenderURL は、Azure Mapsレンダリング操作の URL を表します。

Extends
MapsURL

コンストラクター

RenderURL(Pipeline, string)

RenderURL のインスタンスを作成します。

継承されたプロパティ

mapsUrl

ベース URL 文字列値。

メソッド

getMapImage(Aborter, GetMapImageOptions)

0 ~ 20 のズーム レベルを使用して、マップ セクションを含むユーザー定義の四角形の画像をレンダリングします。 静的イメージ サービスは、0 ~ 20 のズーム レベルを使用して、マップ セクションを含むユーザー定義の四角形の画像をレンダリングします。 マップ イメージでサポートされている解像度の範囲は、1x1 から 8192x8192 です。 マップ タイル サービスよりも静的イメージ サービスを使用するタイミングを決定する場合は、レンダリングされたマップを操作する方法を検討してください。 マップの内容が比較的変更されない場合は、静的マップを選択することをお勧めします。 マップ コンテンツの多くのズーム、パン、変更をサポートする場合は、マップ タイル サービスの方が適しています。 また、サービスには、次のような追加のデータを含む静的イメージを取得するための Image Composition 機能も用意されています。次の S0 および S1 機能を備えたプッシュピンとジオメトリ オーバーレイ。

S0 では、次のことができます。

  • 要求で指定された最大 5 つのプッシュピンをレンダリングする
  • 要求で参照されるピンに対して 1 つのカスタム イメージを指定します
  • 画鄒にラベルを追加する

S1 では、次のことができます。

  • Azure Maps Data Service を介してプッシュピンをレンダリングする
  • 複数のプッシュピン スタイルを指定する
  • Azure Maps Data Service に格納されているカスタム プッシュピン イメージを提供する
  • 円、ポリライン、ポリゴンジオメトリタイプをレンダリングします。
  • Azure Maps Data Service を介してアップロードされた、サポートされている GeoJSON ジオメトリ型のレンダリング

詳細な例については、 ハウツーガイド を参照してください。

注 : center パラメーターまたは bbox パラメーターを API に指定する必要があります。

bbox パラメーターを使用する場合にサポートされる Lat と Lon の範囲は次のとおりです。

ズーム レベル 最大ロン範囲 最大緯度範囲
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

マップ イメージの取得 API を使用します。 https://docs.microsoft.com/rest/api/maps/render/getmapimage
getMapImageryTile(Aborter, number, number, number)

x 座標と y 座標とズーム レベルを指定して、サイズが 256 x 256 のマップ イメージ タイルを返します。 ズーム レベルの範囲は 0 ~ 18 です。 現在使用可能なスタイル値は、衛星画像のみを提供する "satellite" です。 Get Map Imagery Tile API を使用します。 https://docs.microsoft.com/rest/api/maps/render/getmapimagerytile
getMapTile(Aborter, TileFormat, MapTileLayer, MapTileStyle, number, number, number, GetMapTileOptions)

通常、新しいマップ コントロールまたは SDK に統合されるベクター形式またはラスター形式のマップ タイルを返します。 既定では、Azure は Web マップ コントロールにベクター マップ タイルを使用します ( 「ズーム レベルとタイル グリッド」を参照) マップ タイルの取得 API を使用します。 https://docs.microsoft.com/rest/api/maps/render/getmaptile

継承されたメソッド

newPipeline(Credential, INewPipelineOptions)

Credential が指定された新しい Pipeline オブジェクトを作成するために使用される静的メソッド。

コンストラクターの詳細

RenderURL(Pipeline, string)

RenderURL のインスタンスを作成します。

new RenderURL(pipeline: Pipeline, mapsUrl?: string)

パラメーター

pipeline
Pipeline

MapsURL.newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを提供します。

mapsUrl

string

サービスを指す URL 文字列Azure Maps。既定値は です"https://atlas.microsoft.com"。 プロトコルが指定されていない場合 (例: "atlas.microsoft.com")、と https 見なされます。

継承されたプロパティの詳細

mapsUrl

ベース URL 文字列値。

mapsUrl: string

プロパティ値

string

MapsURL.mapsUrlから継承

メソッドの詳細

getMapImage(Aborter, GetMapImageOptions)

0 ~ 20 のズーム レベルを使用して、マップ セクションを含むユーザー定義の四角形の画像をレンダリングします。 静的イメージ サービスは、0 ~ 20 のズーム レベルを使用して、マップ セクションを含むユーザー定義の四角形の画像をレンダリングします。 マップ イメージでサポートされている解像度の範囲は、1x1 から 8192x8192 です。 マップ タイル サービスよりも静的イメージ サービスを使用するタイミングを決定する場合は、レンダリングされたマップを操作する方法を検討してください。 マップの内容が比較的変更されない場合は、静的マップを選択することをお勧めします。 マップ コンテンツの多くのズーム、パン、変更をサポートする場合は、マップ タイル サービスの方が適しています。 また、サービスには、次のような追加のデータを含む静的イメージを取得するための Image Composition 機能も用意されています。次の S0 および S1 機能を備えたプッシュピンとジオメトリ オーバーレイ。

S0 では、次のことができます。

  • 要求で指定された最大 5 つのプッシュピンをレンダリングする
  • 要求で参照されるピンに対して 1 つのカスタム イメージを指定します
  • 画鄒にラベルを追加する

S1 では、次のことができます。

  • Azure Maps Data Service を介してプッシュピンをレンダリングする
  • 複数のプッシュピン スタイルを指定する
  • Azure Maps Data Service に格納されているカスタム プッシュピン イメージを提供する
  • 円、ポリライン、ポリゴンジオメトリタイプをレンダリングします。
  • Azure Maps Data Service を介してアップロードされた、サポートされている GeoJSON ジオメトリ型のレンダリング

詳細な例については、 ハウツーガイド を参照してください。

注 : center パラメーターまたは bbox パラメーターを API に指定する必要があります。

bbox パラメーターを使用する場合にサポートされる Lat と Lon の範囲は次のとおりです。

ズーム レベル 最大ロン範囲 最大緯度範囲
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

マップ イメージの取得 API を使用します。 https://docs.microsoft.com/rest/api/maps/render/getmapimage

function getMapImage(aborter: Aborter, options: GetMapImageOptions): Promise<GetMapImageResponse>

パラメーター

aborter
Aborter

Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。

options
GetMapImageOptions

戻り値

Promise<GetMapImageResponse>

getMapImageryTile(Aborter, number, number, number)

x 座標と y 座標とズーム レベルを指定して、サイズが 256 x 256 のマップ イメージ タイルを返します。 ズーム レベルの範囲は 0 ~ 18 です。 現在使用可能なスタイル値は、衛星画像のみを提供する "satellite" です。 Get Map Imagery Tile API を使用します。 https://docs.microsoft.com/rest/api/maps/render/getmapimagerytile

function getMapImageryTile(aborter: Aborter, zoom: number, xTileIndex: number, yTileIndex: number): Promise<GetMapImageryTileResponse>

パラメーター

aborter
Aborter

Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。

zoom

number

目的のタイルのズーム レベル。 ズーム値は、0 ~ 18 (含む) の範囲内である必要があります。

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

xTileIndex

number

ズーム グリッド上のタイルの X 座標。 値は [0, 2zoom -1] の範囲内である必要があります。

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

yTileIndex

number

ズーム グリッド上のタイルの Y 座標。 値は [0, 2zoom -1] の範囲内である必要があります。

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

戻り値

Promise<GetMapImageryTileResponse>

getMapTile(Aborter, TileFormat, MapTileLayer, MapTileStyle, number, number, number, GetMapTileOptions)

通常、新しいマップ コントロールまたは SDK に統合されるベクター形式またはラスター形式のマップ タイルを返します。 既定では、Azure は Web マップ コントロールにベクター マップ タイルを使用します ( 「ズーム レベルとタイル グリッド」を参照) マップ タイルの取得 API を使用します。 https://docs.microsoft.com/rest/api/maps/render/getmaptile

function getMapTile(aborter: Aborter, format: TileFormat, layer: MapTileLayer, style: MapTileStyle, zoom: number, xTileIndex: number, yTileIndex: number, options?: GetMapTileOptions): Promise<GetMapTileResponse>

パラメーター

aborter
Aborter

Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。

format
TileFormat

応答の目的の形式。 指定できる値は png & pbf です。 使用できる値は、'png'、'pbf' です。

layer
MapTileLayer

要求されたマップ レイヤー。 使用できる値は、基本、ハイブリッド、ラベル、terra です。 使用可能な値は次のとおりです: 'basic'、'hybrid'、'labels'、'terra'

style
MapTileStyle

返されるマップ スタイル。 使用可能な値はメイン & shaded_relief。 使用できる値は、'メイン'、'shaded_relief' です。

zoom

number

目的のタイルのズーム レベル。 ラスター タイルの場合、値の範囲は 0 から 18 (含む) である必要があります。 Terra ラスター タイルの値は、0 ~ 6 (含む) の範囲である必要があります。 ベクター タイルの場合、値の範囲は 0 から 22 (含む) である必要があります。

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

xTileIndex

number

ズーム グリッド上のタイルの X 座標。 値は [0, 2zoom -1] の範囲内である必要があります。

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

yTileIndex

number

ズーム グリッド上のタイルの Y 座標。 値は [0, 2zoom -1] の範囲内である必要があります。

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

options
GetMapTileOptions

戻り値

Promise<GetMapTileResponse>

継承済みメソッドの詳細

newPipeline(Credential, INewPipelineOptions)

Credential が指定された新しい Pipeline オブジェクトを作成するために使用される静的メソッド。

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

パラメーター

credential
Credential

SubscriptionKeyCredential、TokenCredential、MapControlCredential など。

pipelineOptions
INewPipelineOptions

戻り値

Pipeline

新しい Pipeline オブジェクト。

MapsURL.newPipelineから継承