SearchURL class
Um SearchURL representa um URL para as operações de pesquisa Azure Maps.
- Extends
Construtores
| SearchURL(Pipeline, string) | Cria uma instância de SearchURL. |
Propriedades Herdadas
| maps |
Valor da cadeia de URL base. |
Métodos
| search |
Geocodificação de Endereços Em muitos casos, o serviço de pesquisa completo pode ser demasiado, por exemplo, se apenas estiver interessado na geocodificação tradicional. Pesquisa também pode ser acedido para pesquisa exclusiva de endereços. A geocodificação é efetuada ao atingir o ponto final de geocódigo apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado relativamente a tudo o que estiver acima dos dados de nível de rua. Não serão devolvidas poIs. Tenha em atenção que o geocódigo é muito tolerante a erros de digitação e endereços incompletos. Também tratará de tudo, desde ruas ou cruzamentos exatos, bem como geografias de nível superior, como centros da cidade, concelhos, estados, etc. Utiliza a API Obter Endereço Pesquisa:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress |
| search |
Inverter o Geocódigo para um Endereço Pode haver alturas em que precisa de traduzir uma coordenada (por exemplo: -122.3862, 37.786505) para um endereço de rua compreensível para humanos. Na maioria das vezes, isto é necessário no controlo de aplicações onde recebe um feed GPS do dispositivo ou recurso e quer saber qual é o endereço onde a coordenada está localizada. Este ponto final devolverá as informações de endereço de uma determinada coordenada. Utiliza a API Inversa obter endereço Pesquisa:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse |
| search |
Inverter o Geocódigo para uma Cross Street Pode haver alturas em que precisa de traduzir uma coordenada (por exemplo: -122.3862, 37.786505) para uma rua compreensível por humanos. Na maioria das vezes, isto é necessário no controlo de aplicações onde recebe um feed GPS do dispositivo ou recurso e quer saber qual é o endereço onde a coordenada está localizada. Este ponto final irá devolver informações de ruas cruzadas para uma determinada coordenada. Utiliza a API Get Pesquisa Address Reverse Cross Street:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet |
| search |
Geocodificação de Endereços Estruturados A Geocodificação de Endereços do Azure também pode ser acedida para pesquisa exclusiva de endereços estruturados. O índice de pesquisa de geocodificação será consultado relativamente a tudo o que estiver acima dos dados de nível de rua. Não serão devolvidas poIs. Tenha em atenção que o geocódigo é muito tolerante a erros de digitação e endereços incompletos. Também tratará de tudo, desde ruas ou cruzamentos exatos, bem como geografias de nível superior, como centros da cidade, concelhos, estados, etc. Utiliza a API Estruturada de Endereços Get Pesquisa:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured |
| search |
O ponto final Pesquisa Ao Longo da Rota permite-lhe efetuar uma pesquisa difusa de POIs ao longo de uma rota especificada.
Esta pesquisa é restrita ao especificar a |
| search |
Forma Livre Pesquisa A API predefinida básica é o Formato Livre Pesquisa que processa as entradas mais difusas que processam qualquer combinação de endereços ou tokens POI.
Esta API de pesquisa é a "pesquisa de linha única" canónica.
A API de Pesquisa de Formulário Livre é uma combinação totalmente integrada de pesquisa poi e geocodificação.
A API também pode ser ponderada com uma posição contextual (par lat./lon) ou totalmente restrita por uma coordenada e raio, ou pode ser executada de forma mais geral sem qualquer ponto de âncora georrefeccional.
Recomendamos vivamente que utilize o parâmetro "countrySet" para especificar apenas os países para os quais a sua aplicação precisa de cobertura, uma vez que o comportamento predefinido será procurar em todo o mundo, potencialmente devolvendo resultados desnecessários. Por exemplo: |
| search |
O ponto final de Geometria Pesquisa permite-lhe efetuar uma pesquisa de forma livre dentro de uma única geometria ou de muitas delas.
Os resultados da pesquisa que se inserem na geometria/geometria serão devolvidos.
As funcionalidades geográficas a procurar podem ser modeladas como geometrias de Polígono e/ou Círculo representadas através de qualquer um dos seguintes |
| search |
Nas proximidades Pesquisa Se tiver um caso de utilização para obter apenas os resultados do POI em torno de uma localização específica, o método de pesquisa nas proximidades pode ser a escolha certa. Este ponto final só devolverá resultados do POI e não aceita um parâmetro de consulta de pesquisa. Utiliza a API Get Pesquisa Nearby:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby |
| searchPOI(Aborter, string, Search |
Obter POI por Nome Se o seu caso de utilização de pesquisa exigir apenas resultados POI, poderá utilizar o ponto final POI para procurar. Este ponto final só devolverá resultados do POI. Utiliza a API Get Pesquisa POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi |
| search |
Obter POI por Categoria Se o seu caso de utilização de pesquisa exigir apenas resultados POI filtrados por categoria, poderá utilizar o ponto final da categoria. Este ponto final só devolverá resultados POI categorizados conforme especificado. Pode encontrar a lista de categorias disponíveis aqui. Utiliza a API de Categoria Get Pesquisa POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory |
| search |
A API Pesquisa Polygon permite-lhe pedir os dados de geometria, como um destaque de cidade ou país para um conjunto de entidades, obtidos anteriormente a partir de um pedido de Pesquisa Online no formato GeoJSON. O ID de geometria é devolvido no objeto dataSources em "geometria" e "id" num Endereço Pesquisa ou Pesquisa chamada Fuzzy. Tenha em atenção que qualquer ID de geometria obtido a partir de um ponto final de Pesquisa Online tem uma duração limitada. O cliente não deve armazenar IDs de geometria no armazenamento persistente para referência posterior, uma vez que a estabilidade destes identificadores não é garantida durante um longo período de tempo. Espera-se que seja feito um pedido ao método Polygon dentro de alguns minutos após o pedido ao método de Pesquisa Online que forneceu o ID. O serviço permite pedidos em lote até 20 identificadores. Utiliza a API Get Pesquisa Polygon:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon |
Métodos Herdados
| new |
Um método estático utilizado para criar um novo objeto pipeline com Credencial fornecida. |
Detalhes do Construtor
SearchURL(Pipeline, string)
Cria uma instância de SearchURL.
new SearchURL(pipeline: Pipeline, mapsUrl?: string)Parâmetros
- pipeline
- Pipeline
Chame MapsURL.newPipeline() para criar um pipeline predefinido ou forneça um pipeline personalizado.
- mapsUrl
-
string
Uma cadeia de URL a apontar para Azure Maps serviço, a predefinição é "https://atlas.microsoft.com".
Se não for especificado nenhum protocolo, por exemplo "atlas.microsoft.com", , https será assumido.
Detalhes da Propriedade Herdada
mapsUrl
Detalhes de Método
searchAddress(Aborter, string, SearchAddressOptions)
Geocodificação de Endereços Em muitos casos, o serviço de pesquisa completo pode ser demasiado, por exemplo, se apenas estiver interessado na geocodificação tradicional. Pesquisa também pode ser acedido para pesquisa exclusiva de endereços. A geocodificação é efetuada ao atingir o ponto final de geocódigo apenas com o endereço ou endereço parcial em questão. O índice de pesquisa de geocodificação será consultado relativamente a tudo o que estiver acima dos dados de nível de rua. Não serão devolvidas poIs. Tenha em atenção que o geocódigo é muito tolerante a erros de digitação e endereços incompletos. Também tratará de tudo, desde ruas ou cruzamentos exatos, bem como geografias de nível superior, como centros da cidade, concelhos, estados, etc. Utiliza a API Obter Endereço Pesquisa:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>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.
- query
-
string
O endereço a procurar (por exemplo, "1 microsoft way, Redmond, WA").
- options
- SearchAddressOptions
Devoluções
Promise<SearchAddressResponse>
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)
Inverter o Geocódigo para um Endereço Pode haver alturas em que precisa de traduzir uma coordenada (por exemplo: -122.3862, 37.786505) para um endereço de rua compreensível para humanos. Na maioria das vezes, isto é necessário no controlo de aplicações onde recebe um feed GPS do dispositivo ou recurso e quer saber qual é o endereço onde a coordenada está localizada. Este ponto final devolverá as informações de endereço de uma determinada coordenada. Utiliza a API Inversa obter endereço Pesquisa:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse
function searchAddressReverse(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseOptions): Promise<SearchAddressReverseResponse>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.
- position
- GeoJSON.Position
A posição para inverter a pesquisa, uma matriz coordenada de [longitude, latitude] , por exemplo, [-122.125679, 47.641268].
- options
- SearchAddressReverseOptions
Devoluções
Promise<SearchAddressReverseResponse>
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)
Inverter o Geocódigo para uma Cross Street Pode haver alturas em que precisa de traduzir uma coordenada (por exemplo: -122.3862, 37.786505) para uma rua compreensível por humanos. Na maioria das vezes, isto é necessário no controlo de aplicações onde recebe um feed GPS do dispositivo ou recurso e quer saber qual é o endereço onde a coordenada está localizada. Este ponto final irá devolver informações de ruas cruzadas para uma determinada coordenada. Utiliza a API Get Pesquisa Address Reverse Cross Street:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet
function searchAddressReverseCrossStreet(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseCrossStreetOptions): Promise<SearchAddressReverseCrossStreetResponse>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.
- position
- GeoJSON.Position
A posição para inverter a pesquisa, uma matriz coordenada de [longitude, latitude] , por exemplo, [-122.125679, 47.641268].
Devoluções
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)
Geocodificação de Endereços Estruturados A Geocodificação de Endereços do Azure também pode ser acedida para pesquisa exclusiva de endereços estruturados. O índice de pesquisa de geocodificação será consultado relativamente a tudo o que estiver acima dos dados de nível de rua. Não serão devolvidas poIs. Tenha em atenção que o geocódigo é muito tolerante a erros de digitação e endereços incompletos. Também tratará de tudo, desde ruas ou cruzamentos exatos, bem como geografias de nível superior, como centros da cidade, concelhos, estados, etc. Utiliza a API Estruturada de Endereços Get Pesquisa:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>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.
- countryCode
-
string
A parte do código de país de 2 ou 3 letras ISO3166-1 de um endereço. Por exemplo, E.U.A.
- options
- SearchAddressStructuredOptions
Devoluções
Promise<SearchAddressStructuredResponse>
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)
O ponto final Pesquisa Ao Longo da Rota permite-lhe efetuar uma pesquisa difusa de POIs ao longo de uma rota especificada.
Esta pesquisa é restrita ao especificar a maxDetourTime medida de limitação.
Para enviar os pontos de rota, irá utilizar um body que irá conter o route objeto representado como um GeoJSON LineString tipo e o Content-Type cabeçalho será definido como application/json.
Cada ponto de rota no route é representado como um GeoJSON Position tipo, ou seja, uma matriz em que o valor de longitude é seguido pelo valor de latitude e o valor de altitude é ignorado.
O route deve conter, pelo menos, 2 pontos de rota.
É possível que a rota original seja alterada, alguns dos pontos podem ser ignorados.
Se a rota que passa pelo ponto encontrado for mais rápida do que a original, o detourTime valor na resposta é negativo.
Utiliza a API Publicar Pesquisa Ao Longo da Rota:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute
function searchAlongRoute(aborter: Aborter, query: string, maxDetourTime: number, body: SearchAlongRouteRequestBody, options?: SearchAlongRouteOptions): Promise<SearchAlongRouteResponse>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.
- query
-
string
A cadeia de consulta aplicável (por exemplo, "seattle", "pizza").
- maxDetourTime
-
number
Tempo máximo de desvio do ponto de interesse em segundos. O valor máximo é de 3600 segundos
Isto representa a rota para procurar e deve ser um tipo válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.
- options
- SearchAlongRouteOptions
Devoluções
Promise<SearchAlongRouteResponse>
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)
Forma Livre Pesquisa A API predefinida básica é o Formato Livre Pesquisa que processa as entradas mais difusas que processam qualquer combinação de endereços ou tokens POI.
Esta API de pesquisa é a "pesquisa de linha única" canónica.
A API de Pesquisa de Formulário Livre é uma combinação totalmente integrada de pesquisa poi e geocodificação.
A API também pode ser ponderada com uma posição contextual (par lat./lon) ou totalmente restrita por uma coordenada e raio, ou pode ser executada de forma mais geral sem qualquer ponto de âncora georrefeccional.
Recomendamos vivamente que utilize o parâmetro "countrySet" para especificar apenas os países para os quais a sua aplicação precisa de cobertura, uma vez que o comportamento predefinido será procurar em todo o mundo, potencialmente devolvendo resultados desnecessários. Por exemplo: countrySet=E.U.A., FR. Consulte [Pesquisa Coverage] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) para obter uma lista completa de todos os países suportados.
A maioria das consultas Pesquisa predefinição para maxFuzzyLevel=2 para obter desempenho e também reduzir resultados invulgares.
Esta nova predefinição pode ser substituída conforme necessário por pedido ao transmitir o parâmetro maxFuzzyLevelde consulta =3 ou 4.
Utiliza a API Get Pesquisa Fuzzy:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy
function searchFuzzy(aborter: Aborter, query: string | GeoJSON.Position, options?: SearchFuzzyOptions): Promise<SearchFuzzyResponse>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.
- query
-
string | GeoJSON.Position
A cadeia de consulta aplicável (por exemplo, "seattle", "pizza").
Também pode ser especificado como uma matriz de coordenadas de [longitude, latitude] (por exemplo, [-122.125679, 47.641268]).
- options
- SearchFuzzyOptions
Devoluções
Promise<SearchFuzzyResponse>
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)
O ponto final de Geometria Pesquisa permite-lhe efetuar uma pesquisa de forma livre dentro de uma única geometria ou de muitas delas.
Os resultados da pesquisa que se inserem na geometria/geometria serão devolvidos.
As funcionalidades geográficas a procurar podem ser modeladas como geometrias de Polígono e/ou Círculo representadas através de qualquer um dos seguintes GeoJSON tipos: GeoJSON FeatureCollection, O geometry pode ser representado como um GeoJSON FeatureCollection objeto.
Esta é a opção recomendada se a geometria contiver Polígonos e Círculos.
O FeatureCollection pode conter um máximo de 50 GeoJSON Feature objetos.
Cada Feature objeto deve representar um Polígono ou um Círculo com as seguintes condições: um Feature objeto para a geometria do Polígono pode ter um máximo de 50 coordenadas e as suas propriedades têm de estar vazias.
Um Feature objeto para a geometria Circle é composto por um centro representado com um GeoJSON Point tipo e um valor radius (em metros) que tem de ser especificado nas propriedades do objeto juntamente com a propriedade subType cujo valor deve ser "Círculo".
Veja a secção Exemplos abaixo para obter uma representação de exemplo FeatureCollection .
GeoJSON GeometryCollection, Pode geometry ser representado como um GeoJSON GeometryCollection objeto.
Esta é a opção recomendada se a geometria contiver apenas uma lista de Polígonos.
O GeometryCollection pode conter um máximo de 50 GeoJSON Polygon objetos.
Cada Polygon objeto pode ter um máximo de 50 coordenadas.
Veja a secção Exemplos abaixo para obter uma representação de exemplo GeometryCollection .
GeoJSON Polygon, O geometry pode ser representado como um GeoJSON Polygon objeto.
Esta é a opção recomendada se a geometria contiver um único Polígono.
O Polygon objeto pode ter um máximo de 50 coordenadas.
Utiliza a API de Geometria Interna post Pesquisa:https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry
function searchInsideGeometry(aborter: Aborter, query: string, body: SearchInsideGeometryRequestBody, options?: SearchInsideGeometryOptions): Promise<SearchInsideGeometryResponse>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.
- query
-
string
A cadeia de consulta aplicável (por exemplo, "seattle", "pizza").
Isto representa a geometria de uma ou mais funcionalidades geográficas (parques, limites de estado, etc.) para procurar e deve ser um tipo em conformidade com GeoJSON. Consulte RFC 7946 para obter detalhes.
- options
- SearchInsideGeometryOptions
Devoluções
Promise<SearchInsideGeometryResponse>
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)
Nas proximidades Pesquisa Se tiver um caso de utilização para obter apenas os resultados do POI em torno de uma localização específica, o método de pesquisa nas proximidades pode ser a escolha certa. Este ponto final só devolverá resultados do POI e não aceita um parâmetro de consulta de pesquisa. Utiliza a API Get Pesquisa Nearby:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby
function searchNearby(aborter: Aborter, location: GeoJSON.Position, options?: SearchNearbyOptions): Promise<SearchNearbyResponse>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.
- location
- GeoJSON.Position
Localização onde os resultados devem ser tendenciosos.
Deve ser uma matriz de [longitude, latitude], por exemplo, [-121.89, 37.337].
- options
- SearchNearbyOptions
Devoluções
Promise<SearchNearbyResponse>
searchPOI(Aborter, string, SearchPOIOptions)
Obter POI por Nome Se o seu caso de utilização de pesquisa exigir apenas resultados POI, poderá utilizar o ponto final POI para procurar. Este ponto final só devolverá resultados do POI. Utiliza a API Get Pesquisa POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
function searchPOI(aborter: Aborter, query: string, options?: SearchPOIOptions): Promise<SearchPOIResponse>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.
- query
-
string
O nome POI a procurar (por exemplo, "estátua da liberdade", "starbucks").
- options
- SearchPOIOptions
Devoluções
Promise<SearchPOIResponse>
searchPOICategory(Aborter, string, SearchPOICategoryOptions)
Obter POI por Categoria Se o seu caso de utilização de pesquisa exigir apenas resultados POI filtrados por categoria, poderá utilizar o ponto final da categoria. Este ponto final só devolverá resultados POI categorizados conforme especificado. Pode encontrar a lista de categorias disponíveis aqui. Utiliza a API de Categoria Get Pesquisa POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>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.
- query
-
string
A categoria POI a procurar (por exemplo, "AEROPORTO", "PRAIA").
- options
- SearchPOICategoryOptions
Devoluções
Promise<SearchPOICategoryResponse>
searchPolygon(Aborter, string[])
A API Pesquisa Polygon permite-lhe pedir os dados de geometria, como um destaque de cidade ou país para um conjunto de entidades, obtidos anteriormente a partir de um pedido de Pesquisa Online no formato GeoJSON. O ID de geometria é devolvido no objeto dataSources em "geometria" e "id" num Endereço Pesquisa ou Pesquisa chamada Fuzzy. Tenha em atenção que qualquer ID de geometria obtido a partir de um ponto final de Pesquisa Online tem uma duração limitada. O cliente não deve armazenar IDs de geometria no armazenamento persistente para referência posterior, uma vez que a estabilidade destes identificadores não é garantida durante um longo período de tempo. Espera-se que seja feito um pedido ao método Polygon dentro de alguns minutos após o pedido ao método de Pesquisa Online que forneceu o ID. O serviço permite pedidos em lote até 20 identificadores.
Utiliza a API Get Pesquisa Polygon:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon
function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>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.
- geometries
-
string[]
Lista separada por vírgulas de UUIDs de geometria, obtida anteriormente a partir de um pedido de Pesquisa Online.
Devoluções
Promise<SearchPolygonResponse>
Detalhes do Método Herdado
newPipeline(Credential, INewPipelineOptions)
Um método estático utilizado para criar um novo objeto pipeline com Credencial fornecida.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParâmetros
- credential
- Credential
Como SubscriptionKeyCredential, TokenCredential e MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Devoluções
Um novo objeto pipeline.
Herdado deMapsURL.newPipeline