RouteURL class

  • ‏‏المرجع
الحزمة:
azure-maps-rest

يمثل RouteURL عنوان URL لعمليات توجيه خرائط Azure.

Extends
MapsURL

المنشئون

RouteURL(Pipeline, string)

إنشاء مثيل RouteURL.

الخصائص الموروثة

mapsUrl

قيمة سلسلة عنوان URL الأساسي.

الأساليب

calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)

إرجاع مسار بين أصل ووجهة، ويمر عبر نقاط الطريق إذا تم تحديدها. وسيأخذ المسار في الاعتبار عوامل مثل حركة المرور الحالية وسرعات الطرق النموذجية في اليوم المطلوب من الأسبوع والوقت من اليوم. تتضمن المعلومات التي يتم إرجاعها المسافة ووقت السفر المقدر وتمثيل هندسة المسار. تتوفر أيضا معلومات توجيه إضافية مثل ترتيب نقطة الطريق المحسن أو إرشادات التشغيل حسب الدور، اعتمادا على الخيارات المحددة.

توفر خدمة التوجيه مجموعة من المعلمات لوصف مفصل لنموذج الاستهلاك الخاص بالمركبات. يرجى التحقق من نموذج الاستهلاك للحصول على شرح مفصل للمفاهيم والمعلمات المعنية.

إذا options.postBody تم تحديد يستخدم واجهة برمجة تطبيقات اتجاهات ما بعد المسار: https://docs.microsoft.com/rest/api/maps/route/postroutedirections

بخلاف ذلك، تستخدم واجهة برمجة تطبيقات Get Route Directions: https://docs.microsoft.com/rest/api/maps/route/getroutedirections
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

ملاحظة: واجهة برمجة التطبيقات هذه قيد المعاينة حاليا وقد تخضع للتغييرات العاجلة. حساب مصفوفة من ملخصات المسار لمجموعة من المسارات المحددة بواسطة مواقع الأصل والوجهة. لكل أصل معين، تحسب هذه الخدمة تكلفة التوجيه من هذا الأصل إلى كل وجهة معينة. يمكن اعتبار مجموعة الأصول ومجموعة الوجهات رؤوس الأعمدة والصفوف لجدول وتحتوي كل خلية في الجدول على تكاليف التوجيه من الأصل إلى الوجهة لتلك الخلية. لكل مسار، يتم حساب أوقات السفر والمسافات. يمكنك استخدام التكاليف المحسوبة لتحديد المسارات التي يجب حسابها باستخدام Routing Directions API. إذا تم تعيين معلمة waitForResults في الطلب على false (القيمة الافتراضية)، فترجع واجهة برمجة التطبيقات هذه رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 700 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 50x10، 10x10، 28x25. 10x70 (لا يلزم أن يكون مربعا).

يعتبر حساب مصفوفة التوجيه عملية طويلة الأمد. تشير العمليات طويلة الأمد إلى أنه بعد قبول الطلب الأولي (HTTP 202) سيتم استقصاء النتيجة النهائية حتى تصبح متاحة. يعيد كل طلب استقصاء إعادة تشغيل مهلة الإجهاض، إذا تم تحديد أحدها.

يستخدم Post Route Matrix API: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

حساب مجموعة من المواقع التي يمكن الوصول إليها من نقطة الأصل استنادا إلى الوقود أو الطاقة أو الميزانية الزمنية المحددة. يتم إرجاع حد مضلع (أو Isochrone) في اتجاه عكس اتجاه عقارب الساعة بالإضافة إلى مركز المضلع الدقيق الذي كان نتيجة نقطة الأصل. يمكن استخدام المضلع الذي تم إرجاعه لمزيد من المعالجة مثل البحث Inside Geometry للبحث عن POIs داخل Isochrone المتوفر.

يستخدم واجهة برمجة تطبيقات Get Route Range: https://docs.microsoft.com/rest/api/maps/route/getrouterange

الأساليب المتوارثة

newPipeline(Credential, INewPipelineOptions)

أسلوب ثابت يستخدم لإنشاء كائن مسار جديد مع توفير بيانات الاعتماد.

تفاصيل المنشئ

RouteURL(Pipeline, string)

إنشاء مثيل RouteURL.

new RouteURL(pipeline: Pipeline, mapsUrl?: string)

المعلمات

pipeline
Pipeline

اتصل ب MapsURL.newPipeline() لإنشاء مسار افتراضي، أو توفير مسار مخصص.

mapsUrl

string

سلسلة URL تشير إلى خدمة خرائط Azure، الافتراضي هو "https://atlas.microsoft.com". إذا لم يتم تحديد أي بروتوكول، على سبيل المثال "atlas.microsoft.com"، https فسيتم افتراض ذلك.

تفاصيل الخاصية الموروثة

mapsUrl

قيمة سلسلة عنوان URL الأساسي.

mapsUrl: string

قيمة الخاصية

string

موروث منMapsURL.mapsUrl

تفاصيل الأسلوب

calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)

إرجاع مسار بين أصل ووجهة، ويمر عبر نقاط الطريق إذا تم تحديدها. وسيأخذ المسار في الاعتبار عوامل مثل حركة المرور الحالية وسرعات الطرق النموذجية في اليوم المطلوب من الأسبوع والوقت من اليوم. تتضمن المعلومات التي يتم إرجاعها المسافة ووقت السفر المقدر وتمثيل هندسة المسار. تتوفر أيضا معلومات توجيه إضافية مثل ترتيب نقطة الطريق المحسن أو إرشادات التشغيل حسب الدور، اعتمادا على الخيارات المحددة.

توفر خدمة التوجيه مجموعة من المعلمات لوصف مفصل لنموذج الاستهلاك الخاص بالمركبات. يرجى التحقق من نموذج الاستهلاك للحصول على شرح مفصل للمفاهيم والمعلمات المعنية.

إذا options.postBody تم تحديد يستخدم واجهة برمجة تطبيقات اتجاهات ما بعد المسار: https://docs.microsoft.com/rest/api/maps/route/postroutedirections

بخلاف ذلك، تستخدم واجهة برمجة تطبيقات Get Route Directions: https://docs.microsoft.com/rest/api/maps/route/getroutedirections

function calculateRouteDirections(aborter: Aborter, coordinates: GeoJSON.Position[], options?: CalculateRouteDirectionsOptions): Promise<CalculateRouteDirectionsResponse>

المعلمات

aborter
Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter لمزيد من الأمثلة حول إلغاء الطلب.

coordinates

GeoJSON.Position[]

صفيف من الإحداثيات التي يتم من خلالها حساب المسار. كل إحداثيات هي صفيف من [longitude, latitude]. مطلوب إحداثيتان كحد أدنى. الأول هو الأصل والأخير هو وجهة المسار. تعمل الإحداثيات الاختيارية بينهما ك WayPoints في المسار. يمكنك تمرير ما يصل إلى 150 WayPoints.

options
CalculateRouteDirectionsOptions

المرتجعات

Promise<CalculateRouteDirectionsResponse>

calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

ملاحظة: واجهة برمجة التطبيقات هذه قيد المعاينة حاليا وقد تخضع للتغييرات العاجلة. حساب مصفوفة من ملخصات المسار لمجموعة من المسارات المحددة بواسطة مواقع الأصل والوجهة. لكل أصل معين، تحسب هذه الخدمة تكلفة التوجيه من هذا الأصل إلى كل وجهة معينة. يمكن اعتبار مجموعة الأصول ومجموعة الوجهات رؤوس الأعمدة والصفوف لجدول وتحتوي كل خلية في الجدول على تكاليف التوجيه من الأصل إلى الوجهة لتلك الخلية. لكل مسار، يتم حساب أوقات السفر والمسافات. يمكنك استخدام التكاليف المحسوبة لتحديد المسارات التي يجب حسابها باستخدام Routing Directions API. إذا تم تعيين معلمة waitForResults في الطلب على false (القيمة الافتراضية)، فترجع واجهة برمجة التطبيقات هذه رمز استجابة 202 على طول عنوان URL لإعادة التوجيه في حقل الموقع لعنوان الاستجابة. يجب التحقق من عنوان URL هذا بشكل دوري حتى تتوفر بيانات الاستجابة أو معلومات الخطأ. الحد الأقصى لحجم مصفوفة لواجهة برمجة التطبيقات هذه هو 700 (عدد الأصول مضروبا في عدد الوجهات). مع مراعاة هذا القيد، فإن أمثلة أبعاد المصفوفة المحتملة هي: 50x10، 10x10، 28x25. 10x70 (لا يلزم أن يكون مربعا).

يعتبر حساب مصفوفة التوجيه عملية طويلة الأمد. تشير العمليات طويلة الأمد إلى أنه بعد قبول الطلب الأولي (HTTP 202) سيتم استقصاء النتيجة النهائية حتى تصبح متاحة. يعيد كل طلب استقصاء إعادة تشغيل مهلة الإجهاض، إذا تم تحديد أحدها.

يستخدم Post Route Matrix API: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview

function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>

المعلمات

aborter
Aborter

إنشاء مثيل Aborter جديد مع Aborter.none أو Aborter.timeout()، goto documents of Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب.

body
CalculateRouteMatrixRequestBody

تنسق مصفوفة الأصل والوجهة لحساب مسافة المسار ووقت السفر والملخص الآخر لكل خلية من المصفوفة استنادا إلى معلمات الإدخال. الحد الأدنى والحد الأقصى لعدد الخلايا المدعوم هو 1 و700 على التوالي. على سبيل المثال، يمكن أن يكون 35 أصل و20 وجهة أو 25 أصلا و25 وجهة.

options
CalculateRouteMatrixOptions

المرتجعات

Promise<CalculateRouteMatrixResponse>

calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

حساب مجموعة من المواقع التي يمكن الوصول إليها من نقطة الأصل استنادا إلى الوقود أو الطاقة أو الميزانية الزمنية المحددة. يتم إرجاع حد مضلع (أو Isochrone) في اتجاه عكس اتجاه عقارب الساعة بالإضافة إلى مركز المضلع الدقيق الذي كان نتيجة نقطة الأصل. يمكن استخدام المضلع الذي تم إرجاعه لمزيد من المعالجة مثل البحث Inside Geometry للبحث عن POIs داخل Isochrone المتوفر.

يستخدم واجهة برمجة تطبيقات Get Route Range: https://docs.microsoft.com/rest/api/maps/route/getrouterange

function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>

المعلمات

aborter
Aborter

إنشاء مثيل Aborter جديد مع Aborter.none أو Aborter.timeout()، goto documents of Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب.

center
GeoJSON.Position

الإحداثيات التي يجب أن يبدأ منها حساب النطاق.

options
CalculateRouteRangeOptions

المرتجعات

Promise<CalculateRouteRangeResponse>

تفاصيل الأساليب المتوارثة

newPipeline(Credential, INewPipelineOptions)

أسلوب ثابت يستخدم لإنشاء كائن مسار جديد مع توفير بيانات الاعتماد.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

المعلمات

credential
Credential

مثل SubscriptionKeyCredential و TokenCredential و MapControlCredential.

pipelineOptions
INewPipelineOptions

المرتجعات

Pipeline

كائن مسار جديد.

موروث منMapsURL.newPipeline