Share via

RoutePostRouteMatrixPreviewOptionalParams interface

  • Referência
Pacote:
azure-maps-rest

Parâmetros Opcionais.

Extends

RequestOptionsBase

Propriedades

arriveAt

A data e hora de chegada no ponto de destino. Tem de ser especificado como dateTime. Quando um desvio de fuso horário não for especificado, assume-se que é o do ponto de destino. O valor arriveAt tem de estar no futuro. O parâmetro arriveAt não pode ser utilizado em conjunto com departAt, minDeviationDistance ou minDeviationTime.
avoid

Especifica algo que o cálculo da rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes num pedido, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Em calculateReachableRange requests, o valor alreadyUsedRoads não pode ser utilizado. Os valores possíveis incluem: "tollRoads", "auto-estradas", "ferries", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings"
computeTravelTimeFor

Especifica se pretende devolver tempos de viagem adicionais utilizando diferentes tipos de informações de tráfego (nenhum, histórico, em direto), bem como o tempo de viagem predefinido de melhor estimativa. Os valores possíveis incluem: "none", "all"
departAt

A data e hora de partida do ponto de origem. As horas de partida para além de agora têm de ser especificadas como dateTime. Quando um desvio de fuso horário não é especificado, assume-se que é o do ponto de origem. O valor departAt tem de estar no futuro no formato de data-hora (1996-12-19T16:39:57-08:00).
hilliness

Grau de colina para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com routeType=emocionante. Os valores possíveis incluem: "baixo", "normal", "alto"
routeType

O tipo de rota pedida. Os valores possíveis incluem: "mais rápido", "mais curto", "eco", "emocionante"
sectionType

Especifica qual dos tipos de secção é comunicado na resposta da rota.

Por exemplo, se sectionType = peões, as secções adequadas apenas para peões são devolvidas. Podem ser utilizados vários tipos. O sectionType predefinido refere-se à entrada travelMode. Por predefinição, travelMode está definido como carro. Os valores possíveis incluem: "carTrain", "country", "ferry", "highway", "pedestrian", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"
traffic

Valores possíveis:

  • true - Considere todas as informações de tráfego disponíveis durante o encaminhamento
  • false - Ignore os dados de tráfego atuais durante o encaminhamento. Tenha em atenção que, embora os dados de tráfego atuais sejam ignorados durante o encaminhamento, o efeito do tráfego histórico em velocidades de estrada eficazes continua a ser incorporado.
travelMode

O modo de viagem para a rota pedida. Tenha em atenção que o travelMode pedido pode não estar disponível para toda a rota. Quando o travelMode pedido não estiver disponível para uma secção específica, o elemento travelMode da resposta para essa secção será outro. Tenha em atenção que os modos de viagem de ônibus, motociclo, táxi e van são funcionalidades BETA. Os dados de restrição total não estão disponíveis em todas as áreas. Em calculateReachableRange requests, os valores bicicleta e pedestre não podem ser utilizados. Os valores possíveis incluem: "carro", "camião", "táxi", "autocarro", "carrinha", "moto", "bicicleta", "pedestre"
vehicleAxleWeight

Peso por eixo do veículo em kg. Um valor de 0 significa que as restrições de peso por eixo não são consideradas.
vehicleHeight

Altura do veículo em metros. Um valor de 0 significa que as restrições de altura não são consideradas.
vehicleLength

Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.
vehicleLoadType

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a algumas estradas. Os valores de vehicleLoadType disponíveis são classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para utilização noutros países. Os valores que começam com USHazmat destinam-se ao encaminhamento dos EUA, enquanto outrosHazmat devem ser utilizados para todos os outros países. vehicleLoadType pode ser especificado várias vezes. Este parâmetro é atualmente considerado apenas para travelMode=truck. Os valores possíveis incluem: "USHazmatClass1", "USHazmatClass2", "USHazmatClass3", "USHazmatClass4", "USHazmatClass5", "USHazmatClass6", "USHazmatClass7", "USHazmatClass8", "USHazmatClass8", "USHazmatClass9", "otherHazmatExplosive", "otherHazmatGeneral", "otherHazmatHarmfulToWater"
vehicleMaxSpeed

Velocidade máxima do veículo em km/hora. Um valor de 0 significa que um valor adequado para o veículo será determinado e aplicado durante o planeamento da rota. Um valor não zero pode ser substituído durante o planeamento de rotas.
vehicleWeight

Peso do veículo em quilogramas.
vehicleWidth

Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.
waitForResults

Booleano para indicar se deve executar o pedido de forma síncrona. Se estiver definido como verdadeiro, o utilizador obterá uma resposta 200 se o pedido for concluído em menos de 120 segundos. Caso contrário, o utilizador receberá imediatamente uma resposta 202. Veja a descrição da API para obter mais detalhes sobre a resposta 202.
windingness

Nível de voltas para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com routeType=emocionante. Os valores possíveis incluem: "baixo", "normal", "alto"

Propriedades Herdadas

abortSignal

O sinal que pode ser utilizado para abortar pedidos.
customHeaders

{object} [customHeaders] Cabeçalhos de pedido personalizados definidos pelo utilizador que serão aplicados antes do pedido ser enviado.
onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.
onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.
timeout

O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.

Detalhes de Propriedade

arriveAt

A data e hora de chegada no ponto de destino. Tem de ser especificado como dateTime. Quando um desvio de fuso horário não for especificado, assume-se que é o do ponto de destino. O valor arriveAt tem de estar no futuro. O parâmetro arriveAt não pode ser utilizado em conjunto com departAt, minDeviationDistance ou minDeviationTime.

arriveAt?: Date

Valor de Propriedade

Date

avoid

Especifica algo que o cálculo da rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes num pedido, por exemplo, "&avoid=motorways&avoid=tollRoads&avoid=ferries". Em calculateReachableRange requests, o valor alreadyUsedRoads não pode ser utilizado. Os valores possíveis incluem: "tollRoads", "auto-estradas", "ferries", "unpavedRoads", "carpools", "alreadyUsedRoads", "borderCrossings"

avoid?: Avoid[]

Valor de Propriedade

Avoid[]

computeTravelTimeFor

Especifica se pretende devolver tempos de viagem adicionais utilizando diferentes tipos de informações de tráfego (nenhum, histórico, em direto), bem como o tempo de viagem predefinido de melhor estimativa. Os valores possíveis incluem: "none", "all"

computeTravelTimeFor?: ComputeTravelTimeFor

Valor de Propriedade

ComputeTravelTimeFor

departAt

A data e hora de partida do ponto de origem. As horas de partida para além de agora têm de ser especificadas como dateTime. Quando um desvio de fuso horário não é especificado, assume-se que é o do ponto de origem. O valor departAt tem de estar no futuro no formato de data-hora (1996-12-19T16:39:57-08:00).

departAt?: Date

Valor de Propriedade

Date

hilliness

Grau de colina para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com routeType=emocionante. Os valores possíveis incluem: "baixo", "normal", "alto"

hilliness?: Hilliness

Valor de Propriedade

Hilliness

routeType

O tipo de rota pedida. Os valores possíveis incluem: "mais rápido", "mais curto", "eco", "emocionante"

routeType?: RouteType

Valor de Propriedade

RouteType

sectionType

Especifica qual dos tipos de secção é comunicado na resposta da rota.

Por exemplo, se sectionType = peões, as secções adequadas apenas para peões são devolvidas. Podem ser utilizados vários tipos. O sectionType predefinido refere-se à entrada travelMode. Por predefinição, travelMode está definido como carro. Os valores possíveis incluem: "carTrain", "country", "ferry", "highway", "pedestrian", "tollRoad", "tollVignette", "traffic", "travelMode", "tunnel"

sectionType?: SectionType

Valor de Propriedade

SectionType

traffic

Valores possíveis:

  • true - Considere todas as informações de tráfego disponíveis durante o encaminhamento
  • false - Ignore os dados de tráfego atuais durante o encaminhamento. Tenha em atenção que, embora os dados de tráfego atuais sejam ignorados durante o encaminhamento, o efeito do tráfego histórico em velocidades de estrada eficazes continua a ser incorporado.
traffic?: boolean

Valor de Propriedade

boolean

travelMode

O modo de viagem para a rota pedida. Tenha em atenção que o travelMode pedido pode não estar disponível para toda a rota. Quando o travelMode pedido não estiver disponível para uma secção específica, o elemento travelMode da resposta para essa secção será outro. Tenha em atenção que os modos de viagem de ônibus, motociclo, táxi e van são funcionalidades BETA. Os dados de restrição total não estão disponíveis em todas as áreas. Em calculateReachableRange requests, os valores bicicleta e pedestre não podem ser utilizados. Os valores possíveis incluem: "carro", "camião", "táxi", "autocarro", "carrinha", "moto", "bicicleta", "pedestre"

travelMode?: TravelMode

Valor de Propriedade

TravelMode

vehicleAxleWeight

Peso por eixo do veículo em kg. Um valor de 0 significa que as restrições de peso por eixo não são consideradas.

vehicleAxleWeight?: number

Valor de Propriedade

number

vehicleHeight

Altura do veículo em metros. Um valor de 0 significa que as restrições de altura não são consideradas.

vehicleHeight?: number

Valor de Propriedade

number

vehicleLength

Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.

vehicleLength?: number

Valor de Propriedade

number

vehicleLoadType

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a algumas estradas. Os valores de vehicleLoadType disponíveis são classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para utilização noutros países. Os valores que começam com USHazmat destinam-se ao encaminhamento dos EUA, enquanto outrosHazmat devem ser utilizados para todos os outros países. vehicleLoadType pode ser especificado várias vezes. Este parâmetro é atualmente considerado apenas para travelMode=truck. Os valores possíveis incluem: "USHazmatClass1", "USHazmatClass2", "USHazmatClass3", "USHazmatClass4", "USHazmatClass5", "USHazmatClass6", "USHazmatClass7", "USHazmatClass8", "USHazmatClass8", "USHazmatClass9", "otherHazmatExplosive", "otherHazmatGeneral", "otherHazmatHarmfulToWater"

vehicleLoadType?: VehicleLoadType

Valor de Propriedade

VehicleLoadType

vehicleMaxSpeed

Velocidade máxima do veículo em km/hora. Um valor de 0 significa que um valor adequado para o veículo será determinado e aplicado durante o planeamento da rota. Um valor não zero pode ser substituído durante o planeamento de rotas.

vehicleMaxSpeed?: number

Valor de Propriedade

number

vehicleWeight

Peso do veículo em quilogramas.

vehicleWeight?: number

Valor de Propriedade

number

vehicleWidth

Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.

vehicleWidth?: number

Valor de Propriedade

number

waitForResults

Booleano para indicar se deve executar o pedido de forma síncrona. Se estiver definido como verdadeiro, o utilizador obterá uma resposta 200 se o pedido for concluído em menos de 120 segundos. Caso contrário, o utilizador receberá imediatamente uma resposta 202. Veja a descrição da API para obter mais detalhes sobre a resposta 202.

waitForResults?: boolean

Valor de Propriedade

boolean

windingness

Nível de voltas para uma rota emocionante. Este parâmetro só pode ser utilizado em conjunto com routeType=emocionante. Os valores possíveis incluem: "baixo", "normal", "alto"

windingness?: Windingness

Valor de Propriedade

Windingness

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser utilizado para abortar pedidos.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

Herdado de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Cabeçalhos de pedido personalizados definidos pelo utilizador que serão aplicados antes do pedido ser enviado.

customHeaders?: [key: string]: string

Valor de Propriedade

[key: string]: string

Herdado de RequestOptionsBase.customHeaders

onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.

timeout?: number

Valor de Propriedade

number

Herdado de RequestOptionsBase.timeout