RouteBeginPostRouteMatrixPreviewOptionalParams interface

  • Referência
Pacote:
azure-maps-rest

Parâmetros opcionais.

Extends

RequestOptionsBase

Propriedades

arriveAt

A data e a hora de chegada no ponto de destino. Ele deve ser especificado como dateTime. Quando um deslocamento de fuso horário não for especificado, ele será considerado o do ponto de destino. O valor arriveAt deve estar no futuro. O parâmetro arriveAt não pode ser usado em conjunto com departAt, minDeviationDistance ou minDeviationTime.
avoid

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações calculateReachableRange, o valor alreadyUsedRoads não deve ser usado. Os valores possíveis incluem: 'tollRoads', 'motorways', 'ferries', 'unpavedRoads', 'carpools', 'alreadyUsedRoads', 'borderCrossings'
computeTravelTimeFor

Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão. Os valores possíveis incluem: 'none', 'all'
departAt

A data e a hora da partida do ponto de origem. Horários de partida separados de agora devem ser especificados como um dateTime. Quando um deslocamento de fuso horário não for especificado, ele será considerado o do ponto de origem. O valor departAt deve estar no futuro no formato de data e hora (1996-12-19T16:39:57-08:00).
hilliness

Grau de colina para rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante. Os valores possíveis incluem: 'low', 'normal', 'high'
routeType

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

Especifica qual dos tipos de seção é relatado na resposta da rota.

Por exemplo, se sectionType = pedestre, as seções adequadas somente para pedestres serão retornadas. Vários tipos podem ser usados. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro. Os valores possíveis incluem: 'carTrain', 'country', 'ferry', 'motorway', 'pedestrian', 'tollRoad', 'tollVignette', 'traffic', 'travelMode', 'tunnel'
traffic

Valores possíveis:

  • true – considere todas as informações de tráfego disponíveis durante o roteamento
  • false – ignorar dados de tráfego atuais durante o roteamento. Observe que, embora os dados de tráfego atuais sejam ignorados durante o roteamento, o efeito do tráfego histórico nas velocidades efetivas das estradas ainda é incorporado.
travelMode

O modo de viagem para a rota solicitada. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será outro. Observe que os modos de viagem de ônibus, motocicleta, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas. Em solicitações calculateReachableRange , os valores bicicleta e pedestre não devem ser usados. Os valores possíveis incluem: 'carro', 'caminhão', 'táxi', 'ônibus', 'van', '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 restritos de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro só é considerado para travelMode=truck. Os valores possíveis incluem: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3', 'USHazmatClass4', 'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8', 'USHazmatClass9', 'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater'
vehicleMaxSpeed

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

Peso do veículo em quilogramas.
vehicleWidth

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

Booliano para indicar se a solicitação deve ser executada de forma síncrona. Se definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos. Caso contrário, o usuário receberá uma resposta 202 imediatamente. Consulte a descrição da API para obter mais detalhes sobre a resposta 202.
windingness

Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante. Os valores possíveis incluem: 'low', 'normal', 'high'

Propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.
customHeaders

{object} [customHeaders] Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.
onDownloadProgress

Retorno de chamada que é acionado após o progresso do download.
onUploadProgress

Retorno de chamada que é acionado após o progresso do upload.
timeout

O número de milissegundos que uma solicitação pode realizar antes de ser encerrada automaticamente.

Detalhes da propriedade

arriveAt

A data e a hora de chegada no ponto de destino. Ele deve ser especificado como dateTime. Quando um deslocamento de fuso horário não for especificado, ele será considerado o do ponto de destino. O valor arriveAt deve estar no futuro. O parâmetro arriveAt não pode ser usado em conjunto com departAt, minDeviationDistance ou minDeviationTime.

arriveAt?: Date

Valor da propriedade

Date

avoid

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações calculateReachableRange, o valor alreadyUsedRoads não deve ser usado. Os valores possíveis incluem: 'tollRoads', 'motorways', 'ferries', 'unpavedRoads', 'carpools', 'alreadyUsedRoads', 'borderCrossings'

avoid?: Avoid[]

Valor da propriedade

Avoid[]

computeTravelTimeFor

Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão. Os valores possíveis incluem: 'none', 'all'

computeTravelTimeFor?: ComputeTravelTimeFor

Valor da propriedade

ComputeTravelTimeFor

departAt

A data e a hora da partida do ponto de origem. Horários de partida separados de agora devem ser especificados como um dateTime. Quando um deslocamento de fuso horário não for especificado, ele será considerado o do ponto de origem. O valor departAt deve estar no futuro no formato de data e hora (1996-12-19T16:39:57-08:00).

departAt?: Date

Valor da propriedade

Date

hilliness

Grau de colina para rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante. Os valores possíveis incluem: 'low', 'normal', 'high'

hilliness?: Hilliness

Valor da propriedade

Hilliness

routeType

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

routeType?: RouteType

Valor da propriedade

RouteType

sectionType

Especifica qual dos tipos de seção é relatado na resposta da rota.

Por exemplo, se sectionType = pedestre, as seções adequadas somente para pedestres serão retornadas. Vários tipos podem ser usados. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro. Os valores possíveis incluem: 'carTrain', 'country', 'ferry', 'motorway', 'pedestrian', 'tollRoad', 'tollVignette', 'traffic', 'travelMode', 'tunnel'

sectionType?: SectionType

Valor da propriedade

SectionType

traffic

Valores possíveis:

  • true – considere todas as informações de tráfego disponíveis durante o roteamento
  • false – ignorar dados de tráfego atuais durante o roteamento. Observe que, embora os dados de tráfego atuais sejam ignorados durante o roteamento, o efeito do tráfego histórico nas velocidades efetivas das estradas ainda é incorporado.
traffic?: boolean

Valor da propriedade

boolean

travelMode

O modo de viagem para a rota solicitada. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será outro. Observe que os modos de viagem de ônibus, motocicleta, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas. Em solicitações calculateReachableRange , os valores bicicleta e pedestre não devem ser usados. Os valores possíveis incluem: 'carro', 'caminhão', 'táxi', 'ônibus', 'van', 'moto', 'bicicleta', 'pedestre'

travelMode?: TravelMode

Valor da 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 da 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 da 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 da propriedade

number

vehicleLoadType

Tipos de carga que podem ser classificados como materiais perigosos e restritos de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro só é considerado para travelMode=truck. Os valores possíveis incluem: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3', 'USHazmatClass4', 'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8', 'USHazmatClass9', 'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater'

vehicleLoadType?: VehicleLoadType

Valor da propriedade

VehicleLoadType

vehicleMaxSpeed

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

vehicleMaxSpeed?: number

Valor da propriedade

number

vehicleWeight

Peso do veículo em quilogramas.

vehicleWeight?: number

Valor da propriedade

number

vehicleWidth

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

vehicleWidth?: number

Valor da propriedade

number

waitForResults

Booliano para indicar se a solicitação deve ser executada de forma síncrona. Se definido como true, o usuário receberá uma resposta 200 se a solicitação for concluída em menos de 120 segundos. Caso contrário, o usuário receberá uma resposta 202 imediatamente. Consulte a descrição da API para obter mais detalhes sobre a resposta 202.

waitForResults?: boolean

Valor da propriedade

boolean

windingness

Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante. Os valores possíveis incluem: 'low', 'normal', 'high'

windingness?: Windingness

Valor da propriedade

Windingness

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

Herdado de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.

customHeaders?: [key: string]: string

Valor da propriedade

[key: string]: string

Herdado de RequestOptionsBase.customHeaders

onDownloadProgress

Retorno de chamada que é acionado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onDownloadProgress

onUploadProgress

Retorno de chamada que é acionado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que uma solicitação pode realizar antes de ser encerrada automaticamente.

timeout?: number

Valor da propriedade

number

Herdado de RequestOptionsBase.timeout