RouteURL class

Um RouteURL representa um URL para as operações de rota Azure Maps.

Extends

Construtores

RouteURL(Pipeline, string)

Cria uma instância de RouteURL.

Propriedades Herdadas

mapsUrl

Valor da cadeia de URL base.

Métodos

calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)

Devolve uma rota entre uma origem e um destino, passando pelos pontos de passagem, se forem especificados. O percurso terá em conta fatores como o tráfego atual e as velocidades típicas das estradas no dia solicitado da semana e hora do dia. As informações devolvidas incluem a distância, o tempo estimado de viagem e uma representação da geometria da rota. Também estão disponíveis informações de encaminhamento adicionais, como a ordem otimizada do waypoint ou as instruções de turn by turn, consoante as opções selecionadas.

O serviço de encaminhamento fornece um conjunto de parâmetros para uma descrição detalhada do Modelo de Consumo específico do veículo. Verifique o Modelo de Consumo para obter uma explicação detalhada dos conceitos e parâmetros envolvidos.

Se options.postBody for especificado, utiliza a API Direções de Pós-Rota: https://docs.microsoft.com/rest/api/maps/route/postroutedirections

Caso contrário, utiliza a API Obter Direções de Rota: https://docs.microsoft.com/rest/api/maps/route/getroutedirections

calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

Nota: esta API está atualmente em pré-visualização e pode estar sujeita a alterações interruptivas. Calcula uma matriz de resumos de rotas para um conjunto de rotas definidas por localizações de origem e destino. Para cada origem, este serviço calcula o custo do encaminhamento dessa origem para cada destino especificado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de encaminhamento da origem para o destino dessa célula. Para cada rota, os tempos de viagem e as distâncias são calculados. Pode utilizar os custos calculados para determinar as rotas a calcular com a API De Direções de Encaminhamento. Se o parâmetro waitForResults no pedido estiver definido como falso (valor predefinido), esta API devolve um código de resposta 202 ao longo de um URL de redirecionamento no campo Localização do cabeçalho de resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou as informações de erro estejam disponíveis. O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, os exemplos de dimensões de matriz possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa de ser quadrado).

Calcular uma matriz de rota é considerado uma operação de execução prolongada. Uma operação de execução prolongada implica que, após o pedido inicial ser aceite (HTTP 202), o resultado final será consultado até estar disponível. Cada pedido de inquérito reinicia o tempo limite do abortador, se tiver sido especificado um.

Utiliza a API de Matriz de Pós-Rota: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview

calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

Calcule um conjunto de localizações que podem ser alcançadas a partir do ponto de origem com base no orçamento de combustível, energia ou tempo especificado. Um limite de polígono (ou Isochrone) é devolvido numa orientação anti-horário, bem como no centro de polígonos preciso que foi o resultado do ponto de origem. O polígono devolvido pode ser utilizado para processamento adicional, como Pesquisa Geometria Interior para procurar POIs dentro do Isochrone fornecido.

Utiliza a API Obter Intervalo de Rotas: https://docs.microsoft.com/rest/api/maps/route/getrouterange

Métodos Herdados

newPipeline(Credential, INewPipelineOptions)

Um método estático utilizado para criar um novo objeto pipeline com credenciais fornecidas.

Detalhes do Construtor

RouteURL(Pipeline, string)

Cria uma instância de RouteURL.

new RouteURL(pipeline: Pipeline, mapsUrl?: string)

Parâmetros

pipeline
Pipeline

Chame MapsURL.newPipeline() para criar um pipeline predefinido ou fornecer um pipeline personalizado.

mapsUrl

string

Uma cadeia de URL que aponta para Azure Maps serviço, a predefinição é "https://atlas.microsoft.com". Se não for especificado nenhum protocolo, por exemplo "atlas.microsoft.com", será https assumido.

Detalhes da Propriedade Herdada

mapsUrl

Valor da cadeia de URL base.

mapsUrl: string

Valor de Propriedade

string

Herdado deMapsURL.mapsUrl

Detalhes de Método

calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)

Devolve uma rota entre uma origem e um destino, passando pelos pontos de passagem, se forem especificados. O percurso terá em conta fatores como o tráfego atual e as velocidades típicas das estradas no dia solicitado da semana e hora do dia. As informações devolvidas incluem a distância, o tempo estimado de viagem e uma representação da geometria da rota. Também estão disponíveis informações de encaminhamento adicionais, como a ordem otimizada do waypoint ou as instruções de turn by turn, consoante as opções selecionadas.

O serviço de encaminhamento fornece um conjunto de parâmetros para uma descrição detalhada do Modelo de Consumo específico do veículo. Verifique o Modelo de Consumo para obter uma explicação detalhada dos conceitos e parâmetros envolvidos.

Se options.postBody for especificado, utiliza a API Direções de Pós-Rota: https://docs.microsoft.com/rest/api/maps/route/postroutedirections

Caso contrário, utiliza a API Obter Direções de Rota: https://docs.microsoft.com/rest/api/maps/route/getroutedirections

function calculateRouteDirections(aborter: Aborter, coordinates: GeoJSON.Position[], options?: CalculateRouteDirectionsOptions): Promise<CalculateRouteDirectionsResponse>

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre o cancelamento do pedido.

coordinates

GeoJSON.Position[]

Uma matriz de coordenadas através da qual a rota é calculada. Cada coordenada é uma matriz de [longitude, latitude]. É necessário um mínimo de duas coordenadas. A primeira é a origem e a última é o destino da rota. As coordenadas opcionais no meio atuam como WayPoints na rota. Pode deixar passar até 150 WayPoints.

Devoluções

calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

Nota: esta API está atualmente em pré-visualização e pode estar sujeita a alterações interruptivas. Calcula uma matriz de resumos de rotas para um conjunto de rotas definidas por localizações de origem e destino. Para cada origem, este serviço calcula o custo do encaminhamento dessa origem para cada destino especificado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de encaminhamento da origem para o destino dessa célula. Para cada rota, os tempos de viagem e as distâncias são calculados. Pode utilizar os custos calculados para determinar as rotas a calcular com a API De Direções de Encaminhamento. Se o parâmetro waitForResults no pedido estiver definido como falso (valor predefinido), esta API devolve um código de resposta 202 ao longo de um URL de redirecionamento no campo Localização do cabeçalho de resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou as informações de erro estejam disponíveis. O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, os exemplos de dimensões de matriz possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa de ser quadrado).

Calcular uma matriz de rota é considerado uma operação de execução prolongada. Uma operação de execução prolongada implica que, após o pedido inicial ser aceite (HTTP 202), o resultado final será consultado até estar disponível. Cada pedido de inquérito reinicia o tempo limite do abortador, se tiver sido especificado um.

Utiliza a API de Matriz de Pós-Rota: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview

function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre o cancelamento do pedido.

body
CalculateRouteMatrixRequestBody

A matriz das coordenadas de origem e destino para calcular a distância da rota, o tempo de deslocação e outro resumo para cada célula da matriz com base nos parâmetros de entrada. O mínimo e o número máximo de células suportados são 1 e 700, respetivamente. Por exemplo, podem ser 35 origens e 20 destinos ou 25 origens e 25 destinos.

Devoluções

calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

Calcule um conjunto de localizações que podem ser alcançadas a partir do ponto de origem com base no orçamento de combustível, energia ou tempo especificado. Um limite de polígono (ou Isochrone) é devolvido numa orientação anti-horário, bem como no centro de polígonos preciso que foi o resultado do ponto de origem. O polígono devolvido pode ser utilizado para processamento adicional, como Pesquisa Geometria Interior para procurar POIs dentro do Isochrone fornecido.

Utiliza a API Obter Intervalo de Rotas: https://docs.microsoft.com/rest/api/maps/route/getrouterange

function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), documentos goto do Aborter para obter mais exemplos sobre o cancelamento do pedido.

center
GeoJSON.Position

A coordenada a partir da qual o cálculo do intervalo deve ser iniciado.

Devoluções

Detalhes do Método Herdado

newPipeline(Credential, INewPipelineOptions)

Um método estático utilizado para criar um novo objeto pipeline com credenciais fornecidas.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

Parâmetros

credential
Credential

Como SubscriptionKeyCredential, TokenCredential e MapControlCredential.

pipelineOptions
INewPipelineOptions

Devoluções

Um novo objeto pipeline.

Herdado deMapsURL.newPipeline