הכיתה DistanceMatrixService
class
google.maps.DistanceMatrixService
library "routes"
const {DistanceMatrixService} = await google.maps.importLibrary("routes");
יצרן | |
|---|---|
DistanceMatrixService |
DistanceMatrixService()פרמטרים: אין
יצירת מופע חדש של DistanceMatrixService ששולח שאילתות של מטריצת מרחקים לשרתים של Google. |
Methods | |
|---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback])פרמטרים:
ערך מוחזר:
Promise<DistanceMatrixResponse>שליחת בקשה למטריצת מרחקים. |
ממשק 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, השירות מטריצת מרחקים ינסה להימנע מכבישים מהירים ככל האפשר. אופציונלי. |
avoidTolls
אופציונלי |
סוג:
boolean optionalאם הערך הוא true, שירות מטריצת מרחקים ינסה להימנע מכבישי אגרה כשאפשר. אופציונלי. |
drivingOptions
אופציונלי |
סוג:
DrivingOptions optionalהגדרות שחלות רק על בקשות שבהן travelMode הוא DRIVING. לאובייקט הזה לא תהיה השפעה על אמצעי תחבורה אחרים. |
language
אופציונלי |
סוג:
string optionalמזהה השפה שבה התוצאות צריכות להופיע, אם אפשר. כאן אפשר לעיין ברשימת השפות הנתמכות. |
region
אופציונלי |
סוג:
string optionalקוד אזור שמשמש כהטיה לבקשות של המרת כתובות לקואורדינטות (geocoding). קוד האזור מקבל ערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. רוב קודי ה-ccTLD זהים לקודי ISO 3166-1, עם כמה חריגים בולטים. לדוגמה, ה-ccTLD של בריטניה הוא uk ( .co.uk) וקוד ה-ISO 3166-1 שלה הוא gb (מבחינה טכנית, עבור הישות "הממלכה המאוחדת של בריטניה הגדולה וצפון אירלנד"). |
transitOptions
אופציונלי |
סוג:
TransitOptions optionalהגדרות שחלות רק על בקשות שבהן הערך של travelMode הוא TRANSIT. לאובייקט הזה לא תהיה השפעה על אמצעי תחבורה אחרים. |
unitSystem
אופציונלי |
סוג:
UnitSystem optionalמערכת היחידות המועדפת להצגת מרחק. אופציונלי; ברירת המחדל היא metric. |
הממשק 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 קבועים
constants
google.maps.DistanceMatrixStatus
ספרייה "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 |
לא ניתן היה לעבד בקשה של Distance Matrix בגלל שגיאה בחיבור לשרת. יכול להיות שהבקשה תצליח אם תנסו שוב. |
קבועים של DistanceMatrixElementStatus
constants
google.maps.DistanceMatrixElementStatus
ספרייה "routes"
הסטטוס ברמת הרכיב של צמד מסוים של נקודת מוצא ויעד, שמוחזר על ידי DistanceMatrixService אחרי השלמת בקשה למטריצת מרחקים. הערכים האלה מצוינים כמחרוזות, לדוגמה, 'OK'.
אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג DistanceMatrixElementStatusString.
const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes");
קבועים | |
|---|---|
NOT_FOUND |
לא ניתן היה להמיר לקואורדינטות את נקודת המוצא ו/או היעד של הצמד הזה. |
OK |
התשובה מכילה תוצאה תקינה. |
ZERO_RESULTS |
לא נמצא מסלול בין נקודת המוצא ליעד. |