Route (beta)

Route class

google.maps.routes.Route class

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

אפשר להתקשר אל const {Route} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
computeRoutes
computeRoutes(request)
פרמטרים: 
ערך מוחזר:  Promise<{
  routes:Array<Route> optional,
  fallbackInfo:FallbackInfo optional,
  geocodingResults:GeocodingResults optional
}>
הפונקציה מחזירה את המסלול הראשי יחד עם מסלולים חלופיים אופציונליים, בהינתן קבוצה של נקודות ציון סופיות ונקודות ציון ביניים.

הערה: בשיטה הזו צריך לציין מסכת שדות של תגובה בבקשה על ידי הגדרת המאפיין ComputeRoutesRequest.fields. הערך הוא רשימה של נתיבי שדות.

לדוגמה:
  • אנונימיזציה של כל השדות הזמינים: fields: ['*']
  • אנונימיזציה של שדות ברמת המסלול: משך, מרחק ונתיב: fields: ['durationMillis', 'distanceMeters', 'path']

לא מומלץ להשתמש באנונימיזציה של שדות תגובה עם תו כללי לחיפוש fields: ['*'] כי:
  • בחירה רק של השדות שאתם צריכים עוזרת לשרת שלנו לחסוך במחזורי חישוב, וכך אנחנו יכולים להחזיר לכם את התוצאה עם זמן אחזור נמוך יותר.
  • בחירה רק של השדות שאתם צריכים בעבודת הייצור מבטיחה ביצועים יציבים של זמן האחזור. יכול להיות שבעתיד נוסיף עוד שדות תשובה, והשדות החדשים האלה עשויים לדרוש זמן חישוב נוסף. אם תבחרו את כל השדות, או את כל השדות ברמה העליונה, יכול להיות שתחוו ירידה בביצועים כי כל שדה חדש שנוסיף ייכלל אוטומטית בתשובה.
  • בחירה רק של השדות שאתם צריכים מובילה לגודל תגובה קטן יותר, ולכן לטעינה מהירה יותר ברשת.
description
סוג:  string optional
תיאור של המסלול.
distanceMeters
סוג:  number optional
מרחק הנסיעה במסלול, במטרים.
durationMillis
סוג:  number optional
משך הזמן שנדרש כדי לנווט במסלול, באלפיות השנייה. אם מגדירים את ComputeRoutesRequest.routingPreference ל-TRAFFIC_UNAWARE, הערך הזה זהה לערך של Route.staticDurationMillis. אם מגדירים את ComputeRoutesRequest.routingPreference לערך TRAFFIC_AWARE או TRAFFIC_AWARE_OPTIMAL, המערכת מחשבת את הערך הזה תוך התחשבות בתנאי התנועה.

הערה: אם משך הזמן ארוך מ-2^53 מילישניות, הערך הזה הוא Number.POSITIVE_INFINITY.
legs
סוג:  Array<RouteLeg> optional
אוסף של קטעים (קטעי נתיב בין נקודות ציון) שמרכיבים את המסלול. כל קטע תואם לנסיעה בין שתי נקודות ציון שאינן via.

לדוגמה:
  • למסלול בלי נקודות עצירה ביניים יש רק קטע אחד.
  • מסלול שכולל נקודת ביניים אחת שאינה via, כולל שני קטעי דרך.
  • למסלול שכולל נקודת ציון אחת via יש קטע אחד.
סדר מקטעי המסלול תואם לסדר נקודות הציון מ-origin אל intermediates אל destination.
localizedValues
סוג:  RouteLocalizedValues optional
ייצוגים של מאפיינים של Route בצורת טקסט.
optimizedIntermediateWaypointIndices
סוג:  Array<number> optional
אם מגדירים את ComputeRoutesRequest.optimizeWaypointOrder ל-true, השדה הזה מכיל את הסדר האופטימלי של נקודות הביניים. אחרת, השדה הזה ריק. האינדקס מתחיל ב-0 עבור נקודת הביניים הראשונה שמופיעה בקלט.

לדוגמה, אם מזינים את הקלט:
  • מקור: LA
  • נקודות ציון ביניים: דאלאס, בנגור, פיניקס
  • יעד: ניו יורק
וסדר נקודות הביניים שעבר אופטימיזציה הוא פיניקס, דאלאס, בנגור, הערך בשדה הזה יהיה [2, 0, 1].
path
סוג:  Array<LatLngAltitude> optional
רשימת LatLngAltitudes של המסלול, שאפשר להשתמש בה כדי לשרטט קו פוליגוני של המסלול. אפשר לשלוט בגרנולריות של הנתיב באמצעות ההגדרה ComputeRoutesRequest.polylineQuality.
polylineDetails
סוג:  PolylineDetails optional
כולל מידע על פרטים לאורך הנתיב.
routeLabels
סוג:  Array<RouteLabel> optional
תוויות של המסלול שימושיות לזיהוי מאפיינים ספציפיים או להשוואה ביניהם.
routeToken
סוג:  string optional
טוקן אטום שאפשר להעביר אל Navigation SDK כדי לשחזר את המסלול במהלך הניווט, ובמקרה של שינוי מסלול, כדי לכבד את הכוונה המקורית כשנוצר המסלול. האסימון הזה הוא אובייקט אטום. אל תשוו את הערך שלו בין בקשות, כי הערך עשוי להשתנות גם אם השירות מחזיר את אותו מסלול בדיוק.

הערה: routeToken זמין רק לבקשות שבהן הערך של ComputeRoutesRequest.routingPreference הוא TRAFFIC_AWARE או TRAFFIC_AWARE_OPTIMAL. היא לא נתמכת בבקשות עם via נקודות ציון.
speedPaths
סוג:  Array<SpeedPath> optional
קבוצות של קטעים בנתיב המסלול עם קריאת המהירות המתאימה. כדי שהשדה הזה יאוכלס, צריך להגדיר את ComputeRoutesRequest.routingPreference ל-TRAFFIC_AWARE או ל-TRAFFIC_AWARE_OPTIMAL, ואת ComputeRoutesRequest.extraComputations לכלול את TRAFFIC_ON_POLYLINE.
staticDurationMillis
סוג:  number optional
משך הנסיעה במסלול בלי להתחשב במצב התנועה.

הערה: אם משך הזמן ארוך מ-2^53 מילישניות, הערך הזה הוא Number.POSITIVE_INFINITY.
travelAdvisory
סוג:  RouteTravelAdvisory optional
מידע נוסף על המסלול.
viewport
סוג:  LatLngBounds optional
תיבת התוחמת של אזור התצוגה של המסלול.
warnings
סוג:  Array<string> optional
מערך של אזהרות שיוצגו כשמציגים את המסלול.
createPolylines
createPolylines([options])
פרמטרים: 
ערך מוחזר:  Array<Polyline>
יוצר קווים שבורים למסלול על סמך הנתונים הזמינים.

קווים פוליגוניים מרובי-אופנים:
  • דרישות:
  • יוצרת קו פוליגון לכל קטע במסלול שכולל כמה אמצעי תחבורה. קווי פוליגון מעוצבים בהתאם לאמצעי התחבורה של הקטע ולנתוני קו התחבורה הציבורית, אם הם זמינים. אפשר להעביר אפשרויות כדי לשנות את הסגנון של הקו המקומפל בהתאם לאמצעי התחבורה ולקו התחבורה הציבורית.

קווי פוליגון של תנועה:
  • דרישות:
  • יוצר קו פוליגון לכל מרווח של מסלול כשהקריאה של המהירות שונה מהמרווח הקודם. כברירת מחדל, קווים פוליגוניים מעוצבים לפי מהירות. אפשר להעביר אפשרויות כדי לשנות את סגנון הקו המקומקע בהתאם למהירות.

קו פוליגוני כולל:
  • דרישות:
  • יוצרת קו פוליגוני אחד לכל המסלול עם סגנון ברירת מחדל. אפשר להעביר אפשרויות כדי לשנות את הסגנון של הקו המקומט בהתאם לאמצעי התחבורה של המסלול. כדי לבצע התאמה אישית נוספת, אפשר ליצור קווים שבורים ישירות באמצעות Route.path או RouteLeg.path.
createWaypointAdvancedMarkers
createWaypointAdvancedMarkers([options])
פרמטרים: 
ערך מוחזר:  Promise<Array<AdvancedMarkerElement>>
יוצר סמנים למסלול עם התוויות 'א', 'ב', 'ג' וכו' לכל נקודת ציון. לסמנים מוחל עיצוב ברירת מחדל. אפשר להעביר אפשרויות כדי לשנות את סגנון הסמן על סמך אינדקס הסמן או המאפיינים של RouteLeg המתאים. הפרמטר WaypointMarkerDetails.leg לא יוגדר אם למסלול אין קטעים.

כדי לכלול נקודות ציון ביניים, צריך לבקש את השדה "legs" ב-ComputeRoutesRequest.fields.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫ComputeRoutesRequest interface

google.maps.routes.ComputeRoutesRequest ממשק

בקשה למסלולים.
destination
היעד של המסלול. ערך שמועבר כמחרוזת יכול להיות כתובת, קוד פלוס או שם של משאב Place. ערכי הגובה לא נלקחים בחשבון בחישוב המסלולים.
fields
סוג:  Iterable<string>
אוסף של שדות לאחזור. מציינים ["*"] לכל השדות.
origin
נקודת המוצא של המסלול. ערך שמועבר כמחרוזת יכול להיות כתובת, קוד פלוס או שם של משאב Place. ערכי הגובה לא נלקחים בחשבון בחישוב המסלולים.
arrivalTime optional
סוג:  Date optional
שעת ההגעה.

הערה: אפשר להגדיר את הערך הזה רק אם הערך של ComputeRoutesRequest.travelMode הוא TRANSIT. אפשר לציין את ComputeRoutesRequest.departureTime או את ComputeRoutesRequest.arrivalTime, אבל לא את שניהם. אפשר לראות נסיעות בתחבורה ציבורית עד 7 ימים אחורה או עד 100 ימים קדימה.
computeAlternativeRoutes optional
סוג:  boolean optional
מציין אם לחשב מסלולים חלופיים בנוסף למסלול. לא מוחזרים מסלולים חלופיים לבקשות שכוללות נקודות ציון ביניים.
departureTime optional
סוג:  Date optional
שעת היציאה. אם לא מגדירים את הערך הזה, ערך ברירת המחדל הוא הזמן שבו שלחתם את הבקשה.

הערה: אפשר לציין זמן בעבר רק אם הערך של ComputeRoutesRequest.travelMode הוא TRANSIT. אפשר לראות נסיעות בתחבורה ציבורית עד 7 ימים אחורה או עד 100 ימים קדימה.
extraComputations optional
רשימה של חישובים נוספים שאפשר להשתמש בהם כדי להשלים את הבקשה.

הערה: יכול להיות שהחישובים הנוספים האלה יחזירו שדות נוספים בתגובה. כדי שהשדות הנוספים האלה יוחזרו בתגובה, צריך לציין אותם גם ב-ComputeRoutesRequest.fields.
intermediates optional
סוג:  Iterable<Waypoint> optional
קבוצה של נקודות ציון לאורך המסלול (לא כולל נקודות קצה), לעצירה או למעבר. אפשר להוסיף עד 25 נקודות עצירה במסלול.
language optional
סוג:  string optional
קוד השפה בפורמט BCP-47, כמו en-US או sr-Latn. מידע נוסף זמין במאמר Unicode Locale Identifier. כאן אפשר לעיין ברשימת השפות הנתמכות. אם לא מציינים את הערך הזה, השפה נקבעת לפי הגדרות הלוקליזציה של Google Maps JavaScript API. אחרת, השפה נקבעת לפי המיקום של המקור.
optimizeWaypointOrder optional
סוג:  boolean optional
אם הערך מוגדר כ-true, השירות מנסה למזער את העלות הכוללת של המסלול על ידי שינוי הסדר של נקודות הביניים שצוינו. הבקשה נכשלת אם אחת מנקודות הביניים היא נקודת מעבר. משתמשים בRoute.optimizedIntermediateWaypointIndices בתשובה כדי למצוא את הסדר החדש. אם לא מבקשים את "optimizedIntermediateWaypointIndices" ב-ComputeRoutesRequest.fields, הבקשה נכשלת. אם המדיניות מוגדרת כ-False, הערך של Route.optimizedIntermediateWaypointIndices בתגובה יהיה ריק.
polylineQuality optional
סוג:  PolylineQuality optional
מציין את ההעדפה לגבי איכות הקו המקוקו.
region optional
סוג:  string optional
קוד האזור, שמוגדר כערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. מידע נוסף זמין במאמר דומיינים ברמה העליונה עם קוד מדינה. אם לא מציינים את הערך הזה, האזור נקבע לפי הגדרות הלוקליזציה של Google Maps JavaScript API. אחרת, האזור יוסק ממיקום המקור.
requestedReferenceRoutes optional
סוג:  Iterable<ReferenceRoute> optional
מציין אילו מסלולי הפניה לחשב כחלק מהבקשה בנוסף למסלול ברירת המחדל. מסלול ייחוס הוא מסלול עם יעד שונה לחישוב המסלול בהשוואה למסלול ברירת המחדל. לדוגמה, כשמחשבים מסלול ייחוס FUEL_EFFICIENT, המערכת מביאה בחשבון פרמטרים שונים כדי ליצור מסלול אופטימלי שחוסך בדלק. כשמשתמשים בתכונה הזו, מחפשים את הסמל Route.routeLabels במסלולים שמוצגים.
routeModifiers optional
סוג:  RouteModifiers optional
קבוצת תנאים שצריך לעמוד בהם, שמשפיעים על אופן חישוב המסלולים. לדוגמה, אפשר לציין מאפיינים שרוצים להימנע מהם, כמו כבישי אגרה או כבישים מהירים.
routingPreference optional
סוג:  RoutingPreference optional
מציינת איך לחשב את המסלול. השרת מנסה להשתמש בהעדפת הניתוב שנבחרה כדי לחשב את המסלול. אם העדפת הניתוב גורמת לשגיאה או לזמן אחזור ארוך במיוחד, מוחזרת שגיאה. אפשר לציין את האפשרות הזו רק אם הערך של ComputeRoutesRequest.travelMode הוא DRIVING או TWO_WHEELER, אחרת הבקשה תיכשל.
trafficModel optional
סוג:  TrafficModel optional
מציינת את ההנחות שמשמשות לחישוב הזמן בפקקים. ההגדרה הזו משפיעה על הערך של Route.durationMillis ושל RouteLeg.durationMillis, שמכילים את הזמן המשוער בפקקים על סמך ממוצעים היסטוריים. האפשרות ComputeRoutesRequest.trafficModel זמינה רק לבקשות שבהן הערך של ComputeRoutesRequest.routingPreference הוא TRAFFIC_AWARE_OPTIMAL והערך של ComputeRoutesRequest.travelMode הוא DRIVING. ברירת המחדל היא BEST_GUESS.
transitPreference optional
סוג:  TransitPreference optional
ההגדרה הזו מציינת העדפות שמשפיעות על המסלול שמוחזר עבור TRANSIT מסלולים.

הערה: אפשר לציין את הערך הזה רק אם הערך של ComputeRoutesRequest.travelMode הוא TRANSIT.
travelMode optional
סוג:  TravelMode optional
מציינים את אמצעי התחבורה.
units optional
סוג:  UnitSystem optional
מציין את יחידות המידה של שדות התצוגה, כמו הוראות ניווט. הערך הזה לא משפיע על יחידות המידה שמשמשות לחישוב המרחק והמשך של המסלול, של קטע המסלול ושל כל שלב. אם לא תציינו את הערך הזה, יחידות התצוגה יוסקו ממיקום המקור.

ComputeRoutesExtraComputation constants

google.maps.routes.ComputeRoutesExtraComputation constants

חישובים נוספים לביצוע עבור בקשת Route.computeRoutes.

אפשר להתקשר אל const {ComputeRoutesExtraComputation} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
FLYOVER_INFO_ON_POLYLINE מידע על מעבר מעל המסלול או המסלולים. כדי לקבל את המידע הזה, צריך לציין את השדה "polylineDetails" ב-ComputeRoutesRequest.fields. הנתונים האלה מאוכלסים כרגע רק עבור אזורים מטרופוליטניים מסוימים בהודו. התכונה הזו ניסיונית, והמק"ט או החיוב עשויים להשתנות.
FUEL_CONSUMPTION צריכת הדלק המשוערת במסלולים.
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS הוראות ניווט שמוצגות כמחרוזת טקסט בפורמט HTML. התוכן הזה נועד לקריאה כמו שהוא, והוא מוצג רק לצורך המחשה. אל תנתחו אותו באופן פרוגרמטי.
NARROW_ROAD_INFO_ON_POLYLINE מידע על כבישים צרים במסלולים. כדי לקבל את המידע הזה, צריך לציין את השדה "polylineDetails" ב-ComputeRoutesRequest.fields. הנתונים האלה מאוכלסים כרגע רק עבור אזורים מטרופוליטניים מסוימים בהודו. התכונה הזו ניסיונית, והמק"ט או החיוב עשויים להשתנות.
TOLLS מידע על אגרות בכבישים במסלול או במסלולים.
TRAFFIC_ON_POLYLINE קווי פוליגון של המסלולים עם נתוני תנועה.

‫DirectionalLocationLiteral interface

google.maps.routes.DirectionalLocationLiteral ממשק

אפשר להשתמש במקום במופעים של DirectionalLocation במילולי אובייקטים, כדי להקל על השימוש. הם מומרים ל-DirectionalLocation כשהם מזוהים על ידי Maps JS API.

הממשק הזה מרחיב את LatLngAltitudeLiteral.

heading optional
סוג:  number optional
הכיוון במצפן שמשויך לכיוון זרימת התנועה. ערכי הכותרת יכולים להיות מספרים מ-0 עד 360, כאשר 0 מציין כותרת של צפון, 90 מציין כותרת של מזרח וכן הלאה. אפשר להשתמש בשדה הזה רק ב-DRIVING וב-TWO_WHEELER ComputeRoutesRequest.travelMode.
בירושה: altitude, lat, lng

‫DirectionalLocation class

google.maps.routes.DirectionalLocation class

רכיב שמכיל נקודה גיאוגרפית וכותרת אופציונלית.

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

במחלקה הזו מיושם DirectionalLocationLiteral.

אפשר להתקשר אל const {DirectionalLocation} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
Inherited: LatLngAltitude
heading
סוג:  number optional
הכיוון במצפן שמשויך לכיוון זרימת התנועה. ערכי הכותרת יכולים להיות מספרים מ-0 עד 360, כאשר 0 מציין כותרת של צפון, 90 מציין כותרת של מזרח וכן הלאה. אפשר להשתמש בשדה הזה רק ב-DRIVING וב-TWO_WHEELER ComputeRoutesRequest.travelMode.
בירושה: altitude, lat, lng
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  DirectionalLocationLiteral
הפונקציה ממירה לאובייקט.
Inherited: equals

‫FallbackInfo class

google.maps.routes.FallbackInfo class

מידע שקשור לאופן שבו נעשה שימוש בתוצאת גיבוי בתגובה של Route.computeRoutes ולסיבה לכך. אם השדה הזה מוגדר, המשמעות היא שהשרת השתמש במצב ניתוב שונה ממצב ברירת המחדל המועדף שלכם.

אפשר להתקשר אל const {FallbackInfo} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
reason
סוג:  FallbackReason optional
הסיבה לכך שהתשובה החלופית שימשה במקום התשובה המקורית. השדה הזה מאוכלס רק כשמופעל מצב חזרה למצב הקודם ומוחזרת תגובת החזרה למצב הקודם.
routingMode
סוג:  FallbackRoutingMode optional
מצב הניתוב ששימש לתשובה. אם הופעל מעבר לגיבוי, יכול להיות שהמצב יהיה שונה מהעדפת הניתוב שהוגדרה בבקשת הלקוח המקורית.

FallbackReason constants

google.maps.routes.FallbackReason constants

הסיבה לכך שהוחזרה תגובת גיבוי בתגובה Route.computeRoutes.

אפשר להתקשר אל const {FallbackReason} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
LATENCY_EXCEEDED לא הצלחנו לסיים את החישוב עם מצב הניתוב המועדף שלך בזמן, אבל הצלחנו להחזיר תוצאה שחושבה באמצעות מצב חלופי.
SERVER_ERROR קרתה שגיאת שרת במהלך חישוב המסלולים במצב הניתוב המועדף שלך, אבל הצלחנו להחזיר תוצאה שחושבה במצב חלופי.

FallbackRoutingMode constants

google.maps.routes.FallbackRoutingMode constants

מצב הניתוב בפועל שבו נעשה שימוש כשמוחזרת תשובה חלופית בתשובה של Route.computeRoutes.

אפשר להתקשר אל const {FallbackRoutingMode} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
TRAFFIC_AWARE מציין שנעשה שימוש ב-TRAFFIC_AWARE RoutingPreference כדי לחשב את התגובה.
TRAFFIC_UNAWARE מציין שנעשה שימוש ב-TRAFFIC_UNAWARE RoutingPreference כדי לחשב את התגובה.

‫GeocodedWaypoint class

google.maps.routes.GeocodedWaypoint class

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

אפשר להתקשר אל const {GeocodedWaypoint} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
geocoderStatus
סוג:  RPCStatus optional
מציין את קוד הסטטוס שמתקבל מפעולת הגיאוקודינג.
intermediateWaypointRequestIndex
סוג:  number optional
האינדקס של נקודת הביניים המתאימה בבקשה. השדה הזה מאוכלס רק אם ציון הדרך התואם הוא ציון דרך ביניים.
partialMatch
סוג:  boolean
מציין שהגיאוקודר לא החזיר התאמה מדויקת לבקשה המקורית, אבל הוא הצליח להתאים חלק מכתובת הבקשה. כדאי לבדוק את הבקשה המקורית ולחפש שגיאות כתיב או כתובת לא מלאה.
placeId
סוג:  string
מזהה המקום של התוצאה הזו.
types
סוג:  Array<string>
סוגי התוצאות, בצורה של אפס או יותר תגי סוג. סוגים נתמכים מפורטים בכתובת https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

GeocodingResults class

google.maps.routes.GeocodingResults class

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

אפשר להתקשר אל const {GeocodingResults} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
destination
סוג:  GeocodedWaypoint optional
נקודת הציון הגיאוגרפית של היעד.
intermediates
סוג:  Array<GeocodedWaypoint> optional
רשימה של נקודות ציון ביניים עם מיקום גיאוגרפי, שכל אחת מהן מכילה שדה אינדקס שתואם למיקום של נקודת הציון בסדר שבו היא צוינה בבקשה (המיקום מתחיל מאפס).
origin
סוג:  GeocodedWaypoint optional
נקודת הדרך שהומרה לקואורדינטות של המקור.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫MultiModalSegment class

google.maps.routes.MultiModalSegment class

מספק מידע מסוכם על קטע רב-אמצעי של RouteLeg.steps של מסלול. פלח מולטי-מודאלי מוגדר כקטע אחד או יותר של RouteLegStep רצופים עם אותו TravelMode.

אפשר להתקשר אל const {MultiModalSegment} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
instructions
סוג:  string optional
הוראות לניווט בפלח הזה עם כמה אופנים.
maneuver
סוג:  string optional
התמרון שצריך לבצע בשלב הזה בניווט. בקטע תמרון תוכלו לעיין ברשימה של הערכים האפשריים.
stepEndIndex
סוג:  number
האינדקס התואם RouteLegStep שהוא סוף של מקטע מולטימודאלי.
stepStartIndex
סוג:  number
האינדקס התואם RouteLegStep שמתחיל פלח רב-אופני.
travelMode
סוג:  TravelMode optional
אמצעי התחבורה שבו נעשה שימוש בקטע הזה של נסיעה בכמה אמצעי תחבורה.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

PolylineDetailInfo class

google.maps.routes.PolylineDetailInfo class

כולל מידע על מאפיין של כביש לאורך קטע של קו פוליגוני.

אפשר להתקשר אל const {PolylineDetailInfo} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
endIndex
סוג:  number optional
האינדקס לסיום של תכונת הכביש הזו בקו הפוליגוני.
presence
סוג:  RoadFeatureState optional
מציין אם מאפיין הכביש קיים לאורך הקו הפוליגוני.
startIndex
סוג:  number optional
אינדקס ההתחלה של תכונת הכביש הזו בקו הפוליגוני.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‪PolylineDetails class

google.maps.routes.PolylineDetails class

פרטים שמתאימים לאינדקס נתון או לפלח רציף של קו פוליגוני. בהינתן קו פוליגוני עם נקודות P_0, ‏ P_1,‏ ... , ‏ P_N (אינדקס מבוסס-אפס), התג PolylineDetails מתאר תכונת דרך עבור מרווח נתון.

אפשר להתקשר אל const {PolylineDetails} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
flyoverInfo
פרטים על המעוף מעל קו הפוליגון.
narrowRoadInfo
פרטים על כביש צר לאורך הקו המקוטע.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

PolylineQuality constants

google.maps.routes.PolylineQuality constants

מציין את האיכות של הקו המרובה.

אפשר להתקשר אל const {PolylineQuality} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
HIGH_QUALITY התנאי הזה מציין קו פוליגוני באיכות גבוהה שמורכב מיותר נקודות מ-OVERVIEW, על חשבון הגדלת גודל התגובה. משתמשים בערך הזה כשרוצים דיוק רב יותר.
OVERVIEW מציין קו פוליגון של סקירה כללית שמורכב ממספר קטן של נקודות. השימוש באפשרות הזו מאפשר זמן אחזור קצר יותר של הבקשה בהשוואה לשימוש ב-HIGH_QUALITY. משתמשים בערך הזה כשמציגים סקירה כללית של המסלול.

ReferenceRoute constants

google.maps.routes.ReferenceRoute constants

מסלול ייחוס נתמך ב-ComputeRoutesRequest.

אפשר להתקשר אל const {ReferenceRoute} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
FUEL_EFFICIENT מסלול חסכוני בדלק.
SHORTER_DISTANCE מסלול עם מרחק נסיעה קצר יותר.

קבועים של RoadFeatureState

google.maps.routes.RoadFeatureState constants

האובייקט הזה מכיל את המצבים של מאפייני הכביש לאורך קו פוליגוני.

אפשר להתקשר אל const {RoadFeatureState} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
DOES_NOT_EXIST תכונת הכביש לא קיימת.
EXISTS תכונת הכביש קיימת.

RouteLabel constants

google.maps.routes.RouteLabel constants

תוויות של המסלול שעוזרות לזהות נכסים ספציפיים כדי להשוות אותם לנכסים אחרים.

אפשר להתקשר אל const {RouteLabel} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
DEFAULT_ROUTE מסלול ברירת המחדל 'הטוב ביותר' שמוחזר לחישוב המסלול.
DEFAULT_ROUTE_ALTERNATE מסלול חלופי למסלול ברירת המחדל 'הכי טוב'. מסלולים כאלה יוחזרו כשמציינים את ComputeRoutesRequest.computeAlternativeRoutes.
FUEL_EFFICIENT מסלול חסכוני בדלק. המסלולים שמסומנים בערך הזה נחשבים למסלולים אופטימליים מבחינת פרמטרים שקשורים לאיכות הסביבה, כמו צריכת דלק.
SHORTER_DISTANCE מסלול עם מרחק נסיעה קצר יותר. זוהי תכונה ניסיונית.

‫RouteLeg class

google.maps.routes.RouteLeg class

מכיל קטע בין נקודות ציון שאינן via.

אפשר להתקשר אל const {RouteLeg} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
distanceMeters
סוג:  number
מרחק הנסיעה של קטע המסלול, במטרים.
durationMillis
סוג:  number optional
משך הזמן שנדרש כדי לנווט בקטע המסלול באלפיות השנייה. אם מגדירים את ComputeRoutesRequest.routingPreference ל-TRAFFIC_UNAWARE, הערך הזה זהה לערך של staticDurationMillis. אם מגדירים את ComputeRoutesRequest.routingPreference לערך TRAFFIC_AWARE או TRAFFIC_AWARE_OPTIMAL, המערכת מחשבת את הערך הזה תוך התחשבות בתנאי התנועה.

הערה: אם משך הזמן ארוך מ-2^53 מילישניות, הערך הזה הוא Number.POSITIVE_INFINITY.
endLocation
סוג:  DirectionalLocation optional
מיקום הסיום של הקטע הזה. יכול להיות שהמיקום הזה שונה מComputeRoutesRequest.destination. לדוגמה, אם ComputeRoutesRequest.destination לא קרוב לכביש, זו נקודה על הכביש.
localizedValues
סוג:  RouteLegLocalizedValues optional
ייצוגים של מאפיינים של RouteLeg בצורת טקסט.
path
רשימת LatLngAltitude של קטע המסלול, שאפשר להשתמש בה כדי לשרטט קו פוליגוני של קטע המסלול. אפשר לשלוט בגרנולריות של הנתיב באמצעות ההגדרה ComputeRoutesRequest.polylineQuality.
speedPaths
סוג:  Array<SpeedPath>
קיבוצים של קטעים בנתיב של רגל המסלול עם קריאת המהירות המתאימה. כדי שהשדה הזה יאוכלס, צריך להגדיר את ComputeRoutesRequest.routingPreference ל-TRAFFIC_AWARE או ל-TRAFFIC_AWARE_OPTIMAL, ואת ComputeRoutesRequest.extraComputations לכלול את TRAFFIC_ON_POLYLINE.
startLocation
סוג:  DirectionalLocation optional
מיקום ההתחלה של הקטע הזה. יכול להיות שהמיקום הזה שונה מComputeRoutesRequest.origin. לדוגמה, אם ComputeRoutesRequest.origin לא קרוב לכביש, זו נקודה על הכביש.
staticDurationMillis
סוג:  number optional
משך הנסיעה בקטע המסלול בלי להתחשב בתנאי התנועה.

הערה: אם משך הזמן ארוך מ-2^53 מילישניות, הערך הזה הוא Number.POSITIVE_INFINITY.
steps
סוג:  Array<RouteLegStep>
מערך של שלבים שמציינים פלחים בקטע הזה. כל שלב מייצג הוראת ניווט אחת.
stepsOverview
סוג:  StepsOverview optional
מידע כללי על השלבים בRouteLeg. השדה הזה מאוכלס רק במסלולים של TRANSIT.
travelAdvisory
סוג:  RouteLegTravelAdvisory optional
מכיל את המידע הנוסף שהמשתמש צריך לקבל לגבי קטע מסלול, כמו הגבלות אפשריות באזור התנועה.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫RouteLegLocalizedValues class

google.maps.routes.RouteLegLocalizedValues class

ייצוגים של RouteLeg בטקסט.

אפשר להתקשר אל const {RouteLegLocalizedValues} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
distance
סוג:  string optional
מרחק הנסיעה בקטע המסלול בפורמט טקסט.
distanceLanguage
סוג:  string optional
קוד השפה מסוג BCP-47 של טקסט המרחק, למשל en-US או sr-Latn.

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
duration
סוג:  string optional
משך, שמוצג בפורמט טקסט ומותאם לאזור של השאילתה. המסלול מחושב בהתאם למצב התנועה.
durationLanguage
סוג:  string optional
קוד השפה של טקסט משך הזמן בפורמט BCP-47, למשל 'en-US' או 'sr-Latn'.

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
staticDuration
סוג:  string optional
משך הנסיעה בלי להתחשב בתנאי התנועה, שמוצג בפורמט טקסט.
staticDurationLanguage
סוג:  string optional
קוד השפה מסוג BCP-47 של הטקסט הסטטי של משך הזמן, למשל en-US או sr-Latn.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫RouteLegStep class

google.maps.routes.RouteLegStep class

מכיל פלח של RouteLeg. שלב מתאים להוראת ניווט אחת. קטעי דרך במסלול מורכבים משלבים.

אפשר להתקשר אל const {RouteLegStep} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
distanceMeters
סוג:  number
מרחק הנסיעה בשלב הזה, במטרים.
endLocation
סוג:  DirectionalLocation optional
מיקום הסיום של השלב הזה.
instructions
סוג:  string optional
הוראות לניווט בשלב הזה.
localizedValues
סוג:  RouteLegStepLocalizedValues optional
ייצוגים של מאפיינים של RouteLegStep בצורת טקסט.
maneuver
סוג:  string optional
התמרון שצריך לבצע בשלב הזה בניווט. בקטע תמרון תוכלו לעיין ברשימה של הערכים האפשריים.
path
רשימת LatLngAltitude של שלב קטע המסלול, שאפשר להשתמש בה כדי לשרטט קו פוליגוני של שלב קטע המסלול. אפשר לשלוט בגרנולריות של הנתיב באמצעות ההגדרה ComputeRoutesRequest.polylineQuality. כדי שהשדה "path" יאוכלס, צריך לבקש אותו ב-ComputeRoutesRequest.fields.
startLocation
סוג:  DirectionalLocation optional
מיקום ההתחלה של השלב הזה.
staticDurationMillis
סוג:  number optional
משך הנסיעה בשלב הזה בלי להתחשב בתנאי התנועה.

הערה: אם משך הזמן ארוך מ-2^53 מילישניות, הערך הזה הוא Number.POSITIVE_INFINITY.
transitDetails
סוג:  TransitDetails optional
פרטים שקשורים לשלב הזה אם אמצעי התחבורה הוא TRANSIT.
travelMode
סוג:  TravelMode optional
אמצעי התחבורה שבו נעשה שימוש בשלב הזה.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫RouteLegStepLocalizedValues class

google.maps.routes.RouteLegStepLocalizedValues class

ייצוגים של מאפיינים של RouteLegStep בצורת טקסט.

אפשר להתקשר אל const {RouteLegStepLocalizedValues} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
distance
סוג:  string optional
מרחק הנסיעה של שלב המסלול בצורת טקסט.
distanceLanguage
סוג:  string optional
קוד השפה מסוג BCP-47 של טקסט המרחק, למשל en-US או sr-Latn.

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
staticDuration
סוג:  string optional
משך הנסיעה בלי להתחשב בתנאי התנועה, שמוצג בפורמט טקסט.
staticDurationLanguage
סוג:  string optional
קוד השפה מסוג BCP-47 של הטקסט הסטטי של משך הזמן, למשל en-US או sr-Latn.

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫RouteLegTravelAdvisory class

google.maps.routes.RouteLegTravelAdvisory class

מכיל מידע נוסף שהמשתמש צריך לקבל עליו הודעה ב-RouteLeg.

אפשר להתקשר אל const {RouteLegTravelAdvisory} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
speedReadingIntervals
סוג:  Array<SpeedReadingInterval> optional
אינטרוולים של קריאה מהירה עם פרטים על צפיפות התנועה. רלוונטי במקרה של TRAFFIC_AWARE ו-TRAFFIC_AWARE_OPTIMAL ComputeRoutesRequest.routingPreference. המקטעים מכסים את כל הקו המרובה של RouteLeg ללא חפיפה. נקודת ההתחלה של מרווח זמן מסוים זהה לנקודת הסיום של מרווח הזמן הקודם.

דוגמה: 
  polyline: A ---- B ---- C ---- D ---- E ---- F ---- G 
 speedReadingIntervals: [A,C), [C,D), [D,G)
tollInfo
סוג:  TollInfo optional
מכיל מידע על אגרות בכבישים ספציפיים RouteLeg. השדה הזה מאוכלס רק אם צפויים אגרה בRouteLeg. אם השדה הזה מוגדר אבל השדה TollInfo.estimatedPrices לא מאוכלס,אז קיימים אגרה בקטע המסלול אבל המחיר המשוער לא ידוע. אם השדה הזה ריק, לא חלים אגרה על RouteLeg.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

RouteLocalizedValues class

google.maps.routes.RouteLocalizedValues class

ייצוגים של מאפיינים של Route בצורת טקסט.

אפשר להתקשר אל const {RouteLocalizedValues} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
distance
סוג:  string optional
מרחק הנסיעה במסלול, שמוצג כטקסט.
distanceLanguage
סוג:  string optional
קוד השפה מסוג BCP-47 של טקסט המרחק, למשל en-US או sr-Latn.

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
duration
סוג:  string optional
משך, שמוצג בפורמט טקסט ומותאם לאזור של השאילתה. המסלול מחושב בהתאם למצב התנועה. הערה: אם לא ביקשתם מידע על תנועה, הערך הזה זהה לערך של staticDuration.
durationLanguage
סוג:  string optional
קוד השפה של טקסט משך הזמן בפורמט BCP-47, למשל 'en-US' או 'sr-Latn'.

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
staticDuration
סוג:  string optional
משך הנסיעה בלי להתחשב בתנאי התנועה, שמוצג בפורמט טקסט.
staticDurationLanguage
סוג:  string optional
קוד השפה מסוג BCP-47 של הטקסט הסטטי של משך הזמן, למשל en-US או sr-Latn.
transitFare
סוג:  string optional
מחיר הנסיעה בתחבורה ציבורית, שמוצג בפורמט טקסט.
transitFareLanguage
סוג:  string optional
קוד השפה של טקסט מחיר הכרטיס בתקן BCP-47, למשל en-US או sr-Latn.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫RouteModifiers interface

google.maps.routes.RouteModifiers ממשק

מכיל קבוצה של תנאים אופציונליים שצריך לעמוד בהם כשמחשבים מסלולים.
avoidFerries optional
סוג:  boolean optional
אם בוחרים באפשרות true, המערכת תנסה להימנע ממעבורות כשאפשר, ותעדיף מסלולים שלא כוללים מעבורות. ההגדרה חלה רק על DRIVING או על TWO_WHEELER TravelMode.
avoidHighways optional
סוג:  boolean optional
כשההגדרה היא true, המערכת תנסה להימנע מכבישים מהירים כשאפשר, ותעדיף מסלולים שלא כוללים כבישים מהירים. ההגדרה חלה רק על DRIVING או על TWO_WHEELER TravelMode.
avoidIndoor optional
סוג:  boolean optional
כשההגדרה היא true, המערכת מנסה להימנע מניווט בתוך מבנים כשאפשר, ומעדיפה מסלולים שלא כוללים ניווט בתוך מבנים. רלוונטי רק ל-WALKING TravelMode.
avoidTolls optional
סוג:  boolean optional
אם בוחרים באפשרות true, המערכת תנסה להימנע מכבישי אגרה כשאפשר, ותעדיף מסלולים שלא כוללים כבישי אגרה. ההגדרה חלה רק על DRIVING או על TWO_WHEELER TravelMode.
tollPasses optional
סוג:  Iterable<string> optional
כולל מידע על כרטיסי תשלום על נסיעה בכביש אגרה. אם מספקים מינויים לכבישי אגרה, ה-API מנסה להחזיר את מחיר המינוי. אם לא מספקים מינויים לכבישי אגרה, ה-API מתייחס למינוי כאל מינוי לא ידוע ומנסה להחזיר את המחיר במזומן. ההגדרה חלה רק על DRIVING או על TWO_WHEELER TravelMode. במאמר TollPass מופיעה רשימה של ערכים תקינים.
vehicleInfo optional
סוג:  VehicleInfo optional
מציינים את פרטי הרכב.

‫RoutePolylineDetails interface

google.maps.routes.RoutePolylineDetails ממשק

פרטים על קטע של מסלול שמתאים לקו פוליגוני, שאפשר להשתמש בו כדי להתאים אישית את הסגנון של הקו הפוליגוני.
speed optional
סוג:  Speed optional
קריאת המהירות של קטע המסלול שמתאים לקו הפוליגוני הזה. המאפיין הזה מאוכלס רק עבור מסלולים עם מידע על תנועה.
transitDetails optional
סוג:  TransitDetails optional
פרטי התחבורה הציבורית של קטע המסלול שמתאים לקו הפוליגוני הזה. השדה הזה מאוכלס רק במסלולים עם מידע על תחבורה ציבורית.
travelMode optional
סוג:  TravelMode optional
אמצעי התחבורה של קטע המסלול שמתאים לקו הפוליגוני הזה. אם השדה ריק, מדובר בקווי פוליגון של נתוני תנועה.

‫RoutePolylineOptions interface

google.maps.routes.RoutePolylineOptions ממשק

אפשרויות ליצירת קווים שבורים של מסלולים.
colorScheme optional
סוג:  ColorScheme optional
ערכת הצבעים שבה רוצים להשתמש עבור הקו המקוטע. אם מציינים את הערך FOLLOW_SYSTEM כשגם המפה colorScheme היא FOLLOW_SYSTEM, הקווים המקוטעים יצוירו באותו מצב כהה או בהיר כמו המפה. אם לא מציינים את הפרמטר הזה, המערכת מנסה להשתמש בערך Route.createPolylines של המפה או חוזרת לערך ברירת המחדל של המערכת.colorScheme
polylineOptions optional
אפשרויות להתאמה אישית של הסגנון של קו פוליגוני. יכול להיות אובייקט PolylineOptions שמוחל על כל הקווים המקוקווים של המסלול, או פונקציה שמקבלת את ברירת המחדל PolylineOptions ואת RoutePolylineDetails ומחזירה את PolylineOptions שיוחל על הקו המקוקו הזה.

RouteTravelAdvisory class

google.maps.routes.RouteTravelAdvisory class

מכיל מידע נוסף שהמשתמש צריך לקבל עליו הודעה ב-Route.

אפשר להתקשר אל const {RouteTravelAdvisory} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
fuelConsumptionMicroliters
סוג:  number optional
צריכת הדלק הצפויה במיקרוליטרים.

הערה: אם צריכת הדלק גבוהה מ-2^53 מיקרוליטרים, הערך הזה הוא Number.POSITIVE_INFINITY.
routeRestrictionsPartiallyIgnored
סוג:  boolean optional
יכול להיות שבRoute יש הגבלות שלא מתאימות לאמצעי התחבורה או לשינויים במסלול שביקשתם.
speedReadingIntervals
סוג:  Array<SpeedReadingInterval> optional
אינטרוולים של קריאה מהירה עם פרטים על צפיפות התנועה. רלוונטי במקרה של TRAFFIC_AWARE ו-TRAFFIC_AWARE_OPTIMAL ComputeRoutesRequest.routingPreference. המקטעים מכסים את כל הקו המרובה של Route ללא חפיפה. נקודת ההתחלה של מרווח זמן מסוים זהה לנקודת הסיום של מרווח הזמן הקודם.

דוגמה: 
  polyline: A ---- B ---- C ---- D ---- E ---- F ---- G 
 speedReadingIntervals: [A,C), [C,D), [D,G)
tollInfo
סוג:  TollInfo optional
מכיל מידע על אגרות בכבישים בRoute. השדה הזה מאוכלס רק אם צפויים אגרה בRoute. אם השדה הזה מוגדר אבל השדה TollInfo.estimatedPrices לא מאוכלס,סימן שהמסלול כולל אגרה אבל המחיר המשוער לא ידוע. אם השדה הזה ריק, לא חלים אגרה על Route.
transitFare
סוג:  Money optional
אם המאפיין קיים, הוא מכיל את המחיר הכולל של הכרטיס או של כרטיסי הנסיעה של Route. המאפיין הזה מוחזר רק עבור TRANSIT ComputeRoutesRequest.travelMode ורק עבור מסלולים שבהם יש מידע על תעריפים לכל שלבי הנסיעה בתחבורה הציבורית.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

קבועים של RoutingPreference

google.maps.routes.RoutingPreference constants

גורמים שצריך לקחת בחשבון כשמחשבים מסלול.

אפשר להתקשר אל const {RoutingPreference} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
TRAFFIC_AWARE חישוב מסלולים תוך התחשבות בתנאי התנועה בזמן אמת. בניגוד ל-TRAFFIC_AWARE_OPTIMAL, חלק מהאופטימיזציות מיועדות לצמצום משמעותי של זמן האחזור.
TRAFFIC_AWARE_OPTIMAL חישוב המסלולים מתבצע תוך התחשבות בתנאי התנועה בזמן אמת, בלי להחיל את רוב האופטימיזציות של הביצועים. השימוש בערך הזה יוצר את זמן האחזור הגבוה ביותר.
TRAFFIC_UNAWARE חישוב מסלולים בלי להתחשב בתנאי התנועה בזמן אמת. האפשרות הזו מתאימה כשמצב התנועה לא משנה או לא רלוונטי. השימוש בערך הזה יוצר את זמן האחזור הנמוך ביותר.

קבועים של מהירות

google.maps.routes.Speed constants

סיווג המהירות של קו פוליגוני על סמך נתוני תנועה.

אפשר להתקשר אל const {Speed} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
NORMAL מהירות רגילה, אין עומס תנועה.
SLOW זוהה עומס תנועה בינוני.
TRAFFIC_JAM עומסי תנועה.

SpeedPath interface

google.maps.routes.SpeedPath ממשק

מקבצת את ערכי LatLngAltitude של מרווח בנתיב עם קריאת המהירות של המרווח.
path
הנתיב שמכוסה על ידי נתיב המהירות הזה.
speed optional
סוג:  Speed optional
הקראה מהירה של הנתיב.

SpeedReadingInterval class

google.maps.routes.SpeedReadingInterval class

חיווי של צפיפות התנועה בקטע רציף של קו פוליגוני או של נתיב. בהינתן נתיב עם נקודות P_0, ‏ P_1,‏ ... , ‏ P_N (אינדקס מאפס), SpeedReadingInterval מתאר את צפיפות התנועה במרווח.

אפשר להתקשר אל const {SpeedReadingInterval} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
endPolylinePointIndex
סוג:  number optional
האינדקס שבו מסתיים המרווח הזה בקו המפוספס.
speed
סוג:  Speed optional
מהירות התנועה במרווח הזה.
startPolylinePointIndex
סוג:  number optional
אינדקס ההתחלה של המרווח הזה בקו הפוליגוני.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  אין
הפונקציה ממירה לאובייקט.

StepsOverview class

google.maps.routes.StepsOverview class

מספק מידע כללי על רשימה של RouteLeg.steps.

אפשר להתקשר אל const {StepsOverview} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
multiModalSegments
סיכום מידע על פלחים שונים של RouteLeg.steps.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫TollInfo class

google.maps.routes.TollInfo class

התג הזה כולל את פרטי האגרה במכשיר Route או RouteLeg.

אפשר להתקשר אל const {TollInfo} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
estimatedPrices
סוג:  Array<Money> optional
הסכום הכספי של האגרה עבור Route או RouteLeg המתאימים. הרשימה הזו מכילה סכום לכל מטבע שצפוי לחיוב בתחנות אגרה. בדרך כלל הרשימה הזו תכיל רק פריט אחד למסלולים עם אגרה במטבע אחד. בנסיעות בינלאומיות, הרשימה הזו עשויה להכיל כמה פריטים כדי לשקף את האגרה במטבעות שונים.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫TransitAgency class

google.maps.routes.TransitAgency class

מידע על חברת תחבורה ציבורית.

אפשר להתקשר אל const {TransitAgency} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
name
סוג:  string optional
שם חברת התחבורה הציבורית.
phoneNumber
סוג:  string optional
מספר הטלפון של רשות התחבורה הציבורית בפורמט שמותאם לאזור.
url
סוג:  URL optional
כתובת ה-URL של חברת התחבורה הציבורית.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

TransitDetails class

google.maps.routes.TransitDetails class

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

אפשר להתקשר אל const {TransitDetails} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
arrivalStop
סוג:  TransitStop optional
מידע על תחנת ההגעה של השלב.
arrivalTime
סוג:  Date optional
זמן ההגעה המשוער לשלב.
departureStop
סוג:  TransitStop optional
מידע על תחנת היציאה של השלב.
departureTime
סוג:  Date optional
זמן היציאה המשוער של השלב.
headsign
סוג:  string optional
מציין את הכיוון שבו נוסעים בקו הזה, כפי שמסומן בכלי הרכב או בתחנת היציאה. הכיוון הוא בדרך כלל תחנת הקצה.
headwayMillis
סוג:  number optional
מציין את הזמן הצפוי באלפיות השנייה בין היציאות מאותה תחנה בשעה הזו. לדוגמה, אם הערך של headway הוא 600,000, אפשר לצפות להמתנה של עשר דקות אם פספסתם את האוטובוס.

הערה: אם ההפרש עולה על ‎2^53 מילישניות, הערך הזה הוא Number.POSITIVE_INFINITY.
stopCount
סוג:  number
מספר התחנות מהתחנה שממנה יוצאים ועד לתחנת ההגעה. הספירה הזו כוללת את תחנת ההגעה, אבל לא את תחנת היציאה. לדוגמה, אם המסלול מתחיל בתחנה א', עובר דרך תחנות ב' ו-ג' ומגיע לתחנה ד', הערך של stopCount יהיה 3.
transitLine
סוג:  TransitLine optional
מידע על קו התחבורה הציבורית שבו נעשה שימוש בשלב.
tripShortText
סוג:  string optional
הטקסט שמופיע בלוחות זמנים ובשלטי מידע כדי לזהות נסיעה בתחבורה ציבורית לנוסעים. הטקסט מזהה באופן ייחודי נסיעה ביום שירות. לדוגמה, '538' הוא tripShortText של רכבת Amtrak שיוצאת מסן חוזה, קליפורניה בשעה 15:10 בימי חול לסקרמנטו, קליפורניה.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫TransitLine class

google.maps.routes.TransitLine class

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

אפשר להתקשר אל const {TransitLine} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
agencies
סוג:  Array<TransitAgency>
חברת התחבורה הציבורית (או חברות התחבורה הציבוריות) שמפעילה את קו התחבורה הציבורית הזה.
color
סוג:  string optional
הצבע שמשמש בדרך כלל בשילוט של הקו הזה. מיוצג בפורמט הקסדצימלי.
iconURL
סוג:  URL optional
כתובת ה-URL של הסמל שמשויך לשורה הזו.
name
סוג:  string optional
השם המלא של קו התחבורה הציבורית, לדוגמה, '8 Avenue Local'.
shortName
סוג:  string optional
השם הקצר של קו התחבורה הציבורית הזה. השם הזה יהיה בדרך כלל מספר שורה, כמו M7 או 355.
textColor
סוג:  string optional
הצבע שמשמש בדרך כלל לטקסט בשילוט של הקו הזה. מיוצג בפורמט הקסדצימלי.
url
סוג:  URL optional
ה-URL של קו התחבורה הציבורית הזה, כפי שסופק על ידי חברת התחבורה הציבורית.
vehicle
סוג:  TransitVehicle optional
סוג כלי הרכב שפועל בקו התחבורה הציבורית הזה.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

ממשק TransitPreference

google.maps.routes.TransitPreference ממשק

העדפות לגבי מסלולים שמבוססים על TRANSIT ומשפיעות על המסלול שמוחזר.
allowedTransitModes optional
סוג:  Iterable<TransitMode> optional
קבוצה של אמצעי תחבורה לשימוש כשמבקשים TRANSIT מסלול. ברירת המחדל היא כל אמצעי התחבורה הנתמכים.
routingPreference optional
סוג:  TransitRoutePreference optional
העדפת ניתוב שאם מציינים אותה, היא משפיעה על המסלול TRANSIT שמוחזר.

‫TransitStop class

google.maps.routes.TransitStop class

מידע על תחנת מעבר.

אפשר להתקשר אל const {TransitStop} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
location
סוג:  DirectionalLocation optional
המיקום של התחנה בקואורדינטות של קו רוחב וקו אורך, וכיוון נסיעה אופציונלי.
name
סוג:  string optional
שם תחנת התחבורה הציבורית.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

‫TransitVehicle class

google.maps.routes.TransitVehicle class

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

אפשר להתקשר אל const {TransitVehicle} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
iconURL
סוג:  URL optional
כתובת ה-URL של סמל שמשויך לסוג הרכב הזה.
localIconURL
סוג:  URL optional
כתובת ה-URL של הסמל שמשויך לסוג הרכב הזה, על סמך השילוט של התחבורה המקומית.
name
סוג:  string optional
השם של הרכב הזה, באותיות רישיות.
nameLanguage
סוג:  string optional
קוד השפה של שם הרכב בפורמט BCP-47, למשל en-US או sr-Latn.

מידע נוסף זמין בכתובת: https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
vehicleType
סוג:  string optional
סוג הרכב שבו נעשה שימוש.

רשימה של הערכים האפשריים זמינה בכתובת https://developers.google.com/maps/documentation/routes/reference/rpc/google.maps.routing.v2#transitvehicletype.
toJSON
toJSON()
פרמטרים:  אין
ערך מוחזר:  Object
הפונקציה ממירה לאובייקט.

VehicleEmissionType constants

google.maps.routes.VehicleEmissionType constants

קבוצת ערכים שמתארים את סוג הפליטה של הרכב. ההגדרה חלה רק על מצב הנסיעה DRIVING.

אפשר להתקשר אל const {VehicleEmissionType} = await google.maps.importLibrary("routes") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.
DIESEL רכב שמונע בדיזל.
ELECTRIC רכב שמונע על ידי חשמל.
GASOLINE רכב מונע בבנזין.
HYBRID רכב עם דלק היברידי (כמו בנזין + חשמל).

‫VehicleInfo interface

google.maps.routes.VehicleInfo ממשק

המאפיין מכיל את פרטי הרכב, כמו סוג הפליטה של הרכב.
emissionType optional
סוג:  VehicleEmissionType optional
תיאור של סוג הפליטה של הרכב. ההגדרה חלה רק על מצב הנסיעה DRIVING.

ממשק Waypoint

google.maps.routes.Waypoint ממשק

מייצג נקודת ציון במסלול.
location
המיקום של נקודת הביניים. המחרוזת יכולה להיות כתובת, קוד פלוס או שם משאב של מקום.
sideOfRoad optional
סוג:  boolean optional
המאפיין הזה מציין שהמיקום של נקודת הביניים הזו מיועד להעדפה של עצירת הרכב בצד מסוים של הכביש. כשמגדירים את הערך הזה, המסלול עובר דרך המיקום כדי שהרכב יוכל לעצור בצד הכביש שאליו המיקום מוטה ממרכז הכביש. האפשרות הזו פועלת רק ב-DRIVING וב-TWO_WHEELER ComputeRoutesRequest.travelMode
vehicleStopover optional
סוג:  boolean optional
מציין שעצירת הביניים מיועדת לכלי רכב לעצור בה, במטרה לאסוף או להוריד נוסעים. כשמגדירים את הערך הזה, המסלול המחושב לא יכלול עצירות ביניים מסוג via בכבישים שלא מתאימים לאיסוף ולהורדה של נוסעים. האפשרות הזו פועלת רק עבור DRIVING ו-TWO_WHEELER ComputeRoutesRequest.travelMode וכאשר Waypoint.location הוא לא string או Place.
via optional
סוג:  boolean optional
סימון נקודת הביניים הזו כאבן דרך ולא כנקודת עצירה. לכל נקודת ביניים שהיא לא via ב-ComputeRoutesRequest, ‏Route.computeRoutes מוסיף רשומה למערך Route.legs כדי לספק את הפרטים של עצירות הביניים בקטע הזה של הנסיעה.

מגדירים את הערך הזה כ-true כשרוצים שהמסלול יעבור דרך נקודת הביניים הזו בלי לעצור בה. נקודות דרך לא גורמות להוספת רשומה למערך Route.legs, אבל הן מכוונות את המסלול דרך נקודת הדרך.

הערות:
  • אפשר להגדיר את הערך הזה רק בנקודות ציון שהן נקודות ביניים. הבקשה תיכשל אם תגדירו את השדה הזה בנקודות ציון סופיות.
  • אם הערך של ComputeRoutesRequest.optimizeWaypointOrder הוא true, אי אפשר להגדיר את השדה הזה כ-true, אחרת הבקשה תיכשל.

ממשק WaypointMarkerDetails

google.maps.routes.WaypointMarkerDetails ממשק

פרטים על נקודת ציון שאפשר להשתמש בה כדי להתאים אישית את סגנון הסמן.
index
סוג:  number
האינדקס של הסמן.
totalMarkers
סוג:  number
המספר הכולל של הסמנים במסלול.
leg optional
סוג:  RouteLeg optional
הקטע שהסמן שייך לו. השדה ריק אם אין רגליים במסלול.