MapsSearchClient class
Classe cliente pour interagir avec Azure Maps service de recherche.
Constructeurs
| Maps |
Crée une instance de MapsSearchClient à partir d’une clé d’abonnement. Exemple |
| Maps |
Crée une instance de MapsSearchClient à partir d’une identité Exemple |
Méthodes
| begin |
Envoie des lots de demandes de recherche approximatives. La méthode retourne un polleur pour récupérer le résultat ultérieurement. |
| begin |
Envoie des lots de demandes de géocodage inverse. La méthode retourne un polleur pour récupérer le résultat ultérieurement. |
| begin |
Envoie des lots de demandes de géocodage. La méthode retourne un polleur pour récupérer le résultat ultérieurement. |
| fuzzy |
Effectue une recherche de forme libre qui gère la plus approximative des entrées gérant toute combinaison de jetons d’adresse ou de poI. |
| get |
Demande les données géométriques telles qu’un plan de ville ou de pays pour un ensemble d’entités. |
| get |
Demande une liste complète des catégories de points d’intérêt (POI) prises en charge. |
| resume |
Poursuivez la demande de recherche approximative avec un état sérialisé à partir d’un autre polleur. Exemple |
| resume |
Poursuivez la demande de recherche d’adresse inverse avec un état sérialisé à partir d’un autre polleur. Exemple |
| resume |
Poursuivez la demande de recherche d’adresse avec un état sérialisé à partir d’un autre polleur. Exemple |
| reverse |
Traduit une coordonnée en adresse postale compréhensible par l’homme. |
| reverse |
Traduit une coordonnée en un croisement compréhensible par l’homme. |
| search |
Géocode une adresse. |
| search |
Effectue une recherche approximative des points d’entrée le long d’un itinéraire spécifié. |
| search |
Effectue une recherche de formulaire libre à l’intérieur d’une seule géométrie ou de plusieurs d’entre elles. |
| search |
Demande des résultats de points d’intérêt (POI) autour d’un emplacement spécifique. |
| search |
Demande des résultats de points d’intérêt (POI) par nom |
| search |
Résultats des demandes de points d’intérêt (POI) à partir d’une catégorie donnée. |
| search |
Géocode une adresse structurée. |
Détails du constructeur
MapsSearchClient(AzureKeyCredential, MapsSearchClientOptions)
Crée une instance de MapsSearchClient à partir d’une clé d’abonnement.
Exemple
import { MapsSearchClient, AzureKeyCredential } from "@azure/maps-search";
const credential = new AzureKeyCredential("<subscription-key>");
const client = new MapsSearchClient(credential);
new MapsSearchClient(credential: AzureKeyCredential, options?: MapsSearchClientOptions)Paramètres
- credential
- AzureKeyCredential
Une instance AzureKeyCredential utilisée pour authentifier les demandes adressées au service
- options
- MapsSearchClientOptions
Options utilisées pour configurer le client de recherche
MapsSearchClient(TokenCredential, string, MapsSearchClientOptions)
Crée une instance de MapsSearchClient à partir d’une identité TokenCredentialAzure.
Exemple
import { MapsSearchClient } from "@azure/maps-search";
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential();
const client = new MapsSearchClient(credential, "<maps-account-client-id>");
new MapsSearchClient(credential: TokenCredential, mapsAccountClientId: string, options?: MapsSearchClientOptions)Paramètres
- credential
- TokenCredential
Une instance TokenCredential utilisée pour authentifier les demandes adressées au service
- mapsAccountClientId
-
string
ID client Azure Maps d’une ressource de carte spécifique
- options
- MapsSearchClientOptions
Options utilisées pour configurer le client de recherche
Détails de la méthode
beginFuzzySearchBatch(FuzzySearchRequest[], FuzzySearchBatchOptions)
Envoie des lots de demandes de recherche approximatives. La méthode retourne un polleur pour récupérer le résultat ultérieurement.
function beginFuzzySearchBatch(requests: FuzzySearchRequest[], options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Paramètres
- requests
Tableau des demandes de recherche à traiter. Le tableau peut contenir un maximum de 10 000 requêtes et doit contenir au moins 1 requête.
- options
- FuzzySearchBatchOptions
Paramètres facultatifs pour l’opération
Retours
Promise<FuzzySearchBatchPoller>
beginReverseSearchAddressBatch(ReverseSearchAddressRequest[], ReverseSearchAddressBatchOptions)
Envoie des lots de demandes de géocodage inverse. La méthode retourne un polleur pour récupérer le résultat ultérieurement.
function beginReverseSearchAddressBatch(requests: ReverseSearchAddressRequest[], options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Paramètres
- requests
Tableau des demandes de recherche à traiter. Le tableau peut contenir un maximum de 10 000 requêtes et doit contenir au moins 1 requête.
- options
- ReverseSearchAddressBatchOptions
Paramètres facultatifs pour l’opération
Retours
Promise<ReverseSearchAddressBatchPoller>
beginSearchAddressBatch(SearchAddressRequest[], SearchAddressBatchOptions)
Envoie des lots de demandes de géocodage. La méthode retourne un polleur pour récupérer le résultat ultérieurement.
function beginSearchAddressBatch(requests: SearchAddressRequest[], options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Paramètres
- requests
Tableau des demandes de recherche à traiter. Le tableau peut contenir un maximum de 10 000 requêtes et doit contenir au moins 1 requête.
- options
- SearchAddressBatchOptions
Paramètres facultatifs pour l’opération
Retours
Promise<FuzzySearchBatchPoller>
fuzzySearch(SearchQuery, FuzzySearchBaseOptions & OperationOptions)
Effectue une recherche de forme libre qui gère la plus approximative des entrées gérant toute combinaison de jetons d’adresse ou de poI.
function fuzzySearch(searchQuery: SearchQuery, options?: FuzzySearchBaseOptions & OperationOptions): Promise<SearchAddressResult>Paramètres
- searchQuery
- SearchQuery
Requête de texte et informations d’emplacement à rechercher
- options
Options pour la recherche approximative
Retours
Promise<SearchAddressResult>
getGeometries(string[], OperationOptions)
Demande les données géométriques telles qu’un plan de ville ou de pays pour un ensemble d’entités.
function getGeometries(geometryIds: string[], options?: OperationOptions): Promise<EntityGeometry[]>Paramètres
- geometryIds
-
string[]
Liste séparée par des virgules des UUID géométriques, précédemment récupérées à partir d’une demande de recherche en ligne.
- options
- OperationOptions
Paramètres facultatifs pour l’opération
Retours
Promise<EntityGeometry[]>
getPointOfInterestCategories(GetPointOfInterestCategoriesOptions)
Demande une liste complète des catégories de points d’intérêt (POI) prises en charge.
function getPointOfInterestCategories(options?: GetPointOfInterestCategoriesOptions): Promise<PointOfInterestCategory[]>Paramètres
Paramètres facultatifs pour l’opération
Retours
Promise<PointOfInterestCategory[]>
resumeFuzzySearchBatch(string, FuzzySearchBatchOptions)
Poursuivez la demande de recherche approximative avec un état sérialisé à partir d’un autre polleur.
Exemple
const serializedState = poller.toString()
const rehydratedPoller = resumeFuzzySearchBatch(serializedState)
rehydratedPoller.poll()
function resumeFuzzySearchBatch(restoreFrom: string, options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Paramètres
- restoreFrom
-
string
État sérialisé de l’polleur précédent.
- options
- FuzzySearchBatchOptions
Paramètres facultatifs pour l’opération.
Retours
Promise<FuzzySearchBatchPoller>
resumeReverseSearchAddressBatch(string, ReverseSearchAddressBatchOptions)
Poursuivez la demande de recherche d’adresse inverse avec un état sérialisé à partir d’un autre polleur.
Exemple
const serializedState = poller.toString()
const rehydratedPoller = resumeReverseSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeReverseSearchAddressBatch(restoreFrom: string, options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Paramètres
- restoreFrom
-
string
État sérialisé de l’polleur précédent.
- options
- ReverseSearchAddressBatchOptions
Paramètres facultatifs pour l’opération.
Retours
Promise<ReverseSearchAddressBatchPoller>
resumeSearchAddressBatch(string, SearchAddressBatchOptions)
Poursuivez la demande de recherche d’adresse avec un état sérialisé à partir d’un autre polleur.
Exemple
const serializedState = poller.toString()
const rehydratedPoller = resumeSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeSearchAddressBatch(restoreFrom: string, options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Paramètres
- restoreFrom
-
string
État sérialisé de l’polleur précédent.
- options
- SearchAddressBatchOptions
Paramètres facultatifs pour l’opération.
Retours
Promise<FuzzySearchBatchPoller>
reverseSearchAddress(LatLon, ReverseSearchAddressOptions & OperationOptions)
Traduit une coordonnée en adresse postale compréhensible par l’homme.
function reverseSearchAddress(coordinates: LatLon, options?: ReverseSearchAddressOptions & OperationOptions): Promise<ReverseSearchAddressResult>Paramètres
- coordinates
- LatLon
Coordonnées de la requête de recherche inversée
- options
Paramètres facultatifs pour l’opération
Retours
Promise<ReverseSearchAddressResult>
reverseSearchCrossStreetAddress(LatLon, ReverseSearchCrossStreetAddressOptions)
Traduit une coordonnée en un croisement compréhensible par l’homme.
function reverseSearchCrossStreetAddress(coordinates: LatLon, options?: ReverseSearchCrossStreetAddressOptions): Promise<ReverseSearchCrossStreetAddressResult>Paramètres
- coordinates
- LatLon
Coordonnées de la requête de recherche inversée
Paramètres facultatifs pour l’opération
Retours
searchAddress(string, SearchAddressOptions & OperationOptions)
Géocode une adresse.
function searchAddress(query: string, options?: SearchAddressOptions & OperationOptions): Promise<SearchAddressResult>Paramètres
- query
-
string
Adresse à rechercher (par exemple, « 1 Microsoft way, Redmond, WA »)
- options
Paramètres facultatifs pour l’opération
Retours
Promise<SearchAddressResult>
searchAlongRoute(string, number, GeoJsonLineString, SearchAlongRouteOptions)
Effectue une recherche approximative des points d’entrée le long d’un itinéraire spécifié.
function searchAlongRoute(query: string, maxDetourTimeInSeconds: number, route: GeoJsonLineString, options?: SearchAlongRouteOptions): Promise<SearchAddressResult>Paramètres
- query
-
string
Nom poI à rechercher (par exemple, « statue de la liberté », « starbucks », « pizza »).
- maxDetourTimeInSeconds
-
number
Durée maximale de détour du point d’intérêt en secondes. La valeur maximale est de 3600 secondes
- route
- GeoJsonLineString
Cela représente l’itinéraire de recherche et doit être un type valide GeoJSON LineString .
- options
- SearchAlongRouteOptions
Paramètres facultatifs pour l’opération
Retours
Promise<SearchAddressResult>
searchInsideGeometry(string, SearchGeometry, SearchInsideGeometryOptions)
Effectue une recherche de formulaire libre à l’intérieur d’une seule géométrie ou de plusieurs d’entre elles.
function searchInsideGeometry(query: string, geometry: SearchGeometry, options?: SearchInsideGeometryOptions): Promise<SearchAddressResult>Paramètres
- query
-
string
Nom poI à rechercher (par exemple, « statue de la liberté », « starbucks », « pizza »).
- geometry
- SearchGeometry
Cela représente la géométrie d’une ou plusieurs caractéristiques géographiques (parcs, limite d’état, etc.) à rechercher dans et doit être un type conforme à GeoJSON. Pour plus d’informations, consultez RFC 7946 .
- options
- SearchInsideGeometryOptions
Paramètres facultatifs pour l’opération
Retours
Promise<SearchAddressResult>
searchNearbyPointOfInterest(LatLon, SearchNearbyPointOfInterestOptions)
Demande des résultats de points d’intérêt (POI) autour d’un emplacement spécifique.
function searchNearbyPointOfInterest(coordinates: LatLon, options?: SearchNearbyPointOfInterestOptions): Promise<SearchAddressResult>Paramètres
- coordinates
- LatLon
Coordonnées de la recherche de POI à proximité
Paramètres facultatifs pour l’opération
Retours
Promise<SearchAddressResult>
searchPointOfInterest(SearchQuery, SearchPointOfInterestOptions)
Demande des résultats de points d’intérêt (POI) par nom
function searchPointOfInterest(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Paramètres
- searchQuery
- SearchQuery
Requête de texte et informations d’emplacement à rechercher
- options
- SearchPointOfInterestOptions
Options pour la recherche de POI
Retours
Promise<SearchAddressResult>
searchPointOfInterestCategory(SearchQuery, SearchPointOfInterestOptions)
Résultats des demandes de points d’intérêt (POI) à partir d’une catégorie donnée.
function searchPointOfInterestCategory(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Paramètres
- searchQuery
- SearchQuery
Requête de texte et informations d’emplacement à rechercher
- options
- SearchPointOfInterestOptions
Options pour la catégorie poI de recherche
Retours
Promise<SearchAddressResult>
searchStructuredAddress(StructuredAddress, SearchStructuredAddressOptions)
Géocode une adresse structurée.
function searchStructuredAddress(structuredAddress: StructuredAddress, options?: SearchStructuredAddressOptions): Promise<SearchAddressResult>Paramètres
- structuredAddress
- StructuredAddress
Adresse structurée utilisée pour le géocodage
- options
- SearchStructuredAddressOptions
Paramètres facultatifs pour l’opération
Retours
Promise<SearchAddressResult>
