RouteURL class
RouteURL 代表 Azure 地圖服務 路由作業的 URL。
- Extends
建構函式
| RouteURL(Pipeline, string) | 建立 RouteURL 的實例。 |
繼承的屬性
| maps |
基底 URL 字串值。 |
方法
| calculate |
傳回來源與目的地之間的路由，並在指定時通過路線點。 路線會將目前交通和一般道路速度等因素納入考慮，例如一周中要求的一天和一天的時間。 傳回的資訊包括距離、估計的行進時間，以及路線幾何的表示法。 視選取的選項而定，也提供其他路由資訊，例如優化的方式點順序或回合指示。 路線規劃服務提供一組參數，以取得車輛特定取用模型的詳細描述。 如需相關概念和參數的詳細說明，請參閱 取用模型 。 如果 否則會使用取得路線指示 API： https://docs.microsoft.com/rest/api/maps/route/getroutedirections |
| calculate |
注意：此 API 目前為預覽狀態，可能受限於重大變更。 計算來源和目的地位置所定義之一組路由的路由摘要矩陣。 針對每個指定的來源，此服務會計算從該來源路由到每個指定目的地的成本。 原點集合和目的地集合可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從來源路由到該儲存格目的地的成本。 針對每個路線，會計算行進時間和距離。 您可以使用計算成本來判斷要使用路由方向 API 計算的路由。 如果要求的 waitForResults 參數設定為 false (預設值) ，此 API 會在響應標頭的 [位置] 字段中傳回 202 回應碼和重新導向 URL。 應該定期檢查此 URL，直到響應資料或錯誤資訊可用為止。 此 API 矩陣的大小上限為 700， (原點數目乘以目的地數目) 。 考慮到該條件約束，可能的矩陣維度範例包括：50x10、10x10、28x25。 10x70 (不需要正方形) 。 計算路由矩陣會被視為長時間執行的作業。 長時間執行的作業表示在接受初始要求之後， (HTTP 202) 最終結果將會輪詢，直到可用為止。 如果指定了中止器的逾時，每個輪詢要求都會重新啟動。 使用 Post Route Matrix API： https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview |
| calculate |
根據指定的燃料、能源或時間預算，計算一組可從源點到達的位置。 多邊形界限 (或 Isochrone) 會以反時針方向傳回，以及原點結果的精確多邊形中心。 傳回的多邊形可用於進一步處理，例如 搜尋 內部幾何內搜尋所提供 Isochrone 內的 POI。 使用取得路由範圍 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
指向 Azure 地圖服務 服務的網址字串，預設值為 "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
否則會使用取得路線指示 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 的檔，以取得有關要求取消的更多範例。
- coordinates
-
GeoJSON.Position[]
用來計算路由的座標陣列。
每個座標都是的 [longitude, latitude]陣列。 至少需要兩個座標。
第一個是來源，最後一個是路由的目的地。
選擇性座標在路由中做為 WayPoints。 您最多可以傳遞 150 個 WayPoints。
- options
- CalculateRouteDirectionsOptions
傳回
Promise<CalculateRouteDirectionsResponse>
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)
注意：此 API 目前為預覽狀態，可能受限於重大變更。 計算來源和目的地位置所定義之一組路由的路由摘要矩陣。 針對每個指定的來源，此服務會計算從該來源路由到每個指定目的地的成本。 原點集合和目的地集合可以視為數據表的數據行和數據列標頭，而數據表中的每個數據格都包含從來源路由到該儲存格目的地的成本。 針對每個路線，會計算行進時間和距離。 您可以使用計算成本來判斷要使用路由方向 API 計算的路由。 如果要求的 waitForResults 參數設定為 false (預設值) ，此 API 會在響應標頭的 [位置] 字段中傳回 202 回應碼和重新導向 URL。 應該定期檢查此 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 的檔。
根據輸入參數計算矩陣中每個儲存格的路線距離、行動時間和其他摘要的原點和目的地座標矩陣。 支援的最小和最大數據格計數分別為 1 和 700。 例如，它可以是 35 個來源和 20 個目的地，或 25 個來源和 25 個目的地。
- options
- CalculateRouteMatrixOptions
傳回
Promise<CalculateRouteMatrixResponse>
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)
根據指定的燃料、能源或時間預算，計算一組可從源點到達的位置。 多邊形界限 (或 Isochrone) 會以反時針方向傳回，以及原點結果的精確多邊形中心。 傳回的多邊形可用於進一步處理，例如 搜尋 內部幾何內搜尋所提供 Isochrone 內的 POI。
使用取得路由範圍 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 的檔。
- 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 物件。