Compartilhar via

SearchURL class

  • Referência
Pacote:
azure-maps-rest

Uma SearchURL representa uma URL para as operações de pesquisa Azure Mapas.

Extends
MapsURL

Construtores

SearchURL(Pipeline, string)

Cria uma instância do SearchURL.

Propriedades herdadas

mapsUrl

Valor da cadeia de caracteres de URL base.

Métodos

searchAddress(Aborter, string, SearchAddressOptions)

Geocodificação de endereço Em muitos casos, o serviço de pesquisa completo pode ser demais, por exemplo, se você estiver interessado apenas na geocodificação tradicional. Pesquisa também pode ser acessado para pesquisa de endereço exclusivamente. A geocodificação é executada atingindo o ponto de extremidade de código geográfico apenas com o endereço ou o endereço parcial em questão. O índice de pesquisa de geocodificação será consultado para obter tudo acima dos dados de nível de rua. Nenhuma POIs será retornada. Observe que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços de rua exatos ou ruas ou cruzamentos, bem como geografias de nível mais alto, como centros urbanos, condados, estados etc. Usa a API Obter Endereço Pesquisa:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)

Geocódigo reverso para um endereço Pode haver momentos em que você precisa converter uma coordenada (exemplo: -122.3862, 37.786505) em um endereço de rua compreensível para humanos. Na maioria das vezes, isso é necessário no acompanhamento de aplicativos em que você recebe um feed GPS do dispositivo ou ativo e deseja saber qual endereço a coordenada está localizada. Esse ponto de extremidade retornará informações de endereço para uma determinada coordenada. Usa a API Inversa obter endereço Pesquisa:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)

Geocódigo reverso para uma Cross Street Pode haver momentos em que você precisa traduzir uma coordenada (exemplo: -122.3862, 37.786505) em uma rua cruzada compreensível para humanos. Na maioria das vezes, isso é necessário no acompanhamento de aplicativos em que você recebe um feed GPS do dispositivo ou ativo e deseja saber qual endereço a coordenada está localizada. Esse ponto de extremidade retornará informações de rua cruzada para uma determinada coordenada. Usa a API Get Pesquisa Address Reverse Cross Street:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)

Geocodificação de Endereço Estruturado A Geocodificação de Endereço do Azure também pode ser acessada exclusivamente para pesquisa de endereço estruturado. O índice de pesquisa de geocodificação será consultado para obter tudo acima dos dados de nível de rua. Nenhuma POIs será retornada. Observe que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços de rua exatos ou ruas ou cruzamentos, bem como geografias de nível mais alto, como centros urbanos, condados, estados etc. Usa a API Estruturada obter Pesquisa endereço:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)

O ponto de extremidade Pesquisa Ao Longo da Rota permite que você execute uma pesquisa difusa de POIs ao longo de uma rota especificada. Essa pesquisa é restrita especificando a maxDetourTime medida de limitação. Para enviar os pontos de rota, você usará um body que conterá o route objeto representado como um GeoJSON LineString tipo e o Content-Type cabeçalho será definido application/jsoncomo . Cada ponto de rota em 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 pontos podem ser ignorados. Se a rota que passa pelo ponto encontrado for mais rápida que a original, o detourTime valor na resposta será negativo. Usa a API post Pesquisa ao longo da rota:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)

Formulário Livre Pesquisa A API padrão básica é o Formulário Livre Pesquisa que lida com as entradas mais difusas que lidam com qualquer combinação de endereço ou tokens POI. Essa API de pesquisa é a 'pesquisa de linha única' canônica. A API de Pesquisa de Formulário Livre é uma combinação perfeita 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 nenhum ponto de âncora de viés geográfico. Recomendamos que você use o parâmetro 'countrySet' para especificar apenas os países para os quais seu aplicativo precisa de cobertura, pois o comportamento padrão será pesquisar o mundo inteiro, potencialmente retornando resultados desnecessários. Por exemplo: countrySet=US,FR. Consulte [cobertura de Pesquisa] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) para obter uma lista completa de todos os países com suporte. A maioria das consultas Pesquisa padrão para maxFuzzyLevel=2 para obter desempenho e também reduzir resultados incomuns. Esse novo padrão pode ser substituído conforme necessário por solicitação passando a consulta param maxFuzzyLevel=3 ou 4. Usa a API Obter Pesquisa Difusa:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)

O ponto de extremidade Pesquisa Geometry permite que você execute uma pesquisa de formulário livre dentro de uma única geometria ou muitos deles. Os resultados da pesquisa que se enquadram na geometria/geometria serão retornados. Os recursos geográficos a serem pesquisados podem ser modelados como geometrias Polígono e/ou Círculo representadas usando qualquer um dos seguintes GeoJSON tipos: GeoJSON FeatureCollection, O geometry pode ser representado como um GeoJSON FeatureCollection objeto . Essa é a opção recomendada se a geometria contiver polígonos e círculos. O FeatureCollection pode conter no máximo 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 no máximo 50 coordenadas e suas propriedades devem estar vazias. Um Feature objeto para a geometria Circle é composto por um centro representado usando um GeoJSON Point tipo e um valor de raio (em metros) que deve ser especificado nas propriedades do objeto junto com a propriedade subType cujo valor deve ser 'Circle'. Consulte a seção Exemplos abaixo para obter uma representação de exemplo FeatureCollection . GeoJSON GeometryCollection, O geometry pode ser representado como um GeoJSON GeometryCollection objeto . Essa será a opção recomendada se a geometria contiver apenas uma lista de Polígonos. O GeometryCollection pode conter no máximo 50 GeoJSON Polygon objetos. Cada Polygon objeto pode ter no máximo 50 coordenadas. Consulte a seção Exemplos abaixo para obter uma representação de exemplo GeometryCollection . Polígono GeoJSON, O geometry pode ser representado como um GeoJSON Polygon objeto . Essa é a opção recomendada se a geometria contiver um único Polígono. O Polygon objeto pode ter no máximo 50 coordenadas. Usa a API Post Pesquisa Inside Geometry:https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)

Próximo Pesquisa Se você tiver um caso de uso para recuperar apenas os resultados de POI em um local específico, o método de pesquisa próximo poderá ser a escolha certa. Esse ponto de extremidade retornará apenas os resultados da POI e não usará um parâmetro de consulta de pesquisa. Usa a API Get Pesquisa Nearby:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby
searchPOI(Aborter, string, SearchPOIOptions)

Obter POI por Nome Se o caso de uso da pesquisa exigir apenas resultados de POI, você poderá usar o ponto de extremidade poi para pesquisa. Esse ponto de extremidade retornará apenas os resultados da POI. Usa a API Obter Pesquisa POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
searchPOICategory(Aborter, string, SearchPOICategoryOptions)

Obter POI por Categoria Se o caso de uso da pesquisa exigir apenas os resultados de POI filtrados por categoria, você poderá usar o ponto de extremidade de categoria. Esse ponto de extremidade retornará apenas os resultados de POI categorizados conforme especificado. A lista de categorias disponíveis pode ser encontrada aqui. Usa a API de Categoria obter Pesquisa POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
searchPolygon(Aborter, string[])

A API do Polígono Pesquisa permite que você solicite os dados de geometria, como uma estrutura de tópicos de cidade ou país, para um conjunto de entidades, recuperados anteriormente de uma solicitação de Pesquisa Online no formato GeoJSON. A ID de geometria é retornada no objeto dataSources em "geometry" e "id" em um endereço de Pesquisa ou Pesquisa chamada difusa. Observe que qualquer ID de geometria recuperada de um ponto de extremidade de Pesquisa Online tem um tempo de vida limitado. O cliente não deve armazenar IDs de geometria no armazenamento persistente para indicação posterior, pois a estabilidade desses identificadores não é garantida por um longo período de tempo. Espera-se que uma solicitação para o método Polygon seja feita em poucos minutos após a solicitação para o método de Pesquisa Online que forneceu a ID. O serviço permite solicitações em lote de até 20 identificadores.

Usa a API obter Pesquisa polígono:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon

Métodos herdados

newPipeline(Credential, INewPipelineOptions)

Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida.

Detalhes do construtor

SearchURL(Pipeline, string)

Cria uma instância do SearchURL.

new SearchURL(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", , será https assumido.

Detalhes das propriedades herdadas

mapsUrl

Valor da cadeia de caracteres de URL base.

mapsUrl: string

Valor da propriedade

string

Herdado deMapsURL.mapsUrl

Detalhes do método

searchAddress(Aborter, string, SearchAddressOptions)

Geocodificação de endereço Em muitos casos, o serviço de pesquisa completo pode ser demais, por exemplo, se você estiver interessado apenas na geocodificação tradicional. Pesquisa também pode ser acessado para pesquisa de endereço exclusivamente. A geocodificação é executada atingindo o ponto de extremidade de código geográfico apenas com o endereço ou o endereço parcial em questão. O índice de pesquisa de geocodificação será consultado para obter tudo acima dos dados de nível de rua. Nenhuma POIs será retornada. Observe que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços de rua exatos ou ruas ou cruzamentos, bem como geografias de nível mais alto, como centros urbanos, condados, estados etc. Usa 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 cancelamento de solicitação.

query

string

O endereço a ser pesquisado (por exemplo, "1 Microsoft way, Redmond, WA").

options
SearchAddressOptions

Retornos

Promise<SearchAddressResponse>

searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)

Geocódigo reverso para um endereço Pode haver momentos em que você precisa converter uma coordenada (exemplo: -122.3862, 37.786505) em um endereço de rua compreensível para humanos. Na maioria das vezes, isso é necessário no acompanhamento de aplicativos em que você recebe um feed GPS do dispositivo ou ativo e deseja saber qual endereço a coordenada está localizada. Esse ponto de extremidade retornará informações de endereço para uma determinada coordenada. Usa 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 cancelamento de solicitação.

position
GeoJSON.Position

A posição para inverter a pesquisa, uma matriz de coordenadas de [longitude, latitude] , por exemplo, [-122.125679, 47.641268].

options
SearchAddressReverseOptions

Retornos

Promise<SearchAddressReverseResponse>

searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)

Geocódigo reverso para uma Cross Street Pode haver momentos em que você precisa traduzir uma coordenada (exemplo: -122.3862, 37.786505) em uma rua cruzada compreensível para humanos. Na maioria das vezes, isso é necessário no acompanhamento de aplicativos em que você recebe um feed GPS do dispositivo ou ativo e deseja saber qual endereço a coordenada está localizada. Esse ponto de extremidade retornará informações de rua cruzada para uma determinada coordenada. Usa 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 cancelamento de solicitação.

position
GeoJSON.Position

A posição para inverter a pesquisa, uma matriz de coordenadas de [longitude, latitude] , por exemplo, [-122.125679, 47.641268].

options
SearchAddressReverseCrossStreetOptions

Retornos

Promise<SearchAddressReverseCrossStreetResponse>

searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)

Geocodificação de Endereço Estruturado A Geocodificação de Endereço do Azure também pode ser acessada exclusivamente para pesquisa de endereço estruturado. O índice de pesquisa de geocodificação será consultado para obter tudo acima dos dados de nível de rua. Nenhuma POIs será retornada. Observe que o geocodificador é muito tolerante a erros de digitação e endereços incompletos. Ele também lidará com tudo, desde endereços de rua exatos ou ruas ou cruzamentos, bem como geografias de nível mais alto, como centros urbanos, condados, estados etc. Usa a API Estruturada obter Pesquisa endereço: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 cancelamento de solicitação.

countryCode

string

A parte de código de país de 2 ou 3 letras ISO3166-1 de um endereço. Por exemplo, EUA.

options
SearchAddressStructuredOptions

Retornos

Promise<SearchAddressStructuredResponse>

searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)

O ponto de extremidade Pesquisa Ao Longo da Rota permite que você execute uma pesquisa difusa de POIs ao longo de uma rota especificada. Essa pesquisa é restrita especificando a maxDetourTime medida de limitação. Para enviar os pontos de rota, você usará um body que conterá o route objeto representado como um GeoJSON LineString tipo e o Content-Type cabeçalho será definido application/jsoncomo . Cada ponto de rota em 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 pontos podem ser ignorados. Se a rota que passa pelo ponto encontrado for mais rápida que a original, o detourTime valor na resposta será negativo. Usa a API post 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 cancelamento de solicitação.

query

string

A cadeia de caracteres 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

body
SearchAlongRouteRequestBody

Isso representa a rota para pesquisar e deve ser um tipo válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.

options
SearchAlongRouteOptions

Retornos

Promise<SearchAlongRouteResponse>

searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)

Formulário Livre Pesquisa A API padrão básica é o Formulário Livre Pesquisa que lida com as entradas mais difusas que lidam com qualquer combinação de endereço ou tokens POI. Essa API de pesquisa é a 'pesquisa de linha única' canônica. A API de Pesquisa de Formulário Livre é uma combinação perfeita 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 nenhum ponto de âncora de viés geográfico. Recomendamos que você use o parâmetro 'countrySet' para especificar apenas os países para os quais seu aplicativo precisa de cobertura, pois o comportamento padrão será pesquisar o mundo inteiro, potencialmente retornando resultados desnecessários. Por exemplo: countrySet=US,FR. Consulte [cobertura de Pesquisa] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) para obter uma lista completa de todos os países com suporte. A maioria das consultas Pesquisa padrão para maxFuzzyLevel=2 para obter desempenho e também reduzir resultados incomuns. Esse novo padrão pode ser substituído conforme necessário por solicitação passando a consulta param maxFuzzyLevel=3 ou 4. Usa a API Obter Pesquisa Difusa: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 cancelamento de solicitação.

query

string | GeoJSON.Position

A cadeia de caracteres 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

Retornos

Promise<SearchFuzzyResponse>

searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)

O ponto de extremidade Pesquisa Geometry permite que você execute uma pesquisa de formulário livre dentro de uma única geometria ou muitos deles. Os resultados da pesquisa que se enquadram na geometria/geometria serão retornados. Os recursos geográficos a serem pesquisados podem ser modelados como geometrias Polígono e/ou Círculo representadas usando qualquer um dos seguintes GeoJSON tipos: GeoJSON FeatureCollection, O geometry pode ser representado como um GeoJSON FeatureCollection objeto . Essa é a opção recomendada se a geometria contiver polígonos e círculos. O FeatureCollection pode conter no máximo 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 no máximo 50 coordenadas e suas propriedades devem estar vazias. Um Feature objeto para a geometria Circle é composto por um centro representado usando um GeoJSON Point tipo e um valor de raio (em metros) que deve ser especificado nas propriedades do objeto junto com a propriedade subType cujo valor deve ser 'Circle'. Consulte a seção Exemplos abaixo para obter uma representação de exemplo FeatureCollection . GeoJSON GeometryCollection, O geometry pode ser representado como um GeoJSON GeometryCollection objeto . Essa será a opção recomendada se a geometria contiver apenas uma lista de Polígonos. O GeometryCollection pode conter no máximo 50 GeoJSON Polygon objetos. Cada Polygon objeto pode ter no máximo 50 coordenadas. Consulte a seção Exemplos abaixo para obter uma representação de exemplo GeometryCollection . Polígono GeoJSON, O geometry pode ser representado como um GeoJSON Polygon objeto . Essa é a opção recomendada se a geometria contiver um único Polígono. O Polygon objeto pode ter no máximo 50 coordenadas. Usa a API Post Pesquisa Inside Geometry: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 cancelamento de solicitação.

query

string

A cadeia de caracteres de consulta aplicável (por exemplo, "seattle", "pizza").

body
SearchInsideGeometryRequestBody

Isso representa a geometria de um ou mais recursos geográficos (parques, limite de estado etc.) para pesquisar e deve ser um tipo em conformidade com GeoJSON. Consulte RFC 7946 para obter detalhes.

options
SearchInsideGeometryOptions

Retornos

Promise<SearchInsideGeometryResponse>

searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)

Próximo Pesquisa Se você tiver um caso de uso para recuperar apenas os resultados de POI em um local específico, o método de pesquisa próximo poderá ser a escolha certa. Esse ponto de extremidade retornará apenas os resultados da POI e não usará um parâmetro de consulta de pesquisa. Usa 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 cancelamento de solicitação.

location
GeoJSON.Position

Local em que os resultados devem ser tendenciosos. Deve ser uma matriz de [longitude, latitude], por exemplo, [-121.89, 37.337].

options
SearchNearbyOptions

Retornos

Promise<SearchNearbyResponse>

searchPOI(Aborter, string, SearchPOIOptions)

Obter POI por Nome Se o caso de uso da pesquisa exigir apenas resultados de POI, você poderá usar o ponto de extremidade poi para pesquisa. Esse ponto de extremidade retornará apenas os resultados da POI. Usa a API Obter 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 cancelamento de solicitação.

query

string

O nome da POI a ser procurado (por exemplo, "estátua da liberdade", "starbucks").

options
SearchPOIOptions

Retornos

Promise<SearchPOIResponse>

searchPOICategory(Aborter, string, SearchPOICategoryOptions)

Obter POI por Categoria Se o caso de uso da pesquisa exigir apenas os resultados de POI filtrados por categoria, você poderá usar o ponto de extremidade de categoria. Esse ponto de extremidade retornará apenas os resultados de POI categorizados conforme especificado. A lista de categorias disponíveis pode ser encontrada aqui. Usa a API de Categoria obter 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 cancelamento de solicitação.

query

string

A categoria POI a ser pesquisada (por exemplo, "AEROPORTO", "PRAIA").

options
SearchPOICategoryOptions

Retornos

Promise<SearchPOICategoryResponse>

searchPolygon(Aborter, string[])

A API do Polígono Pesquisa permite que você solicite os dados de geometria, como uma estrutura de tópicos de cidade ou país, para um conjunto de entidades, recuperados anteriormente de uma solicitação de Pesquisa Online no formato GeoJSON. A ID de geometria é retornada no objeto dataSources em "geometry" e "id" em um endereço de Pesquisa ou Pesquisa chamada difusa. Observe que qualquer ID de geometria recuperada de um ponto de extremidade de Pesquisa Online tem um tempo de vida limitado. O cliente não deve armazenar IDs de geometria no armazenamento persistente para indicação posterior, pois a estabilidade desses identificadores não é garantida por um longo período de tempo. Espera-se que uma solicitação para o método Polygon seja feita em poucos minutos após a solicitação para o método de Pesquisa Online que forneceu a ID. O serviço permite solicitações em lote de até 20 identificadores.

Usa a API obter Pesquisa polígono: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 cancelamento de solicitação.

geometries

string[]

Lista separada por vírgulas de UUIDs de geometria, recuperada anteriormente de uma solicitação de Pesquisa Online.

Retornos

Promise<SearchPolygonResponse>

Detalhes do método herdado

newPipeline(Credential, INewPipelineOptions)

Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida.

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

Parâmetros

credential
Credential

Como SubscriptionKeyCredential, TokenCredential e MapControlCredential.

pipelineOptions
INewPipelineOptions

Retornos

Pipeline

Um novo objeto Pipeline.

Herdado deMapsURL.newPipeline