Directions

הסיווג DirectionsService

google.maps.DirectionsService סיווג

שירות לחישוב מסלולי נסיעה בין שני מקומות או יותר.

ניתן לגשת באמצעות חיוג אל const {DirectionsService} = await google.maps.importLibrary("routes"). ראה ספריות ב-Maps JavaScript API.

DirectionsService
DirectionsService()
פרמטרים: ללא
יצירת מופע חדש של DirectionsService ששולח שאילתות מסלול אל שרתי Google.
route
route(request[, callback])
פרמטרים: 
הערך המוחזר:  Promise<DirectionsResult>
שולחים בקשה לחיפוש מסלול.

ממשק DirectionsRequest

ממשק google.maps.DirectionsRequest

שאילתת מסלול תישלח אל DirectionsService.

destination
סוג:  string|LatLng|Place|LatLngLiteral
מיקום היעד. אפשר לציין אותו כמחרוזת לקידוד גיאוגרפי, כמחרוזת LatLng או כPlace. חובה.
origin
סוג:  string|LatLng|Place|LatLngLiteral
מיקום המוצא. אפשר לציין אותו כמחרוזת לקידוד גיאוגרפי, כמחרוזת LatLng או כPlace. חובה.
travelMode
סוג:  TravelMode
סוג הניתוב המבוקש. חובה.
avoidFerries optional
סוג:  boolean optional
אם true, מורה לשירות המסלול להימנע ממעבורות היכן שאפשר. זה שינוי אופציונלי.
avoidHighways optional
סוג:  boolean optional
אם true, מורה לשירות המסלול להימנע מכבישים מהירים כשהדבר אפשרי. זה שינוי אופציונלי.
avoidTolls optional
סוג:  boolean optional
אם true, מורה לשירות המסלול להימנע מכבישי אגרה כשהדבר אפשרי. זה שינוי אופציונלי.
drivingOptions optional
סוג:  DrivingOptions optional
הגדרות שחלות רק על בקשות שבהן travelMode הוא DRIVING. לאובייקט הזה לא תהיה השפעה על אמצעי הגעה אחרים.
language optional
סוג:  string optional
מזהה השפה של השפה שבה התוצאות יוחזרו, כשהדבר אפשרי. כאן אפשר לעיין ברשימת השפות הנתמכות.
optimizeWaypoints optional
סוג:  boolean optional
אם המדיניות מוגדרת לערך true, DirectionsService ינסה לשנות את הסדר של נקודות הביניים שצוינו כדי לצמצם את העלות הכוללת של המסלול. אם בוצעה אופטימיזציה של ציוני הדרך, בודקים את הסדר של DirectionsRoute.waypoint_order בתשובה כדי לקבוע את הסדר החדש.
provideRouteAlternatives optional
סוג:  boolean optional
האם יש לספק חלופות או לא. זה שינוי אופציונלי.
region optional
סוג:  string optional
קוד האזור משמש כהטיה של בקשות לקידוד גיאוגרפי. קוד האזור מקבל ערך בן שני תווים של ccTLD ("דומיין ברמה העליונה"). רוב הקודים של ccTLD זהים לקודי ISO 3166-1, למעט כמה יוצאים מן הכלל. לדוגמה, הדומיין ברמה העליונה של קוד מדינה (ccTLD) בבריטניה הוא "uk" (.co.uk) אבל קוד ISO 3166-1 שלו הוא "gb" (טכני עבור הישות "בריטניה וצפון אירלנד").
transitOptions optional
סוג:  TransitOptions optional
הגדרות שחלות רק על בקשות שבהן travelMode הוא TRANSIT. לאובייקט הזה לא תהיה השפעה על אמצעי הגעה אחרים.
unitSystem optional
סוג:  UnitSystem optional
ברירת מחדל: מערכת היחידה שבה משתמשים במדינת המקור.
מערכת היחידות המועדפת לשימוש להצגת המרחק.
waypoints optional
סוג:  Array<DirectionsWaypoint> optional
מערך של ציוני דרך ברמת הביניים. המסלול מחושב מהמוצא ליעד לפי כל נקודת ציון במערך הזה. מספר ציוני הדרך המקסימלי המותר הוא במדריך למפתחים. אין תמיכה בציוני דרך כמסלולים לתחבורה ציבורית. זה שינוי אופציונלי.

קבועים של DirectionsStatus

google.maps.DirectionsStatus קבועים

הסטטוס שהוחזר על ידי DirectionsService במהלך שיחה אל route(). צריך לציין את הערכים האלה לפי ערך או על ידי שימוש בשם הקבוע. לדוגמה, 'OK' או google.maps.DirectionsStatus.OK.

ניתן לגשת באמצעות חיוג אל const {DirectionsStatus} = await google.maps.importLibrary("routes"). ראה ספריות ב-Maps JavaScript API.

INVALID_REQUEST הערך שהזנת בשדה DirectionsRequest לא היה חוקי.
MAX_WAYPOINTS_EXCEEDED ציינת יותר מדי DirectionsWaypoint במאפיין DirectionsRequest. מספר ציוני הדרך המקסימלי המותר הוא במדריך למפתחים.
NOT_FOUND לא ניתן היה להמיר לקואורדינטות (geocoding) לפחות אחד מהמוצא, היעד או ציוני הדרך.
OK התשובה מכילה DirectionsResult חוקי.
OVER_QUERY_LIMIT דף האינטרנט חרג ממגבלת הבקשות בפרק זמן קצר מדי.
REQUEST_DENIED דף האינטרנט אינו מורשה להשתמש בשירות המסלולים.
UNKNOWN_ERROR לא ניתן לעבד את הבקשה לקבלת מסלול עקב שגיאה בחיבור לשרת. ניסיון חוזר של הבקשה עשוי להתבצע בהצלחה.
ZERO_RESULTS לא נמצא מסלול בין נקודת המוצא ליעד.

ממשק DirectionsResult

ממשק google.maps.DirectionsResult

תגובת המסלול שאוחזרה משרת המסלול. אפשר לעבד אותם באמצעות DirectionsRenderer או לנתח את האובייקט ולעבד אותו בעצמכם. חובה להציג את האזהרות ואת זכויות היוצרים כפי שמצוין בתנאים ובהגבלות של הפלטפורמה של מפות Google. חשוב לשים לב שהתוצאה הזו היא "כמו JSON", אבל זה לא קובץ JSON בלבד כי הוא כולל באופן עקיף אובייקטים של LatLng.

request
הבקשה לקבלת מסלול שהניבה את התוצאה הזו.
routes
מערך של DirectionsRoutes, שכל אחד מהם מכיל מידע על הרגליים והשלבים שמהן הוא מורכב. יהיה רק מסלול אחד, אלא אם ה-DirectionsRequest נוצר עם provideRouteAlternatives שהוגדר כ-true.
available_travel_modes optional
סוג:  Array<TravelMode> optional
מכיל מגוון של אמצעי תחבורה זמינים. השדה הזה מוחזר כאשר בקשה מציינת מצב נסיעה ולא מקבלת תוצאות. המערך מכיל את אמצעי ההגעה הזמינים במדינות של קבוצת ציוני הדרך הנתונה. השדה הזה לא מוחזר אם אחת או יותר מציוני הדרך הן 'דרך ציוני דרך'.
geocoded_waypoints optional
סוג:  Array<DirectionsGeocodedWaypoint> optional
מערך של DirectionsGeocodedWaypoint, שכל אחד מהם מכיל מידע על הקידוד הגיאוגרפי של המוצא, היעד וציוני הדרך.

המחלקה DirectionsRenderer

google.maps.DirectionsRenderer סיווג

הצגת המסלול שהתקבלו מ-DirectionsService.

הכיתה הזו משתרעת על פני MVCObject.

ניתן לגשת באמצעות חיוג אל const {DirectionsRenderer} = await google.maps.importLibrary("routes"). ראה ספריות ב-Maps JavaScript API.

DirectionsRenderer
DirectionsRenderer([opts])
פרמטרים: 
יצירת הכלי לרינדור עם האפשרויות הנתונות. ניתן להציג את המסלול במפה (כשכבות-על חזותיות) או בנוסף ללוח <div> (כהוראות טקסטואליות).
getDirections
getDirections()
פרמטרים: ללא
הערך המוחזר:  DirectionsResult
מחזירה את קבוצת הכיוונים הנוכחית של הכלי לעיבוד.
getMap
getMap()
פרמטרים: ללא
הערך המוחזר:  Map
מחזירה את המפה שבה מוצג DirectionsResult.
getPanel
getPanel()
פרמטרים: ללא
הערך המוחזר:  HTMLElement|null
מחזירה את הלוח <div> שבו DirectionsResult מעובד.
getRouteIndex
getRouteIndex()
פרמטרים: ללא
הערך המוחזר:  number
מחזירה את אינדקס המסלול הנוכחי (מבוסס אפס) שבו נעשה שימוש באובייקט DirectionsRenderer הזה.
setDirections
setDirections(directions)
פרמטרים: 
ערך החזרה: ללא
מגדירים את כלי הרינדור כך שישתמש בתוצאה מ-DirectionsService. הגדרה חוקית של הוראות הגעה באופן הזה תציג את ההוראות במפה ובחלונית הייעודיות של כלי הרינדור.
setMap
setMap(map)
פרמטרים: 
ערך החזרה: ללא
שיטה זו מציינת את המפה שבה יוצגו המסלול. כדי להסיר את המסלול מהמפה, צריך לעבור את null.
setOptions
setOptions(options)
פרמטרים: 
ערך החזרה: ללא
יש לשנות את הגדרות האפשרויות של DirectionsRenderer אחרי האתחול.
setPanel
setPanel(panel)
פרמטרים: 
ערך החזרה: ללא
השיטה הזו מעבדת את ההוראות ב-<div>. כדי להסיר את התוכן מהלוח, מקישים על null.
setRouteIndex
setRouteIndex(routeIndex)
פרמטרים: 
  • routeIndexnumber
ערך החזרה: ללא
מגדירים את האינדקס (מבוסס-אפס) של המסלול באובייקט DirectionsResult לעיבוד. כברירת מחדל, יוצג הנתיב הראשון במערך.
עברה בירושה: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
directions_changed
function()
ארגומנטים: ללא
האירוע הזה מופעל כשהמסלול שעבר רינדור משתנה, כשמוגדר DirectionsResult חדש או כשהמשתמש משלים שינוי לנתיב המסלול.

ממשק DirectionsRendererOptions

ממשק google.maps.DirectionsRendererOptions

האובייקט הזה מגדיר את המאפיינים שניתן להגדיר על אובייקט DirectionsRenderer.

directions optional
סוג:  DirectionsResult optional
המסלול להצגה במפה ו/או בחלונית <div>, מאוחזר כאובייקט DirectionsResult מ-DirectionsService.
draggable optional
סוג:  boolean optional
אם הערך true מאפשר למשתמש לגרור ולשנות את נתיבי הנתיבים שמעובדים על ידי DirectionsRenderer.
hideRouteList optional
סוג:  boolean optional
ברירת מחדל: false
המאפיין הזה מציין אם כלי הרינדור צריך לספק רשימת מסלולים שהמשתמשים יכולים לבחור, ומוצגת בחלונית המסלול.
infoWindow optional
סוג:  InfoWindow optional
ה-InfoWindow שבו יש לעבד פרטי טקסט כאשר לוחצים על סמן. התוכן הקיים של חלון המידע יוחלף והמיקום שלו ישתנה. אם לא מציינים חלון מידע, מערכת DirectionsRenderer יוצרת חלון מידע משלו ומשתמשת בו. המערכת תתעלם מהמאפיין הזה אם בשדה suppressInfoWindows מוגדר הערך true.
map optional
סוג:  Map optional
מפה שבה אפשר לראות את המסלול.
markerOptions optional
סוג:  MarkerOptions optional
אפשרויות לסמנים. כל הסמנים שעובדו על ידי DirectionsRenderer ישתמשו באפשרויות האלה.
panel optional
סוג:  HTMLElement optional
<div> שבו יש להציג את שלבי המסלול.
polylineOptions optional
סוג:  PolylineOptions optional
אפשרויות לקווים פוליגוניים. כל הקווים הפוליגוניים שעובדו על ידי DirectionsRenderer ישתמשו באפשרויות האלה.
preserveViewport optional
סוג:  boolean optional
ברירת מחדל: false
אם אפשרות זו מוגדרת לערך true או שלא הוגדרו מרכז המפה ושינוי מרחק התצוגה, מפת הקלט ממורכזת וגודלה תתמקד בתיבה התוחמת של קבוצת המסלולים הזו.
routeIndex optional
סוג:  number optional
אינדקס המסלול בתוך האובייקט DirectionsResult. ערך ברירת המחדל הוא 0.
suppressBicyclingLayer optional
סוג:  boolean optional
יש למנוע את הרינדור של BicyclingLayer כשנשלחות בקשות למסלול רכיבה על אופניים.
suppressInfoWindows optional
סוג:  boolean optional
ביטול הרינדור של חלונות מידע.
suppressMarkers optional
סוג:  boolean optional
הפסקת עיבוד הסמנים.
suppressPolylines optional
סוג:  boolean optional
הפסקת הרינדור של קווים פוליגוניים.

הממשק של DirectionsWaypoint

ממשק google.maps.DirectionsWaypoint

DirectionsWaypoint מייצג מיקום בין נקודת מוצא ליעד שדרכו הנסיעה צריכה להיות מנותבת.

location optional
סוג:  string|LatLng|LatLngLiteral|Place optional
מיקום ציון הדרך. יכול להיות מחרוזת כתובת, LatLng או Place. זה שינוי אופציונלי.
stopover optional
סוג:  boolean optional
ברירת מחדל: true
אם הערך true מציין שציון הדרך הוא עצירה בין נקודת המוצא ליעד. התוצאה של הפעולה הזאת היא פיצול המסלול לשני חלקים. אם הערך false מציין שהמסלול צריך להיות מוטה כדי לעבור דרך ציון הדרך הזה, אך לא לפצל אותו לשתי רגליים. האפשרות הזו שימושית אם רוצים ליצור מסלול בתגובה לגרירה של ציוני דרך על המפה.

הממשק של DirectionsGeocodedWaypoint

ממשק google.maps.DirectionsGeocodedWaypoint

ציון דרך יחיד בקידוד גיאוגרפי.

partial_match optional
סוג:  boolean optional
האם המקודד הגיאוגרפי לא החזיר התאמה מדויקת לציון הדרך המקורי, על אף שהוא הצליח להתאים לחלק מהכתובת המבוקשת.
place_id optional
סוג:  string optional
מזהה המקום שמשויך לציון הדרך. מזהי המקומות מזהים מקום באופן ייחודי במסד הנתונים של 'מקומות Google' ובמפות Google. למידע נוסף על מזהי מקומות במדריך למפתחים של Places API.
types optional
סוג:  Array<string> optional
מערך של מחרוזות שמציינות את סוג הרכיב המוחזר בקידוד גיאוגרפי. לרשימה של מחרוזות אפשריות, יש לעיין בקטע סוגי רכיבי הכתובת במדריך למפתחים.

הממשק של DirectionsRoute

ממשק google.maps.DirectionsRoute

מסלול יחיד שמכיל סדרת רגליים בתוך DirectionsResult. חשוב לשים לב: אומנם האובייקט הזה הוא 'דומה ל-JSON' אבל הוא לא רק JSON, כי הוא כולל אובייקטים מסוג LatLng באופן ישיר ועקיף.

bounds
סוג:  LatLngBounds
הגבולות של המסלול הזה.
copyrights
סוג:  string
טקסט זכויות היוצרים שיוצג במסלול הזה.
legs
סוג:  Array<DirectionsLeg>
מערך של DirectionsLeg, שכל אחד מהם מכיל מידע על השלבים שהוא מורכב. יהיה רגל אחת לכל נקודת עצירה או יעד שצוינו. כך, מסלול ללא עצירת ביניים יכיל DirectionsLeg אחד ומסלול עם עצירת ביניים אחת יכיל שתיים.
overview_path
סוג:  Array<LatLng>
מערך של LatLng שמייצג את כל המסלול של המסלול הזה. הנתיב מפושט כדי להתאים אותו בהקשרים שבהם נדרש מספר קטן של קודקודים (כגון כתובות URL של API של מפות סטטיות).
overview_polyline
סוג:  string
ייצוג פוליגוני מקודד של המסלול ב-Overview_path. קו פוליגוני זה הוא נתיב משוער (מוחלק) של המסלול שנוצר.
summary
סוג:  string
האפליקציה מכילה תיאור טקסטואלי קצר של המסלול, שמתאים למתן שמות ולהבחנה בין האפשרויות השונות.
warnings
סוג:  Array<string>
אזהרות שיוצגו בזמן הצגת המסלול הזה.
waypoint_order
סוג:  Array<number>
אם optimizeWaypoints הוגדר לערך true, השדה הזה יכיל את התמורה המסודרת מחדש של ציוני הדרך בקלט. לדוגמה, אם הקלט היה:
מקור: לוס אנג'לס
Waypoints: דאלאס, בנגור, פיניקס
יעד: ניו יורק
והפלט שעבר אופטימיזציה היה בסדר הבא:
מקור: לוס אנג'לס
ציוני דרך: עוף החול, רחל, בנגור
יעד: ניו יורק
, השדה הזה יהיה Array, עם הערכים [1]. שימו לב שמספור ציוני הדרך הוא לפי אפס.
אם אחת מנקודות העצירה בקלט הוגדרה ל-stopover כ-false, השדה הזה יהיה ריק כי אופטימיזציית נתיבים לא זמינה לשאילתות כאלה.
fare optional
סוג:  TransitFare optional
המחיר הכולל של כל הנסיעה בתחבורה הציבורית. רלוונטי רק לבקשות תחבורה ציבורית.

ממשק DirectionsLeg

ממשק google.maps.DirectionsLeg

רגל אחת שמורכבת מקבוצת מדרגות בתוך DirectionsResult. יכול להיות שחלק מהשדות בקטע לא יוחזרו לכל הבקשות. חשוב לשים לב שהתוצאה הזו היא "דומה ל-JSON", אבל היא לא בהכרח JSON כי היא כוללת אובייקטים מסוג LatLng באופן ישיר ועקיף.

end_address
סוג:  string
כתובת היעד של הרגל הזו. התוכן הזה נועד לקריאה כפי שהוא. אין לנתח באופן פרוגרמטי את הכתובת בפורמט המתאים.
end_location
סוג:  LatLng
הפונקציה DirectionsService מחשבת את המסלול בין מיקומים באמצעות אפשרות התחבורה הקרובה ביותר (בדרך כלל כביש) בנקודת ההתחלה וביעד הנסיעה. end_location מציין את היעד בקידוד גיאוגרפי בפועל, שעשוי להיות שונה מה-end_location של השלב האחרון אם, לדוגמה, הדרך לא נמצאת בקרבת היעד של הרגל הזו.
start_address
סוג:  string
כתובת המקור של הרגל הזו. התוכן הזה נועד לקריאה כפי שהוא. אין לנתח באופן פרוגרמטי את הכתובת בפורמט המתאים.
start_location
סוג:  LatLng
הפונקציה DirectionsService מחשבת את המסלול בין מיקומים באמצעות אפשרות התחבורה הקרובה ביותר (בדרך כלל כביש) בנקודת ההתחלה וביעד הנסיעה. start_location מציין את המקור בקידוד גיאוגרפי בפועל, שעשוי להיות שונה מה-start_location של השלב הראשון אם, לדוגמה, הדרך לא נמצאת בקרבת המקור של הרגל הזו.
steps
מערך של DirectionsStep, שכל אחד מהם מכיל מידע על השלבים השונים בקטע הזה.
traffic_speed_entry
סוג:  Array<?>
מידע על מהירות התנועה לאורך הרגל.
via_waypoints
סוג:  Array<LatLng>
מערך של ציוני דרך ללא עצירות לאורך קטע זה, שצוינו בבקשה המקורית.

הוצא משימוש במסלולים חלופיים. גרסה 3.27 תהיה הגרסה האחרונה של ה-API שמוסיפה עוד via_waypoints בנתיבים חלופיים.

בעת שימוש בשירות 'מסלולים' כדי ליישם הנחיות גרירה, מומלץ להשבית את הגרירה של נתיבים חלופיים. אפשר לגרור רק את המסלול הראשי. המשתמשים יכולים לגרור את המסלול הראשי עד שהוא יתאים למסלול חלופי.

arrival_time optional
סוג:  Time optional
זמן ההגעה המשוער לקטע הזה. רלוונטי רק לבקשות TRANSIT.
departure_time optional
סוג:  Time optional
זמן היציאה המשוער של הקטע הזה. רלוונטי רק לבקשות TRANSIT.
distance optional
סוג:  Distance optional
המרחק הכולל שהרגל הזו מכסה. ייתכן שמאפיין זה לא מוגדר כי המרחק עשוי להיות לא ידוע.
duration optional
סוג:  Duration optional
משך הזמן הכולל של הרגל הזו. משך הזמן של הנכס הזה עשוי להיות undefined כי ייתכן שמשך הזמן לא ידוע.
duration_in_traffic optional
סוג:  Duration optional
משך הזמן הכולל של הקטע הזה, תוך התייחסות למצב התנועה שצוין על ידי המאפיין trafficModel. משך הזמן של הנכס הזה עשוי להיות undefined כי ייתכן שמשך הזמן לא ידוע.

הממשק של DirectionsStep

ממשק google.maps.DirectionsStep

DirectionsStep יחיד ב-DirectionsResult. יכול להיות שחלק מהשדות יהיו undefined. חשוב לשים לב: למרות שהאובייקט "דומה ל-JSON" הוא לא רק JSON, מכיוון שהוא כולל באופן ישיר אובייקטים מסוג LatLng.

encoded_lat_lngs
סוג:  string
ייצוג פוליגוני מקודד של השלב. זהו נתיב משוער (מוחלק) של השלב.
end_location
סוג:  LatLng
מיקום הסיום של השלב הזה.
end_point
סוג:  LatLng
מיקום הסיום של השלב הזה.
instructions
סוג:  string
הוראות לביצוע השלב הזה
lat_lngs
סוג:  Array<LatLng>
רצף של LatLng שמתאר את מהלך השלב הזה. זהו נתיב משוער (מוחלק) של השלב.
maneuver
סוג:  string
מכילה את הפעולה שיש לבצע בשלב הנוכחי (turn-left, merge, straight וכו'). הערכים עשויים להשתנות, וייתכן שיתווספו ערכים חדשים ללא הודעה מוקדמת.
path
סוג:  Array<LatLng>
רצף של LatLng שמתאר את מהלך השלב הזה. זהו נתיב משוער (מוחלק) של השלב.
start_location
סוג:  LatLng
המיקום שממנו מתחיל השלב הזה.
start_point
סוג:  LatLng
המיקום שממנו מתחיל השלב הזה.
travel_mode
סוג:  TravelMode
אמצעי התחבורה שבו נעשה שימוש בשלב זה.
distance optional
סוג:  Distance optional
המרחק שהשלב הזה מכסה. המאפיין הזה עשוי להיות undefined כי המרחק עשוי להיות לא ידוע.
duration optional
סוג:  Duration optional
הזמן הטיפוסי הנדרש לביצוע השלב הזה בשניות ובטופס טקסט. משך הזמן של הנכס הזה עשוי להיות undefined כי ייתכן שמשך הזמן לא ידוע.
polyline optional
סוג:  DirectionsPolyline optional
מכיל אובייקט עם מאפיין יחיד, 'points', שמכיל ייצוג קו פוליגוני מקודד של השלב. קו פוליגוני זה הוא נתיב משוער (מוחלק) של השלב.
steps optional
סוג:  Array<DirectionsStep> optional
שלבי משנה של שלב זה. מצוין עבור קטעים שאינם לתחבורה ציבורית במסלולים של תחבורה ציבורית.
transit optional
סוג:  TransitDetails optional
פרטים ספציפיים לתחבורה ציבורית לגבי השלב הזה. המאפיין הזה לא יוגדר, אלא אם אמצעי התחבורה של השלב הזה הוא TRANSIT.
transit_details optional
סוג:  TransitDetails optional
פרטים שקשורים לשלב הזה אם אמצעי ההגעה הוא TRANSIT.

הממשק של DirectionsPolyline

ממשק google.maps.DirectionsPolyline

אובייקט שמכיל את המאפיין points לתיאור הקו הפוליגוני של DirectionsStep.

points
סוג:  string

ממשק Place (מיקום)

ממשק google.maps.Place

מכיל מידע הדרוש לאיתור, לזיהוי או לתיאור מקום עבור DirectionsRequest או DistanceMatrixRequest. בהקשר זה, "מקום" פירושו עסק, נקודת עניין או מיקום גיאוגרפי. כדי לאחזר מידע על מקום מסוים, אפשר לעבור אל PlacesService.

location optional
סוג:  LatLng|LatLngLiteral optional
LatLng של הישות שמתוארת על ידי המקום הזה.
placeId optional
סוג:  string optional
מזהה המקום של המקום (למשל עסק או נקודת עניין). מזהה המקום הוא מזהה ייחודי של מקום במסד הנתונים של מפות Google. לתשומת ליבך, placeId היא הדרך המדויקת ביותר לזיהוי מקום. במידת האפשר, יש לציין את placeId ולא query. ניתן לאחזר מזהה מקום מכל בקשה אל Places API, כמו TextSearch. ניתן גם לאחזר מזהי מקומות מבקשות אל ה-API לקידוד גיאוגרפי. מידע נוסף זמין בסקירה הכללית על מזהי מקומות.
query optional
סוג:  string optional
שאילתת חיפוש שמתארת את המקום (למשל עסק או מקום מעניין). שאילתה לדוגמה היא "Quay, Upper Level, Overseas Consumer Terminal 5 Hickson Road, The Rocks NSW". במידת האפשר, יש לציין את placeId ולא query. ה-API לא מבטיח שהעיבוד של מחרוזת השאילתה מדויק ביחס למקום מסוים. אם הנתונים placeId וגם query סופקו, מתרחשת שגיאה.

קבועים של TravelMode

google.maps.TravelMode קבועים

אמצעי ההגעה התקפים שניתן לציין ב-DirectionsRequest וכן אמצעי ההגעה המוחזרים ב-DirectionsStep. צריך לציין את הערכים האלה לפי ערך או על ידי שימוש בשם הקבוע. לדוגמה, 'BICYCLING' או google.maps.TravelMode.BICYCLING.

ניתן לגשת באמצעות חיוג אל const {TravelMode} = await google.maps.importLibrary("routes"). ראה ספריות ב-Maps JavaScript API.

BICYCLING מציין בקשה למסלול אופניים.
DRIVING מציין בקשה למסלול נסיעה.
TRANSIT מציין בקשה למסלול לתחבורה ציבורית.
WALKING מציין בקשה למסלול הליכה.

ממשק DrivingOptions

ממשק google.maps.DrivingOptions

המדיניות מגדירה את DirectionsRequest כשמצב הנסיעה מוגדר ל-DRIVING.

departureTime
סוג:  Date
זמן היציאה הרצוי של המסלול, מצוין כאובייקט Date. האובייקט Date מודד את הזמן באלפיות השנייה מאז 1 בינואר 1970. יש לציין זאת כדי ש-DrivingOptions יהיה חוקי. צריך להגדיר את שעת היציאה לשעה הנוכחית או לזמן עתידי. אי אפשר לציין בעבר תאריך.
trafficModel optional
סוג:  TrafficModel optional
ההנחה המועדפת לשימוש בעת חיזוי משך התנועה. ערך ברירת המחדל הוא BEST_GUESS.

קבועים של TrafficModel

google.maps.TrafficModel קבועים

ההנחות שיש להשתמש בהן בעת חיזוי משך התנועה. מצוין כחלק מ-DirectionsRequest או DistanceMatrixRequest. צריך לציין את הערכים האלה לפי ערך או על ידי שימוש בשם הקבוע. לדוגמה, 'bestguess' או google.maps.TrafficModel.BEST_GUESS.

ניתן לגשת באמצעות חיוג אל const {TrafficModel} = await google.maps.importLibrary("routes"). ראה ספריות ב-Maps JavaScript API.

BEST_GUESS ניתן להשתמש בנתונים היסטוריים של תנועת גולשים כדי לקבל אומדן מדויק של משך התנועה.
OPTIMISTIC מומלץ להשתמש בנתוני תנועה היסטוריים כדי לקבל הערכה אופטימית לגבי משך הזמן של התנועה.
PESSIMISTIC השתמש בנתוני תנועה היסטוריים כדי לספק הערכה פסימית לגבי משך הזמן של התנועה.

ממשק TransitOptions

ממשק google.maps.TransitOptions

האובייקט TransitOptions ייכלל ב-DirectionsRequest כשמצב הנסיעה מוגדר כ-TRANSIT.

arrivalTime optional
סוג:  Date optional
שעת ההגעה הרצויה למסלול, מצוינת כאובייקט תאריך. האובייקט 'תאריך' מודד את הזמן באלפיות השנייה מאז 1 בינואר 1970. אם מציינים את שעת ההגעה, המערכת מתעלמת משעת היציאה.
departureTime optional
סוג:  Date optional
זמן היציאה הרצוי של המסלול, מצוין כאובייקט Date (תאריך). האובייקט 'תאריך' מודד את הזמן באלפיות השנייה מאז 1 בינואר 1970. אם לא ציינתם שעת יציאה או שעת הגעה, ההנחה היא שהשעה היא 'עכשיו'.
modes optional
סוג:  Array<TransitMode> optional
אמצעי מועדף אחד או יותר של תחבורה ציבורית, כמו אוטובוס או רכבת. אם לא נותנים העדפה, ה-API מחזיר את הנתיב הטוב ביותר שמוגדר כברירת מחדל.
routingPreference optional
סוג:  TransitRoutePreference optional
העדפה שיכולה להטות את הבחירה במסלול התחבורה הציבורית, כמו פחות הליכה. אם לא נותנים העדפה, ה-API מחזיר את הנתיב הטוב ביותר שמוגדר כברירת מחדל.

קבועים של TransitMode

google.maps.TransitMode קבועים

אמצעי התחבורה החוקי, למשל, אוטובוס שאפשר לציין בTransitOptions. צריך לציין את הערכים האלה לפי ערך או על ידי שימוש בשם הקבוע. לדוגמה, 'BUS' או google.maps.TransitMode.BUS.

ניתן לגשת באמצעות חיוג אל const {TransitMode} = await google.maps.importLibrary("routes"). ראה ספריות ב-Maps JavaScript API.

BUS מציין את האפשרות אוטובוס כאמצעי תחבורה מועדף.
RAIL מציין את שירות הרכבת כדרך המועדפת של תחבורה.
SUBWAY מציין את האפשרות 'רכבת תחתית' כאמצעי תחבורה מועדף.
TRAIN מציין את הרכבת כאמצעי תחבורה מועדף.
TRAM מציין חשמלית כאמצעי התחבורה המועדף.

קבועים של TransitRoutePreference

google.maps.TransitRoutePreference קבועים

סוג המסלול התקף לתחבורה ציבורית, שניתן לציין ב-TransitOptions. צריך לציין את הערכים האלה לפי ערך או על ידי שימוש בשם הקבוע. לדוגמה, 'LESS_WALKING' או google.maps.TransitRoutePreference.LESS_WALKING.

ניתן לגשת באמצעות חיוג אל const {TransitRoutePreference} = await google.maps.importLibrary("routes"). ראה ספריות ב-Maps JavaScript API.

FEWER_TRANSFERS ההגדרה מציינת שהמסלול המחושב צריך להעדיף מספר מוגבל של החלפות.
LESS_WALKING ההגדרה מציינת שהמסלול המחושב צריך להעדיף מספר מוגבל של הליכה.

ממשק TransitFare

ממשק google.maps.TransitFare

מחיר כרטיס של DirectionsRoute שכולל ערך ומטבע.

currency
סוג:  string
קוד מטבע לפי תקן ISO 4217 שמציין את המטבע שבו המחיר מיוצג.
value
סוג:  number
הערך המספרי של מחיר הכרטיס, מבוטא ב-currency הנתון.

ממשק TransitDetails

ממשק google.maps.TransitDetails

פרטים על היציאה, ההגעה ואמצעי התחבורה שבהם נעשה שימוש בשלב הזה.

arrival_stop
סוג:  TransitStop
תחנת ההגעה של שלב התחבורה הציבורית הזה.
arrival_time
סוג:  Time
זמן ההגעה של השלב הזה, מצוין כאובייקט זמן.
departure_stop
סוג:  TransitStop
תחנת היציאה של השלב הזה בתחבורה הציבורית.
departure_time
סוג:  Time
שעת היציאה של השלב הזה, מצוינת כאובייקט זמן.
headsign
סוג:  string
הכיוון שאליו יש לנסוע בקו הזה, כפי שמסומן בכלי הרכב או בתחנת היציאה.
headway
סוג:  number
מספר השניות הצפוי בין כלי רכב מקבילים בתחנה הזו.
line
סוג:  TransitLine
פרטים על קו התחבורה הציבורית שבו נעשה שימוש בשלב הזה.
num_stops
סוג:  number
מספר העצירות בשלב הזה. כולל את תחנת ההגעה אבל לא את תחנת היציאה.
trip_short_name
סוג:  string
הטקסט שמופיע בלוחות הזמנים ובלוחות השילוט לציון נסיעה בתחבורה ציבורית לנוסעים, לדוגמה, כדי לזהות מספרי רכבות לנסיעות ברכבת. הטקסט מזהה באופן ייחודי נסיעה שבוצעה ביום שירות.

ממשק TransitStop

ממשק google.maps.TransitStop

פרטים על תחנה של תחבורה ציבורית או תחנה.

location
סוג:  LatLng
המיקום של התחנה הזו.
name
סוג:  string
שם התחנה הזו של התחבורה הציבורית.

ממשק TransitLine

ממשק google.maps.TransitLine

מידע על קו התחבורה הציבורית שמפעיל את השלב הזה.

agencies
סוג:  Array<TransitAgency>
חברת התחבורה הציבורית שמפעילה את הקו הזה.
color
סוג:  string
הצבע שבו משתמשים בדרך כלל בשילוט של הקו הזה, מיוצג כמחרוזת הקסדצימלית.
icon
סוג:  string
כתובת ה-URL של סמל שמשויך לשורה הזו.
name
סוג:  string
השם המלא של קו התחבורה הציבורית הזה, למשל "שדרות רוטשילד 8".
short_name
סוג:  string
השם המקוצר של קו התחבורה הציבורית הזה, למשל E.
text_color
סוג:  string
צבע הטקסט שמשמש בדרך כלל בשילוט של הקו הזה, מיוצג כמחרוזת הקסדצימלית.
url
סוג:  string
כתובת ה-URL של הסוכנות, שספציפית לקו התחבורה הציבורית הזה.
vehicle
סוג:  TransitVehicle
סוג כלי הרכב, למשל רכבת או אוטובוס.

ממשק TransitAgency

ממשק google.maps.TransitAgency

מידע על סוכנות שמפעילה קו תחבורה ציבורית.

name
סוג:  string
השם של חברת התחבורה הציבורית הזו.
phone
סוג:  string
מספר הטלפון של חברת התחבורה הציבורית.
url
סוג:  string
כתובת ה-URL של חברת התחבורה הציבורית.

ממשק TransitVehicle

ממשק google.maps.TransitVehicle

מידע על כלי הרכב שפועל על קו תחבורה ציבורית.

icon
סוג:  string
כתובת URL של סמל שתואם לסוג הרכב שמופיע בשורה הזו.
local_icon
סוג:  string
כתובת URL של סמל שתואם לסוג הרכב שבשימוש באזור הזה, במקום לסמל הכללי יותר.
name
סוג:  string
שם לסוג של כלי התחבורה הציבורית הזה, למשל "רכבת" או "אוטובוס".
type
סוג:  VehicleType
סוג כלי הרכב, למשל רכבת, אוטובוס או מעבורת.

קבועים של VehicleType

google.maps.VehicleType קבועים

ערכים אפשריים לסוגי רכב.

ניתן לגשת באמצעות חיוג אל const {VehicleType} = await google.maps.importLibrary("routes"). ראה ספריות ב-Maps JavaScript API.

BUS אוטובוס
CABLE_CAR כלי רכב שפועל על גבי כבל, בדרך כלל על הקרקע. רכבל אווירי יכול להיות מסוג GONDOLA_LIFT.
COMMUTER_TRAIN רכבת נוסעים.
FERRY מעבורת.
FUNICULAR רכב שעולה בשיפוע תלול באמצעות כבל.
GONDOLA_LIFT רכבל.
HEAVY_RAIL רכבת כבדה.
HIGH_SPEED_TRAIN רכבת מהירה.
INTERCITY_BUS אוטובוס בין-עירוני.
METRO_RAIL רכבת קלה.
MONORAIL רכבת מונורייל.
OTHER כלי רכב אחרים.
RAIL רכבת.
SHARE_TAXI מונית שיתופית היא סוג של תחבורה ציבורית באוטובוסים, שמאפשרת להוריד ולאסוף נוסעים בכל מקום במסלול. בדרך כלל, המוניות עושות שימוש ברכבי מיניבוס.
SUBWAY רכבת קלה תת-קרקעית.
TRAM רכבת קלה מעל לקרקע.
TROLLEYBUS אוטובוס חשמלי.

קבועים של UnitSystem

google.maps.UnitSystem קבועים

מערכות היחידה התקינות שאפשר לציין ב-DirectionsRequest.

ניתן לגשת באמצעות חיוג אל const {UnitSystem} = await google.maps.importLibrary("core"). ראה ספריות ב-Maps JavaScript API.

IMPERIAL המדיניות הזו מציינת את המרחקים בDirectionsResult יש לבטא ביחידות אימפריאליות.
METRIC המדיניות הזו מציינת את המרחקים ב-DirectionsResult שיש לבטא ביחידות מטריות.

ממשק מרחק

ממשק google.maps.Distance

ייצוג של המרחק כערך מספרי ומחרוזת תצוגה.

text
סוג:  string
מחרוזת ייצוגית של ערך המרחק, באמצעות UnitSystem שצוין בבקשה.
value
סוג:  number
המרחק במטרים.

ממשק Duration (משך זמן)

ממשק google.maps.Duration

ייצוג של משך הזמן כערך מספרי ומחרוזת תצוגה.

text
סוג:  string
מחרוזת ייצוגית של ערך משך הזמן.
value
סוג:  number
משך הזמן בשניות.

ממשק Time

ממשק google.maps.Time

ייצוג של זמן כאובייקט תאריך, מחרוזת מותאמת לשוק המקומי ואזור זמן.

text
סוג:  string
מחרוזת שמייצגת את ערך הזמן. השעה מוצגת באזור הזמן של תחנת התחבורה הציבורית.
time_zone
סוג:  string
אזור הזמן שבו נמצאת העצירה. הערך הוא שם אזור הזמן כפי שמוגדר במסד הנתונים של אזור הזמן IANA, לדוגמה: "America/New_York".
value
סוג:  Date
שעת היציאה או ההגעה הזו, מצוינת כאובייקט תאריך של JavaScript.

קבועים של DirectionsTravelMode

google.maps.DirectionsTravelMode קבועים

קבועים של DirectionsUnitSystem

google.maps.DirectionsUnitSystem קבועים