Routes Data

کلاس مسیر

کلاس google.maps.routes.Route
کتابخانه "routes"

حاوی مسیری است که از مجموعه‌ای از بخش‌های جاده‌ای متصل تشکیل شده است که نقاط‌مسیر شروع، پایان، و میانی را به هم وصل می‌کند.

const {Route} = await google.maps.importLibrary("routes");
computeRoutes
computeRoutes(request)
پارامترها:
مقدار برگشتی: Promise<{
  routes:Array<Route> optional,
  fallbackInfo:FallbackInfo optional,
  geocodingResults:GeocodingResults optional
}>
با داشتن مجموعه‌ای از نقطه‌مسیرهای پایانی و میانی، مسیر اصلی را به‌همراه مسیرهای جایگزین اختیاری برمی‌گرداند.

توجه: این روش مستلزم آن است که با تنظیم کردن ویژگی ComputeRoutesRequest.fields، ماسک فیلد پاسخ را در درخواست مشخص کنید. مقدار، فهرستی از مسیرهای فیلد است.

برای مثال:
  • پوشش فیلد همه فیلدهای دردسترس: fields: ['*']
  • پوشش فیلد مدت، فاصله، و مسیر در سطح «مسیر»: fields: ['durationMillis', 'distanceMeters', 'path']

استفاده از پوشش فیلد پاسخ عام fields: ['*'] توصیه نمی‌شود زیرا:
  • انتخاب کردن فقط فیلدهایی که نیاز دارید به سرور ما کمک می‌کند چرخه‌های محاسباتی را ذخیره کند و به ما امکان می‌دهد نتیجه را با تأخیر کمتری به شما برگردانیم.
  • انتخاب کردن فقط فیلدهایی که در کار تولیدتان نیاز دارید عملکرد تأخیر پایداری را تضمین می‌کند. ممکن است در آینده فیلدهای پاسخ بیشتری اضافه کنیم و این فیلدهای جدید ممکن است به زمان محاسباتی بیشتری نیاز داشته باشند. اگر همه فیلدها را انتخاب کنید، یا اگر همه فیلدها را در سطح بالا انتخاب کنید، ممکن است با کاهش عملکرد مواجه شوید زیرا هر فیلد جدیدی که اضافه می‌کنیم به‌طور خودکار در پاسخ گنجانده می‌شود.
  • انتخاب فقط فیلدهایی که نیاز دارید منجر به اندازه پاسخ کوچک‌تر و درنتیجه بارگیری سریع‌تر در شبکه می‌شود.
description
readonly
نوع: string optional
شرح مسیر.
distanceMeters
readonly
نوع: number optional
مسافت سفر در مسیر، به متر.
durationMillis
readonly
نوع: number optional
مدت زمان لازم برای پیمایش مسیر برحسب میلی‌ثانیه. اگر ComputeRoutesRequest.routingPreference را روی TRAFFIC_UNAWARE تنظیم کنید، این مقدار با Route.staticDurationMillis یکسان خواهد بود. اگر ComputeRoutesRequest.routingPreference را روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کنید، این مقدار با درنظر گرفتن شرایط ترافیک محاسبه می‌شود.

توجه: اگر مدت‌زمان از ۲^۵۳ میلی‌ثانیه بیشتر شود، این مقدار Number.POSITIVE_INFINITY است.
legs
readonly
نوع: Array<RouteLeg> optional
مجموعه‌ای از بخش‌ها (بخش‌های مسیر بین نقطه‌مسیرها) که مسیر را تشکیل می‌دهند. هر بخش مربوط به سفر بین دو نقطه‌مسیر غیرvia است.

برای مثال:
  • مسیری که نقطه‌مسیر میانی ندارد فقط یک بخش دارد.
  • مسیری که شامل یک نقطه‌مسیر میانی غیرvia باشد، دو بخش دارد.
  • مسیری که شامل یک نقطه‌مسیر میانی via باشد، یک بخش دارد.
ترتیب بخش‌ها با ترتیب نقطه‌مسیرها از origin به intermediates به destination مطابقت دارد.
localizedValues
readonly
نوع: RouteLocalizedValues optional
نمایش‌های نوشتاری ویژگی‌های Route.
optimizedIntermediateWaypointIndices
readonly
نوع: Array<number> optional
اگر ComputeRoutesRequest.optimizeWaypointOrder را روی true تنظیم کنید، این فیلد حاوی ترتیب بهینه‌شده نقاط‌مسیر میانی است. درغیراین‌صورت، این فیلد خالی است. نمایه با ۰ برای اولین نقطه‌مسیر میانی ارائه‌شده در ورودی شروع می‌شود.

برای مثال، اگر این ورودی را ارائه دهید:
  • مبدأ: LA
  • نقطه‌مسیرهای میانی: دالاس، بنگور، فینیکس
  • مقصد: نیویورک
و ترتیب بهینه‌شده نقطه‌مسیرهای میانی فینیکس، دالاس، بنگور باشد، این فیلد [2, 0, 1] خواهد بود.
path
readonly
نوع: Array<LatLngAltitude> optional
فهرست LatLngAltitudeهای مسیر که می‌توان از آن برای ترسیم چندخطی مسیر استفاده کرد. دقت مسیر را می‌توان با تنظیم ComputeRoutesRequest.polylineQuality کنترل کرد.
polylineDetails
readonly
نوع: PolylineDetails optional
حاوی اطلاعاتی درباره جزئیات مسیر است.
routeLabels
readonly
نوع: Array<RouteLabel> optional
برچسب‌های مسیر که برای شناسایی ویژگی‌های خاص یا مقایسه با دیگران مفید هستند.
routeToken
readonly
نوع: string optional
یک توکن مات که می‌تواند به Navigation SDK منتقل شود تا مسیر را درطول ناوبری بازسازی کند و درصورت تغییر مسیر، به هدف اصلی هنگام ایجاد مسیر احترام بگذارد. این کد را به‌عنوان یک حباب مات درنظر بگیرید. مقدار آن را در درخواست‌ها مقایسه نکنید زیرا ممکن است مقدار آن تغییر کند حتی اگر سرویس دقیقاً همان مسیر را برگرداند.

توجه: routeToken فقط برای درخواست‌هایی دردسترس است که ComputeRoutesRequest.routingPreference را روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کرده باشند. این ویژگی برای درخواست‌هایی که via نقطه‌مسیر دارند پشتیبانی نمی‌شود.
speedPaths
readonly
نوع: Array<SpeedPath> optional
گروه‌بندی بخش‌های مسیر با خواندن سرعت مربوط به آن‌ها. برای پر شدن این فیلد، ComputeRoutesRequest.routingPreference باید روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم شود و ComputeRoutesRequest.extraComputations باید شامل TRAFFIC_ON_POLYLINE باشد.
staticDurationMillis
readonly
نوع: number optional
مدت زمان سفر در مسیر بدون درنظر گرفتن شرایط ترافیک.

توجه: اگر مدت‌زمان از ۲^۵۳ میلی‌ثانیه بیشتر شود، این مقدار Number.POSITIVE_INFINITY است.
travelAdvisory
readonly
نوع: RouteTravelAdvisory optional
اطلاعات بیشتر درباره مسیر.
viewport
readonly
نوع: LatLngBounds optional
جعبه مرزی ناحیه نمایش مسیر.
warnings
readonly
نوع: Array<string> optional
آرایه‌ای از هشدارها برای نمایش هنگام نشان دادن مسیر.
Alphacreate3DPolylines
create3DPolylines([options])
پارامترها:
مقدار برگشتی: Promise<Array<Polyline3DElement>>
چندخطی‌های سه‌بعدی برای مسیر براساس داده‌های دردسترس برای مسیر ایجاد می‌کند.
createPolylines
createPolylines([options])
پارامترها:
مقدار برگشتی: Array<Polyline>
چندخطی‌هایی برای مسیر براساس داده‌های دردسترس ایجاد می‌کند.

چندخطی‌های چندحالتی:
  • پیش‌نیازها:
  • برای هر بخش مسیر چندحالته، یک چندخطی ایجاد می‌کند. چندخطی‌ها براساس حالت سفر بخش و داده‌های خط حمل‌ونقل عمومی (درصورت دردسترس بودن) سبک‌بندی می‌شوند. گزینه‌ها را می‌توان برای تغییر سبک چندخطی براساس حالت سفر و خط حمل‌ونقل عمومی ارسال کرد.

چندخطی‌های ترافیک:
  • پیش‌نیازها:
  • وقتی خوانش سرعت با فاصله زمانی قبلی متفاوت باشد، برای هر فاصله زمانی مسیر یک چندخطی ایجاد می‌کند. چندخطی‌ها دارای سبک پیش‌فرض مبتنی بر سرعت هستند. می‌توان گزینه‌هایی را برای تغییر سبک چندخطی براساس سرعت ارسال کرد.

چندخطی کلی:
  • پیش‌نیازها:
  • یک چندخطی واحد برای کل مسیر با اعمال سبک‌پردازی پیش‌فرض ایجاد می‌کند. می‌توان گزینه‌هایی را برای تغییر سبک چندخطی براساس حالت سفر در مسیر ارسال کرد. برای سفارشی‌سازی بیشتر، چندخطی‌ها را مستقیماً بااستفاده از Route.path یا RouteLeg.path ایجاد کنید.
AlphacreatePopover
createPopover()
پارامترها: هیچ
مقدار برگشتی: Promise<PopoverElement>
براساس داده‌های دردسترس برای مسیر، یک پاپ‌اور برای مسیر ایجاد می‌کند که به‌گونه‌ای پیکربندی شده است که برای حاشیه‌نویسی مسیر روی نقشه مناسب باشد. درحال‌حاضر از Route.localizedValues، Route.path، و Route.legs (درصورت دردسترس بودن) استفاده می‌کند.
createWaypointAdvancedMarkers
createWaypointAdvancedMarkers([options])
پارامترها:
مقدار برگشتی: Promise<Array<AdvancedMarkerElement>>
نشانگرهایی برای مسیر با برچسب‌های «الف»، «ب»، «پ»، و غیره برای هر نقطه‌مسیر ایجاد می‌کند. سبک پیش‌فرض روی نشانگرها اعمال شده است. می‌توان گزینه‌هایی را برای تغییر سبک نشانگر براساس نمایه نشانگر یا ویژگی‌های RouteLeg مربوطه ارسال کرد. اگر مسیر فاقد بخش باشد، پارامتر WaypointMarkerDetails.leg تعریف‌نشده خواهد بود.

فیلد "legs" باید در ComputeRoutesRequest.fields درخواست شود تا نقاط‌مسیر میانی اضافه شوند.
AlphacreateWaypointMarkers
پارامترها:
مقدار برگشتی: Promise<Array<T>>
نشانگرهایی برای مبدأ و مقصد مسیر ایجاد می‌کند. نشانگرها دارای سبک پیش‌فرض هستند، مگراینکه تابع customOverride مشخص شده باشد. درحال‌حاضر از نقاط‌مسیر میانی پشتیبانی نمی‌شود.

CollisionBehavior نشانگرهای ایجادشده به‌طور پیش‌فرض روی CollisionBehavior.REQUIRED_AND_HIDES_OPTIONAL تنظیم شده است.
از سازمان بالاتر: toJSON

میانای ComputeRoutesRequest

میانا google.maps.routes.ComputeRoutesRequest

درخواست برای مسیرها.
destination
مقصد مسیر. مقداری که به‌عنوان رشته ارسال می‌شود می‌تواند نشانی، Plus Code، یا نام منبع «مکان» باشد. مقادیر ارتفاع برای محاسبه مسیرها درنظر گرفته نمی‌شود.
fields
نوع: Iterable<string>
مجموعه فیلدهایی که باید واکشی شوند. ["*"] را برای همه فیلدها مشخص کنید.
origin
مبدأ مسیر. مقداری که به‌عنوان رشته ارسال می‌شود می‌تواند نشانی، Plus Code، یا نام منبع «مکان» باشد. مقادیر ارتفاع برای محاسبه مسیرها درنظر گرفته نمی‌شود.
arrivalTime
اختیاری
نوع: Date optional
زمان رسیدن.

توجه: فقط زمانی می‌توان تنظیم کرد که ComputeRoutesRequest.travelMode روی TRANSIT تنظیم شده باشد. می‌توانید ComputeRoutesRequest.departureTime یا ComputeRoutesRequest.arrivalTime را مشخص کنید، اما نه هر دو را. سفرهای حمل‌ونقل عمومی برای حداکثر ۷ روز گذشته یا ۱۰۰ روز آینده دردسترس است.
computeAlternativeRoutes
اختیاری
نوع: boolean optional
مشخص می‌کند که آیا مسیرهای جایگزین علاوه‌بر مسیر اصلی محاسبه شوند یا نه. برای درخواست‌هایی که نقطه‌مسیرهای میانی دارند، هیچ مسیر جایگزینی برگردانده نمی‌شود.
departureTime
اختیاری
نوع: Date optional
زمان حرکت. اگر این مقدار را تنظیم نکنید، این مقدار به‌طور پیش‌فرض روی زمانی که درخواست را ارسال کرده‌اید تنظیم می‌شود.

توجه: فقط زمانی می‌توانید زمان را در گذشته مشخص کنید که ComputeRoutesRequest.travelMode روی TRANSIT تنظیم شده باشد. سفرهای حمل‌ونقل عمومی برای حداکثر ۷ روز گذشته یا ۱۰۰ روز آینده دردسترس است.
extraComputations
اختیاری
فهرستی از محاسبات اضافی که ممکن است برای تکمیل درخواست استفاده شود.

توجه: این محاسبات اضافی ممکن است فیلدهای اضافی را در پاسخ برگرداند. این فیلدهای اضافی باید در ComputeRoutesRequest.fields نیز مشخص شوند تا در پاسخ برگردانده شوند.
intermediates
اختیاری
نوع: Iterable<Waypoint> optional
مجموعه‌ای از نقطه‌مسیرها درطول مسیر (به‌استثنای نقاط پایانه)، برای توقف یا عبور. حداکثر ۲۵ نقطه‌مسیر میانی پشتیبانی می‌شود.
internalUsageAttributionIds
اختیاری
نوع: Iterable<string> optional
شناسه‌هایی که برای نسبت دادن تماس‌ها به بسته‌های خاص یا کتابخانه‌های OSS استفاده می‌شود.
language
اختیاری
نوع: string optional
کد زبان BCP-47، مانند «en-US» یا «sr-Latn». برای اطلاعات بیشتر، شناسه محلی یونیکد را ببینید. برای مشاهده فهرست زبان‌های پشتیبانی‌شده، به پشتیبانی زبان مراجعه کنید. وقتی این مقدار را ارائه نمی‌دهید، زبان از تنظیمات بومی‌سازی Google Maps JavaScript API شما استنباط می‌شود. درغیراین‌صورت، زبان از مکان مبدأ استنباط می‌شود.
optimizeWaypointOrder
اختیاری
نوع: boolean optional
اگر روی «درست» تنظیم شود، سرویس تلاش می‌کند با تغییر ترتیب نقطه‌مسیرهای میانی مشخص‌شده، هزینه کلی مسیر را به حداقل برساند. اگر هرکدام از نقطه‌مسیرهای میانی از نوع نقطه‌مسیر گذری باشد، درخواست ناموفق خواهد بود. برای پیدا کردن ترتیب جدید، از Route.optimizedIntermediateWaypointIndices در پاسخ استفاده کنید. اگر "optimizedIntermediateWaypointIndices" در ComputeRoutesRequest.fields درخواست نشود، درخواست ناموفق خواهد بود. اگر روی «نادرست» تنظیم شود، Route.optimizedIntermediateWaypointIndices در پاسخ خالی خواهد بود.
polylineQuality
اختیاری
نوع: PolylineQuality optional
اولویت کیفیت چندخطی را مشخص می‌کند.
region
اختیاری
نوع: string optional
کد منطقه، که به‌عنوان مقدار دو نویسه‌ای ccTLD («دامنه سطح بالا») مشخص شده است. برای اطلاعات بیشتر، دامنه‌های سطح بالای کد کشور را ببینید. وقتی این مقدار را ارائه نمی‌دهید، منطقه از تنظیمات بومی‌سازی Google Maps JavaScript API شما استنباط می‌شود. درغیراین‌صورت، منطقه از مکان مبدأ استنباط می‌شود.
requestedReferenceRoutes
اختیاری
نوع: Iterable<ReferenceRoute> optional
مشخص می‌کند که علاوه‌بر مسیر پیش‌فرض، چه مسیرهای مرجعی به‌عنوان بخشی از درخواست محاسبه شود. مسیر مرجع مسیری است که هدف محاسبه آن با مسیر پیش‌فرض متفاوت است. برای مثال، محاسبه مسیر مرجع FUEL_EFFICIENT پارامترهای مختلفی را درنظر می‌گیرد که مسیر بهینه با مصرف سوخت بهینه را ایجاد می‌کند. هنگام استفاده از این ویژگی، به‌دنبال Route.routeLabels در مسیرهای حاصل بگردید.
routeModifiers
اختیاری
نوع: RouteModifiers optional
مجموعه‌ای از شرایط که باید برآورده شوند و بر نحوه محاسبه مسیرها تأثیر می‌گذارند. برای مثال، می‌توانید ویژگی‌هایی را که می‌خواهید از آن‌ها اجتناب شود مشخص کنید، مثل جاده‌های عوارضی یا بزرگراه‌ها.
routingPreference
اختیاری
نوع: RoutingPreference optional
نحوه محاسبه مسیر را مشخص می‌کند. سرور تلاش می‌کند از اولویت مسیریابی انتخاب‌شده برای محاسبه مسیر استفاده کند. اگر اولویت مسیریابی منجر به خطا یا تأخیر بسیار طولانی شود، خطا برگردانده می‌شود. این گزینه را فقط وقتی می‌توانید مشخص کنید که ComputeRoutesRequest.travelMode روی DRIVING یا TWO_WHEELER باشد، درغیراین‌صورت درخواست ناموفق خواهد بود.
trafficModel
اختیاری
نوع: TrafficModel optional
فرض‌های مورد استفاده هنگام محاسبه زمان در ترافیک را مشخص می‌کند. این تنظیم بر مقدار Route.durationMillis و RouteLeg.durationMillis که حاوی زمان پیش‌بینی‌شده در ترافیک براساس میانگین‌های تاریخی است تأثیر می‌گذارد. ‫ComputeRoutesRequest.trafficModel فقط برای درخواست‌هایی دردسترس است که ComputeRoutesRequest.routingPreference را روی TRAFFIC_AWARE_OPTIMAL و ComputeRoutesRequest.travelMode را روی DRIVING تنظیم کرده باشند. پیش‌فرض‌ها به BEST_GUESS.
transitPreference
اختیاری
نوع: TransitPreference optional
اولویت‌هایی را مشخص می‌کند که بر مسیر برگردانده‌شده برای مسیرهای TRANSIT تأثیر می‌گذارد.

توجه: فقط زمانی می‌توان مشخص کرد که ComputeRoutesRequest.travelMode روی TRANSIT تنظیم شده باشد.
travelMode
اختیاری
نوع: TravelMode optional
حالت حمل‌ونقل را مشخص می‌کند.
units
اختیاری
نوع: UnitSystem optional
واحدهای اندازه‌گیری را برای فیلدهای نمایش، مانند دستورالعمل‌های پیمایش، مشخص می‌کند. واحدهای اندازه‌گیری استفاده‌شده برای مسیر، بخش، فاصله گام، و مدت تحت‌تأثیر این مقدار قرار نمی‌گیرند. اگر این مقدار را ارائه نکنید، واحدهای نمایش از مکان مبدأ استنباط می‌شود.

ثابت‌های ComputeRoutesExtraComputation

ثابت‌ها google.maps.routes.ComputeRoutesExtraComputation کتابخانه
"routes"

محاسبات اضافی که باید هنگام تکمیل درخواست انجام شود. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع ComputeRoutesExtraComputationString تعریف می‌شوند.

const {ComputeRoutesExtraComputation} = await google.maps.importLibrary("routes");
FLYOVER_INFO_ON_POLYLINE اطلاعات پرواز بر فراز مسیر(ها). برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
FUEL_CONSUMPTION مصرف سوخت تخمینی برای مسیر(ها). برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
NARROW_ROAD_INFO_ON_POLYLINE اطلاعات جاده باریک برای مسیر(ها). برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
TOLLS اطلاعات عوارض برای مسیر(ها). برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
TRAFFIC_ON_POLYLINE چندخطی‌های آگاه از ترافیک برای مسیر(ها). برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

میانای CreateWaypointMarkersOptions

میانا google.maps.routes.CreateWaypointMarkersOptions<T = MarkerElement|Marker3DElement|MarkerInteractiveElement|Marker3DInteractiveElement>

گزینه‌های ایجاد نشانگرهای نقطه‌مسیر.
forEach
اختیاری
نوع: function(T): void optional
تابع سفارشی برای جهش عناصر ایجادشده. تابع پیش‌فرض forEach سنجاق‌هایی با نویسه‌های A-Z به هر نشانگر اضافه می‌کند. برای رفتار متفاوت، این تابع را لغو کنید.
markerClass
اختیاری
نوع: new () => T optional
سازنده عنصری که باید ایجاد شود. انواع پشتیبانی‌شده عبارت‌اند از:

DirectionalLocationLiteral میانجی

میانای google.maps.routes.DirectionalLocationLiteral LatLngAltitudeLiteral, LatLngLiteral را گسترش می‌دهد
توسط DirectionalLocation پیاده‌سازی شده است

راستین‌نمادهای شیء به‌جای نمونه‌های DirectionalLocation برای راحتی پذیرفته می‌شوند. وقتی Maps JS API با این موارد مواجه می‌شود، آن‌ها را به DirectionalLocation تبدیل می‌کند.
heading
اختیاری
نوع: number optional
جهت قطب‌نما مربوط به جهت جریان ترافیک. مقادیر جهت می‌توانند اعدادی از ۰ تا ۳۶۰ باشند، که ۰ جهت شمال واقعی، ۹۰ جهت شرق واقعی، و غیره را مشخص می‌کند. از این فیلد فقط برای DRIVING و TWO_WHEELER ComputeRoutesRequest.travelMode می‌توانید استفاده کنید.
به‌ارث‌رسیده: altitude، lat، lng

کلاس DirectionalLocation

class google.maps.routes.DirectionalLocation extends LatLngAltitude implements DirectionalLocationLiteral, LatLngAltitudeLiteral, LatLngLiteral
library "routes"

یک نقطه جغرافیایی و یک عنوان اختیاری را دربرمی‌گیرد.

const {DirectionalLocation} = await google.maps.importLibrary("routes");
از سازمان بالاتر: LatLngAltitude
heading
readonly
نوع: number optional
جهت قطب‌نما مربوط به جهت جریان ترافیک. مقادیر جهت می‌توانند اعدادی از ۰ تا ۳۶۰ باشند، که ۰ جهت شمال واقعی، ۹۰ جهت شرق واقعی، و غیره را مشخص می‌کند. از این فیلد فقط برای DRIVING و TWO_WHEELER ComputeRoutesRequest.travelMode می‌توانید استفاده کنید.
به‌ارث‌رسیده: altitude، lat، lng
toJSON
toJSON([key])
پارامترها:
  • key: string optional
مقدار برگشتی: DirectionalLocationLiteral
به شیء ساده تبدیل می‌کند.
از سازمان بالاتر: equals

FallbackInfo کلاس

کلاس google.maps.routes.FallbackInfo
کتابخانه "routes"

اطلاعات مربوط به نحوه و دلیل استفاده از نتیجه جایگزین در پاسخ Route.computeRoutes. اگر این فیلد تنظیم شده باشد، به این معنی است که سرور از حالت مسیریابی متفاوتی نسبت به حالت ترجیحی شما به‌عنوان جایگزین استفاده کرده است.

const {FallbackInfo} = await google.maps.importLibrary("routes");
reason
readonly
نوع: FallbackReason optional
دلیل استفاده از پاسخ جایگزین به‌جای پاسخ اصلی. این فیلد فقط زمانی پر می‌شود که حالت بازگشت فعال شود و پاسخ بازگشت برگردانده شود.
routingMode
readonly
نوع: FallbackRoutingMode optional
حالت مسیریابی استفاده‌شده برای پاسخ. اگر بازگشت راه‌اندازی شده باشد، ممکن است حالت با اولویت مسیریابی تنظیم‌شده در درخواست مشتری اصلی متفاوت باشد.
از سازمان بالاتر: toJSON

ثابت‌های FallbackReason

ثابت‌ها google.maps.routes.FallbackReason کتابخانه
"routes"

دلایل استفاده از پاسخ جایگزین. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع FallbackReasonString تعریف می‌شوند.

const {FallbackReason} = await google.maps.importLibrary("routes");
LATENCY_EXCEEDED نتوانستیم محاسبه را با حالت مسیریابی ترجیحی شما به‌موقع تمام کنیم، اما توانستیم نتیجه محاسبه‌شده با حالت جایگزین را برگردانیم. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
SERVER_ERROR هنگام محاسبه مسیرها با حالت مسیریابی ترجیحی شما، خطای سرور رخ داد، اما توانستیم نتیجه محاسبه‌شده با حالت جایگزین را برگردانیم. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

ثابت‌های FallbackRoutingMode

ثابت‌ها google.maps.routes.FallbackRoutingMode کتابخانه
"routes"

حالت مسیریابی واقعی که برای پاسخ رزرو برگردانده‌شده استفاده شده است. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع FallbackRoutingModeString تعریف می‌شوند.

const {FallbackRoutingMode} = await google.maps.importLibrary("routes");
TRAFFIC_AWARE برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
TRAFFIC_UNAWARE برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

کلاس GeocodedWaypoint

کلاس google.maps.routes.GeocodedWaypoint
کتابخانه "routes"

زمین‌کدیابی درباره مکان‌هایی که به‌عنوان نقطه‌مسیر استفاده شده‌اند. فقط برای نقاط‌مسیر نشانی درج می‌شود. شامل جزئیات مربوط به نتایج زمین‌کدیابی برای تعیین اینکه نشانی به چه چیزی زمین‌کدیابی شده است.

const {GeocodedWaypoint} = await google.maps.importLibrary("routes");
geocoderStatus
readonly
نوع: RPCStatus optional
رمز وضعیت حاصل از عملیات زمین‌کدیابی را نشان می‌دهد.
intermediateWaypointRequestIndex
readonly
نوع: number optional
شاخص نقطه‌مسیر میانی مربوطه در درخواست. فقط درصورتی درج می‌شود که نقطه‌مسیر مربوطه نقطه‌مسیر میانی باشد.
partialMatch
readonly
نوع: boolean
نشان می‌دهد که زمین‌کدیاب برای درخواست اصلی مطابقت دقیقی برنگردانده است، هرچند توانسته است بخشی از نشانی درخواست‌شده را مطابقت دهد. شاید بخواهید درخواست اصلی را ازنظر غلط املایی و/یا نشانی ناقص بررسی کنید.
placeId
readonly
نوع: string
شناسه مکان برای این نتیجه.
types
readonly
نوع: Array<string>
نوع(انواع) نتیجه، به‌صورت صفر یا چند برچسب نوع. برای انواع پشتیبانی‌شده، https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types را ببینید.
از سازمان بالاتر: toJSON

GeocodingResults کلاس

کلاس google.maps.routes.GeocodingResults
کتابخانه "routes"

حاوی GeocodedWaypoints برای مبدأ، مقصد، و نقاط‌مسیر میانی است. فقط برای نقاط‌مسیر نشانی درج می‌شود.

const {GeocodingResults} = await google.maps.importLibrary("routes");
destination
readonly
نوع: GeocodedWaypoint optional
نقطه‌مسیر زمین‌کدیابی‌شده برای مقصد.
intermediates
readonly
نوع: Array<GeocodedWaypoint> optional
فهرستی از نقطه‌مسیرهای زمین‌کدیابی‌شده میانی که هرکدام حاوی فیلد نمایه‌ای است که با موقعیت نقطه‌مسیر در ترتیب مشخص‌شده در درخواست مطابقت دارد (موقعیت‌ها از صفر شروع می‌شوند).
origin
readonly
نوع: GeocodedWaypoint optional
نقطه‌مسیر زمین‌کدیابی‌شده برای مبدأ.
از سازمان بالاتر: toJSON

کلاس MultiModalSegment

کلاس google.maps.routes.MultiModalSegment
کتابخانه "routes"

اطلاعات خلاصه‌شده‌ای درباره بخش چندحالتی RouteLeg.steps مسیر ارائه می‌دهد. بخش چندحالتی به‌عنوان یک یا چند RouteLegStep مجاور تعریف می‌شود که TravelMode یکسانی دارند.

const {MultiModalSegment} = await google.maps.importLibrary("routes");
instructions
readonly
نوع: string optional
دستورالعمل‌های پیمایش این بخش چندحالتی.
maneuver
readonly
نوع: string optional
مانور ناوبری که باید در این مرحله انجام شود. برای مشاهده فهرست مقادیر ممکن، مانور را ببینید.
stepEndIndex
readonly
نوع: number
نمایه RouteLegStep مربوطه که پایان بخش چندحالتی است.
stepStartIndex
readonly
نوع: number
نمایه RouteLegStep مربوطه که شروع بخش چندحالتی است.
travelMode
readonly
نوع: TravelMode optional
حالت سفر استفاده‌شده برای این بخش چندحالته.
از سازمان بالاتر: toJSON

کلاس PolylineDetailInfo

کلاس google.maps.routes.PolylineDetailInfo
کتابخانه "routes"

اطلاعات مربوط به عارضه جاده را در امتداد یک چندخطی کپسوله‌سازی می‌کند.

const {PolylineDetailInfo} = await google.maps.importLibrary("routes");
endIndex
readonly
نوع: number optional
نمایه پایانی این عارضه جاده در چندخطی.
presence
readonly
نوع: RoadFeatureState optional
نشان می‌دهد که آیا عارضه جاده درطول چندخطی وجود دارد یا نه.
startIndex
readonly
نوع: number optional
نمایه شروع این عارضه جاده در چندخطی.
از سازمان بالاتر: toJSON

کلاس PolylineDetails

کلاس google.maps.routes.PolylineDetails
کتابخانه "routes"

جزئیات مربوط به نمایه یا بخش مجاور چندخطی. با داشتن چندخطی با نقاط P_0،‏ P_1،‏ ...،‏ P_N (نمایه با مبنای صفر)، PolylineDetails ویژگی جاده را برای بازه مشخصی توصیف می‌کند.

const {PolylineDetails} = await google.maps.importLibrary("routes");
flyoverInfo
readonly
جزئیات پرواز در امتداد چندخطی.
narrowRoadInfo
readonly
جزئیات جاده باریک درطول چندخطی.
از سازمان بالاتر: toJSON

ثابت‌های PolylineQuality

ثابت‌ها google.maps.routes.PolylineQuality کتابخانه
"routes"

مجموعه‌ای از مقادیر که کیفیت چندخطی را مشخص می‌کند. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع PolylineQualityString تعریف می‌شوند.

const {PolylineQuality} = await google.maps.importLibrary("routes");
HIGH_QUALITY چندخطی با کیفیت بالا را مشخص می‌کند - که بااستفاده از نقاط بیشتری نسبت به OVERVIEW تشکیل شده است، به قیمت افزایش اندازه پاسخ. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
OVERVIEW یک چندخطی نمای کلی را مشخص می‌کند - که بااستفاده از تعداد کمی نقطه تشکیل شده است. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

ثابت‌های ReferenceRoute

ثابت‌ها google.maps.routes.ReferenceRoute کتابخانه
"routes"

مسیر مرجع پشتیبانی‌شده در ComputeRoutesRequest. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع ReferenceRouteString تعریف می‌شوند.

const {ReferenceRoute} = await google.maps.importLibrary("routes");
FUEL_EFFICIENT مسیر با بهره‌وری سوخت. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
SHORTER_DISTANCE مسیر با مسافت سفر کوتاه‌تر. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

ثابت‌های RoadFeatureState

ثابت‌ها google.maps.routes.RoadFeatureState کتابخانه
"routes"

وضعیت‌های ویژگی‌های جاده را درطول یک بخش چندخطی کپسوله‌سازی می‌کند. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع RoadFeatureStateString تعریف می‌شوند.

const {RoadFeatureState} = await google.maps.importLibrary("routes");
DOES_NOT_EXIST این عارضه جاده وجود ندارد. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
EXISTS ویژگی جاده وجود دارد. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

ثابت‌های RouteLabel

ثابت‌ها google.maps.routes.RouteLabel کتابخانه
"routes"

برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع RouteLabelString تعریف می‌شوند.

const {RouteLabel} = await google.maps.importLibrary("routes");
DEFAULT_ROUTE مسیر «بهترین» پیش‌فرض برای محاسبه مسیر برگردانده شد. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
DEFAULT_ROUTE_ALTERNATE جایگزینی برای مسیر «بهترین» پیش‌فرض. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
FUEL_EFFICIENT مسیر با بهره‌وری سوخت. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
SHORTER_DISTANCE مسیر با مسافت سفر کوتاه‌تر. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

کلاس RouteLeg

کلاس google.maps.routes.RouteLeg
کتابخانه "routes"

حاوی بخشی بین نقاط‌مسیر غیرvia است.

const {RouteLeg} = await google.maps.importLibrary("routes");
distanceMeters
readonly
نوع: number
مسافت سفر بخش مسیر، به متر.
durationMillis
readonly
نوع: number optional
مدت زمان لازم برای پیمایش بخش مسیر برحسب میلی‌ثانیه. اگر ComputeRoutesRequest.routingPreference را روی TRAFFIC_UNAWARE تنظیم کنید، این مقدار با staticDurationMillis یکسان خواهد بود. اگر ComputeRoutesRequest.routingPreference را روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کنید، این مقدار با درنظر گرفتن شرایط ترافیک محاسبه می‌شود.

توجه: اگر مدت‌زمان از ۲^۵۳ میلی‌ثانیه بیشتر شود، این مقدار Number.POSITIVE_INFINITY است.
endLocation
readonly
نوع: DirectionalLocation optional
مکان پایان این بخش. این مکان ممکن است با ComputeRoutesRequest.destination متفاوت باشد. برای مثال، وقتی ComputeRoutesRequest.destination نزدیک جاده نیست، این نقطه روی جاده است.
localizedValues
readonly
نوع: RouteLegLocalizedValues optional
نمایش‌های نوشتاری ویژگی‌های RouteLeg.
path
readonly
فهرست LatLngAltitudeهای بخش مسیر که می‌توان از آن برای ترسیم چندخطی بخش مسیر استفاده کرد. دقت مسیر را می‌توان با تنظیم ComputeRoutesRequest.polylineQuality کنترل کرد.
speedPaths
readonly
نوع: Array<SpeedPath>
گروه‌بندی بخش‌های مسیر مرحله با خواندن سرعت مربوطه. برای پر شدن این فیلد، ComputeRoutesRequest.routingPreference باید روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم شود و ComputeRoutesRequest.extraComputations باید شامل TRAFFIC_ON_POLYLINE باشد.
startLocation
readonly
نوع: DirectionalLocation optional
مکان شروع این بخش. این مکان ممکن است با ComputeRoutesRequest.origin متفاوت باشد. برای مثال، وقتی ComputeRoutesRequest.origin نزدیک جاده نیست، این نقطه روی جاده است.
staticDurationMillis
readonly
نوع: number optional
مدت سفر در بخش بدون درنظر گرفتن شرایط ترافیک.

توجه: اگر مدت‌زمان از ۲^۵۳ میلی‌ثانیه بیشتر شود، این مقدار Number.POSITIVE_INFINITY است.
steps
readonly
آرایه‌ای از مراحل که بخش‌های درون این مسیر را نشان می‌دهد. هر مرحله نشان‌دهنده یک دستورالعمل ناوبری است.
stepsOverview
readonly
نوع: StepsOverview optional
اطلاعات کلی درباره مراحل این RouteLeg. این فیلد فقط برای مسیرهای TRANSIT پر می‌شود.
travelAdvisory
readonly
نوع: RouteLegTravelAdvisory optional
حاوی اطلاعات تکمیلی است که کاربر باید از آن‌ها مطلع شود، مثل محدودیت‌های احتمالی منطقه ترافیکی در یک بخش مسیر.
از سازمان بالاتر: toJSON

RouteLegLocalizedValues کلاس

کلاس google.maps.routes.RouteLegLocalizedValues
کتابخانه "routes"

نمایش نوشتاری RouteLeg.

const {RouteLegLocalizedValues} = await google.maps.importLibrary("routes");
distance
readonly
نوع: string optional
مسافت سفر بخش مسیر به‌صورت نوشتاری.
distanceLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار فاصله، مانند «en-US» یا «sr-Latn».

برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید.
duration
readonly
نوع: string optional
مدت، به‌صورت نوشتاری و بومی‌سازی‌شده برای منطقه پُرسمان نشان داده می‌شود. شرایط ترافیک را درنظر می‌گیرد.
durationLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار مدت، مانند «en-US» یا «sr-Latn».

برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید.
staticDuration
readonly
نوع: string optional
مدت‌زمان بدون درنظر گرفتن شرایط ترافیک، که به‌صورت نوشتاری نشان داده می‌شود.
staticDurationLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار مدت‌زمان ایستا، مانند «en-US» یا «sr-Latn».
از سازمان بالاتر: toJSON

کلاس RouteLegStep

کلاس google.maps.routes.RouteLegStep
کتابخانه "routes"

حاوی بخشی از RouteLeg است. هر مرحله مربوط به یک دستورالعمل ناوبری است. بخش‌های مسیر از مراحل تشکیل شده‌اند.

const {RouteLegStep} = await google.maps.importLibrary("routes");
distanceMeters
readonly
نوع: number
مسافت سفر این مرحله، به متر.
endLocation
readonly
نوع: DirectionalLocation optional
مکان پایان این مرحله.
instructions
readonly
نوع: string optional
دستورالعمل‌های پیمایش این مرحله.
localizedValues
readonly
نمایش‌های نوشتاری ویژگی‌های RouteLegStep.
maneuver
readonly
نوع: string optional
مانور ناوبری که باید در این مرحله انجام شود. برای مشاهده فهرست مقادیر ممکن، مانور را ببینید.
path
readonly
فهرست LatLngAltitudeهای مرحله بخش مسیر که می‌توان از آن برای ترسیم چندخطی مرحله بخش مسیر استفاده کرد. دقت مسیر را می‌توان با تنظیم ComputeRoutesRequest.polylineQuality کنترل کرد. فیلد "path" باید در ComputeRoutesRequest.fields درخواست شود تا این فیلد پر شود.
startLocation
readonly
نوع: DirectionalLocation optional
مکان شروع این مرحله.
staticDurationMillis
readonly
نوع: number optional
مدت زمان سفر در این مرحله بدون درنظر گرفتن شرایط ترافیک.

توجه: اگر مدت‌زمان از ۲^۵۳ میلی‌ثانیه بیشتر شود، این مقدار Number.POSITIVE_INFINITY است.
transitDetails
readonly
نوع: TransitDetails optional
جزئیات مربوط به این مرحله اگر حالت سفر TRANSIT باشد.
travelMode
readonly
نوع: TravelMode optional
حالت سفر استفاده‌شده برای این مرحله.
از سازمان بالاتر: toJSON

RouteLegStepLocalizedValues کلاس

کلاس google.maps.routes.RouteLegStepLocalizedValues
کتابخانه "routes"

نمایش‌های نوشتاری ویژگی‌های RouteLegStep.

const {RouteLegStepLocalizedValues} = await google.maps.importLibrary("routes");
distance
readonly
نوع: string optional
مسافت سفر مرحله بخش مسیر به‌صورت نوشتاری.
distanceLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار فاصله، مانند «en-US» یا «sr-Latn».

برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید.
staticDuration
readonly
نوع: string optional
مدت‌زمان بدون درنظر گرفتن شرایط ترافیک، که به‌صورت نوشتاری نشان داده می‌شود.
staticDurationLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار مدت‌زمان ایستا، مانند «en-US» یا «sr-Latn».

برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید.
از سازمان بالاتر: toJSON

کلاس RouteLegTravelAdvisory

کلاس google.maps.routes.RouteLegTravelAdvisory
کتابخانه "routes"

حاوی اطلاعات بیشتری است که کاربر باید در RouteLeg از آن‌ها مطلع شود.

const {RouteLegTravelAdvisory} = await google.maps.importLibrary("routes");
speedReadingIntervals
readonly
نوع: 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
readonly
نوع: TollInfo optional
حاوی اطلاعاتی درباره عوارض در RouteLeg خاص است. این فیلد فقط درصورتی پر می‌شود که انتظار برود در RouteLeg عوارض وجود داشته باشد. اگر این فیلد تنظیم شده باشد اما TollInfo.estimatedPrices درج نشده باشد، بخش مسیر شامل عوارض است اما قیمت تخمینی نامشخص است. اگر این فیلد خالی باشد، یعنی در RouteLeg عوارضی وجود ندارد.
از سازمان بالاتر: toJSON

RouteLocalizedValues کلاس

کلاس google.maps.routes.RouteLocalizedValues
کتابخانه "routes"

نمایش‌های نوشتاری ویژگی‌های Route.

const {RouteLocalizedValues} = await google.maps.importLibrary("routes");
distance
readonly
نوع: string optional
مسافت سفر مسیر به‌صورت نوشتاری نشان داده می‌شود.
distanceLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار فاصله، مانند «en-US» یا «sr-Latn».

برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید.
duration
readonly
نوع: string optional
مدت، به‌صورت نوشتاری و بومی‌سازی‌شده برای منطقه پُرسمان نشان داده می‌شود. شرایط ترافیک را درنظر می‌گیرد. توجه: اگر اطلاعات ترافیک را درخواست نکرده باشید، این مقدار همان مقدار staticDuration است.
durationLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار مدت، مانند «en-US» یا «sr-Latn».

برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید.
staticDuration
readonly
نوع: string optional
مدت‌زمان بدون درنظر گرفتن شرایط ترافیک، که به‌صورت نوشتاری نشان داده می‌شود.
staticDurationLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار مدت‌زمان ایستا، مانند «en-US» یا «sr-Latn».
transitFare
readonly
نوع: string optional
کرایه حمل‌ونقل عمومی به‌صورت نوشتاری نشان داده می‌شود.
transitFareLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار کرایه حمل‌ونقل عمومی، مثل «en-US» یا «sr-Latn».
از سازمان بالاتر: toJSON

میانای RouteModifiers

میانا google.maps.routes.RouteModifiers

مجموعه‌ای از شرایط اختیاری را برای برآورده کردن هنگام محاسبه مسیرها دربرمی‌گیرد.
avoidFerries
اختیاری
نوع: boolean optional
وقتی روی true تنظیم شده باشد، درصورت امکان از کشتی‌های خودروبر اجتناب می‌کند و مسیرهای بدون کشتی خودروبر را ترجیح می‌دهد. فقط برای DRIVING یا TWO_WHEELER TravelMode اعمال می‌شود.
avoidHighways
اختیاری
نوع: boolean optional
وقتی روی true تنظیم شود، درصورت امکان از بزرگراه‌ها اجتناب می‌کند و مسیرهایی را که بزرگراه ندارند ترجیح می‌دهد. فقط برای DRIVING یا TWO_WHEELER TravelMode اعمال می‌شود.
avoidIndoor
اختیاری
نوع: boolean optional
وقتی روی true تنظیم شده باشد، درصورت امکان از پیمایش در فضای بسته اجتناب می‌کند و مسیرهایی را که حاوی پیمایش در فضای بسته نیستند ترجیح می‌دهد. فقط برای WALKING TravelMode اعمال می‌شود.
avoidTolls
اختیاری
نوع: boolean optional
وقتی روی true تنظیم شده باشد، درصورت امکان از جاده‌های عوارضی اجتناب می‌کند و مسیرهایی را که جاده عوارضی ندارند ترجیح می‌دهد. فقط برای DRIVING یا TWO_WHEELER TravelMode اعمال می‌شود.
tollPasses
اختیاری
نوع: Iterable<string> optional
اطلاعات مربوط به گذرکارت‌های عوارضی را کپسوله‌سازی می‌کند. اگر گذرکارت عوارضی ارائه شده باشد، API تلاش می‌کند قیمت گذرکارت را برگرداند. اگر گذرکارت عوارضی ارائه نشده باشد، API گذرکارت عوارضی را به‌عنوان نامشخص درنظر می‌گیرد و سعی می‌کند قیمت نقدی را برگرداند. فقط برای DRIVING یا TWO_WHEELER TravelMode اعمال می‌شود. برای مشاهده فهرست مقادیر معتبر، TollPass را ببینید.
vehicleInfo
اختیاری
نوع: VehicleInfo optional
اطلاعات خودرو را مشخص می‌کند.

میانای RoutePolyline3DOptions

میانا google.maps.routes.RoutePolyline3DOptions

گزینه‌های ایجاد چندخطی سه‌بعدی مسیر.
colorScheme
اختیاری
نوع: ColorScheme optional
طرح رنگی که برای چندخطی سه‌بعدی استفاده می‌شود. وقتی به‌عنوان FOLLOW_SYSTEM مشخص شود و نقشه colorScheme نیز FOLLOW_SYSTEM باشد، چندخطی‌ها در همان حالت تیره/روشن نقشه ترسیم خواهند شد. وقتی مشخص نشده باشد، AlphaRoute.create3DPolylines تلاش می‌کند از colorScheme نقشه استفاده کند یا به پیش‌فرض سیستم برمی‌گردد.
polylineOptions
اختیاری
گزینه‌های سفارشی‌سازی کردن سبک چندخطی سه‌بعدی.
trafficPolylinesDisabled
اختیاری
نوع: boolean optional
آیا چندخطی‌های آگاه از ترافیک غیرفعال شوند یا نه. چندخطی‌های آگاه از ترافیک فقط زمانی دردسترس است که routingPreference روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم شده باشد.

میانای RoutePolylineDetails

میانا google.maps.routes.RoutePolylineDetails

جزئیات مربوط به بخشی از مسیر مطابق با چندخطی که می‌تواند برای سفارشی‌سازی سبک چندخطی استفاده شود.
speed
اختیاری
نوع: Speed optional
سرعت خواندن بخشی از مسیر مربوط به این چندخطی. فقط برای مسیرهای دارای اطلاعات ترافیک درج می‌شود.
transitDetails
اختیاری
نوع: TransitDetails optional
جزئیات حمل‌ونقل عمومی بخشی از مسیر که با این چندخطی مطابقت دارد. فقط برای مسیرهای دارای اطلاعات حمل‌ونقل عمومی درج می‌شود.
travelMode
اختیاری
نوع: TravelMode optional
حالت سفر بخشی از مسیر که با این چندخطی مطابقت دارد. خالی برای چندخطی‌های ترافیک.

میانای RoutePolylineOptions

میانا google.maps.routes.RoutePolylineOptions

گزینه‌های ایجاد چندخطی‌های مسیر.
colorScheme
اختیاری
نوع: ColorScheme optional
آرایش رنگ‌ها برای استفاده در چندخطی. وقتی به‌عنوان FOLLOW_SYSTEM مشخص شود و نقشه colorScheme نیز FOLLOW_SYSTEM باشد، چندخطی‌ها در همان حالت تیره/روشن نقشه ترسیم خواهند شد. وقتی مشخص نشده باشد، Route.createPolylines تلاش می‌کند از colorScheme نقشه استفاده کند یا به پیش‌فرض سیستم برمی‌گردد.
polylineOptions
اختیاری
گزینه‌های سفارشی‌سازی کردن سبک چندخطی. می‌تواند شیء PolylineOptions باشد که برای همه چندخطی‌های مسیر اعمال می‌شود یا تابعی باشد که PolylineOptions و RoutePolylineDetails پیش‌فرض را می‌گیرد و PolylineOptions را برای اعمال شدن روی آن چندخطی برمی‌گرداند.

RouteTravelAdvisory کلاس

کلاس google.maps.routes.RouteTravelAdvisory
کتابخانه "routes"

حاوی اطلاعات بیشتری است که کاربر باید در Route از آن‌ها مطلع شود.

const {RouteTravelAdvisory} = await google.maps.importLibrary("routes");
fuelConsumptionMicroliters
readonly
نوع: number optional
مصرف سوخت پیش‌بینی‌شده به میکرولیتر.

توجه: اگر مصرف سوخت از ۲^۵۳ میکرولیتر بیشتر شود، این مقدار Number.POSITIVE_INFINITY است.
routeRestrictionsPartiallyIgnored
readonly
نوع: boolean optional
Route ممکن است محدودیت‌هایی داشته باشد که برای حالت سفر یا اصلاح‌کننده‌های مسیر درخواست‌شده مناسب نباشد.
speedReadingIntervals
readonly
نوع: 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
readonly
نوع: TollInfo optional
حاوی اطلاعاتی درباره عوارض در Route است. این فیلد فقط درصورتی پر می‌شود که انتظار برود در Route عوارض وجود داشته باشد. اگر این فیلد تنظیم شده باشد اما TollInfo.estimatedPrices درج نشده باشد، مسیر دارای عوارض است اما قیمت تخمینی نامشخص است. اگر این فیلد خالی باشد، یعنی در Route عوارضی وجود ندارد.
transitFare
readonly
نوع: Money optional
درصورت وجود، شامل کل هزینه کرایه یا بلیت این Route است. این ویژگی فقط برای TRANSIT ComputeRoutesRequest.travelMode و فقط برای مسیرهایی برگردانده می‌شود که اطلاعات کرایه برای همه مراحل حمل‌ونقل عمومی دردسترس باشد.
از سازمان بالاتر: toJSON

ثابت‌های RoutingPreference

ثابت‌ها google.maps.routes.RoutingPreference کتابخانه
"routes"

مجموعه‌ای از مقادیر که عواملی را مشخص می‌کند که باید هنگام محاسبه مسیر درنظر گرفته شوند. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع RoutingPreferenceString تعریف می‌شوند.

const {RoutingPreference} = await google.maps.importLibrary("routes");
TRAFFIC_AWARE مسیرها را با درنظر گرفتن شرایط ترافیک زنده محاسبه می‌کند. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
TRAFFIC_AWARE_OPTIMAL مسیرها را با درنظر گرفتن شرایط ترافیک زنده محاسبه می‌کند، بدون اینکه اکثر بهینه‌سازی‌های عملکرد را اعمال کند. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
TRAFFIC_UNAWARE مسیرها را بدون درنظر گرفتن شرایط ترافیک زنده محاسبه می‌کند. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

یادآورهای همیشگی سرعت

ثابت‌ها google.maps.routes.Speed کتابخانه
"routes"

طبقه‌بندی سرعت چندخطی براساس داده‌های ترافیک. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع SpeedString تعریف می‌شوند.

const {Speed} = await google.maps.importLibrary("routes");
NORMAL سرعت عادی، بدون تأخیر ترافیکی. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
SLOW کاهش سرعت شناسایی شد، ترافیک متوسط. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
TRAFFIC_JAM تأخیر ترافیک. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

میانای SpeedPath

میانا google.maps.routes.SpeedPath

‫LatLngAltitudeهای یک بازه مسیر را با خواندن سرعت برای آن بازه گروه‌بندی می‌کند.
path
مسیر تحت پوشش این مسیر سرعت.
speed
اختیاری
نوع: Speed optional
سرعت خواندن مسیر.

کلاس SpeedReadingInterval

کلاس google.maps.routes.SpeedReadingInterval
کتابخانه "routes"

نشانگر تراکم ترافیک در بخش مجاور چندخطی یا مسیر. با داشتن مسیری با نقاط P_0،‏ P_1،‏ ...،‏ P_N (شاخص صفرپایه)، SpeedReadingInterval تراکم ترافیک یک بازه را توصیف می‌کند.

const {SpeedReadingInterval} = await google.maps.importLibrary("routes");
endPolylinePointIndex
readonly
نوع: number optional
نمایه پایانی این فاصله در چندخطی.
speed
readonly
نوع: Speed optional
سرعت ترافیک در این بازه.
startPolylinePointIndex
readonly
نوع: number optional
نمایه شروع این فاصله زمانی در چندخطی.

StepsOverview کلاس

کلاس google.maps.routes.StepsOverview
کتابخانه "routes"

اطلاعات کلی درباره فهرستی از RouteLeg.steps ارائه می‌دهد.

const {StepsOverview} = await google.maps.importLibrary("routes");
multiModalSegments
readonly
اطلاعات خلاصه‌شده درباره بخش‌های چندحالتی مختلف RouteLeg.steps.
از سازمان بالاتر: toJSON

TollInfo کلاس

کلاس google.maps.routes.TollInfo
کتابخانه "routes"

اطلاعات عوارض را در Route یا RouteLeg کپسوله می‌کند.

const {TollInfo} = await google.maps.importLibrary("routes");
estimatedPrices
readonly
نوع: Array<Money> optional
مبلغ پولی عوارض برای Route یا RouteLeg مربوطه. این فهرست حاوی مبلغی برای هر واحد پولی است که انتظار می‌رود ایستگاه‌های عوارضی دریافت کنند. معمولاً این فهرست فقط شامل یک مورد برای مسیرهای دارای عوارض با یک ارز خواهد بود. برای سفرهای بین‌المللی، این فهرست ممکن است شامل چندین مورد باشد تا عوارض را با واحدهای پولی مختلف نشان دهد. اگر عوارض موردانتظار باشد اما قیمت تخمینی نامشخص باشد، این فیلد ممکن است آرایه خالی باشد.
از سازمان بالاتر: toJSON

TransitAgency class

کلاس google.maps.routes.TransitAgency
کتابخانه "routes"

اطلاعات مربوط به دفتر حمل‌ونقل عمومی.

const {TransitAgency} = await google.maps.importLibrary("routes");
name
readonly
نوع: string optional
نام این سازمان حمل‌ونقل عمومی.
phoneNumber
readonly
نوع: string optional
شماره تلفن سازمان حمل‌ونقل عمومی با قالب‌بندی مختص منطقه زبانی.
url
readonly
نوع: URL optional
نشانی وب دفتر حمل‌ونقل عمومی.
از سازمان بالاتر: toJSON

کلاس TransitDetails

کلاس google.maps.routes.TransitDetails
کتابخانه "routes"

اطلاعات بیشتر درباره مرحله حمل‌ونقل عمومی در مسیر.

const {TransitDetails} = await google.maps.importLibrary("routes");
arrivalStop
readonly
نوع: TransitStop optional
اطلاعات مربوط به ایستگاه مقصد برای این مرحله.
arrivalTime
readonly
نوع: Date optional
زمان تخمینی ورود برای مرحله.
departureStop
readonly
نوع: TransitStop optional
اطلاعات مربوط به ایستگاه حرکت برای این مرحله.
departureTime
readonly
نوع: Date optional
زمان تخمینی حرکت برای این مرحله.
headsign
readonly
نوع: string optional
جهت حرکت در این خط را همان‌طور که روی وسیله نقلیه یا در ایستگاه عزیمت علامت‌گذاری شده است مشخص می‌کند. جهت اغلب ایستگاه پایانی است.
headwayMillis
readonly
نوع: number optional
زمان موردانتظار را برحسب میلی‌ثانیه بین حرکت‌ها از یک ایستگاه در این زمان مشخص می‌کند. برای مثال، با مقدار فاصله زمانی ۶۰۰٬۰۰۰، اگر اتوبوس را ازدست بدهید، انتظار می‌رود ده دقیقه منتظر بمانید.

توجه: اگر فاصله زمانی از ۲^۵۳ میلی‌ثانیه بیشتر شود، این مقدار Number.POSITIVE_INFINITY است.
stopCount
readonly
نوع: number
تعداد توقف‌ها از ایستگاه عزیمت تا ایستگاه ورود. این تعداد شامل ایستگاه ورود می‌شود، اما ایستگاه خروج را دربرنمی‌گیرد. برای مثال، اگر مسیرتان از ایستگاه الف شروع شود، از ایستگاه‌های ب و پ عبور کند، و به ایستگاه ت برسد، stopCount برابر با ۳ خواهد بود.
transitLine
readonly
نوع: TransitLine optional
اطلاعات مربوط به خط حمل‌ونقل عمومی استفاده‌شده در مرحله.
tripShortText
readonly
نوع: string optional
نوشتاری که در زمان‌بندی‌ها و تابلوهای راهنما نشان داده می‌شود تا سفر حمل‌ونقل عمومی را برای مسافران مشخص کند. این نوشتار به‌طور منحصربه‌فردی سفر را در یک روز خدمات مشخص می‌کند. برای مثال، «۵۳۸» tripShortText قطار Amtrak است که در روزهای هفته ساعت ۱۵:۱۰ از سن خوزه، کالیفرنیا به مقصد ساکرامنتو، کالیفرنیا حرکت می‌کند.
از سازمان بالاتر: toJSON

TransitLine کلاس

کلاس google.maps.routes.TransitLine
کتابخانه "routes"

اطلاعات مربوط به خط حمل‌ونقل عمومی.

const {TransitLine} = await google.maps.importLibrary("routes");
agencies
readonly
سازمان حمل‌ونقل عمومی (یا سازمان‌هایی) که این خط حمل‌ونقل عمومی را اداره می‌کند.
color
readonly
نوع: string optional
رنگی که معمولاً در تابلوهای این خط استفاده می‌شود. به‌صورت شانزده‌شانزدهی نشان داده می‌شود.
iconURL
readonly
نوع: URL optional
نشانی وب نماد مرتبط با این خط.
name
readonly
نوع: string optional
نام کامل این خط حمل‌ونقل عمومی، برای مثال، «8 Avenue Local».
shortName
readonly
نوع: string optional
نام کوتاه این خط حمل‌ونقل عمومی. این نام معمولاً شماره خط است، مثل «M7» یا «355».
textColor
readonly
نوع: string optional
رنگی که معمولاً در نوشتار تابلوهای این خط استفاده می‌شود. به‌صورت شانزده‌شانزدهی نشان داده می‌شود.
url
readonly
نوع: URL optional
نشانی وب این خط حمل‌ونقل عمومی که توسط سازمان حمل‌ونقل عمومی ارائه شده است.
vehicle
readonly
نوع: TransitVehicle optional
نوع وسیله نقلیه‌ای که در این خط حمل‌ونقل عمومی کار می‌کند.
از سازمان بالاتر: toJSON

میانای TransitPreference

میانا google.maps.routes.TransitPreference

اولویت‌های مربوط به مسیرهای مبتنی بر TRANSIT که بر مسیر برگشتی تأثیر می‌گذارد.
allowedTransitModes
اختیاری
نوع: Iterable<TransitMode> optional
مجموعه‌ای از حالت‌های سفر برای استفاده هنگام دریافت مسیر TRANSIT. به‌طور پیش‌فرض همه حالت‌های سفر پشتیبانی‌شده را نشان می‌دهد.
routingPreference
اختیاری
نوع: TransitRoutePreference optional
اولویت مسیریابی که درصورت مشخص شدن، بر مسیر TRANSIT برگردانده‌شده تأثیر می‌گذارد.

کلاس TransitStop

کلاس google.maps.routes.TransitStop
کتابخانه "routes"

اطلاعات مربوط به ایستگاه حمل‌ونقل عمومی.

const {TransitStop} = await google.maps.importLibrary("routes");
location
readonly
نوع: DirectionalLocation optional
مکان ایستگاه که با مختصات عرض جغرافیایی/طول جغرافیایی و عنوان اختیاری بیان می‌شود.
name
readonly
نوع: string optional
نام ایستگاه حمل‌ونقل عمومی.
از سازمان بالاتر: toJSON

کلاس TransitVehicle

کلاس google.maps.routes.TransitVehicle
کتابخانه "routes"

اطلاعات مربوط به وسیله نقلیه مورداستفاده در مسیرهای حمل‌ونقل عمومی.

const {TransitVehicle} = await google.maps.importLibrary("routes");
iconURL
readonly
نوع: URL optional
نشانی وب نماد مرتبط با این نوع خودرو.
localIconURL
readonly
نوع: URL optional
نشانی وب نماد مرتبط با این نوع وسیله نقلیه، براساس علائم حمل‌ونقل محلی.
name
readonly
نوع: string optional
نام این خودرو، با حروف بزرگ.
nameLanguage
readonly
نوع: string optional
کد زبان BCP-47 نوشتار نام خودرو، مثل «en-US» یا «sr-Latn».

برای اطلاعات بیشتر، به این نشانی مراجعه کنید: https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
vehicleType
readonly
نوع: string optional
نوع وسیله نقلیه استفاده‌شده.

برای مشاهده فهرست مقادیر ممکن، https://developers.google.com/maps/documentation/routes/reference/rpc/google.maps.routing.v2#transitvehicletype را ببینید.
از سازمان بالاتر: toJSON

ثابت‌های VehicleEmissionType

ثابت‌ها google.maps.routes.VehicleEmissionType کتابخانه
"routes"

مجموعه‌ای از مقادیر که نوع انتشار کربن خودرو را توصیف می‌کند. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع VehicleEmissionTypeString تعریف می‌شوند.

const {VehicleEmissionType} = await google.maps.importLibrary("routes");
DIESEL خودروِ گازوئیلی. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
ELECTRIC خودرو برقی. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
GASOLINE خودروِ بنزینی. برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.
HYBRID خودرو با سوخت ترکیبی (مثل بنزین + برق). برای اطلاعات بیشتر، به اسناد سرویس وب مراجعه کنید.

میانای VehicleInfo

میانا google.maps.routes.VehicleInfo

حاوی اطلاعات خودرو، مثل نوع آلایندگی خودرو است.
emissionType
اختیاری
نوع: VehicleEmissionType optional
نوع انتشار کربن خودرو را توصیف می‌کند. فقط برای حالت سفر DRIVING اعمال می‌شود.

میانای Waypoint

میانا google.maps.routes.Waypoint

نشان‌دهنده نقطه‌مسیر در مسیر است.
location
مکان نقطه‌مسیر. رشته می‌تواند نشانی، plus code، یا نام منبع «مکان» باشد.
sideOfRoad
اختیاری
نوع: boolean optional
نشان می‌دهد که مکان این نقطه‌مسیر برای توقف خودرو در سمت خاصی از جاده ترجیح داده می‌شود. وقتی این مقدار را تنظیم می‌کنید، مسیر از مکان عبور می‌کند تا خودرو بتواند در سمتی از جاده که مکان نسبت‌به مرکز جاده به آن متمایل است توقف کند. این گزینه فقط برای DRIVING و TWO_WHEELER ComputeRoutesRequest.travelMode کار می‌کند
vehicleStopover
اختیاری
نوع: boolean optional
نشان می‌دهد که نقطه‌مسیر برای توقف خودروها درنظر گرفته شده است، جایی که هدف سوار کردن یا پیاده کردن است. وقتی این مقدار را تنظیم می‌کنید، مسیر محاسبه‌شده شامل نقطه‌مسیرهای غیرvia در جاده‌هایی که برای سوار کردن و پیاده کردن مناسب نیستند نخواهد بود. این گزینه فقط برای DRIVING و TWO_WHEELER ComputeRoutesRequest.travelMode و زمانی‌که Waypoint.location string یا Place نباشد کار می‌کند.
via
اختیاری
نوع: boolean optional
این نقطه‌مسیر را به‌عنوان نقطه عطف علامت‌گذاری می‌کند نه نقطه توقف. برای هر نقطه‌مسیر غیرvia در ComputeRoutesRequest، Route.computeRoutes ورودی‌ای به آرایه Route.legs اضافه می‌کند تا جزئیات توقف‌های بین راه را در آن بخش از سفر ارائه دهد.

وقتی می‌خواهید مسیر بدون توقف از این نقطه‌مسیر عبور کند، این مقدار را روی true تنظیم کنید. نقطه‌مسیرهای گذری باعث نمی‌شوند ورودی‌ای به آرایه Route.legs اضافه شود، اما سفر را ازطریق نقطه‌مسیر مسیریابی می‌کنند.

نکته‌ها:
  • این مقدار را فقط می‌توانید برای نقاط‌مسیر میانی تنظیم کنید. اگر این فیلد را روی نقطه‌مسیرهای پایانه تنظیم کنید، درخواست ناموفق خواهد بود.
  • اگر ComputeRoutesRequest.optimizeWaypointOrder روی true تنظیم شده باشد، این فیلد نمی‌تواند روی درست تنظیم شود؛ درغیراین‌صورت، درخواست ناموفق خواهد بود.

میانای WaypointMarkerDetails

میانا google.maps.routes.WaypointMarkerDetails

جزئیات مربوط به نقطه‌مسیر که می‌تواند برای سفارشی‌سازی سبک نشانگر استفاده شود.
index
نوع: number
نمایه نشانگر.
totalMarkers
نوع: number
تعداد کل نشانگرها در مسیر.
leg
اختیاری
نوع: RouteLeg optional
مسیری که نشانگر به آن تعلق دارد. اگر مسیر بخش نداشته باشد، خالی است.