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 یکسان هستند، با چند استثنای قابل‌توجه. برای مثال، دامنه سطح بالای کد کشوری پادشاهی متحد «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 حداقل یکی از مبدأ، مقصد، یا نقطه‌مسیرها زمین‌کدیابی نشد.
OK پاسخ حاوی DirectionsResult معتبر است.
OVER_QUERY_LIMIT صفحه وب در مدت زمان بسیار کوتاهی از حد مجاز درخواست‌ها فراتر رفته است.
REQUEST_DENIED این صفحه وب اجازه ندارد از سرویس مسیرها استفاده کند.
UNKNOWN_ERROR به‌دلیل خطای سرور، درخواست مسیر پردازش نشد. اگر دوباره امتحان کنید، ممکن است درخواست موفقیت‌آمیز باشد.
ZERO_RESULTS هیچ مسیری بین مبدأ و مقصد پیدا نشد.

میانای DirectionsResult

میانا google.maps.DirectionsResult

پاسخ مسیرها از سرور مسیرها بازیابی شد. می‌توانید این موارد را بااستفاده از DirectionsRenderer ارائه کنید یا این شیء را تجزیه کنید و خودتان آن را ارائه کنید. باید هشدارها و حق نشرها را همان‌طور که در شرایط خدمات پلاتفرم Google Maps ذکر شده است نمایش دهید. توجه داشته باشید که اگرچه این نتیجه «شبیه 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

‫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)
پارامترها: 
  • ‫map:  Map
مقدار برگشتی:  هیچ
این روش نقشه‌ای را که مسیرها در آن ارائه می‌شود مشخص می‌کند. از null عبور کنید تا مسیرها از نقشه برداشته شود.
setOptions
setOptions(options)
پارامترها: 
مقدار برگشتی:  هیچ
تنظیمات گزینه‌های این DirectionsRenderer را پس‌از مقداردهی اولیه تغییر دهید.
setPanel
setPanel(panel)
پارامترها: 
مقدار برگشتی:  هیچ
این روش مسیرها را در <div> ارائه می‌دهد. برای برداشتن محتوا از پانل، null را رد کنید.
setRouteIndex
setRouteIndex(routeIndex)
پارامترها: 
  • ‫routeIndex:  number
مقدار برگشتی:  هیچ
نمایه (مبتنی بر صفر) مسیر را در شیء 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. مقدار پیش‌فرض ۰ است.
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 Places و در Google Maps شناسایی می‌کند. درباره شناسه‌های جا در راهنمای توسعه‌دهنده 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 که نشان‌دهنده کل مسیر است. مسیر ساده شده است تا برای زمینه‌هایی که تعداد کمی رأس لازم است (مانند نشانی‌های وب 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
نشانی مقصد این بخش. این محتوا باید همان‌طور که هست خوانده شود. نشانی قالب‌بندی‌شده را به‌صورت برنامه‌نویسی تجزیه نکنید.
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>
آرایه‌ای از نقاط‌مسیر بدون توقف درطول این بخش که در درخواست اصلی مشخص شده‌اند.

در مسیرهای جایگزین منسوخ شده است. نسخه ۳.۲۷ آخرین نسخه از میانای برنامه‌سازی کاربردی خواهد بود که 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
چندخطی کدبندی‌شده.

میانای مکان

میانا google.maps.Place

حاوی اطلاعات لازم برای یافتن، شناسایی، یا توصیف مکانی برای DirectionsRequest یا DistanceMatrixRequest است. در این زمینه، «مکان» به‌معنای کسب‌وکار، مکان جالب، یا مکان جغرافیایی است. برای واکشی اطلاعات درباره مکان، PlacesService را ببینید.
location optional
نوع:  LatLng|LatLngLiteral optional
LatLng نهادی که این مکان توصیف می‌کند.
placeId optional
نوع:  string optional
شناسه مکانِ مکان (مانند کسب‌وکار یا نقطه موردعلاقه). شناسه مکان شناسه یکتای مکان در پایگاه داده Google Maps است. توجه داشته باشید که placeId دقیق‌ترین روش برای شناسایی مکان است. درصورت امکان، باید placeId را به‌جای query مشخص کنید. شناسه جا را می‌توان از هر درخواستی به Places API، مثل TextSearch، بازیابی کرد. شناسه‌های جا را می‌توان از درخواست‌های Geocoding API نیز بازیابی کرد. برای اطلاعات بیشتر، به نمای کلی شناسه‌های مکان مراجعه کنید.
query optional
نوع:  string optional
پرسمان جستجویی که مکان را توصیف می‌کند (مانند کسب‌وکار یا نقطه جالب). یک پُرسمان نمونه «Quay, Upper Level, Overseas Passenger Terminal 5 Hickson Road, The Rocks NSW» است. درصورت امکان، باید placeId را به‌جای query مشخص کنید. این میانای برنامه‌سازی کاربردی دقت حل رشته پُرسمان به مکان را تضمین نمی‌کند. اگر هم 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 درخواست مسیرهای حمل‌ونقل عمومی را مشخص می‌کند.
BetaTWO_WHEELER درخواست مسیرهای موتورسیکلت را مشخص می‌کند.
WALKING درخواست مسیر پیاده‌روی را مشخص می‌کند.

DrivingOptions میانای

میانا google.maps.DrivingOptions

وقتی حالت سفر روی DRIVING تنظیم شده باشد، DirectionsRequest را پیکربندی می‌کند.
departureTime
نوع:  Date
زمان خروج مطلوب برای مسیر، که به‌عنوان شیء Date مشخص شده است. شیء Date زمان را برحسب میلی‌ثانیه از ۱ ژانویه ۱۹۷۰ اندازه‌گیری می‌کند. این مورد باید برای معتبر بودن 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 که وقتی حالت سفر روی TRANSIT تنظیم شده است باید در DirectionsRequest گنجانده شود.
arrivalTime optional
نوع:  Date optional
زمان ورود مطلوب برای مسیر، که به‌عنوان شیء «تاریخ» مشخص شده است. شیء Date زمان را برحسب میلی‌ثانیه از ۱ ژانویه ۱۹۷۰ اندازه‌گیری می‌کند. اگر زمان ورود مشخص شده باشد، زمان حرکت نادیده گرفته می‌شود.
departureTime optional
نوع:  Date optional
زمان خروج موردنظر برای مسیر، که به‌عنوان شیء «تاریخ» مشخص شده است. شیء Date زمان را برحسب میلی‌ثانیه از ۱ ژانویه ۱۹۷۰ اندازه‌گیری می‌کند. اگر نه زمان حرکت و نه زمان رسیدن مشخص شده باشد، زمان «اکنون» فرض می‌شود.
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 اتوبوس را به‌عنوان حالت ترجیحی حمل‌ونقل عمومی مشخص می‌کند.
BetaLIGHT_RAIL قطار شهری را به‌عنوان حالت ترجیحی حمل‌ونقل عمومی مشخص می‌کند.
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 که نشان‌دهنده ارزی است که کرایه با آن بیان می‌شود.
text
نوع:  string
مقدار کرایه، بیان‌شده در currency داده‌شده، به‌صورت رشته.
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
نشانی وب نماد مرتبط با این خط.
name
نوع:  string
نام کامل این خط حمل‌ونقل عمومی، مثلاً «8 Avenue Local».
short_name
نوع:  string
نام کوتاه این خط حمل‌ونقل عمومی، مثلاً «E».
text_color
نوع:  string
رنگ نوشتاری که معمولاً در تابلوهای این خط حمل‌ونقل عمومی استفاده می‌شود و به‌صورت رشته هگزادسیمال نشان داده می‌شود.
url
نوع:  string
نشانی وب آژانس که مختص این خط حمل‌ونقل عمومی است.
vehicle
نوع:  TransitVehicle
نوع وسیله نقلیه استفاده‌شده، مثلاً قطار یا اتوبوس.

میانای TransitAgency

میانا google.maps.TransitAgency

اطلاعات مربوط به دفتری که خط حمل‌ونقل عمومی را اداره می‌کند.
name
نوع:  string
نام این سازمان حمل‌ونقل عمومی.
phone
نوع:  string
شماره تلفن سازمان حمل‌ونقل عمومی.
url
نوع:  string
نشانی وب دفتر حمل‌ونقل عمومی.

میانای TransitVehicle

میانا google.maps.TransitVehicle

اطلاعات مربوط به وسیله نقلیه‌ای که در خط حمل‌ونقل عمومی کار می‌کند.
icon
نوع:  string
نشانی وب نمادی که با نوع وسیله نقلیه استفاده‌شده در این خط مطابقت دارد.
local_icon
نوع:  string
نشانی وب برای نمادی که با نوع وسیله نقلیه استفاده‌شده در این منطقه مطابقت دارد، به‌جای نماد عمومی‌تر.
name
نوع:  string
نامی برای این نوع TransitVehicle، مثلاً «قطار» یا «اتوبوس».
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
فاصله به متر.

رابط مدت

میانا google.maps.Duration

نمایش مدت زمان به‌صورت مقدار عددی و رشته نمایشی.
text
نوع:  string
نمایش رشته‌ای مقدار مدت.
value
نوع:  number
مدت‌زمان برحسب ثانیه.

رابط زمان

میانا google.maps.Time

نمایش زمان به‌عنوان شیء «تاریخ»، رشته بومی‌سازی‌شده، و منطقه زمانی.
text
نوع:  string
رشته‌ای که نشان‌دهنده مقدار زمان است. زمان در منطقه زمانی ایستگاه حمل‌ونقل عمومی نمایش داده می‌شود.
time_zone
نوع:  string
منطقه زمانی که این ایستگاه در آن قرار دارد. مقدار، نام منطقه زمانی است که در «پایگاه داده منطقه زمانی IANA» تعریف شده است، مثلاً «America/New_York».
value
نوع:  Date
زمان این خروج یا ورود، که به‌عنوان شیء «تاریخ جاوا اسکریپت» مشخص شده است.

ثابت‌های DirectionsTravelMode

google.maps.DirectionsTravelMode یادآور همیشگی

ثابت‌های DirectionsUnitSystem

google.maps.DirectionsUnitSystem یادآور همیشگی