MapsSearchClient class
Classe client per l'interazione con il servizio di ricerca di Mappe di Azure.
Costruttori
| Maps |
Crea un'istanza di MapsSearchClient da una chiave di sottoscrizione. Esempio |
| Maps |
Crea un'istanza di MapsSearchClient da un'identità Esempio |
Metodi
| begin |
Invia batch di richieste di ricerca fuzzy. Il metodo restituisce un poller per recuperare il risultato in un secondo momento. |
| begin |
Invia batch di richieste di geocodifica inversa. Il metodo restituisce un poller per recuperare il risultato in un secondo momento. |
| begin |
Invia batch di richieste di geocodifica. Il metodo restituisce un poller per recuperare il risultato in un secondo momento. |
| fuzzy |
Esegue una ricerca in formato libero che gestisce gli input più fuzzy gestendo qualsiasi combinazione di token di indirizzo o PDI. |
| get |
Richiede i dati geometrici, ad esempio il contorno di una città o di un paese, per un insieme di entità. |
| get |
Richiede un elenco completo delle categorie di punti di interesse supportate. |
| resume |
Continuare la richiesta di ricerca fuzzy con uno stato serializzato da un altro poller. Esempio |
| resume |
Continuare la richiesta di ricerca inversa dell'indirizzo con uno stato serializzato da un altro poller. Esempio |
| resume |
Continuare la richiesta di ricerca dell'indirizzo con uno stato serializzato da un altro poller. Esempio |
| reverse |
Traduce le coordinate in un indirizzo stradale comprensibile dall'uomo. |
| reverse |
Traduce le coordinate in un incrocio comprensibile dall'uomo. |
| search |
Geocodifica un indirizzo. |
| search |
Esegue una ricerca fuzzy dei punti di interesse lungo un percorso specificato. |
| search |
Esegue una ricerca in forma libera all'interno di una singola geometria o di più di esse. |
| search |
Richiede i risultati dei punti di interesse (POI) intorno a una posizione specifica. |
| search |
Richiede i risultati dei punti di interesse (POI) per nome |
| search |
Richiede i risultati dei punti di interesse (POI) da una determinata categoria. |
| search |
Geocodifica un indirizzo strutturato. |
Dettagli costruttore
MapsSearchClient(AzureKeyCredential, MapsSearchClientOptions)
Crea un'istanza di MapsSearchClient da una chiave di sottoscrizione.
Esempio
import { MapsSearchClient, AzureKeyCredential } from "@azure/maps-search";
const credential = new AzureKeyCredential("<subscription-key>");
const client = new MapsSearchClient(credential);
new MapsSearchClient(credential: AzureKeyCredential, options?: MapsSearchClientOptions)Parametri
- credential
- AzureKeyCredential
Istanza di AzureKeyCredential usata per autenticare le richieste al servizio
- options
- MapsSearchClientOptions
Opzioni usate per configurare il client di ricerca
MapsSearchClient(TokenCredential, string, MapsSearchClientOptions)
Crea un'istanza di MapsSearchClient da un'identità TokenCredentialdi Azure.
Esempio
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)Parametri
- credential
- TokenCredential
Istanza tokenCredential usata per autenticare le richieste al servizio
- mapsAccountClientId
-
string
ID client di Mappe di Azure di una risorsa mappa specifica
- options
- MapsSearchClientOptions
Opzioni usate per configurare il client di ricerca
Dettagli metodo
beginFuzzySearchBatch(FuzzySearchRequest[], FuzzySearchBatchOptions)
Invia batch di richieste di ricerca fuzzy. Il metodo restituisce un poller per recuperare il risultato in un secondo momento.
function beginFuzzySearchBatch(requests: FuzzySearchRequest[], options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parametri
- requests
Matrice di richieste di ricerca da elaborare. La matrice può contenere un massimo di 10.000 richieste e deve contenere almeno 1 richiesta.
- options
- FuzzySearchBatchOptions
Parametri opzionali per l'operazione
Restituisce
Promise<FuzzySearchBatchPoller>
beginReverseSearchAddressBatch(ReverseSearchAddressRequest[], ReverseSearchAddressBatchOptions)
Invia batch di richieste di geocodifica inversa. Il metodo restituisce un poller per recuperare il risultato in un secondo momento.
function beginReverseSearchAddressBatch(requests: ReverseSearchAddressRequest[], options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parametri
- requests
Matrice di richieste di ricerca da elaborare. La matrice può contenere un massimo di 10.000 richieste e deve contenere almeno 1 richiesta.
- options
- ReverseSearchAddressBatchOptions
Parametri opzionali per l'operazione
Restituisce
Promise<ReverseSearchAddressBatchPoller>
beginSearchAddressBatch(SearchAddressRequest[], SearchAddressBatchOptions)
Invia batch di richieste di geocodifica. Il metodo restituisce un poller per recuperare il risultato in un secondo momento.
function beginSearchAddressBatch(requests: SearchAddressRequest[], options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parametri
- requests
Matrice di richieste di ricerca da elaborare. La matrice può contenere un massimo di 10.000 richieste e deve contenere almeno 1 richiesta.
- options
- SearchAddressBatchOptions
Parametri opzionali per l'operazione
Restituisce
Promise<FuzzySearchBatchPoller>
fuzzySearch(SearchQuery, FuzzySearchBaseOptions & OperationOptions)
Esegue una ricerca in formato libero che gestisce gli input più fuzzy gestendo qualsiasi combinazione di token di indirizzo o PDI.
function fuzzySearch(searchQuery: SearchQuery, options?: FuzzySearchBaseOptions & OperationOptions): Promise<SearchAddressResult>Parametri
- searchQuery
- SearchQuery
Query di testo e informazioni sulla posizione da cercare
- options
Opzioni per la ricerca fuzzy
Restituisce
Promise<SearchAddressResult>
getGeometries(string[], OperationOptions)
Richiede i dati geometrici, ad esempio il contorno di una città o di un paese, per un insieme di entità.
function getGeometries(geometryIds: string[], options?: OperationOptions): Promise<EntityGeometry[]>Parametri
- geometryIds
-
string[]
Elenco separato da virgole di UUID geometrici, precedentemente recuperato da una richiesta di ricerca online.
- options
- OperationOptions
Parametri opzionali per l'operazione
Restituisce
Promise<EntityGeometry[]>
getPointOfInterestCategories(GetPointOfInterestCategoriesOptions)
Richiede un elenco completo delle categorie di punti di interesse supportate.
function getPointOfInterestCategories(options?: GetPointOfInterestCategoriesOptions): Promise<PointOfInterestCategory[]>Parametri
Parametri opzionali per l'operazione
Restituisce
Promise<PointOfInterestCategory[]>
resumeFuzzySearchBatch(string, FuzzySearchBatchOptions)
Continuare la richiesta di ricerca fuzzy con uno stato serializzato da un altro poller.
Esempio
const serializedState = poller.toString()
const rehydratedPoller = resumeFuzzySearchBatch(serializedState)
rehydratedPoller.poll()
function resumeFuzzySearchBatch(restoreFrom: string, options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parametri
- restoreFrom
-
string
Stato serializzato del poller precedente.
- options
- FuzzySearchBatchOptions
Parametri facoltativi per l'operazione.
Restituisce
Promise<FuzzySearchBatchPoller>
resumeReverseSearchAddressBatch(string, ReverseSearchAddressBatchOptions)
Continuare la richiesta di ricerca inversa dell'indirizzo con uno stato serializzato da un altro poller.
Esempio
const serializedState = poller.toString()
const rehydratedPoller = resumeReverseSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeReverseSearchAddressBatch(restoreFrom: string, options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parametri
- restoreFrom
-
string
Stato serializzato del poller precedente.
- options
- ReverseSearchAddressBatchOptions
Parametri facoltativi per l'operazione.
Restituisce
Promise<ReverseSearchAddressBatchPoller>
resumeSearchAddressBatch(string, SearchAddressBatchOptions)
Continuare la richiesta di ricerca dell'indirizzo con uno stato serializzato da un altro poller.
Esempio
const serializedState = poller.toString()
const rehydratedPoller = resumeSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeSearchAddressBatch(restoreFrom: string, options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parametri
- restoreFrom
-
string
Stato serializzato del poller precedente.
- options
- SearchAddressBatchOptions
Parametri facoltativi per l'operazione.
Restituisce
Promise<FuzzySearchBatchPoller>
reverseSearchAddress(LatLon, ReverseSearchAddressOptions & OperationOptions)
Traduce le coordinate in un indirizzo stradale comprensibile dall'uomo.
function reverseSearchAddress(coordinates: LatLon, options?: ReverseSearchAddressOptions & OperationOptions): Promise<ReverseSearchAddressResult>Parametri
- coordinates
- LatLon
Le coordinate per la query di ricerca inversa
- options
Parametri opzionali per l'operazione
Restituisce
Promise<ReverseSearchAddressResult>
reverseSearchCrossStreetAddress(LatLon, ReverseSearchCrossStreetAddressOptions)
Traduce le coordinate in un incrocio comprensibile dall'uomo.
function reverseSearchCrossStreetAddress(coordinates: LatLon, options?: ReverseSearchCrossStreetAddressOptions): Promise<ReverseSearchCrossStreetAddressResult>Parametri
- coordinates
- LatLon
Le coordinate per la query di ricerca inversa
Parametri opzionali per l'operazione
Restituisce
searchAddress(string, SearchAddressOptions & OperationOptions)
Geocodifica un indirizzo.
function searchAddress(query: string, options?: SearchAddressOptions & OperationOptions): Promise<SearchAddressResult>Parametri
- query
-
string
L'indirizzo da cercare (ad esempio, "1 Microsoft way, Redmond, WA")
- options
Parametri opzionali per l'operazione
Restituisce
Promise<SearchAddressResult>
searchAlongRoute(string, number, GeoJsonLineString, SearchAlongRouteOptions)
Esegue una ricerca fuzzy dei punti di interesse lungo un percorso specificato.
function searchAlongRoute(query: string, maxDetourTimeInSeconds: number, route: GeoJsonLineString, options?: SearchAlongRouteOptions): Promise<SearchAddressResult>Parametri
- query
-
string
Nome poi da cercare (ad esempio, "statua della libertà", "starbucks", "pizza").
- maxDetourTimeInSeconds
-
number
Tempo massimo di deviazione del punto di interesse in secondi. Il valore massimo è 3600 secondi
- route
- GeoJsonLineString
Rappresenta il percorso da cercare e deve essere di tipo valido GeoJSON LineString .
- options
- SearchAlongRouteOptions
Parametri opzionali per l'operazione
Restituisce
Promise<SearchAddressResult>
searchInsideGeometry(string, SearchGeometry, SearchInsideGeometryOptions)
Esegue una ricerca in forma libera all'interno di una singola geometria o di più di esse.
function searchInsideGeometry(query: string, geometry: SearchGeometry, options?: SearchInsideGeometryOptions): Promise<SearchAddressResult>Parametri
- query
-
string
Nome poi da cercare (ad esempio, "statua della libertà", "starbucks", "pizza").
- geometry
- SearchGeometry
Rappresenta la geometria per una o più caratteristiche geografiche (parchi, confine di stato e così via) in cui eseguire la ricerca e deve essere di tipo conforme a GeoJSON. Per informazioni dettagliate, vedere RFC 7946.
- options
- SearchInsideGeometryOptions
Parametri opzionali per l'operazione
Restituisce
Promise<SearchAddressResult>
searchNearbyPointOfInterest(LatLon, SearchNearbyPointOfInterestOptions)
Richiede i risultati dei punti di interesse (POI) intorno a una posizione specifica.
function searchNearbyPointOfInterest(coordinates: LatLon, options?: SearchNearbyPointOfInterestOptions): Promise<SearchAddressResult>Parametri
- coordinates
- LatLon
Le coordinate per la ricerca dei punti di interesse nelle vicinanze
Parametri opzionali per l'operazione
Restituisce
Promise<SearchAddressResult>
searchPointOfInterest(SearchQuery, SearchPointOfInterestOptions)
Richiede i risultati dei punti di interesse (POI) per nome
function searchPointOfInterest(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parametri
- searchQuery
- SearchQuery
Query di testo e informazioni sulla posizione da cercare
- options
- SearchPointOfInterestOptions
Opzioni per la ricerca di punti di interesse
Restituisce
Promise<SearchAddressResult>
searchPointOfInterestCategory(SearchQuery, SearchPointOfInterestOptions)
Richiede i risultati dei punti di interesse (POI) da una determinata categoria.
function searchPointOfInterestCategory(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parametri
- searchQuery
- SearchQuery
Query di testo e informazioni sulla posizione da cercare
- options
- SearchPointOfInterestOptions
Opzioni per la ricerca della categoria di POI
Restituisce
Promise<SearchAddressResult>
searchStructuredAddress(StructuredAddress, SearchStructuredAddressOptions)
Geocodifica un indirizzo strutturato.
function searchStructuredAddress(structuredAddress: StructuredAddress, options?: SearchStructuredAddressOptions): Promise<SearchAddressResult>Parametri
- structuredAddress
- StructuredAddress
Indirizzo strutturato utilizzato per la geocodifica
- options
- SearchStructuredAddressOptions
Parametri opzionali per l'operazione
Restituisce
Promise<SearchAddressResult>
