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

MobilityGetTransitRoutePreviewOptionalParams interface

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

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

Extends

RequestOptionsBase

Свойства

agency

Указывает, следует ли по возможности предпочитать маршруты из определенного набора учреждений; в виде списка, разделенного запятыми. Если действительное путешествие не найдено в предпочтительном агентстве или только с очень длительными поездками или с большим количеством трансферов, маршруты с другими агентствами будут возвращены.
agencyType

Указывает идентификатор агентства для запроса маршрутов от предпочтительных агентств. По умолчанию — agencyType=agencyId. Возможные значения: "agencyId", "agencyKey", "agencyName"
bikeType

Тип велосипеда. Указывает, какой тип велосипедов будет использоваться. Если не указано, будут разрешены все. Возможные значения: privateBike, dockedBike.
destinationType

Тип назначения. Возможные значения: position, stopId, stopKey.
language

Язык, на котором будут возвращены результаты поиска. Поддерживается только NGT. Дополнительные сведения см. в статье Поддерживаемые языки .
modeType

Режим перемещения для запрошенного маршрута; в виде списка, разделенного запятыми. Если не указано, будут разрешены все режимы. Все режимы могут быть доступны не во всех районах метро. Если допустимая поездка не найдена, возвращается пустой результат.
originType

Тип источника. По умолчанию originType=position указывается в виде строки, разделенной запятыми, состоящей из широты и долготы, например "47,641268,-122.125679". Возможные значения: position, stopId, stopKey.
routeType

Тип запрошенного маршрута. Если этот параметр не указан, будет использоваться "оптимальный". Возможные значения: "optimal", "leastWalk", "leastTransfers"
time

Время отправления или прибытия по местному времени в формате ISO (2019-04-05T14:24:18-04:00). Если параметр timeType не указан, он будет считаться "вылетом", а time — текущим местным временем в исходной точке.
timeType

Указывает, означает ли время отъезда или время прибытия. Если значение не определено, значение по умолчанию — "вылет". Возможные значения: "arrival", "departure", "last"
transitType

Применимо только с параметром modeType = publicTransit. Разрешить возвращать для маршрута только определенный набор типов общественного транспорта (в виде списка, разделенного запятыми). Обратите внимание, что запрошенный transitType может быть недоступен для всего маршрута. Если не указано, будут разрешены все режимы.

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

abortSignal

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

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

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

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

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

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

agency

Указывает, следует ли по возможности предпочитать маршруты из определенного набора учреждений; в виде списка, разделенного запятыми. Если действительное путешествие не найдено в предпочтительном агентстве или только с очень длительными поездками или с большим количеством трансферов, маршруты с другими агентствами будут возвращены.

agency?: string[]

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

string[]

agencyType

Указывает идентификатор агентства для запроса маршрутов от предпочтительных агентств. По умолчанию — agencyType=agencyId. Возможные значения: "agencyId", "agencyKey", "agencyName"

agencyType?: AgencyType

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

AgencyType

bikeType

Тип велосипеда. Указывает, какой тип велосипедов будет использоваться. Если не указано, будут разрешены все. Возможные значения: privateBike, dockedBike.

bikeType?: BikeType

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

BikeType

destinationType

Тип назначения. Возможные значения: position, stopId, stopKey.

destinationType?: DestinationType

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

DestinationType

language

Язык, на котором будут возвращены результаты поиска. Поддерживается только NGT. Дополнительные сведения см. в статье Поддерживаемые языки .

language?: string

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

string

modeType

Режим перемещения для запрошенного маршрута; в виде списка, разделенного запятыми. Если не указано, будут разрешены все режимы. Все режимы могут быть доступны не во всех районах метро. Если допустимая поездка не найдена, возвращается пустой результат.

modeType?: ModeType[]

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

ModeType[]

originType

Тип источника. По умолчанию originType=position указывается в виде строки, разделенной запятыми, состоящей из широты и долготы, например "47,641268,-122.125679". Возможные значения: position, stopId, stopKey.

originType?: OriginType

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

OriginType

routeType

Тип запрошенного маршрута. Если этот параметр не указан, будет использоваться "оптимальный". Возможные значения: "optimal", "leastWalk", "leastTransfers"

routeType?: TransitRouteType

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

TransitRouteType

time

Время отправления или прибытия по местному времени в формате ISO (2019-04-05T14:24:18-04:00). Если параметр timeType не указан, он будет считаться "вылетом", а time — текущим местным временем в исходной точке.

time?: string

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

string

timeType

Указывает, означает ли время отъезда или время прибытия. Если значение не определено, значение по умолчанию — "вылет". Возможные значения: "arrival", "departure", "last"

timeType?: TimeType

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

TimeType

transitType

Применимо только с параметром modeType = publicTransit. Разрешить возвращать для маршрута только определенный набор типов общественного транспорта (в виде списка, разделенного запятыми). Обратите внимание, что запрошенный transitType может быть недоступен для всего маршрута. Если не указано, будут разрешены все режимы.

transitType?: TransitTypeFilter[]

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

TransitTypeFilter[]

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

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