Directions

‫DirectionsService class

google.maps.DirectionsService class

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

אפשר להתקשר אל 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 constants

google.maps.DirectionsStatus constants

הסטטוס שמוחזר על ידי 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 לא ניתן היה לבצע קידוד גיאוגרפי לפחות לאחד מהמקור, היעד או נקודות הביניים.
OK התשובה מכילה DirectionsResult תקין.
OVER_QUERY_LIMIT הדף חרג ממגבלת הבקשות בפרק זמן קצר מדי.
REQUEST_DENIED לדף האינטרנט אין הרשאה להשתמש בשירות ההוראות.
UNKNOWN_ERROR לא ניתן לעבד בקשה להוראות הגעה בגלל שגיאה בשרת. אם תנסו שוב, יכול להיות שהבקשה תצליח.
ZERO_RESULTS לא נמצא מסלול בין נקודת המוצא ליעד.

ממשק DirectionsResult

google.maps.DirectionsResult ממשק

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

‫DirectionsRenderer class

google.maps.DirectionsRenderer class

רכיב שמציג מסלולים שהתקבלו מ-DirectionsService.

הכיתה הזו היא הרחבה של MVCObject.

אפשר להתקשר אל const {DirectionsRenderer} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
DirectionsRenderer
DirectionsRenderer([opts])
פרמטרים: 
יוצר את רכיב ה-Renderer עם האפשרויות שצוינו. אפשר להציג את ההוראות במפה (כשכבות-על חזותיות) או בנוסף בחלונית <div> (כהוראות טקסטואליות).
getDirections
getDirections()
פרמטרים:  אין
ערך מוחזר:  DirectionsResult
הפונקציה מחזירה את קבוצת הכיוונים הנוכחית של רכיב ה-renderer.
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)
פרמטרים: 
  • routeIndex:  number
ערך מוחזר:  אין
מגדירים את האינדקס (החל מ-0) של המסלול באובייקט 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
המאפיין הזה מציין אם רכיב ה-renderer צריך לספק רשימה של מסלולים שמוצגת בחלונית ההוראות, והמשתמש יכול לבחור מתוכה.
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 interface

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 של Static Maps API).
overview_polyline
סוג:  string
ייצוג של קו פוליגוני מקודד של המסלול ב-overview_path. הקו הפוליגוני הזה הוא נתיב משוער (מוחלק) של ההוראות שמתקבלות.
summary
סוג:  string
מכיל תיאור טקסטואלי קצר של המסלול, שמתאים למתן שם למסלול ולהבחנה בינו לבין מסלולים חלופיים.
warnings
סוג:  Array<string>
אזהרות שיוצגו כשמציגים את ההוראות האלה.
waypoint_order
סוג:  Array<number>
אם optimizeWaypoints הוגדר ל-true, השדה הזה יכיל את הפרמוט של נקודות הציון שהוזנו, אחרי שסודרו מחדש. לדוגמה, אם הקלט היה:
  מקור: לוס אנג'לס
  נקודות עצירה: דאלאס, בנגור, פיניקס
  יעד: ניו יורק
והפלט שעבר אופטימיזציה היה מסודר כך:
  מקור: לוס אנג'לס
  נקודות עצירה: פיניקס, דאלאס, בנגור
  יעד: ניו יורק
אז השדה הזה יהיה Array ויכיל את הערכים [2, 0, 1]. שימו לב: המספור של נקודות הציון מבוסס על אפסים.‫
אם לאחת מנקודות הביניים שהוזנו מוגדר הערך stopover ‏false, השדה הזה יהיה ריק, כי אופטימיזציה של מסלולים לא זמינה לשאילתות כאלה.
fare optional
סוג:  TransitFare optional
המחיר הכולל של כרטיס הנסיעה בתחבורה הציבורית. המאפיין הזה רלוונטי רק לבקשות שקשורות לתחבורה ציבורית.

ממשק DirectionsLeg

google.maps.DirectionsLeg ממשק

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