Поделиться через

RouteBeginPostRouteMatrixPreviewOptionalParams interface

  • Ссылка
Пакет:
azure-maps-rest

Необязательные параметры.

Extends

RequestOptionsBase

Свойства

arriveAt

Дата и время прибытия в точку назначения. Его необходимо указать как dateTime. Если смещение часового пояса не указано, оно будет считаться смещением конечной точки. Значение arriveAt должно быть в будущем. Параметр arriveAt нельзя использовать в сочетании с типом departAt, minDeviationDistance или minDeviationTime.
avoid

Указывает то, чего следует избегать при вычислении маршрута при определении маршрута. Можно указать несколько раз в одном запросе, например "&avoid=автомагистрали&avoid=tollRoads&avoid=ferries". В запросах calculateReachableRange не следует использовать значение alreadyUsedRoads. Возможные значения: tollRoads, 'автомагистрали', 'паромы', 'unpavedRoads', 'carpools', 'alreadyUsedRoads', 'borderCrossings'
computeTravelTimeFor

Указывает, следует ли возвращать дополнительное время в пути, используя различные типы сведений о дорожном движении (нет, исторические, динамические), а также оптимальное время поездки по умолчанию. Возможные значения: "none", "all"
departAt

Дата и время отправления из точки начала. Время отправления, кроме этого, должно быть указано как dateTime. Если смещение часового пояса не указано, предполагается, что это смещение исходной точки. Значение departAt должно быть в будущем в формате даты и времени (1996-12-19T16:39:57-08:00).
hilliness

Степень холмистости для захватывающего маршрута. Этот параметр можно использовать только в сочетании с routeTypeпараметром =thrilling. Возможные значения: low, normal, high
routeType

Тип запрошенного маршрута. Возможные значения: "самый быстрый", "кратчайший", "эко", "захватывающий"
sectionType

Указывает, какой из типов разделов указывается в ответе маршрута.

Например, если sectionType = пешеход, возвращаются разделы, которые подходят только для пешеходов. Можно использовать несколько типов. Значение по умолчанию sectionType относится к входным данным travelMode. По умолчанию travelMode имеет значение car. Возможные значения: "carTrain", "country", "ferry", "автомагистраль", "пешеход", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"
traffic

Возможные значения:

  • True — учитывайте все доступные сведения о трафике во время маршрутизации.
  • false — игнорировать текущие данные трафика во время маршрутизации. Обратите внимание, что, хотя текущие данные о дорожном движении игнорируются во время маршрутизации, влияние исторического трафика на эффективную скорость движения по-прежнему учитывается.
travelMode

Режим перемещения для запрошенного маршрута. Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет другим. Обратите внимание, что режимы перемещения автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные об ограничениях доступны не во всех областях. В запросах calculateReachableRange не следует использовать значения велосипеда и пешехода. Возможные значения: "автомобиль", "грузовик", "такси", "автобус", "ван", "мотоцикл", "велосипед", "пешеход"
vehicleAxleWeight

Вес на оси транспортного средства в кг. Значение 0 означает, что ограничения веса на оси не учитываются.
vehicleHeight

Высота транспортного средства в метрах. Значение 0 означает, что ограничения по высоте не учитываются.
vehicleLength

Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются.
vehicleLoadType

Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены с некоторых дорог. Доступные значения vehicleLoadType — это классы 1–9 в США Hazmat, а также универсальные классификации для использования в других странах. Значения, начинающиеся с USHazmat, предназначены для маршрутизации в США, в то время как otherHazmat следует использовать для всех остальных стран. vehicleLoadType можно указать несколько раз. В настоящее время этот параметр учитывается только для travelMode=truck. Возможные значения: USHazmatClass1, "USHazmatClass2", "USHazmatClass3", "USHazmatClass4", "USHazmatClass5", "USHazmatClass6", "USHazmatClass7", "USHazmatClass8", "USHazmatClass9", "otherHazmatExplosive", "otherHazmatGeneral", "otherHazmatHarmfulToWater"
vehicleMaxSpeed

Максимальная скорость транспортного средства в км/час. Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута. Ненулевое значение может быть переопределено во время планирования маршрута.
vehicleWeight

Вес транспортного средства в килограммах.
vehicleWidth

Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются.
waitForResults

Логическое значение, указывающее, следует ли выполнять запрос синхронно. Если задано значение true, пользователь получит ответ 200, если запрос будет завершен в течение 120 секунд. В противном случае пользователь сразу же получит ответ 202. Дополнительные сведения об ответе 202 см. в описании API.
windingness

Уровень поворотов для захватывающего маршрута. Этот параметр можно использовать только в сочетании с routeType=thrilling. Возможные значения: low, normal, high

Унаследованные свойства

abortSignal

Сигнал, который можно использовать для прерывания запросов.
customHeaders

{object} [customHeaders] Определяемые пользователем пользовательские заголовки запросов, которые будут применены перед отправкой запроса.
onDownloadProgress

Обратный вызов, который срабатывает при скачивании.
onUploadProgress

Обратный вызов, который срабатывает при выполнении отправки.
timeout

Количество миллисекундах, которые может занять запрос до автоматического завершения.

Сведения о свойстве

arriveAt

Дата и время прибытия в точку назначения. Его необходимо указать как dateTime. Если смещение часового пояса не указано, оно будет считаться смещением конечной точки. Значение arriveAt должно быть в будущем. Параметр arriveAt нельзя использовать в сочетании с типом departAt, minDeviationDistance или minDeviationTime.

arriveAt?: Date

Значение свойства

Date

avoid

Указывает то, чего следует избегать при вычислении маршрута при определении маршрута. Можно указать несколько раз в одном запросе, например "&avoid=автомагистрали&avoid=tollRoads&avoid=ferries". В запросах calculateReachableRange не следует использовать значение alreadyUsedRoads. Возможные значения: tollRoads, 'автомагистрали', 'паромы', 'unpavedRoads', 'carpools', 'alreadyUsedRoads', 'borderCrossings'

avoid?: Avoid[]

Значение свойства

Avoid[]

computeTravelTimeFor

Указывает, следует ли возвращать дополнительное время в пути, используя различные типы сведений о дорожном движении (нет, исторические, динамические), а также оптимальное время поездки по умолчанию. Возможные значения: "none", "all"

computeTravelTimeFor?: ComputeTravelTimeFor

Значение свойства

ComputeTravelTimeFor

departAt

Дата и время отправления из точки начала. Время отправления, кроме этого, должно быть указано как dateTime. Если смещение часового пояса не указано, предполагается, что это смещение исходной точки. Значение departAt должно быть в будущем в формате даты и времени (1996-12-19T16:39:57-08:00).

departAt?: Date

Значение свойства

Date

hilliness

Степень холмистости для захватывающего маршрута. Этот параметр можно использовать только в сочетании с routeTypeпараметром =thrilling. Возможные значения: low, normal, high

hilliness?: Hilliness

Значение свойства

Hilliness

routeType

Тип запрошенного маршрута. Возможные значения: "самый быстрый", "кратчайший", "эко", "захватывающий"

routeType?: RouteType

Значение свойства

RouteType

sectionType

Указывает, какой из типов разделов указывается в ответе маршрута.

Например, если sectionType = пешеход, возвращаются разделы, которые подходят только для пешеходов. Можно использовать несколько типов. Значение по умолчанию sectionType относится к входным данным travelMode. По умолчанию travelMode имеет значение car. Возможные значения: "carTrain", "country", "ferry", "автомагистраль", "пешеход", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"

sectionType?: SectionType

Значение свойства

SectionType

traffic

Возможные значения:

  • True — учитывайте все доступные сведения о трафике во время маршрутизации.
  • false — игнорировать текущие данные трафика во время маршрутизации. Обратите внимание, что, хотя текущие данные о дорожном движении игнорируются во время маршрутизации, влияние исторического трафика на эффективную скорость движения по-прежнему учитывается.
traffic?: boolean

Значение свойства

boolean

travelMode

Режим перемещения для запрошенного маршрута. Обратите внимание, что запрошенный travelMode может быть недоступен для всего маршрута. Если запрошенный travelMode недоступен для определенного раздела, элемент travelMode ответа для этого раздела будет другим. Обратите внимание, что режимы перемещения автобус, мотоцикл, такси и фургон являются бета-функциями. Полные данные об ограничениях доступны не во всех областях. В запросах calculateReachableRange не следует использовать значения велосипеда и пешехода. Возможные значения: "автомобиль", "грузовик", "такси", "автобус", "ван", "мотоцикл", "велосипед", "пешеход"

travelMode?: TravelMode

Значение свойства

TravelMode

vehicleAxleWeight

Вес на оси транспортного средства в кг. Значение 0 означает, что ограничения веса на оси не учитываются.

vehicleAxleWeight?: number

Значение свойства

number

vehicleHeight

Высота транспортного средства в метрах. Значение 0 означает, что ограничения по высоте не учитываются.

vehicleHeight?: number

Значение свойства

number

vehicleLength

Длина транспортного средства в метрах. Значение 0 означает, что ограничения длины не учитываются.

vehicleLength?: number

Значение свойства

number

vehicleLoadType

Типы грузов, которые могут быть классифицированы как опасные материалы и ограничены с некоторых дорог. Доступные значения vehicleLoadType — это классы 1–9 в США Hazmat, а также универсальные классификации для использования в других странах. Значения, начинающиеся с USHazmat, предназначены для маршрутизации в США, в то время как otherHazmat следует использовать для всех остальных стран. vehicleLoadType можно указать несколько раз. В настоящее время этот параметр учитывается только для travelMode=truck. Возможные значения: USHazmatClass1, "USHazmatClass2", "USHazmatClass3", "USHazmatClass4", "USHazmatClass5", "USHazmatClass6", "USHazmatClass7", "USHazmatClass8", "USHazmatClass9", "otherHazmatExplosive", "otherHazmatGeneral", "otherHazmatHarmfulToWater"

vehicleLoadType?: VehicleLoadType

Значение свойства

VehicleLoadType

vehicleMaxSpeed

Максимальная скорость транспортного средства в км/час. Значение 0 означает, что соответствующее значение для транспортного средства будет определено и применено во время планирования маршрута. Ненулевое значение может быть переопределено во время планирования маршрута.

vehicleMaxSpeed?: number

Значение свойства

number

vehicleWeight

Вес транспортного средства в килограммах.

vehicleWeight?: number

Значение свойства

number

vehicleWidth

Ширина транспортного средства в метрах. Значение 0 означает, что ограничения ширины не учитываются.

vehicleWidth?: number

Значение свойства

number

waitForResults

Логическое значение, указывающее, следует ли выполнять запрос синхронно. Если задано значение true, пользователь получит ответ 200, если запрос будет завершен в течение 120 секунд. В противном случае пользователь сразу же получит ответ 202. Дополнительные сведения об ответе 202 см. в описании API.

waitForResults?: boolean

Значение свойства

boolean

windingness

Уровень поворотов для захватывающего маршрута. Этот параметр можно использовать только в сочетании с routeType=thrilling. Возможные значения: low, normal, high

windingness?: Windingness

Значение свойства

Windingness

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

Наследуется от RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Определяемые пользователем пользовательские заголовки запросов, которые будут применены перед отправкой запроса.

customHeaders?: [key: string]: string

Значение свойства

[key: string]: string

Наследуется от RequestOptionsBase.customHeaders

onDownloadProgress

Обратный вызов, который срабатывает при скачивании.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

Наследуется от RequestOptionsBase.onDownloadProgress

onUploadProgress

Обратный вызов, который срабатывает при выполнении отправки.

onUploadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

Наследуется от RequestOptionsBase.onUploadProgress

timeout

Количество миллисекундах, которые может занять запрос до автоматического завершения.

timeout?: number

Значение свойства

number

Наследуется от RequestOptionsBase.timeout