MapsSearchClient class
Klasa klienta do interakcji z usługą Azure Maps Search Service.
Konstruktory
| Maps |
Tworzy wystąpienie elementu MapsSearchClient na podstawie klucza subskrypcji. Przykład |
| Maps |
Tworzy wystąpienie MapsSearchClient na podstawie tożsamości Przykład |
Metody
| begin |
Wysyła partie żądań wyszukiwania rozmytego. Metoda zwraca poller w celu późniejszego pobrania wyniku. |
| begin |
Wysyła partie żądań geokodowania odwrotnego. Metoda zwraca poller w celu późniejszego pobrania wyniku. |
| begin |
Wysyła partie żądań geokodowania. Metoda zwraca poller w celu późniejszego pobrania wyniku. |
| fuzzy |
Przeprowadza wyszukiwanie w dowolnym kształcie, które obsługuje najbardziej rozmyte dane wejściowe, obsługując dowolną kombinację tokenów adresu lub punktu POI. |
| get |
Żąda danych geometrycznych, takich jak kontur miasta lub kraju, dla zestawu elementów. |
| get |
Żąda pełnej listy obsługiwanych kategorii użytecznych miejsc (POI). |
| resume |
Kontynuuj żądanie wyszukiwania rozmytego ze stanem serializowanym z innego programu odpytującego. Przykład |
| resume |
Kontynuuj żądanie wyszukiwania adresu zwrotnego ze stanem serializowanym z innego modułu odpytowania. Przykład |
| resume |
Kontynuuj żądanie wyszukiwania adresu z serializowanym stanem z innego pollera. Przykład |
| reverse |
Tłumaczy współrzędne na zrozumiały dla człowieka adres. |
| reverse |
Przekształca współrzędne w zrozumiałe dla człowieka skrzyżowanie. |
| search |
Geokoduje adres. |
| search |
Przeprowadza wyszukiwanie rozmyte punktów POI wzdłuż określonej trasy. |
| search |
Przeprowadza wyszukiwanie w formie dowolnej wewnątrz jednej geometrii lub wielu z nich. |
| search |
Żąda wyników z interesujących miejsc (POI) wokół określonej lokalizacji. |
| search |
Żąda wyników z interesujących miejsc (POI) według nazwy |
| search |
Żąda wyników z punktów szczególnych (POI) z danej kategorii. |
| search |
Geokoduje uporządkowany adres. |
Szczegóły konstruktora
MapsSearchClient(AzureKeyCredential, MapsSearchClientOptions)
Tworzy wystąpienie elementu MapsSearchClient na podstawie klucza subskrypcji.
Przykład
import { MapsSearchClient, AzureKeyCredential } from "@azure/maps-search";
const credential = new AzureKeyCredential("<subscription-key>");
const client = new MapsSearchClient(credential);
new MapsSearchClient(credential: AzureKeyCredential, options?: MapsSearchClientOptions)Parametry
- credential
- AzureKeyCredential
Wystąpienie azureKeyCredential używane do uwierzytelniania żądań w usłudze
- options
- MapsSearchClientOptions
Opcje używane do konfigurowania klienta wyszukiwania
MapsSearchClient(TokenCredential, string, MapsSearchClientOptions)
Tworzy wystąpienie MapsSearchClient na podstawie tożsamości TokenCredentialplatformy Azure.
Przykład
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)Parametry
- credential
- TokenCredential
Wystąpienie TokenCredential używane do uwierzytelniania żądań w usłudze
- mapsAccountClientId
-
string
Identyfikator klienta usługi Azure Maps określonego zasobu mapy
- options
- MapsSearchClientOptions
Opcje używane do konfigurowania klienta wyszukiwania
Szczegóły metody
beginFuzzySearchBatch(FuzzySearchRequest[], FuzzySearchBatchOptions)
Wysyła partie żądań wyszukiwania rozmytego. Metoda zwraca poller w celu późniejszego pobrania wyniku.
function beginFuzzySearchBatch(requests: FuzzySearchRequest[], options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parametry
- requests
Tablica żądań wyszukiwania do przetworzenia. Tablica może zawierać maksymalnie 10 000 żądań i musi zawierać co najmniej 1 żądanie.
- options
- FuzzySearchBatchOptions
Opcjonalne parametry operacji
Zwraca
Promise<FuzzySearchBatchPoller>
beginReverseSearchAddressBatch(ReverseSearchAddressRequest[], ReverseSearchAddressBatchOptions)
Wysyła partie żądań geokodowania odwrotnego. Metoda zwraca poller w celu późniejszego pobrania wyniku.
function beginReverseSearchAddressBatch(requests: ReverseSearchAddressRequest[], options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parametry
- requests
Tablica żądań wyszukiwania do przetworzenia. Tablica może zawierać maksymalnie 10 000 żądań i musi zawierać co najmniej 1 żądanie.
- options
- ReverseSearchAddressBatchOptions
Opcjonalne parametry operacji
Zwraca
Promise<ReverseSearchAddressBatchPoller>
beginSearchAddressBatch(SearchAddressRequest[], SearchAddressBatchOptions)
Wysyła partie żądań geokodowania. Metoda zwraca poller w celu późniejszego pobrania wyniku.
function beginSearchAddressBatch(requests: SearchAddressRequest[], options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parametry
- requests
Tablica żądań wyszukiwania do przetworzenia. Tablica może zawierać maksymalnie 10 000 żądań i musi zawierać co najmniej 1 żądanie.
- options
- SearchAddressBatchOptions
Opcjonalne parametry operacji
Zwraca
Promise<FuzzySearchBatchPoller>
fuzzySearch(SearchQuery, FuzzySearchBaseOptions & OperationOptions)
Przeprowadza wyszukiwanie w dowolnym kształcie, które obsługuje najbardziej rozmyte dane wejściowe, obsługując dowolną kombinację tokenów adresu lub punktu POI.
function fuzzySearch(searchQuery: SearchQuery, options?: FuzzySearchBaseOptions & OperationOptions): Promise<SearchAddressResult>Parametry
- searchQuery
- SearchQuery
Zapytanie tekstowe i informacje o lokalizacji do wyszukania
- options
Opcje wyszukiwania rozmytego
Zwraca
Promise<SearchAddressResult>
getGeometries(string[], OperationOptions)
Żąda danych geometrycznych, takich jak kontur miasta lub kraju, dla zestawu elementów.
function getGeometries(geometryIds: string[], options?: OperationOptions): Promise<EntityGeometry[]>Parametry
- geometryIds
-
string[]
Rozdzielona przecinkami lista identyfikatorów UUID geometrii, wcześniej pobranych z żądania wyszukiwania online.
- options
- OperationOptions
Opcjonalne parametry operacji
Zwraca
Promise<EntityGeometry[]>
getPointOfInterestCategories(GetPointOfInterestCategoriesOptions)
Żąda pełnej listy obsługiwanych kategorii użytecznych miejsc (POI).
function getPointOfInterestCategories(options?: GetPointOfInterestCategoriesOptions): Promise<PointOfInterestCategory[]>Parametry
Opcjonalne parametry operacji
Zwraca
Promise<PointOfInterestCategory[]>
resumeFuzzySearchBatch(string, FuzzySearchBatchOptions)
Kontynuuj żądanie wyszukiwania rozmytego ze stanem serializowanym z innego programu odpytującego.
Przykład
const serializedState = poller.toString()
const rehydratedPoller = resumeFuzzySearchBatch(serializedState)
rehydratedPoller.poll()
function resumeFuzzySearchBatch(restoreFrom: string, options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parametry
- restoreFrom
-
string
Serializowany stan z poprzedniego pollera.
- options
- FuzzySearchBatchOptions
Parametry opcjonalne dla operacji.
Zwraca
Promise<FuzzySearchBatchPoller>
resumeReverseSearchAddressBatch(string, ReverseSearchAddressBatchOptions)
Kontynuuj żądanie wyszukiwania adresu zwrotnego ze stanem serializowanym z innego modułu odpytowania.
Przykład
const serializedState = poller.toString()
const rehydratedPoller = resumeReverseSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeReverseSearchAddressBatch(restoreFrom: string, options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parametry
- restoreFrom
-
string
Serializowany stan z poprzedniego pollera.
- options
- ReverseSearchAddressBatchOptions
Parametry opcjonalne dla operacji.
Zwraca
Promise<ReverseSearchAddressBatchPoller>
resumeSearchAddressBatch(string, SearchAddressBatchOptions)
Kontynuuj żądanie wyszukiwania adresu z serializowanym stanem z innego pollera.
Przykład
const serializedState = poller.toString()
const rehydratedPoller = resumeSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeSearchAddressBatch(restoreFrom: string, options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parametry
- restoreFrom
-
string
Serializowany stan z poprzedniego pollera.
- options
- SearchAddressBatchOptions
Parametry opcjonalne dla operacji.
Zwraca
Promise<FuzzySearchBatchPoller>
reverseSearchAddress(LatLon, ReverseSearchAddressOptions & OperationOptions)
Tłumaczy współrzędne na zrozumiały dla człowieka adres.
function reverseSearchAddress(coordinates: LatLon, options?: ReverseSearchAddressOptions & OperationOptions): Promise<ReverseSearchAddressResult>Parametry
- coordinates
- LatLon
Współrzędne zapytania wyszukiwania wstecznego
- options
Opcjonalne parametry operacji
Zwraca
Promise<ReverseSearchAddressResult>
reverseSearchCrossStreetAddress(LatLon, ReverseSearchCrossStreetAddressOptions)
Przekształca współrzędne w zrozumiałe dla człowieka skrzyżowanie.
function reverseSearchCrossStreetAddress(coordinates: LatLon, options?: ReverseSearchCrossStreetAddressOptions): Promise<ReverseSearchCrossStreetAddressResult>Parametry
- coordinates
- LatLon
Współrzędne zapytania wyszukiwania wstecznego
Opcjonalne parametry operacji
Zwraca
searchAddress(string, SearchAddressOptions & OperationOptions)
Geokoduje adres.
function searchAddress(query: string, options?: SearchAddressOptions & OperationOptions): Promise<SearchAddressResult>Parametry
- query
-
string
Adres do wyszukania (np. "1 Microsoft way, Redmond, WA")
- options
Opcjonalne parametry operacji
Zwraca
Promise<SearchAddressResult>
searchAlongRoute(string, number, GeoJsonLineString, SearchAlongRouteOptions)
Przeprowadza wyszukiwanie rozmyte punktów POI wzdłuż określonej trasy.
function searchAlongRoute(query: string, maxDetourTimeInSeconds: number, route: GeoJsonLineString, options?: SearchAlongRouteOptions): Promise<SearchAddressResult>Parametry
- query
-
string
Nazwa POI do wyszukania (np. "statua wolności", "starbucks", "pizza").
- maxDetourTimeInSeconds
-
number
Maksymalny czas objazdu punktu orientacyjnego w sekundach. Maksymalna wartość to 3600 sekund
- route
- GeoJsonLineString
Reprezentuje to trasę do wyszukiwania i powinna być prawidłowym GeoJSON LineString typem.
- options
- SearchAlongRouteOptions
Opcjonalne parametry operacji
Zwraca
Promise<SearchAddressResult>
searchInsideGeometry(string, SearchGeometry, SearchInsideGeometryOptions)
Przeprowadza wyszukiwanie w formie dowolnej wewnątrz jednej geometrii lub wielu z nich.
function searchInsideGeometry(query: string, geometry: SearchGeometry, options?: SearchInsideGeometryOptions): Promise<SearchAddressResult>Parametry
- query
-
string
Nazwa POI do wyszukania (np. "statua wolności", "starbucks", "pizza").
- geometry
- SearchGeometry
Reprezentuje to geometrię co najmniej jednego obiektu geograficznego (parki, granica stanu itp.) do wyszukiwania i powinna być typem zgodnym z formatem GeoJSON. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
- options
- SearchInsideGeometryOptions
Opcjonalne parametry operacji
Zwraca
Promise<SearchAddressResult>
searchNearbyPointOfInterest(LatLon, SearchNearbyPointOfInterestOptions)
Żąda wyników z interesujących miejsc (POI) wokół określonej lokalizacji.
function searchNearbyPointOfInterest(coordinates: LatLon, options?: SearchNearbyPointOfInterestOptions): Promise<SearchAddressResult>Parametry
- coordinates
- LatLon
Współrzędne do wyszukiwania pobliskich punktów POI
Opcjonalne parametry operacji
Zwraca
Promise<SearchAddressResult>
searchPointOfInterest(SearchQuery, SearchPointOfInterestOptions)
Żąda wyników z interesujących miejsc (POI) według nazwy
function searchPointOfInterest(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parametry
- searchQuery
- SearchQuery
Zapytanie tekstowe i informacje o lokalizacji do wyszukania
- options
- SearchPointOfInterestOptions
Opcje wyszukiwania punktów POI
Zwraca
Promise<SearchAddressResult>
searchPointOfInterestCategory(SearchQuery, SearchPointOfInterestOptions)
Żąda wyników z punktów szczególnych (POI) z danej kategorii.
function searchPointOfInterestCategory(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parametry
- searchQuery
- SearchQuery
Zapytanie tekstowe i informacje o lokalizacji do wyszukania
- options
- SearchPointOfInterestOptions
Opcje wyszukiwania kategorii POI
Zwraca
Promise<SearchAddressResult>
searchStructuredAddress(StructuredAddress, SearchStructuredAddressOptions)
Geokoduje uporządkowany adres.
function searchStructuredAddress(structuredAddress: StructuredAddress, options?: SearchStructuredAddressOptions): Promise<SearchAddressResult>Parametry
- structuredAddress
- StructuredAddress
Adres strukturalny używany do geokodowania
- options
- SearchStructuredAddressOptions
Opcjonalne parametry operacji
Zwraca
Promise<SearchAddressResult>
