SearchURL class
Un SearchURL representa una dirección URL a las operaciones de búsqueda Azure Maps.
- Extends
Constructores
| SearchURL(Pipeline, string) | Crea una instancia de SearchURL. |
Propiedades heredadas
| maps |
Valor de cadena de dirección URL base. |
Métodos
| search |
Geocodificación de direcciones En muchos casos, el servicio de búsqueda completo puede ser demasiado, por ejemplo, si solo está interesado en la geocodificación tradicional. también se puede acceder a Búsqueda para la búsqueda de direcciones exclusivamente. La geocodificación se realiza al presionar el punto de conexión de código geográfico con solo la dirección o la dirección parcial en cuestión. El índice de búsqueda de geocodificación se consultará para conocer todo lo que está por encima de los datos de nivel de calle. No se devolverá ningún POIs. Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También controlará todo desde direcciones de calle exactas, calles o intersecciones, así como zonas geográficas de nivel superior, como centros de ciudad, condados, estados, etc. Usa get Búsqueda Address API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress |
| search |
Código geográfico inverso a una dirección Puede haber ocasiones en las que necesite traducir una coordenada (ejemplo: -122.3862, 37.786505) en una dirección postal comprensible para el usuario. Por lo general, esta conversión es necesaria en las aplicaciones de seguimiento, donde recibe una fuente GPS del dispositivo o recurso y desea saber en qué dirección se encuentra en la coordenada. Este punto de conexión devolverá información de dirección para una coordenada determinada. Usa get Búsqueda Address Reverse API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse |
| search |
Código geográfico inverso a una calle cruzada Puede haber ocasiones en las que necesite traducir una coordenada (ejemplo: -122.3862, 37.786505) en una calle transversal comprensible humana. Por lo general, esta conversión es necesaria en las aplicaciones de seguimiento, donde recibe una fuente GPS del dispositivo o recurso y desea saber en qué dirección se encuentra en la coordenada. Este punto de conexión devolverá información entre calles para una coordenada determinada. Usa get Búsqueda Address Reverse Cross Street API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet |
| search |
Geocodificación de direcciones estructuradas También se puede acceder a la geocodificación de direcciones de Azure para la búsqueda de direcciones estructuradas exclusivamente. El índice de búsqueda de geocodificación se consultará para conocer todo lo que está por encima de los datos de nivel de calle. No se devolverá ningún POIs. Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También controlará todo desde direcciones de calle exactas, calles o intersecciones, así como zonas geográficas de nivel superior, como centros de ciudad, condados, estados, etc. Usa Get Búsqueda Address Structured API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured |
| search |
El punto de conexión de Búsqueda Along Route permite realizar una búsqueda aproximada de POIs a lo largo de una ruta especificada.
Esta búsqueda está restringida especificando la |
| search |
Forma libre Búsqueda La API predeterminada básica es forma libre Búsqueda que controla la mayoría aproximada de las entradas que controlan cualquier combinación de tokens de dirección o poi.
Esta API de búsqueda es la "búsqueda de una sola línea" canónica.
La API de Búsqueda de forma libre es una combinación perfecta de búsqueda de PUNTOS de interés y geocodificación.
La API también se puede ponderar con una posición contextual (lat./lon. par), o totalmente restringida por una coordenada y radio, o bien se puede ejecutar de forma más general sin ningún punto de anclaje de sesgo geográfico.
Le recomendamos encarecidamente que use el parámetro "countrySet" para especificar solo los países para los que la aplicación necesita cobertura, ya que el comportamiento predeterminado será buscar en todo el mundo, lo que podría devolver resultados innecesarios. Por ejemplo: |
| search |
El punto de conexión de Búsqueda Geometry permite realizar una búsqueda de forma libre dentro de una sola geometría o de muchas de ellas.
Se devolverán los resultados de búsqueda que se encuentran dentro de geometry/geometries.
Las características geográficas que se van a buscar se pueden modelar como geometrías de polígono o círculo representadas mediante cualquiera de los siguientes |
| search |
Cerca de Búsqueda Si tiene un caso de uso para recuperar solo los resultados de poi alrededor de una ubicación específica, el método de búsqueda cercano puede ser la opción adecuada. Este punto de conexión solo devolverá resultados de POI y no tendrá en cuenta ningún parámetro de consulta de búsqueda. Usa la API Get Búsqueda Nearby:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby |
| searchPOI(Aborter, string, Search |
Obtener poi por nombre Si el caso de uso de la búsqueda solo requiere resultados de POI, puede usar el punto de conexión de POI para la búsqueda. Este punto de conexión solo devolverá resultados de POI. Usa la API Get Búsqueda POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi |
| search |
Obtener puntos de interés por categoría Si el caso de uso de búsqueda solo requiere resultados de POI filtrados por categoría, puede usar el punto de conexión de categoría. Este punto de conexión solo devolverá resultados de PUNTOS de interés que se clasifican como se especifica. Puede encontrar una lista de categorías disponibles aquí. Usa la API Get Búsqueda POI Category:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory |
| search |
La API de Búsqueda Polygon permite solicitar los datos de geometría, como un esquema de ciudad o país para un conjunto de entidades, recuperados previamente de una solicitud de Búsqueda en línea en formato GeoJSON. El identificador de geometría se devuelve en el objeto dataSources bajo "geometry" y "id" en una dirección de Búsqueda o Búsqueda llamada aproximada. Tenga en cuenta que cualquier identificador de geometría recuperado de un punto de conexión de Búsqueda en línea tiene una duración limitada. El cliente no debe almacenar identificadores de geometría en el almacenamiento persistente para la referencia posterior, ya que no se garantiza la estabilidad de estos identificadores durante un largo período de tiempo. Se espera que se realice una solicitud al método Polygon en unos minutos a partir de la solicitud al método Online Búsqueda que proporcionó el identificador. El servicio permite solicitudes por lotes de hasta 20 identificadores. Usa get Búsqueda Polygon API:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon |
Métodos heredados
| new |
Método estático que se usa para crear un nuevo objeto Pipeline con Credential proporcionado. |
Detalles del constructor
SearchURL(Pipeline, string)
Crea una instancia de SearchURL.
new SearchURL(pipeline: Pipeline, mapsUrl?: string)Parámetros
- pipeline
- Pipeline
Llame a MapsURL.newPipeline() para crear una canalización predeterminada o proporcione una canalización personalizada.
- mapsUrl
-
string
Una cadena de dirección URL que apunta a Azure Maps servicio, el valor predeterminado es "https://atlas.microsoft.com".
Si no se especifica ningún protocolo, por ejemplo "atlas.microsoft.com", https se supone que.
Detalles de las propiedades heredadas
mapsUrl
Valor de cadena de dirección URL base.
mapsUrl: stringValor de propiedad
string
Heredado deMapsURL.mapsUrl
Detalles del método
searchAddress(Aborter, string, SearchAddressOptions)
Geocodificación de direcciones En muchos casos, el servicio de búsqueda completo puede ser demasiado, por ejemplo, si solo está interesado en la geocodificación tradicional. también se puede acceder a Búsqueda para la búsqueda de direcciones exclusivamente. La geocodificación se realiza al presionar el punto de conexión de código geográfico con solo la dirección o la dirección parcial en cuestión. El índice de búsqueda de geocodificación se consultará para conocer todo lo que está por encima de los datos de nivel de calle. No se devolverá ningún POIs. Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También controlará todo desde direcciones de calle exactas, calles o intersecciones, así como zonas geográficas de nivel superior, como centros de ciudad, condados, estados, etc. Usa get Búsqueda Address API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- query
-
string
Dirección que se va a buscar (por ejemplo, "1 microsoft way, Redmond, WA").
- options
- SearchAddressOptions
Devoluciones
Promise<SearchAddressResponse>
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)
Código geográfico inverso a una dirección Puede haber ocasiones en las que necesite traducir una coordenada (ejemplo: -122.3862, 37.786505) en una dirección postal comprensible para el usuario. Por lo general, esta conversión es necesaria en las aplicaciones de seguimiento, donde recibe una fuente GPS del dispositivo o recurso y desea saber en qué dirección se encuentra en la coordenada. Este punto de conexión devolverá información de dirección para una coordenada determinada. Usa get Búsqueda Address Reverse API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse
function searchAddressReverse(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseOptions): Promise<SearchAddressReverseResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- position
- GeoJSON.Position
Posición de búsqueda inversa, una matriz de coordenadas de [longitude, latitude] , por ejemplo, [-122.125679, 47.641268].
- options
- SearchAddressReverseOptions
Devoluciones
Promise<SearchAddressReverseResponse>
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)
Código geográfico inverso a una calle cruzada Puede haber ocasiones en las que necesite traducir una coordenada (ejemplo: -122.3862, 37.786505) en una calle transversal comprensible humana. Por lo general, esta conversión es necesaria en las aplicaciones de seguimiento, donde recibe una fuente GPS del dispositivo o recurso y desea saber en qué dirección se encuentra en la coordenada. Este punto de conexión devolverá información entre calles para una coordenada determinada. Usa get Búsqueda Address Reverse Cross Street API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet
function searchAddressReverseCrossStreet(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseCrossStreetOptions): Promise<SearchAddressReverseCrossStreetResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- position
- GeoJSON.Position
Posición de búsqueda inversa, una matriz de coordenadas de [longitude, latitude] , por ejemplo, [-122.125679, 47.641268].
Devoluciones
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)
Geocodificación de direcciones estructuradas También se puede acceder a la geocodificación de direcciones de Azure para la búsqueda de direcciones estructuradas exclusivamente. El índice de búsqueda de geocodificación se consultará para conocer todo lo que está por encima de los datos de nivel de calle. No se devolverá ningún POIs. Tenga en cuenta que el geocodificador es muy tolerante a errores tipográficos y direcciones incompletas. También controlará todo desde direcciones de calle exactas, calles o intersecciones, así como zonas geográficas de nivel superior, como centros de ciudad, condados, estados, etc. Usa Get Búsqueda Address Structured API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- countryCode
-
string
La parte de código de país de 2 o 3 letras ISO3166-1 de una dirección. Por ejemplo, EE. UU.
- options
- SearchAddressStructuredOptions
Devoluciones
Promise<SearchAddressStructuredResponse>
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)
El punto de conexión de Búsqueda Along Route permite realizar una búsqueda aproximada de POIs a lo largo de una ruta especificada.
Esta búsqueda está restringida especificando la maxDetourTime medida de limitación.
Para enviar los puntos de ruta, usará un body objeto que contendrá el route objeto representado como un GeoJSON LineString tipo y el Content-Type encabezado se establecerá en application/json.
Cada punto de ruta de route se representa como un GeoJSON Position tipo, es decir, una matriz donde el valor de longitud va seguido del valor de latitud y se omite el valor de altitud .
route debe contener al menos 2 puntos de ruta.
Es posible que se modifique la ruta original, algunos de sus puntos se pueden omitir.
Si la ruta que pasa por el punto encontrado es más rápida que la original, el detourTime valor de la respuesta es negativo.
Usa post Búsqueda Along Route API: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
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- query
-
string
La cadena de consulta aplicable (por ejemplo, "seattle", "pizza").
- maxDetourTime
-
number
Tiempo máximo de desvío del punto de interés en segundos. El valor máximo es de 3600 segundos
Representa la ruta que se va a buscar y debe ser un tipo válido GeoJSON LineString . Consulte RFC 7946 para obtener más información.
- options
- SearchAlongRouteOptions
Devoluciones
Promise<SearchAlongRouteResponse>
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)
Forma libre Búsqueda La API predeterminada básica es forma libre Búsqueda que controla la mayoría aproximada de las entradas que controlan cualquier combinación de tokens de dirección o poi.
Esta API de búsqueda es la "búsqueda de una sola línea" canónica.
La API de Búsqueda de forma libre es una combinación perfecta de búsqueda de PUNTOS de interés y geocodificación.
La API también se puede ponderar con una posición contextual (lat./lon. par), o totalmente restringida por una coordenada y radio, o bien se puede ejecutar de forma más general sin ningún punto de anclaje de sesgo geográfico.
Le recomendamos encarecidamente que use el parámetro "countrySet" para especificar solo los países para los que la aplicación necesita cobertura, ya que el comportamiento predeterminado será buscar en todo el mundo, lo que podría devolver resultados innecesarios. Por ejemplo: countrySet=US,FR. Consulte [Búsqueda Cobertura] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) para obtener una lista completa de todos los países admitidos.
La mayoría de las consultas Búsqueda tienen como valor predeterminado maxFuzzyLevel=2 para obtener rendimiento y también reducir los resultados inusuales.
Este nuevo valor predeterminado se puede invalidar según sea necesario por solicitud pasando el parámetro maxFuzzyLevelde consulta =3 o 4.
Usa get Búsqueda Fuzzy API: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
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- query
-
string | GeoJSON.Position
La cadena de consulta aplicable (por ejemplo, "seattle", "pizza").
También se puede especificar como una matriz de coordenadas de [longitude, latitude] (por ejemplo, [-122.125679, 47.641268]).
- options
- SearchFuzzyOptions
Devoluciones
Promise<SearchFuzzyResponse>
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)
El punto de conexión de Búsqueda Geometry permite realizar una búsqueda de forma libre dentro de una sola geometría o de muchas de ellas.
Se devolverán los resultados de búsqueda que se encuentran dentro de geometry/geometries.
Las características geográficas que se van a buscar se pueden modelar como geometrías de polígono o círculo representadas mediante cualquiera de los siguientes GeoJSON tipos: GeoJSON FeatureCollection, geometry puede representarse como un GeoJSON FeatureCollection objeto .
Esta es la opción recomendada si la geometría contiene polígonos y círculos.
FeatureCollection puede contener un máximo de 50 GeoJSON Feature objetos.
Cada Feature objeto debe representar un polígono o un círculo con las condiciones siguientes: un Feature objeto para la geometría Polygon puede tener un máximo de 50 coordenadas y sus propiedades deben estar vacías.
Un Feature objeto para la geometría Circle se compone de un centro representado mediante un GeoJSON Point tipo y un valor de radio (en metros) que se deben especificar en las propiedades del objeto junto con la propiedad subType cuyo valor debe ser "Circle".
Consulte la sección Ejemplos a continuación para obtener una representación de ejemplo FeatureCollection .
GeoJSON GeometryCollection, geometry puede representarse como un GeoJSON GeometryCollection objeto .
Esta es la opción recomendada si la geometría contiene solo una lista de polígonos.
GeometryCollection puede contener un máximo de 50 GeoJSON Polygon objetos.
Cada Polygon objeto puede tener un máximo de 50 coordenadas.
Consulte la sección Ejemplos a continuación para obtener una representación de ejemplo GeometryCollection .
Polígono GeoJSON, geometry puede representarse como un GeoJSON Polygon objeto .
Esta es la opción recomendada si la geometría contiene un solo polígono.
El Polygon objeto puede tener un máximo de 50 coordenadas.
Usa post Búsqueda Inside Geometry API: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
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- query
-
string
La cadena de consulta aplicable (por ejemplo, "seattle", "pizza").
Esto representa la geometría de una o varias características geográficas (parques, límites de estado, etc.) para buscar en y debe ser un tipo compatible con GeoJSON. Consulte RFC 7946 para obtener más información.
- options
- SearchInsideGeometryOptions
Devoluciones
Promise<SearchInsideGeometryResponse>
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)
Cerca de Búsqueda Si tiene un caso de uso para recuperar solo los resultados de poi alrededor de una ubicación específica, el método de búsqueda cercano puede ser la opción adecuada. Este punto de conexión solo devolverá resultados de POI y no tendrá en cuenta ningún parámetro de consulta de búsqueda. Usa la API Get Búsqueda 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
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- location
- GeoJSON.Position
Ubicación donde los resultados deben estar sesgados.
Debe ser una matriz de [longitude, latitude], por ejemplo, [-121.89, 37.337].
- options
- SearchNearbyOptions
Devoluciones
Promise<SearchNearbyResponse>
searchPOI(Aborter, string, SearchPOIOptions)
Obtener poi por nombre Si el caso de uso de la búsqueda solo requiere resultados de POI, puede usar el punto de conexión de POI para la búsqueda. Este punto de conexión solo devolverá resultados de POI. Usa la API Get Búsqueda POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
function searchPOI(aborter: Aborter, query: string, options?: SearchPOIOptions): Promise<SearchPOIResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- query
-
string
El nombre de POI que se va a buscar (por ejemplo, "estatua de libertad", "starbucks").
- options
- SearchPOIOptions
Devoluciones
Promise<SearchPOIResponse>
searchPOICategory(Aborter, string, SearchPOICategoryOptions)
Obtener puntos de interés por categoría Si el caso de uso de búsqueda solo requiere resultados de POI filtrados por categoría, puede usar el punto de conexión de categoría. Este punto de conexión solo devolverá resultados de PUNTOS de interés que se clasifican como se especifica. Puede encontrar una lista de categorías disponibles aquí. Usa la API Get Búsqueda POI Category:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- query
-
string
Categoría poi que se va a buscar (por ejemplo, "AIRPORT", "BEACH").
- options
- SearchPOICategoryOptions
Devoluciones
Promise<SearchPOICategoryResponse>
searchPolygon(Aborter, string[])
La API de Búsqueda Polygon permite solicitar los datos de geometría, como un esquema de ciudad o país para un conjunto de entidades, recuperados previamente de una solicitud de Búsqueda en línea en formato GeoJSON. El identificador de geometría se devuelve en el objeto dataSources bajo "geometry" y "id" en una dirección de Búsqueda o Búsqueda llamada aproximada. Tenga en cuenta que cualquier identificador de geometría recuperado de un punto de conexión de Búsqueda en línea tiene una duración limitada. El cliente no debe almacenar identificadores de geometría en el almacenamiento persistente para la referencia posterior, ya que no se garantiza la estabilidad de estos identificadores durante un largo período de tiempo. Se espera que se realice una solicitud al método Polygon en unos minutos a partir de la solicitud al método Online Búsqueda que proporcionó el identificador. El servicio permite solicitudes por lotes de hasta 20 identificadores.
Usa get Búsqueda Polygon API:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon
function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- geometries
-
string[]
Lista separada por comas de UUID de geometría, recuperadas previamente de una solicitud de Búsqueda en línea.
Devoluciones
Promise<SearchPolygonResponse>
Detalles de los métodos heredados
newPipeline(Credential, INewPipelineOptions)
Método estático que se usa para crear un nuevo objeto Pipeline con Credential proporcionado.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParámetros
- credential
- Credential
Por ejemplo, SubscriptionKeyCredential, TokenCredential y MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Devoluciones
Nuevo objeto Pipeline.
Heredado deMapsURL.newPipeline