RouteURL class
Uma RouteURL representa uma URL para as operações de rota Azure Mapas.
- Extends
Construtores
| RouteURL(Pipeline, string) | Cria uma instância de RouteURL. |
Propriedades herdadas
| maps |
Valor da cadeia de caracteres da URL base. |
Métodos
| calculate |
Retorna uma rota entre uma origem e um destino, passando por pontos de passagem se eles forem especificados. A rota levará em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia solicitado da semana e hora do dia. As informações retornadas incluem a distância, o tempo estimado de viagem e uma representação da geometria da rota. Informações adicionais de roteamento, como ordem otimizada do ponto de passagem ou instruções por turno, também estão disponíveis, dependendo das opções selecionadas. O serviço de roteamento fornece um conjunto de parâmetros para uma descrição detalhada do Modelo de Consumo específico do veículo. Marcar Modelo de Consumo para obter uma explicação detalhada dos conceitos e parâmetros envolvidos. Se Caso contrário, usa a API Obter Trajetos de Rota: https://docs.microsoft.com/rest/api/maps/route/getroutedirections |
| calculate |
Observação: essa API está atualmente em versão prévia e pode estar sujeita a alterações interruptivas. Calcula uma matriz de resumos de rota para um conjunto de rotas definidas por locais de origem e destino. Para cada origem determinada, esse serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Para cada rota, os tempos de viagem e as distâncias são calculados. Você pode usar os custos calculados para determinar quais rotas calcular usando a API de Direções de Roteamento. Se o parâmetro waitForResults na solicitação estiver definido como false (valor padrão), essa API retornará um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou as informações de erro estejam disponíveis. O tamanho máximo de uma matriz para essa API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de possíveis dimensões de matriz são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado). O cálculo de uma matriz de rotas é considerado uma operação de execução prolongada. Uma operação de execução prolongada implica que, depois que a solicitação inicial for aceita (HTTP 202), o resultado final será sondado até que esteja disponível. Cada solicitação de sondagem reiniciará o tempo limite do anulador, se um tiver sido especificado. Usa a API de Matriz pós-rota: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview |
| calculate |
Calcule um conjunto de locais que podem ser alcançados do ponto de origem com base no combustível, energia ou orçamento de tempo especificado. Um limite de polígono (ou Isócrono) é retornado em uma orientação anti-horário, bem como no centro de polígono preciso que foi o resultado do ponto de origem. O polígono retornado pode ser usado para processamento adicional, como Pesquisa Dentro da Geometria para pesquisar POIs dentro do Isócrono fornecido. Usa a API Obter Intervalo de Rotas: https://docs.microsoft.com/rest/api/maps/route/getrouterange |
Métodos herdados
| new |
Um método estático usado para criar um novo objeto Pipeline com Credential fornecido. |
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 padrão ou forneça um pipeline personalizado.
- mapsUrl
-
string
Uma cadeia de caracteres de URL que aponta para Azure Mapas serviço, o padrão é "https://atlas.microsoft.com".
Se nenhum protocolo for especificado, por exemplo "atlas.microsoft.com", , https será assumido.
Detalhes das propriedades herdadas
mapsUrl
Valor da cadeia de caracteres da URL base.
mapsUrl: stringValor da propriedade
string
Herdado deMapsURL.mapsUrl
Detalhes do método
calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)
Retorna uma rota entre uma origem e um destino, passando por pontos de passagem se eles forem especificados. A rota levará em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia solicitado da semana e hora do dia. As informações retornadas incluem a distância, o tempo estimado de viagem e uma representação da geometria da rota. Informações adicionais de roteamento, como ordem otimizada do ponto de passagem ou instruções por turno, também estão disponíveis, dependendo das opções selecionadas.
O serviço de roteamento fornece um conjunto de parâmetros para uma descrição detalhada do Modelo de Consumo específico do veículo. Marcar Modelo de Consumo para obter uma explicação detalhada dos conceitos e parâmetros envolvidos.
Se options.postBody for especificado, usará a API de Direções pós-rota: https://docs.microsoft.com/rest/api/maps/route/postroutedirections
Caso contrário, usa a API Obter Trajetos 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 cancelamento de solicitação.
- coordinates
-
GeoJSON.Position[]
Uma matriz de coordenadas por meio da qual a rota é calculada.
Cada coordenada é uma matriz de [longitude, latitude]. Um mínimo de duas coordenadas é necessário.
A primeira é a origem e a última é o destino da rota.
As coordenadas opcionais no meio atuam como WayPoints na rota. Você pode passar até 150 WayPoints.
- options
- CalculateRouteDirectionsOptions
Retornos
Promise<CalculateRouteDirectionsResponse>
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)
Observação: essa API está atualmente em versão prévia e pode estar sujeita a alterações interruptivas. Calcula uma matriz de resumos de rota para um conjunto de rotas definidas por locais de origem e destino. Para cada origem determinada, esse serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Para cada rota, os tempos de viagem e as distâncias são calculados. Você pode usar os custos calculados para determinar quais rotas calcular usando a API de Direções de Roteamento. Se o parâmetro waitForResults na solicitação estiver definido como false (valor padrão), essa API retornará um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou as informações de erro estejam disponíveis. O tamanho máximo de uma matriz para essa API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de possíveis dimensões de matriz são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).
O cálculo de uma matriz de rotas é considerado uma operação de execução prolongada. Uma operação de execução prolongada implica que, depois que a solicitação inicial for aceita (HTTP 202), o resultado final será sondado até que esteja disponível. Cada solicitação de sondagem reiniciará o tempo limite do anulador, se um tiver sido especificado.
Usa a API de Matriz 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 cancelamento de solicitação.
A matriz de coordenadas de origem e destino para calcular a distância da rota, o tempo de viagem e outros resumos para cada célula da matriz com base nos parâmetros de entrada. O mínimo e a contagem máxima de células com suporte são 1 e 700, respectivamente. Por exemplo, pode ser 35 origens e 20 destinos ou 25 origens e 25 destinos.
- options
- CalculateRouteMatrixOptions
Retornos
Promise<CalculateRouteMatrixResponse>
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)
Calcule um conjunto de locais que podem ser alcançados do ponto de origem com base no combustível, energia ou orçamento de tempo especificado. Um limite de polígono (ou Isócrono) é retornado em uma orientação anti-horário, bem como no centro de polígono preciso que foi o resultado do ponto de origem. O polígono retornado pode ser usado para processamento adicional, como Pesquisa Dentro da Geometria para pesquisar POIs dentro do Isócrono fornecido.
Usa 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 cancelamento de solicitação.
- center
- GeoJSON.Position
A coordenada da qual o cálculo do intervalo deve ser iniciado.
- options
- CalculateRouteRangeOptions
Retornos
Promise<CalculateRouteRangeResponse>
Detalhes do método herdado
newPipeline(Credential, INewPipelineOptions)
Um método estático usado para criar um novo objeto Pipeline com Credential fornecido.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParâmetros
- credential
- Credential
Como SubscriptionKeyCredential, TokenCredential e MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Retornos
Um novo objeto Pipeline.
Herdado deMapsURL.newPipeline