RoutePostRouteMatrixPreviewOptionalParams interface

  • Reference
Balíček:
azure-maps-rest

Volitelné parametry.

Extends

RequestOptionsBase

Vlastnosti

arriveAt

Datum a čas příjezdu do cílového bodu. Musí být zadán jako dateTime. Pokud není zadaný posun časového pásma, předpokládá se, že se jedná o posun cílového bodu. Hodnota arriveAt musí být v budoucnu. Parametr arriveAt nelze použít ve spojení s departAt, minDeviationDistance nebo minDeviationTime.
avoid

Určuje něco, čeho by se měl výpočet trasy při určování trasy snažit vyhnout. V jednom požadavku je možné zadat vícekrát, například "&avoid=motorways&avoid=tollRoads&avoid=ferries". V požadavcích calculateReachableRange se nesmí použít hodnota alreadyUsedRoads. Mezi možné hodnoty patří: "tollRoads", "dálnice", "trajekty", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings"
computeTravelTimeFor

Určuje, zda se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádný, historický, živý) a výchozího nejlepšího odhadu doby cesty. Mezi možné hodnoty patří: 'none', 'all'
departAt

Datum a čas odjezdu z výchozího bodu. Časy odjezdu kromě této chvíle musí být zadány jako dateTime. Pokud není zadaný posun časového pásma, předpokládá se, že je posunem počátečního bodu. Hodnota departAt musí být v budoucnu ve formátu data a času (1996-12-19T16:39:57-08:00).
hilliness

Stupeň kopcovitosti pro vzrušující trasu. Tento parametr se dá použít pouze ve spojení s parametrem routeType=thrilling. Mezi možné hodnoty patří: "nízká", "normální", "vysoká"
routeType

Typ požadované trasy. Mezi možné hodnoty patří: "nejrychlejší", "nejkratší", "eco", "vzrušující"
sectionType

Určuje, které typy oddílů jsou hlášeny v odpovědi na trasu.

Pokud například sectionType = pěší, vrátí se úseky, které jsou vhodné pouze pro chodce. Je možné použít více typů. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastavený na auto. Mezi možné hodnoty patří: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"
traffic

Možné hodnoty:

  • true – Při směrování zvažte všechny dostupné informace o provozu.
  • false – ignoruje aktuální data provozu během směrování. Všimněte si, že i když se aktuální data o provozu během směrování ignorují, vliv historického provozu na efektivní rychlost silnic je stále začleněný.
travelMode

Režim jízdy pro požadovanou trasu. Upozorňujeme, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není k dispozici pro konkrétní oddíl, bude prvek travelMode odpovědi pro tento oddíl jiný. Všimněte si, že režimy cestování autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou k dispozici ve všech oblastech. V požadavcích calculateReachableRange nesmí být použity hodnoty jízdní kolo a pěší. Mezi možné hodnoty patří: "auto", "truck", "taxi", "bus", "van", "motocykl", "kolo", "chodec"
vehicleAxleWeight

Hmotnost na nápravu vozidla v kg. Hodnota 0 znamená, že se nepřihlíží k hmotnostním omezením na nápravu.
vehicleHeight

Výška vozidla v metrech. Hodnota 0 znamená, že se neúčtují omezení výšky.
vehicleLength

Délka vozidla v metrech. Hodnota 0 znamená, že se neúčtují omezení délky.
vehicleLoadType

Druhy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny z některých silnic. Dostupné hodnoty vehicleLoadType jsou americké třídy Hazmat 1 až 9 a obecné klasifikace pro použití v jiných zemích. Hodnoty začínající na USHazmat jsou pro směrování v USA, zatímco ostatníHazmat by se měly používat pro všechny ostatní země. vehicleLoadType lze zadat vícekrát. Tento parametr se v současné době uvažuje pouze pro travelMode=truck. Mezi možné hodnoty patří: USHazmatClass1, USHazmatClass2, USHazmatClass3, USHazmatClass4, USHazmatClass5, USHazmatClass6, USHazmatClass7, USHazmatClass8, USHazmatClass9, otherHazmatExplosive, otherHazmatGenermatmat, otherHazmatGenermatal, otherHazmatHarmfulToWater.
vehicleMaxSpeed

Maximální rychlost vozidla v km/hod. Hodnota 0 znamená, že odpovídající hodnota pro vozidlo bude určena a použita během plánování trasy. Nenulová hodnota může být během plánování trasy přepsána.
vehicleWeight

Hmotnost vozidla v kilogramech.
vehicleWidth

Šířka vozidla v metrech. Hodnota 0 znamená, že omezení šířky nejsou brána v úvahu.
waitForResults

Logická hodnota označující, jestli se má požadavek spustit synchronně. Pokud je nastavená hodnota true, uživatel obdrží odpověď 200, pokud je požadavek dokončen pod 120 sekund. V opačném případě uživatel dostane okamžitě odpověď 202. Další podrobnosti o odpovědi 202 najdete v popisu rozhraní API.
windingness

Úroveň zatáček pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=thrilling. Mezi možné hodnoty patří: "nízký", "normální", "vysoký".

Zděděné vlastnosti

abortSignal

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

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

Zpětné volání, které se aktivuje při průběhu 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 před automatickým ukončením.

Podrobnosti vlastnosti

arriveAt

Datum a čas příjezdu do cílového bodu. Musí být zadán jako dateTime. Pokud není zadaný posun časového pásma, předpokládá se, že se jedná o posun cílového bodu. Hodnota arriveAt musí být v budoucnu. Parametr arriveAt nelze použít ve spojení s departAt, minDeviationDistance nebo minDeviationTime.

arriveAt?: Date

Hodnota vlastnosti

Date

avoid

Určuje něco, čeho by se měl výpočet trasy při určování trasy snažit vyhnout. V jednom požadavku je možné zadat vícekrát, například "&avoid=motorways&avoid=tollRoads&avoid=ferries". V požadavcích calculateReachableRange se nesmí použít hodnota alreadyUsedRoads. Mezi možné hodnoty patří: "tollRoads", "dálnice", "trajekty", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings"

avoid?: Avoid[]

Hodnota vlastnosti

Avoid[]

computeTravelTimeFor

Určuje, zda se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádný, historický, živý) a výchozího nejlepšího odhadu doby cesty. Mezi možné hodnoty patří: 'none', 'all'

computeTravelTimeFor?: ComputeTravelTimeFor

Hodnota vlastnosti

ComputeTravelTimeFor

departAt

Datum a čas odjezdu z výchozího bodu. Časy odjezdu kromě této chvíle musí být zadány jako dateTime. Pokud není zadaný posun časového pásma, předpokládá se, že je posunem počátečního bodu. Hodnota departAt musí být v budoucnu ve formátu data a času (1996-12-19T16:39:57-08:00).

departAt?: Date

Hodnota vlastnosti

Date

hilliness

Stupeň kopcovitosti pro vzrušující trasu. Tento parametr se dá použít pouze ve spojení s parametrem routeType=thrilling. Mezi možné hodnoty patří: "nízká", "normální", "vysoká"

hilliness?: Hilliness

Hodnota vlastnosti

Hilliness

routeType

Typ požadované trasy. Mezi možné hodnoty patří: "nejrychlejší", "nejkratší", "eco", "vzrušující"

routeType?: RouteType

Hodnota vlastnosti

RouteType

sectionType

Určuje, které typy oddílů jsou hlášeny v odpovědi na trasu.

Pokud například sectionType = pěší, vrátí se úseky, které jsou vhodné pouze pro chodce. Je možné použít více typů. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastavený na auto. Mezi možné hodnoty patří: "carTrain", "country", "ferry", "motorway", "pedestrian", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"

sectionType?: SectionType

Hodnota vlastnosti

SectionType

traffic

Možné hodnoty:

  • true – Při směrování zvažte všechny dostupné informace o provozu.
  • false – ignoruje aktuální data provozu během směrování. Všimněte si, že i když se aktuální data o provozu během směrování ignorují, vliv historického provozu na efektivní rychlost silnic je stále začleněný.
traffic?: boolean

Hodnota vlastnosti

boolean

travelMode

Režim jízdy pro požadovanou trasu. Upozorňujeme, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není k dispozici pro konkrétní oddíl, bude prvek travelMode odpovědi pro tento oddíl jiný. Všimněte si, že režimy cestování autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou k dispozici ve všech oblastech. V požadavcích calculateReachableRange nesmí být použity hodnoty jízdní kolo a pěší. Mezi možné hodnoty patří: "auto", "truck", "taxi", "bus", "van", "motocykl", "kolo", "chodec"

travelMode?: TravelMode

Hodnota vlastnosti

TravelMode

vehicleAxleWeight

Hmotnost na nápravu vozidla v kg. Hodnota 0 znamená, že se nepřihlíží k hmotnostním omezením na nápravu.

vehicleAxleWeight?: number

Hodnota vlastnosti

number

vehicleHeight

Výška vozidla v metrech. Hodnota 0 znamená, že se neúčtují omezení výšky.

vehicleHeight?: number

Hodnota vlastnosti

number

vehicleLength

Délka vozidla v metrech. Hodnota 0 znamená, že se neúčtují omezení délky.

vehicleLength?: number

Hodnota vlastnosti

number

vehicleLoadType

Druhy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny z některých silnic. Dostupné hodnoty vehicleLoadType jsou americké třídy Hazmat 1 až 9 a obecné klasifikace pro použití v jiných zemích. Hodnoty začínající na USHazmat jsou pro směrování v USA, zatímco ostatníHazmat by se měly používat pro všechny ostatní země. vehicleLoadType lze zadat vícekrát. Tento parametr se v současné době uvažuje pouze pro travelMode=truck. Mezi možné hodnoty patří: USHazmatClass1, USHazmatClass2, USHazmatClass3, USHazmatClass4, USHazmatClass5, USHazmatClass6, USHazmatClass7, USHazmatClass8, USHazmatClass9, otherHazmatExplosive, otherHazmatGenermatmat, otherHazmatGenermatal, otherHazmatHarmfulToWater.

vehicleLoadType?: VehicleLoadType

Hodnota vlastnosti

VehicleLoadType

vehicleMaxSpeed

Maximální rychlost vozidla v km/hod. Hodnota 0 znamená, že odpovídající hodnota pro vozidlo bude určena a použita během plánování trasy. Nenulová hodnota může být během plánování trasy přepsána.

vehicleMaxSpeed?: number

Hodnota vlastnosti

number

vehicleWeight

Hmotnost vozidla v kilogramech.

vehicleWeight?: number

Hodnota vlastnosti

number

vehicleWidth

Šířka vozidla v metrech. Hodnota 0 znamená, že omezení šířky nejsou brána v úvahu.

vehicleWidth?: number

Hodnota vlastnosti

number

waitForResults

Logická hodnota označující, jestli se má požadavek spustit synchronně. Pokud je nastavená hodnota true, uživatel obdrží odpověď 200, pokud je požadavek dokončen pod 120 sekund. V opačném případě uživatel dostane okamžitě odpověď 202. Další podrobnosti o odpovědi 202 najdete v popisu rozhraní API.

waitForResults?: boolean

Hodnota vlastnosti

boolean

windingness

Úroveň zatáček pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=thrilling. Mezi možné hodnoty patří: "nízký", "normální", "vysoký".

windingness?: Windingness

Hodnota vlastnosti

Windingness

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] Uživatelem definované vlastní hlavičky požadavků, 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 průběhu 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 před automatickým ukončením.

timeout?: number

Hodnota vlastnosti

number

Zděděno z RequestOptionsBase.timeout