RouteURL class
RouteURL は、Azure Mapsルート操作の URL を表します。
- Extends
コンストラクター
| RouteURL(Pipeline, string) | RouteURL のインスタンスを作成します。 |
継承されたプロパティ
| maps |
ベース URL 文字列値。 |
メソッド
| calculate |
出発地と目的地の間のルートを返し、指定されている場合はウェイポイントを通過します。 ルートには、現在のトラフィックや、要求された曜日と時刻の一般的な道路速度などの要因が考慮されます。 返される情報には、距離、推定移動時間、ルート ジオメトリの表現が含まれます。 選択したオプションに応じて、最適化されたウェイポイント注文やターンバイターン命令などの追加のルーティング情報も利用できます。 ルーティング サービスには、車両固有の従量課金モデルの詳細な説明に関する一連のパラメーターが用意されています。 関連する概念とパラメーターの詳細については、「従量課金モデル」をチェックしてください。 が指定されている場合 それ以外の場合は、Get Route Directions API を使用します。 https://docs.microsoft.com/rest/api/maps/route/getroutedirections |
| calculate |
注: この API は現在プレビュー段階であり、重大な変更が発生する可能性があります。 出発地と目的地の場所によって定義された一連のルートのルート概要のマトリックスを計算します。 指定された配信元ごとに、このサービスは、その配信元から特定のすべての宛先へのルーティングのコストを計算します。 起点のセットと宛先のセットは、テーブルの列ヘッダーと行ヘッダーと考えることができます。テーブル内の各セルには、配信元からそのセルの宛先へのルーティングコストが含まれます。 ルートごとに、移動時間と距離が計算されます。 計算されたコストを使用して、ルーティング方向 API を使用して計算するルートを決定できます。 要求の waitForResults パラメーターが false (既定値) に設定されている場合、この API は応答ヘッダーの Location フィールドにリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 この API のマトリックスの最大サイズは 700 です (配信元の数に宛先の数を掛けた値)。 この制約を念頭に置いて、考えられる行列ディメンションの例は、50x10、10x10、28x25 です。 10x70 (正方形である必要はありません)。 ルート マトリックスの計算は、実行時間の長い操作と見なされます。 実行時間の長い操作は、最初の要求が受け入れられる (HTTP 202) 後に、最終的な結果が使用可能になるまでポーリングされることを意味します。 各ポーリング要求は、アボートのタイムアウト (指定されている場合) を再起動します。 Post Route Matrix API を使用します。 https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview |
| calculate |
指定された燃料、エネルギー、または時間の予算に基づいて、起点から到達できる一連の場所を計算します。 ポリゴン境界 (または等時線) は、反時計回りの方向と、原点の結果である正確な多角形の中心で返されます。 返されたポリゴンは、Search Inside Geometry などの追加処理に使用して、指定された等時線内の POI を検索できます。 Get Route Range API を使用します。 https://docs.microsoft.com/rest/api/maps/route/getrouterange |
継承されたメソッド
| new |
Credential が指定された新しい Pipeline オブジェクトを作成するために使用される静的メソッド。 |
コンストラクターの詳細
RouteURL(Pipeline, string)
RouteURL のインスタンスを作成します。
new RouteURL(pipeline: Pipeline, mapsUrl?: string)パラメーター
- pipeline
- Pipeline
MapsURL.newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを提供します。
- mapsUrl
-
string
サービスを指す URL 文字列Azure Maps。既定値は です"https://atlas.microsoft.com"。
プロトコルが指定されていない場合 (例: "atlas.microsoft.com")、と https 見なされます。
継承されたプロパティの詳細
mapsUrl
メソッドの詳細
calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)
出発地と目的地の間のルートを返し、指定されている場合はウェイポイントを通過します。 ルートには、現在のトラフィックや、要求された曜日と時刻の一般的な道路速度などの要因が考慮されます。 返される情報には、距離、推定移動時間、ルート ジオメトリの表現が含まれます。 選択したオプションに応じて、最適化されたウェイポイント注文やターンバイターン命令などの追加のルーティング情報も利用できます。
ルーティング サービスには、車両固有の従量課金モデルの詳細な説明に関する一連のパラメーターが用意されています。 関連する概念とパラメーターの詳細については、「従量課金モデル」をチェックしてください。
が指定されている場合 options.postBody は、Post Route Directions API を使用します。 https://docs.microsoft.com/rest/api/maps/route/postroutedirections
それ以外の場合は、Get Route Directions API を使用します。 https://docs.microsoft.com/rest/api/maps/route/getroutedirections
function calculateRouteDirections(aborter: Aborter, coordinates: GeoJSON.Position[], options?: CalculateRouteDirectionsOptions): Promise<CalculateRouteDirectionsResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- coordinates
-
GeoJSON.Position[]
ルートが計算される座標の配列。
各座標は の [longitude, latitude]配列です。 少なくとも 2 つの座標が必要です。
1 つ目は配信元、最後はルートの宛先です。
中間のオプションの座標は、ルート内の WayPoint として機能します。 最大 150 個の WayPoint を渡すことができます。
- options
- CalculateRouteDirectionsOptions
戻り値
Promise<CalculateRouteDirectionsResponse>
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)
注: この API は現在プレビュー段階であり、重大な変更が発生する可能性があります。 出発地と目的地の場所によって定義された一連のルートのルート概要のマトリックスを計算します。 指定された配信元ごとに、このサービスは、その配信元から特定のすべての宛先へのルーティングのコストを計算します。 起点のセットと宛先のセットは、テーブルの列ヘッダーと行ヘッダーと考えることができます。テーブル内の各セルには、配信元からそのセルの宛先へのルーティングコストが含まれます。 ルートごとに、移動時間と距離が計算されます。 計算されたコストを使用して、ルーティング方向 API を使用して計算するルートを決定できます。 要求の waitForResults パラメーターが false (既定値) に設定されている場合、この API は応答ヘッダーの Location フィールドにリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 この API のマトリックスの最大サイズは 700 です (配信元の数に宛先の数を掛けた値)。 この制約を念頭に置いて、考えられる行列ディメンションの例は、50x10、10x10、28x25 です。 10x70 (正方形である必要はありません)。
ルート マトリックスの計算は、実行時間の長い操作と見なされます。 実行時間の長い操作は、最初の要求が受け入れられる (HTTP 202) 後に、最終的な結果が使用可能になるまでポーリングされることを意味します。 各ポーリング要求は、アボートのタイムアウト (指定されている場合) を再起動します。
Post Route Matrix API を使用します。 https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
入力パラメーターに基づいて、マトリックスの各セルのルート距離、移動時間、およびその他の概要を計算する起点座標と目的地座標の行列。 サポートされる最小セル数と最大セル数はそれぞれ 1 と 700 です。 たとえば、35 の出発地と 20 の宛先、または 25 の出発地と 25 の宛先を指定できます。
- options
- CalculateRouteMatrixOptions
戻り値
Promise<CalculateRouteMatrixResponse>
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)
指定された燃料、エネルギー、または時間の予算に基づいて、起点から到達できる一連の場所を計算します。 ポリゴン境界 (または等時線) は、反時計回りの方向と、原点の結果である正確な多角形の中心で返されます。 返されたポリゴンは、Search Inside Geometry などの追加処理に使用して、指定された等時線内の POI を検索できます。
Get Route Range API を使用します。 https://docs.microsoft.com/rest/api/maps/route/getrouterange
function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>パラメーター
- aborter
- Aborter
Aborter.none または Aborter.timeout() を使用して新しい Aborter インスタンスを作成します。要求の取り消しに関するその他の例については、Aborter の goto ドキュメントを参照してください。
- center
- GeoJSON.Position
範囲の計算の開始元となる座標。
- options
- CalculateRouteRangeOptions
戻り値
Promise<CalculateRouteRangeResponse>
継承済みメソッドの詳細
newPipeline(Credential, INewPipelineOptions)
Credential が指定された新しい Pipeline オブジェクトを作成するために使用される静的メソッド。
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipelineパラメーター
- credential
- Credential
SubscriptionKeyCredential、TokenCredential、MapControlCredential など。
- pipelineOptions
- INewPipelineOptions
戻り値
新しい Pipeline オブジェクト。