DirectionsService class
google.maps.DirectionsService
ספריית
הכיתה "routes"
const {DirectionsService} = await google.maps.importLibrary("routes");
יצרן | |
|---|---|
DirectionsService |
DirectionsService()פרמטרים: אין
יוצר מופע חדש של DirectionsService ששולח שאילתות מסלול לשרתים של Google. |
Methods | |
|---|---|
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
אופציונלי |
סוג:
boolean optionalאם הערך הוא true, שירות המסלולים ינסה להימנע ממעבורות ככל האפשר. אופציונלי. |
avoidHighways
אופציונלי |
סוג:
boolean optionalאם הערך הוא true, שירות המסלולים ינסה להימנע מכבישים מהירים ככל האפשר. אופציונלי. |
avoidTolls
אופציונלי |
סוג:
boolean optionalאם הערך הוא true, שירות המסלולים ינסה להימנע מכבישי אגרה כשאפשר. אופציונלי. |
drivingOptions
אופציונלי |
סוג:
DrivingOptions optionalהגדרות שחלות רק על בקשות שבהן travelMode הוא DRIVING. לאובייקט הזה לא תהיה השפעה על אמצעי תחבורה אחרים. |
language
אופציונלי |
סוג:
string optionalמזהה השפה שבה התוצאות צריכות להופיע, אם אפשר. כאן אפשר לעיין ברשימת השפות הנתמכות. |
optimizeWaypoints
אופציונלי |
סוג:
boolean optionalאם הערך הוא true, DirectionsService ינסה לשנות את הסדר של נקודות הדרך שסופקו כדי לצמצם את העלות הכוללת של המסלול. אם נקודות הדרך עברו אופטימיזציה, בודקים את DirectionsRoute.waypoint_order בתגובה כדי לקבוע את הסדר החדש. |
provideRouteAlternatives
אופציונלי |
סוג:
boolean 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ברירת מחדל: שיטת המדידה שבה משתמשים במדינת המקור.
מערכת היחידות המועדפת להצגת מרחק. |
waypoints
אופציונלי |
סוג:
Array<DirectionsWaypoint> optionalמערך של נקודות דרך ביניים. המסלול מחושב מנקודת המוצא אל היעד דרך כל נקודת ציון במערך הזה. במדריך למפתחים מפורט המספר המקסימלי המותר של נקודות ציון. אין תמיכה בנקודות ציון במסלולים לתחבורה ציבורית. אופציונלי. |
ערכי DirectionsStatus קבועים
google.maps.DirectionsStatus
קבועים
ספרייה "routes"
הסטטוס שמוחזר על ידי DirectionsService בסיום קריאה ל-route(). אפשר לציין אותם לפי ערך או לפי שם הקבוע. לדוגמה: 'OK' או google.maps.DirectionsStatus.OK.
אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג DirectionsStatusString.
const {DirectionsStatus} = await google.maps.importLibrary("routes");
קבועים | |
|---|---|
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 Maps Platform. שימו לב שלמרות שהתוצאה הזו היא "דמוית JSON", היא לא JSON באופן מוחלט, כי היא כוללת אובייקטים של LatLng באופן עקיף.
מאפיינים | |
|---|---|
request |
סוג:
DirectionsRequestה-DirectionsRequest שהניב את התוצאה הזו. |
routes |
סוג:
Array<DirectionsRoute>מערך של DirectionsRoute, שכל אחד מהם מכיל מידע על המקטעים והשלבים שמהם הוא מורכב. יהיה רק מסלול אחד, אלא אם DirectionsRequest נוצר עם provideRouteAlternatives שמוגדר כ-true. |
available_travel_modes
אופציונלי |
סוג:
Array<TravelMode> optionalמכיל מערך של אמצעי הגעה זמינים. השדה הזה מוחזר כשבקשה מציינת אמצעי הגעה ולא מתקבלות תוצאות. המערך מכיל את אמצעי התחבורה הזמינים במדינות של קבוצת נקודות הדרך הנתונה. השדה הזה לא מוחזר אם אחת או יותר מנקודות הדרך הן "נקודות דרך ביניים". |
geocoded_waypoints
אופציונלי |
סוג:
Array<DirectionsGeocodedWaypoint> optionalמערך של DirectionsGeocodedWaypoint, שכל אחד מהם מכיל מידע על המרת הכתובות לקואורדינטות של נקודת המוצא, היעד ונקודות הציון. |
DirectionsRenderer class
google.maps.DirectionsRenderer
class
extends MVCObject
library "routes"
const {DirectionsRenderer} = await google.maps.importLibrary("routes");
יצרן | |
|---|---|
DirectionsRenderer |
DirectionsRenderer([opts])פרמטרים:
יוצר את ה-renderer עם האפשרויות הנתונות. אפשר להציג מסלולים במפה (כשכבות-על חזותיות) או בחלונית <div> (כהוראות טקסטואליות). |
Methods | |
|---|---|
getDirections |
getDirections()פרמטרים: אין
ערך מוחזר:
DirectionsResult|nullהפונקציה מחזירה את קבוצת המסלולים הנוכחית של ה-renderer. |
getMap |
getMap()פרמטרים: אין
ערך מוחזר:
Map|nullמחזירה את המפה שבה מוצג DirectionsResult. |
getPanel |
getPanel()פרמטרים: אין
ערך מוחזר:
HTMLElement|nullהפונקציה מחזירה את החלונית <div> שבה מוצג DirectionsResult. |
getRouteIndex |
getRouteIndex()פרמטרים: אין
ערך מוחזר:
numberמחזירה את אינדקס המסלול הנוכחי (מבוסס-אפס) שבו משתמש האובייקט DirectionsRenderer הזה. |
setDirections |
setDirections(directions)פרמטרים:
הערך המוחזר: אין
מגדירים את ה-renderer כך שישתמש בתוצאה מה- DirectionsService. אם תגדירו קבוצה תקינה של מסלולים באופן הזה, המסלולים יוצגו במפה ובחלונית הייעודיות של ה-renderer. |
setMap |
setMap(map)פרמטרים:
הערך המוחזר: אין
השיטה הזו מציינת את המפה שבה יוצגו המסלולים. מעבירים את הערך null כדי להסיר את המסלול מהמפה. |
setOptions |
setOptions(options)פרמטרים:
הערך המוחזר: אין
שינוי הגדרות האפשרויות של DirectionsRenderer אחרי האתחול. |
setPanel |
setPanel(panel)פרמטרים:
הערך המוחזר: אין
השיטה הזו מציגה את המסלול ב- <div>. לוחצים על null כדי להסיר את התוכן מהחלונית. |
setRouteIndex |
setRouteIndex(routeIndex)פרמטרים:
הערך המוחזר: אין
מגדירים את האינדקס (החל מ-0) של המסלול באובייקט DirectionsResult לעיבוד. כברירת מחדל, המסלול הראשון במערך יוצג. |
עברו בירושה:
addListener,
bindTo,
get,
notify,
set,
setValues,
unbind,
unbindAll
| |
אירועים | |
|---|---|
directions_changed |
function()ארגומנטים: אין
האירוע הזה מופעל כשהמסלול שמוצג משתנה, כשמוגדר DirectionsResult חדש או כשהמשתמש מסיים לגרור שינוי לנתיב המסלול. |
ממשק DirectionsRendererOptions
ממשק google.maps.DirectionsRendererOptions
האובייקט הזה מגדיר את המאפיינים שאפשר להגדיר באובייקט DirectionsRenderer.
מאפיינים | |
|---|---|
directions
אופציונלי |
סוג:
DirectionsResult optionalהמסלול שיוצג במפה ו/או בחלונית <div>, מאוחזר כאובייקט DirectionsResult מ-DirectionsService. |
draggable
אופציונלי |
סוג:
boolean optionalאם הערך הוא true, המשתמש יכול לגרור ולשנות את המסלולים שמוצגים על ידי ה-DirectionsRenderer הזה. |
hideRouteList
אופציונלי |
סוג:
boolean optionalברירת המחדל:
falseהמאפיין הזה מציין אם המרנדר צריך לספק רשימה של מסלולים שהמשתמש יכול לבחור, שמוצגת בחלונית המסלולים. |
infoWindow
אופציונלי |
סוג:
InfoWindow optionalה- InfoWindow שבו יוצג מידע טקסטואלי כשלוחצים על סמן. התוכן הקיים בחלון המידע יוחלף והמיקום שלו ישתנה. אם לא צוין חלון מידע, DirectionsRenderer ייצור חלון מידע משלו וישתמש בו. המערכת תתעלם מהמאפיין הזה אם המדיניות suppressInfoWindows מוגדרת לערך true. |
map
אופציונלי |
סוג:
Map optionalהמפה שבה יוצגו המסלולים. |
markerOptions
אופציונלי |
סוג:
MarkerOptions optionalאפשרויות לסמנים. כל הסמנים שיוצגו על ידי DirectionsRenderer ישתמשו באפשרויות האלה. |
panel
אופציונלי |
סוג:
HTMLElement optionalהשפה ( <div>) שבה יוצגו השלבים במסלול. |
polylineOptions
אופציונלי |
סוג:
PolylineOptions optionalאפשרויות לקווים הפוליגוניים. כל הקווים הפוליגוניים שיוצגו על ידי DirectionsRenderer ישתמשו באפשרויות האלה. |
preserveViewport
אופציונלי |
סוג:
boolean optionalברירת המחדל:
falseאם האפשרות הזו מוגדרת לערך true או שמרכז המפה ורמת הזום שלה לא הוגדרו אף פעם, המפה שמוזנת ממורכזת ומוגדרת לזום של התיבה התוחמת של קבוצת המסלולים הזו. |
routeIndex
אופציונלי |
סוג:
number optionalהאינדקס של המסלול בתוך האובייקט DirectionsResult. ערך ברירת המחדל הוא 0. |
suppressBicyclingLayer
אופציונלי |
סוג:
boolean optionalמניעת העיבוד של BicyclingLayer כשמבקשים מסלול אופניים. |
suppressInfoWindows
אופציונלי |
סוג:
boolean optionalביטול העיבוד של חלונות מידע. |
suppressMarkers
אופציונלי |
סוג:
boolean optionalמניעת העיבוד של סמנים. |
suppressPolylines
אופציונלי |
סוג:
boolean optionalמניעת העיבוד של קווים פוליגוניים. |
ממשק DirectionsWaypoint
ממשק google.maps.DirectionsWaypoint
DirectionsWaypoint מייצג מיקום בין נקודת המוצא ליעד, שדרכו צריך לעבור המסלול של הנסיעה.
מאפיינים | |
|---|---|
location
אופציונלי |
סוג:
string|LatLng|LatLngLiteral|Place optionalמיקום של נקודת ציון. הערך יכול להיות מחרוזת של כתובת, LatLng או Place. אופציונלי. |
stopover
אופציונלי |
סוג:
boolean optionalברירת המחדל:
trueאם הערך הוא true, ציון הדרך הזה הוא עצירה בין נקודת המוצא ליעד. הפעולה הזו מפצלת את המסלול לשני מקטעים. אם הערך הוא false, המסלול צריך לעבור דרך נקודת הדרך הזו, אבל לא להתפצל לשני מקטעים. האפשרות הזו שימושית אם רוצים ליצור מסלול בתגובה לכך שהמשתמש גורר נקודות דרך במפה. |
הממשק DirectionsGeocodedWaypoint
ממשק google.maps.DirectionsGeocodedWaypoint
ציון דרך יחיד שהומרה לקואורדינטות.
מאפיינים | |
|---|---|
partial_match
אופציונלי |
סוג:
boolean optionalאם הכלי להמרת כתובות לקואורדינטות (geocoder) לא החזיר התאמה מדויקת לנקודת הדרך המקורית, אבל הצליח להתאים חלק מהכתובת המבוקשת. |
place_id
אופציונלי |
סוג:
string optionalמזהה המקום שמשויך לנקודת הדרך. מזהה מקום הוא המזהה הייחודי של מקום במסד הנתונים של "מקומות Google" ובמפות Google. מידע נוסף על מזהי מקומות זמין במדריך למפתחים של Places API. |
types
אופציונלי |
סוג:
Array<string> optionalמערך של מחרוזות שמציינות את הסוג של הרכיב שהכתובת שלו הומרה לקואורדינטות. רשימה של מחרוזות אפשריות מופיעה בקטע סוגים של רכיבי כתובת במדריך למפתחים. |
ממשק DirectionsRoute
ממשק google.maps.DirectionsRoute
מסלול אחד שמכיל קבוצה של מקטעים ב-DirectionsResult. שימו לב שלמרות שהאובייקט הזה הוא "דמוי JSON", הוא לא JSON באופן מוחלט, כי הוא כולל אובייקטים של LatLng באופן ישיר ועקיף.
מאפיינים | |
|---|---|
bounds |
סוג:
LatLngBoundsהגבולות של המסלול הזה. |
copyrights |
סוג:
stringטקסט זכויות היוצרים שיוצג במסלול הזה. |
legs |
סוג:
Array<DirectionsLeg>מערך של DirectionsLeg, שכל אחד מהם מכיל מידע על השלבים שמהם הוא מורכב. יהיה קטע אחד לכל נקודת עצירה או יעד שצוינו. לכן, מסלול ללא נקודות עצירה יכיל DirectionsLeg אחד, ומסלול עם נקודת עצירה אחת יכיל שניים. |
overview_path |
מערך של 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
אופציונלי |
סוג:
TransitFare optionalהמחיר הכולל של כל הנסיעה בתחבורה הציבורית. רלוונטי רק לבקשות שקשורות לתחבורה ציבורית. |
הממשק DirectionsLeg
ממשק google.maps.DirectionsLeg
קטע אחד שמורכב מקבוצת שלבים בDirectionsResult. יכול להיות שחלק מהשדות במקטע לא יוחזרו בכל הבקשות. שימו לב שלמרות שהתוצאה הזו היא "דמוית JSON", היא לא בדיוק JSON, כי היא כוללת אובייקטים של LatLng באופן ישיר ועקיף.
מאפיינים | |
|---|---|
end_address |
סוג:
stringהכתובת של היעד של המקטע הזה. התוכן הזה מיועד לקריאה כמו שהוא. אל תנתחו באופן פרוגרמטי את הכתובת המעוצבת. |
end_location |
סוג:
LatLngDirectionsService מחשב מסלולים בין מיקומים באמצעות אפשרות התחבורה הקרובה ביותר (בדרך כלל כביש) במיקומי ההתחלה והסיום. השדה end_location מציין את היעד בפועל שהומרו בו הקואורדינטות, שיכול להיות שונה מהשדה end_location של השלב האחרון אם, לדוגמה, הכביש לא קרוב ליעד של המקטע הזה. |
start_address |
סוג:
stringהכתובת של נקודת המוצא של המקטע הזה. התוכן הזה מיועד לקריאה כמו שהוא. אל תנתחו באופן פרוגרמטי את הכתובת המעוצבת. |
start_location |
סוג:
LatLngDirectionsService מחשב מסלולים בין מיקומים באמצעות אפשרות התחבורה הקרובה ביותר (בדרך כלל כביש) במיקומי ההתחלה והסיום. start_location מציין את נקודת המוצא בפועל שהומרה לקואורדינטות. היא עשויה להיות שונה מהערך start_location של השלב הראשון אם, לדוגמה, הכביש לא נמצא ליד נקודת המוצא של המקטע הזה. |
steps |
סוג:
Array<DirectionsStep>מערך של DirectionsStep, שכל אחד מהם מכיל מידע על השלבים הנפרדים במקטע הזה. |
|
סוג:
Array<*>מידע על מהירות התנועה לאורך המקטע. |
via_waypoints |
מערך של נקודות ציון ללא עצירת ביניים לאורך הקטע הזה, שצוינו בבקשה המקורית. הוצא משימוש במסלולים חלופיים. גרסה 3.27 תהיה הגרסה האחרונה של ה-API שמוסיפה כשמשתמשים בשירות המסלולים כדי להטמיע מסלולים שניתן לגרור, מומלץ להשבית את האפשרות לגרור מסלולים חלופיים. אפשר לגרור רק את המסלול הראשי. המשתמשים יכולים לגרור את המסלול הראשי עד שהוא תואם למסלול חלופי. |
arrival_time
אופציונלי |
סוג:
Time optionalזמן ההגעה המשוער לקטע הזה. רלוונטי רק לבקשות TRANSIT. |
departure_time
אופציונלי |
סוג:
Time optionalשעת היציאה המשוערת של קטע הנסיעה הזה. רלוונטי רק לבקשות TRANSIT. |
distance
אופציונלי |
סוג:
Distance optionalהמרחק הכולל של המקטע הזה. יכול להיות שהמאפיין הזה לא מוגדר כי המרחק לא ידוע. |
duration
אופציונלי |
סוג:
Duration optionalמשך הזמן הכולל של המקטע הזה. המאפיין הזה יכול להיות undefined כי יכול להיות שמשך הזמן לא ידוע. |
duration_in_traffic
אופציונלי |
סוג:
Duration optionalמשך הזמן הכולל של הקטע הזה, תוך התחשבות במצב התנועה שצוין במאפיין trafficModel. המאפיין הזה יכול להיות undefined כי יכול להיות שמשך הזמן לא ידוע. |
הממשק DirectionsStep
ממשק google.maps.DirectionsStep
DirectionsStep אחד בDirectionsResult. יכול להיות שחלק מהשדות יהיו undefined. שימו לב שלמרות שהאובייקט הזה הוא "דמוי JSON", הוא לא JSON באופן מוחלט, כי הוא כולל ישירות אובייקטים של LatLng.
מאפיינים | |
|---|---|
encoded_lat_lngs |
סוג:
stringייצוג של קו פוליגוני מקודד של השלב. זהו נתיב משוער (מוחלק) של השלב. |
end_location |
סוג:
LatLngמיקום הסיום של השלב הזה. |
|
סוג:
LatLngמיקום הסיום של השלב הזה. |
instructions |
סוג:
stringהוראות לשלב הזה. |
|
רצף של LatLng שמתאר את מהלך השלב הזה. זהו נתיב משוער (מוחלק) של השלב. |
maneuver |
סוג:
stringמכיל את הפעולה שצריך לבצע בשלב הנוכחי ( turn-left, merge, straight וכו'). הערכים עשויים להשתנות, וערכים חדשים עשויים להתווסף ללא הודעה מוקדמת. |
path |
רצף של LatLng שמתאר את מהלך השלב הזה. זהו נתיב משוער (מוחלק) של השלב. |
start_location |
סוג:
LatLngהמיקום שבו השלב הזה מתחיל. |
|
סוג:
LatLngהמיקום שבו השלב הזה מתחיל. |
travel_mode |
סוג:
TravelModeאמצעי התחבורה שבו משתמשים בשלב הזה. |
distance
אופציונלי |
סוג:
Distance optionalהמרחק שהושלם בשלב הזה. המאפיין הזה יכול להיות undefined כי יכול להיות שהמרחק לא ידוע. |
duration
אופציונלי |
סוג:
Duration optionalהזמן שבדרך כלל נדרש כדי לבצע את השלב הזה, בשניות ובפורמט טקסט. המאפיין הזה יכול להיות undefined כי יכול להיות שמשך הזמן לא ידוע. |
אופציונלי |
סוג:
DirectionsPolyline optionalמכיל אובייקט עם מאפיין יחיד, "נקודות", שמכיל ייצוג של קו פוליגוני מקודד של השלב. הקו הפוליגוני הזה הוא נתיב משוער (מוחלק) של השלב. |
steps
אופציונלי |
סוג:
Array<DirectionsStep> optionalשלבי המשנה של השלב הזה. מצוין בקטעים של מסלולי תחבורה ציבורית שלא כוללים תחבורה ציבורית. |
transit
אופציונלי |
סוג:
TransitDetails optionalפרטים ספציפיים לתחבורה ציבורית לגבי השלב הזה. המאפיין הזה לא יהיה מוגדר, אלא אם אמצעי התחבורה של השלב הזה הוא TRANSIT. |
transit_details
אופציונלי |
סוג:
TransitDetails optionalפרטים שקשורים לשלב הזה אם אמצעי התחבורה הוא TRANSIT. |
ממשק DirectionsPolyline
ממשק google.maps.DirectionsPolyline
אובייקט שמכיל מאפיין points שמתאר את הקו הפוליגוני של DirectionsStep.
מאפיינים | |
|---|---|
points |
סוג:
string |
ממשק Place
ממשק google.maps.Place
מכיל מידע שנדרש כדי לאתר, לזהות או לתאר מקום בשביל DirectionsRequest או DistanceMatrixRequest. בהקשר הזה, "מקום" הוא עסק, נקודת עניין או מיקום גיאוגרפי. כדי לאחזר מידע על מקום, אפשר לעיין במאמר PlacesService.
מאפיינים | |
|---|---|
location
אופציונלי |
סוג:
LatLng|LatLngLiteral optionalה- LatLng של הישות שמתוארת במקום הזה. |
placeId
אופציונלי |
סוג:
string optionalמזהה המקום (למשל, עסק או נקודת עניין). מזהה המקום הוא מזהה ייחודי של מקום במסד הנתונים של מפות Google. חשוב לזכור ש- placeId היא הדרך הכי מדויקת לזהות מקום. אם אפשר, כדאי לציין את placeId במקום query. אפשר לאחזר מזהה מקום מכל בקשה ל-Places API, כמו TextSearch. אפשר גם לאחזר מזהי מקומות מבקשות ל-Geocoding API. מידע נוסף זמין בסקירה הכללית של מזהי מקומות. |
query
אופציונלי |
סוג:
string optionalשאילתת חיפוש שמתארת את המקום (כמו עסק או נקודת עניין). שאילתה לדוגמה: "Quay, Upper Level, Overseas Passenger Terminal 5 Hickson Road, The Rocks NSW". אם אפשר, כדאי לציין את placeId במקום query. ה-API לא מבטיח שהמחרוזת של השאילתה תתורגם למקום בצורה מדויקת. אם גם placeId וגם query סופקו, תתרחש שגיאה. |
קבועים של TravelMode
google.maps.TravelMode
קבועים
ספרייה "routes"
אמצעי ההגעה התקינים שאפשר לציין ב-DirectionsRequest, וגם אמצעי ההגעה שמוחזרים ב-DirectionsStep. אפשר לציין אותם לפי ערך או לפי שם הקבוע. לדוגמה: 'BICYCLING' או google.maps.TravelMode.BICYCLING.
אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג TravelModeString.
const {TravelMode} = await google.maps.importLibrary("routes");
קבועים | |
|---|---|
BICYCLING |
מציינת בקשה למסלול אופניים. |
DRIVING |
מציינת בקשה למסלול נסיעה. |
TRANSIT |
מציינת בקשה למסלול לתחבורה ציבורית. |
|
מציין בקשה למסלול לרכב דו-גלגלי. |
WALKING |
מציינת בקשה למסלול הליכה. |
ממשק DrivingOptions
ממשק google.maps.DrivingOptions
הגדרת DirectionsRequest כשמצב הנסיעה מוגדר ל-DRIVING.
מאפיינים | |
|---|---|
departureTime |
סוג:
Dateשעת היציאה הרצויה למסלול, שצוינה כאובייקט Date. האובייקט Date מודד את הזמן באלפיות השנייה מאז 1 בינואר 1970. כדי שהמאפיין DrivingOptions יהיה תקין, צריך לציין את הפרטים האלה. שעת היציאה צריכה להיות השעה הנוכחית או שעה בעתיד. התאריך לא יכול להיות בעבר. |
trafficModel
אופציונלי |
סוג:
TrafficModel optionalההנחה המועדפת לשימוש כשמחשבים את משך הזמן בתנועה. ערך ברירת המחדל הוא BEST_GUESS. |
קבועים של TrafficModel
google.maps.TrafficModel
קבועים
ספרייה "routes"
ההנחות שצריך להשתמש בהן כשמחשבים את משך הנסיעה הצפוי בהתאם למצב התנועה. מוגדר כחלק מ-DirectionsRequest או מ-DistanceMatrixRequest. אפשר לציין אותם לפי ערך או לפי שם הקבוע. לדוגמה: 'bestguess' או google.maps.TrafficModel.BEST_GUESS.
אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג TrafficModelString.
const {TrafficModel} = await google.maps.importLibrary("routes");
קבועים | |
|---|---|
BEST_GUESS |
להשתמש בנתוני תנועה היסטוריים כדי להעריך בצורה הטובה ביותר את הזמן שייקח לנסוע בפקקים. |
OPTIMISTIC |
משתמשים בנתוני תנועה היסטוריים כדי לבצע הערכה אופטימית של משך הזמן בתנועה. |
PESSIMISTIC |
משתמשים בנתוני תנועה היסטוריים כדי לבצע הערכה פסימית של משך הזמן בתנועה. |
הממשק TransitOptions
ממשק google.maps.TransitOptions
אובייקט TransitOptions שצריך לכלול ב-DirectionsRequest כשמצב הנסיעה מוגדר כ-TRANSIT.
מאפיינים | |
|---|---|
arrivalTime
אופציונלי |
סוג:
Date optionalזמן ההגעה הרצוי למסלול, שצוין כאובייקט Date. האובייקט Date מודד את הזמן באלפיות השנייה מאז 1 בינואר 1970. אם מציינים את זמן ההגעה, המערכת מתעלמת מזמן היציאה. |
departureTime
אופציונלי |
סוג:
Date optionalשעת היציאה הרצויה למסלול, שצוינה כאובייקט Date. האובייקט Date מודד את הזמן באלפיות השנייה מאז 1 בינואר 1970. אם לא מציינים את זמן היציאה או את זמן ההגעה, המערכת מניחה שהזמן הוא "עכשיו". |
modes
אופציונלי |
סוג:
Array<TransitMode> optionalאמצעי תחבורה ציבורית מועדף אחד או יותר, כמו אוטובוס או רכבת. אם לא מציינים העדפה, ה-API מחזיר את המסלול הטוב ביותר כברירת מחדל. |
routingPreference
אופציונלי |
סוג:
TransitRoutePreference optionalהעדפה שיכולה להשפיע על בחירת המסלול בתחבורה הציבורית, כמו פחות הליכה. אם לא מציינים העדפה, ה-API מחזיר את המסלול הטוב ביותר כברירת מחדל. |
קבועים של TransitMode
google.maps.TransitMode
קבועים
ספרייה "routes"
מצב התחבורה הציבורית התקין, למשל אוטובוס, שאפשר לציין ב-TransitOptions. אפשר לציין אותם לפי ערך או לפי שם הקבוע. לדוגמה: 'BUS' או google.maps.TransitMode.BUS.
אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג TransitModeString.
const {TransitMode} = await google.maps.importLibrary("routes");
קבועים | |
|---|---|
BUS |
מציין אוטובוס כאמצעי התחבורה הציבורית המועדף. |
|
מגדיר רכבת קלה כאמצעי התחבורה הציבורית המועדף. |
RAIL |
מציין רכבת כאמצעי התחבורה הציבורית המועדף. |
SUBWAY |
מציין רכבת תחתית כאמצעי התחבורה הציבורית המועדף. |
TRAIN |
מציין רכבת כאמצעי התחבורה הציבורית המועדף. |
TRAM |
מציין חשמלית כאמצעי התחבורה הציבורית המועדף. |
קבועים של TransitRoutePreference
google.maps.TransitRoutePreference
קבועים
ספרייה "routes"
סוג מסלול התחבורה הציבורית התקין שאפשר לציין ב-TransitOptions. אפשר לציין אותם לפי ערך או לפי שם הקבוע. לדוגמה: 'LESS_WALKING' או google.maps.TransitRoutePreference.LESS_WALKING.
אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג TransitRoutePreferenceString.
const {TransitRoutePreference} = await google.maps.importLibrary("routes");
קבועים | |
|---|---|
FEWER_TRANSFERS |
מציין שהמסלול המחושב צריך להעדיף מספר מוגבל של החלפות. |
LESS_WALKING |
מציין שהמסלול המחושב צריך לכלול כמה שפחות הליכה. |
ממשק TransitFare
ממשק google.maps.TransitFare
תעריף של DirectionsRoute שמורכב מערך ומטבע.
מאפיינים | |
|---|---|
currency |
סוג:
stringקוד מטבע בתקן ISO 4217 שמציין את המטבע שבו המחיר מוצג. |
text |
סוג:
stringערך מחיר הנסיעה, מבוטא ב currency הנתון, כמחרוזת. |
value |
סוג:
numberהערך המספרי של מחיר הנסיעה, מבוטא ב currency הנתון. |
ממשק TransitDetails
ממשק google.maps.TransitDetails
פרטים על היציאה, ההגעה ואמצעי התחבורה שמשמשים בשלב הזה.
מאפיינים | |
|---|---|
arrival_stop |
סוג:
TransitStopתחנת ההגעה של השלב הזה בנסיעה בתחבורה הציבורית. |
arrival_time |
סוג:
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 Avenue Local". |
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שם לסוג הזה של TransitVehicle, למשל "רכבת" או "אוטובוס". |
type |
סוג:
VehicleTypeסוג הרכב שבו השתמשתם, למשל רכבת, אוטובוס או מעבורת. |
קבועים של VehicleType
google.maps.VehicleType
קבועים
ספרייה "routes"
ערכים אפשריים לסוגי כלי רכב.
אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג VehicleTypeString.
const {VehicleType} = await google.maps.importLibrary("routes");
קבועים | |
|---|---|
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
קבועים
ספרייה "core"
מערכות היחידות החוקיות שאפשר לציין ב-DirectionsRequest.
const {UnitSystem} = await google.maps.importLibrary("core");
קבועים | |
|---|---|
IMPERIAL |
מציינת שהמרחקים ב-DirectionsResult צריכים להיות מוצגים ביחידות אימפריאליות. |
METRIC |
מציין שהמרחקים ב-DirectionsResult צריכים להיות ביחידות מטריות. |
ממשק Distance
ממשק google.maps.Distance
ייצוג של מרחק כערך מספרי וכמחרוזת תצוגה.
מאפיינים | |
|---|---|
text |
סוג:
stringייצוג מחרוזת של ערך המרחק, באמצעות UnitSystem שצוין בבקשה. |
value |
סוג:
numberהמרחק במטרים. |
ממשק משך הזמן
ממשק google.maps.Duration
ייצוג של משך זמן כערך מספרי וכמחרוזת תצוגה.
מאפיינים | |
|---|---|
text |
סוג:
stringייצוג מחרוזת של ערך משך הזמן. |
value |
סוג:
numberמשך הזמן בשניות. |
ממשק זמן
ממשק google.maps.Time
ייצוג של זמן כאובייקט Date, מחרוזת מקומית ואזור זמן.
מאפיינים | |
|---|---|
text |
סוג:
stringמחרוזת שמייצגת את ערך הזמן. השעה מוצגת באזור הזמן של תחנת התחבורה הציבורית. |
time_zone |
סוג:
stringאזור הזמן שבו נמצאת התחנה. הערך הוא השם של אזור הזמן כפי שהוא מוגדר במסד הנתונים של אזורי הזמן של IANA, למשל "America/New_York". |
value |
סוג:
Dateהשעה של היציאה או ההגעה, שצוינה כאובייקט תאריך של JavaScript. |