DistanceMatrixService 類別
google.maps.DistanceMatrixService
class
library "routes"
const {DistanceMatrixService} = await google.maps.importLibrary("routes");
建構函式 | |
|---|---|
DistanceMatrixService |
DistanceMatrixService()參數:無
建立新的 DistanceMatrixService 執行個體,將距離矩陣查詢傳送至 Google 伺服器。 |
方法 | |
|---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback])參數:
提出距離矩陣要求。 |
DistanceMatrixRequest 介面
google.maps.DistanceMatrixRequest
介面
DistanceMatrixService 傳送的距離矩陣查詢,包含起點和目的地位置的陣列,以及各種計算指標的選項。
屬性 | |
|---|---|
destinations |
類型:
Array<string|LatLng|LatLngLiteral|Place>包含目的地地址字串、 LatLng 或 Place 物件的陣列,用於計算距離和時間。必填。 |
origins |
類型:
Array<string|LatLng|LatLngLiteral|Place>這個陣列包含起點地址字串、 LatLng 或 Place 物件,用於計算距離和時間。必填。 |
travelMode |
類型:
TravelMode要求的路線類型。必填。 |
avoidFerries
選填 |
類型:
boolean optional如果設為 true,則指示距離矩陣服務盡可能避開渡輪。選用項目。 |
avoidHighways
選填 |
類型:
boolean optional如果設為 true,則指示 Distance Matrix 服務盡可能避開高速公路。選用項目。 |
avoidTolls
選填 |
類型:
boolean optional如果設為 true,則指示 Distance Matrix 服務盡可能避開收費路段。選用項目。 |
drivingOptions
選填 |
類型:
DrivingOptions optional僅適用於 travelMode 為 DRIVING 的請求設定。這個物件不會影響其他交通工具。 |
language
選填 |
類型:
string optional語言 ID,用於指定傳回結果時應盡可能使用的語言。請參閱支援語言清單。 |
region
選填 |
類型:
string optional用於地理編碼要求自訂調整的區域代碼。區碼接受 ccTLD (「頂層網域」) 的兩位字元值。多數 ccTLD 代碼與 ISO 3166-1 代碼相同,只有少數例外。舉例來說,英國的 ccTLD 是「uk」( .co.uk),而 ISO 3166-1 代碼則是「gb」(技術上代表「大不列顛暨北愛爾蘭聯合王國」)。 |
transitOptions
選填 |
類型:
TransitOptions optional僅適用於 travelMode 為 TRANSIT 的要求。這個物件不會影響其他交通工具。 |
unitSystem
選填 |
類型:
UnitSystem optional顯示距離時使用的常用單位系統。選用,預設為公制。 |
DistanceMatrixResponse 介面
google.maps.DistanceMatrixResponse
介面
DistanceMatrixService 要求的應答,包含格式化的起點和目的地地址,以及一連串的 DistanceMatrixResponseRow,每個對應的起點地址各有一個。
屬性 | |
|---|---|
destinationAddresses |
類型:
Array<string>格式化的目的地地址。 |
originAddresses |
類型:
Array<string>格式化的起點地址。 |
rows |
對應至起點地址的矩陣列。 |
DistanceMatrixResponseRow 介面
google.maps.DistanceMatrixResponseRow
介面
DistanceMatrixService 要求回應中的一列,由一連串 DistanceMatrixResponseElement 組成,每個對應一個目的地地址。
屬性 | |
|---|---|
elements |
對應目的地地址的列元素。 |
DistanceMatrixResponseElement 介面
google.maps.DistanceMatrixResponseElement
介面
DistanceMatrixService 要求回應中的單一元素,包含從一個起點到一個目的地的車程時間和距離。
屬性 | |
|---|---|
distance |
類型:
Distance此起點與目的地對組之間的距離。因為距離不明,這個屬性可能未定義。 |
duration |
類型:
Duration此起點與目的地對組的期間。因為期間不明,這個屬性可能未定義。 |
duration_in_traffic |
類型:
Duration這個起點/目的地組合的所需時間,考量了 trafficModel 屬性指出的路況。如果時間長度不明,這個屬性可能會是 undefined。僅適用於付費方案客戶,且必須在提出要求時定義 drivingOptions。 |
fare |
類型:
TransitFare這個起點/目的地組合的總票價。僅適用於大眾運輸要求。 |
status |
此特定起點與目的地對組的狀態。 |
DistanceMatrixStatus 常數
google.maps.DistanceMatrixStatus
constants
程式庫"routes"
距離矩陣要求完成後,DistanceMatrixService 傳回的要求整體頂層狀態。請依值或使用常數名稱指定這些值。例如 'OK' 或 google.maps.DistanceMatrixStatus.OK。
這些常數也可以做為字串使用。在 TypeScript 中,字串常值是由 DistanceMatrixStatusString 類型定義。
const {DistanceMatrixStatus} = await google.maps.importLibrary("routes");
常數 | |
|---|---|
INVALID_REQUEST |
提供的要求無效。 |
MAX_DIMENSIONS_EXCEEDED |
該要求包含超過 25 個起點,或超過 25 個目的地。 |
MAX_ELEMENTS_EXCEEDED |
起點與目的地的乘積超出每項查詢的限制。 |
OK |
回應包含有效的結果。 |
OVER_QUERY_LIMIT |
在允許的時段內要求了過多的元素。如果稍後再試,要求應該就會成功。 |
REQUEST_DENIED |
服務拒絕您的網頁使用距離矩陣服務。 |
UNKNOWN_ERROR |
伺服器發生錯誤,無法處理距離矩陣要求。如果您再試一次,該要求可能會成功。 |
DistanceMatrixElementStatus 常數
google.maps.DistanceMatrixElementStatus
constants
程式庫"routes"
距離矩陣要求完成後,DistanceMatrixService 傳回的特定起點/目的地配對元素層級狀態。這些值會指定為字串,例如 'OK'。
這些常數也可以做為字串使用。在 TypeScript 中,字串常值是由 DistanceMatrixElementStatusString 類型定義。
const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes");
常數 | |
|---|---|
NOT_FOUND |
此起點和/或目的地對組不可進行地理編碼。 |
OK |
回應包含有效的結果。 |
ZERO_RESULTS |
在起點和目的地之間找不到路線。 |