MobilityGetTransitRoutePreviewOptionalParams interface

Balíček:

azure-maps-rest

Volitelné parametry.

Extends

RequestOptionsBase

Vlastnosti

agency	Určuje, zda se mají upřednostňovat trasy z konkrétní sady agentur, pokud je to možné. jako seznam oddělený čárkami. Pokud se u preferované agentury nenajde platná cesta nebo pouze jedna s velmi dlouhými cestami nebo s velkým počtem transferů, vrátí se itineráře s jinými agenturami.
agencyType	Určuje identifikátor agentury pro vyžádání tras od upřednostňovaných agentur. Ve výchozím nastavení je agencyType=agencyId. Mezi možné hodnoty patří: 'agencyId', 'agencyKey', 'agencyName'
bikeType	Typ kola. Určuje, jaký typ kol se použije. Pokud není zadaný, budou povoleny všechny. Mezi možné hodnoty patří: privateBike, dockedBike.
destinationType	Typ cíle. Mezi možné hodnoty patří: position, stopId, stopKey.
language	Jazyk, ve kterém se budou vracet výsledky hledání. Podporuje se pouze NGT. Podrobnosti najdete v části Podporované jazyky .
modeType	Režim jízdy pro požadovanou trasu; jako seznam oddělený čárkami. Pokud není zadán, budou povoleny všechny režimy. Všechny režimy nemusí být dostupné ve všech oblastech metra. Pokud se platná cesta nenajde, vrátí se prázdný výsledek.
originType	Typ původu. Ve výchozím nastavení je originType=position zadaný jako řetězec oddělený čárkami složený podle zeměpisné šířky následované délkou, např. "47.641268,-122.125679". Mezi možné hodnoty patří: position, stopId, stopKey.
routeType	Typ požadované trasy. Pokud není zadáno, použije se "optimální". Mezi možné hodnoty patří: "optimal", "leastWalk", "leastTransfers"
time	Čas odletu nebo příjezdu v místním čase ve formátu ISO (2019-04-05T14:24:18-04:00). Pokud parametr timeType není zadaný, bude považován za "odjezd" a čas je aktuální místní čas v počátečním bodě.
timeType	Určuje, jestli čas označuje čas odletu nebo čas příjezdu. Pokud není definován, výchozí hodnota je "departure". Mezi možné hodnoty patří: 'arrival', 'departure', 'last'
transitType	Platí pouze pro modeType = publicTransit. Povolit vrácení pouze konkrétní sady typů veřejné dopravy (jako seznam oddělených čárkami) pro trasu. Všimněte si, že požadovaný typ transitType nemusí být k dispozici pro celou trasu. Pokud není zadán, budou povoleny všechny režimy.

Zděděné vlastnosti

abortSignal	Signál, který lze použít k přerušení požadavků.
customHeaders	{object} [customHeaders] Vlastní hlavičky požadavků definované uživatelem, které se použijí před odesláním požadavku.
onDownloadProgress	Zpětné volání, které se aktivuje při stahování.
onUploadProgress	Zpětné volání, které se aktivuje při průběhu nahrávání.
timeout	Počet milisekund, které může požadavek trvat, než se automaticky ukončí.

Podrobnosti vlastnosti

agency

Určuje, zda se mají upřednostňovat trasy z konkrétní sady agentur, pokud je to možné. jako seznam oddělený čárkami. Pokud se u preferované agentury nenajde platná cesta nebo pouze jedna s velmi dlouhými cestami nebo s velkým počtem transferů, vrátí se itineráře s jinými agenturami.

agency?: string[]

Hodnota vlastnosti

string[]

agencyType

Určuje identifikátor agentury pro vyžádání tras od upřednostňovaných agentur. Ve výchozím nastavení je agencyType=agencyId. Mezi možné hodnoty patří: 'agencyId', 'agencyKey', 'agencyName'

agencyType?: AgencyType

Hodnota vlastnosti

AgencyType

bikeType

Typ kola. Určuje, jaký typ kol se použije. Pokud není zadaný, budou povoleny všechny. Mezi možné hodnoty patří: privateBike, dockedBike.

bikeType?: BikeType

Hodnota vlastnosti

BikeType

destinationType

Typ cíle. Mezi možné hodnoty patří: position, stopId, stopKey.

destinationType?: DestinationType

Hodnota vlastnosti

DestinationType

language

Jazyk, ve kterém se budou vracet výsledky hledání. Podporuje se pouze NGT. Podrobnosti najdete v části Podporované jazyky .

language?: string

Hodnota vlastnosti

string

modeType

Režim jízdy pro požadovanou trasu; jako seznam oddělený čárkami. Pokud není zadán, budou povoleny všechny režimy. Všechny režimy nemusí být dostupné ve všech oblastech metra. Pokud se platná cesta nenajde, vrátí se prázdný výsledek.

modeType?: ModeType[]

Hodnota vlastnosti

ModeType[]

originType

Typ původu. Ve výchozím nastavení je originType=position zadaný jako řetězec oddělený čárkami složený podle zeměpisné šířky následované délkou, např. "47.641268,-122.125679". Mezi možné hodnoty patří: position, stopId, stopKey.

originType?: OriginType

Hodnota vlastnosti

OriginType

routeType

Typ požadované trasy. Pokud není zadáno, použije se "optimální". Mezi možné hodnoty patří: "optimal", "leastWalk", "leastTransfers"

routeType?: TransitRouteType

Hodnota vlastnosti

TransitRouteType

time

Čas odletu nebo příjezdu v místním čase ve formátu ISO (2019-04-05T14:24:18-04:00). Pokud parametr timeType není zadaný, bude považován za "odjezd" a čas je aktuální místní čas v počátečním bodě.

time?: string

Hodnota vlastnosti

string

timeType

Určuje, jestli čas označuje čas odletu nebo čas příjezdu. Pokud není definován, výchozí hodnota je "departure". Mezi možné hodnoty patří: 'arrival', 'departure', 'last'

timeType?: TimeType

Hodnota vlastnosti

TimeType

transitType

Platí pouze pro modeType = publicTransit. Povolit vrácení pouze konkrétní sady typů veřejné dopravy (jako seznam oddělených čárkami) pro trasu. Všimněte si, že požadovaný typ transitType nemusí být k dispozici pro celou trasu. Pokud není zadán, budou povoleny všechny režimy.

transitType?: TransitTypeFilter[]

Hodnota vlastnosti

TransitTypeFilter[]

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

Zděděno z RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Vlastní hlavičky požadavků definované uživatelem, které se použijí před odesláním požadavku.

customHeaders?: [key: string]: string

Hodnota vlastnosti

[key: string]: string

Zděděno z RequestOptionsBase.customHeaders

onDownloadProgress

Zpětné volání, které se aktivuje při stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z RequestOptionsBase.onDownloadProgress

onUploadProgress

Zpětné volání, které se aktivuje při průběhu nahrávání.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z RequestOptionsBase.onUploadProgress

timeout

Počet milisekund, které může požadavek trvat, než se automaticky ukončí.

timeout?: number

Hodnota vlastnosti

number

Zděděno z RequestOptionsBase.timeout