MapsSearchClient class
Kelas klien untuk berinteraksi dengan Azure Maps Search Service.
Konstruktor
| Maps |
Membuat instans MapsSearchClient dari kunci langganan. Example |
| Maps |
Membuat instans MapsSearchClient dari Azure Identity Example |
Metode
| begin |
Mengirim batch permintaan pencarian fuzzy. Metode ini mengembalikan poller untuk mengambil hasilnya nanti. |
| begin |
Mengirim batch permintaan geocoding terbalik. Metode ini mengembalikan poller untuk mengambil hasilnya nanti. |
| begin |
Mengirim batch permintaan geocoding. Metode ini mengembalikan poller untuk mengambil hasilnya nanti. |
| fuzzy |
Melakukan Pencarian bentuk bebas yang menangani input paling kabur yang menangani kombinasi alamat atau token POI apa pun. |
| get |
Meminta data geometri seperti garis besar kota atau negara untuk sekumpulan entitas. |
| get |
Meminta daftar lengkap kategori Tempat Menarik (POI) yang didukung. |
| resume |
Lanjutkan permintaan pencarian kabur dengan status berseri dari poller lain. Example |
| resume |
Lanjutkan permintaan pencarian alamat terbalik dengan status berseri dari poller lain. Example |
| resume |
Lanjutkan permintaan pencarian alamat dengan status berseri dari poller lain. Example |
| reverse |
Menerjemahkan koordinat ke dalam alamat jalan yang dapat dimengerti manusia. |
| reverse |
Menerjemahkan koordinat menjadi persimpangan jalan yang dapat dimengerti manusia. |
| search |
Geocode alamat. |
| search |
Melakukan pencarian kabur untuk POI di sepanjang rute tertentu. |
| search |
Melakukan pencarian bentuk bebas di dalam satu geometri atau banyak di antaranya. |
| search |
Meminta hasil tempat menarik (POI) di sekitar lokasi tertentu. |
| search |
Meminta hasil tempat menarik (POI) berdasarkan nama |
| search |
Meminta hasil tempat menarik (POI) dari kategori tertentu. |
| search |
Geokode alamat terstruktur. |
Detail Konstruktor
MapsSearchClient(AzureKeyCredential, MapsSearchClientOptions)
Membuat instans MapsSearchClient dari kunci langganan.
Example
import { MapsSearchClient, AzureKeyCredential } from "@azure/maps-search";
const credential = new AzureKeyCredential("<subscription-key>");
const client = new MapsSearchClient(credential);
new MapsSearchClient(credential: AzureKeyCredential, options?: MapsSearchClientOptions)Parameter
- credential
- AzureKeyCredential
Instans AzureKeyCredential yang digunakan untuk mengautentikasi permintaan ke layanan
- options
- MapsSearchClientOptions
Opsi yang digunakan untuk mengonfigurasi Klien Pencarian
MapsSearchClient(TokenCredential, string, MapsSearchClientOptions)
Membuat instans MapsSearchClient dari Azure Identity TokenCredential.
Example
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)Parameter
- credential
- TokenCredential
Instans TokenCredential yang digunakan untuk mengautentikasi permintaan ke layanan
- mapsAccountClientId
-
string
Id klien Azure Maps dari sumber daya peta tertentu
- options
- MapsSearchClientOptions
Opsi yang digunakan untuk mengonfigurasi Klien Pencarian
Detail Metode
beginFuzzySearchBatch(FuzzySearchRequest[], FuzzySearchBatchOptions)
Mengirim batch permintaan pencarian fuzzy. Metode ini mengembalikan poller untuk mengambil hasilnya nanti.
function beginFuzzySearchBatch(requests: FuzzySearchRequest[], options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parameter
- requests
Array permintaan pencarian yang akan diproses. Array dapat berisi maksimal 10.000 permintaan dan harus berisi setidaknya 1 permintaan.
- options
- FuzzySearchBatchOptions
Parameter opsional untuk operasi
Mengembalikan
Promise<FuzzySearchBatchPoller>
beginReverseSearchAddressBatch(ReverseSearchAddressRequest[], ReverseSearchAddressBatchOptions)
Mengirim batch permintaan geocoding terbalik. Metode ini mengembalikan poller untuk mengambil hasilnya nanti.
function beginReverseSearchAddressBatch(requests: ReverseSearchAddressRequest[], options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parameter
- requests
Array permintaan pencarian yang akan diproses. Array dapat berisi maksimal 10.000 permintaan dan harus berisi setidaknya 1 permintaan.
- options
- ReverseSearchAddressBatchOptions
Parameter opsional untuk operasi
Mengembalikan
Promise<ReverseSearchAddressBatchPoller>
beginSearchAddressBatch(SearchAddressRequest[], SearchAddressBatchOptions)
Mengirim batch permintaan geocoding. Metode ini mengembalikan poller untuk mengambil hasilnya nanti.
function beginSearchAddressBatch(requests: SearchAddressRequest[], options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parameter
- requests
Array permintaan pencarian yang akan diproses. Array dapat berisi maksimal 10.000 permintaan dan harus berisi setidaknya 1 permintaan.
- options
- SearchAddressBatchOptions
Parameter opsional untuk operasi
Mengembalikan
Promise<FuzzySearchBatchPoller>
fuzzySearch(SearchQuery, FuzzySearchBaseOptions & OperationOptions)
Melakukan Pencarian bentuk bebas yang menangani input paling kabur yang menangani kombinasi alamat atau token POI apa pun.
function fuzzySearch(searchQuery: SearchQuery, options?: FuzzySearchBaseOptions & OperationOptions): Promise<SearchAddressResult>Parameter
- searchQuery
- SearchQuery
Kueri teks dan informasi lokasi untuk dicari
- options
Opsi untuk pencarian kabur
Mengembalikan
Promise<SearchAddressResult>
getGeometries(string[], OperationOptions)
Meminta data geometri seperti garis besar kota atau negara untuk sekumpulan entitas.
function getGeometries(geometryIds: string[], options?: OperationOptions): Promise<EntityGeometry[]>Parameter
- geometryIds
-
string[]
Daftar UUID geometri yang dipisahkan koma, yang sebelumnya diambil dari permintaan Pencarian Online.
- options
- OperationOptions
Parameter opsional untuk operasi
Mengembalikan
Promise<EntityGeometry[]>
getPointOfInterestCategories(GetPointOfInterestCategoriesOptions)
Meminta daftar lengkap kategori Tempat Menarik (POI) yang didukung.
function getPointOfInterestCategories(options?: GetPointOfInterestCategoriesOptions): Promise<PointOfInterestCategory[]>Parameter
Parameter opsional untuk operasi
Mengembalikan
Promise<PointOfInterestCategory[]>
resumeFuzzySearchBatch(string, FuzzySearchBatchOptions)
Lanjutkan permintaan pencarian kabur dengan status berseri dari poller lain.
Example
const serializedState = poller.toString()
const rehydratedPoller = resumeFuzzySearchBatch(serializedState)
rehydratedPoller.poll()
function resumeFuzzySearchBatch(restoreFrom: string, options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parameter
- restoreFrom
-
string
Negara berseri dari poller sebelumnya.
- options
- FuzzySearchBatchOptions
Parameter opsional untuk operasi.
Mengembalikan
Promise<FuzzySearchBatchPoller>
resumeReverseSearchAddressBatch(string, ReverseSearchAddressBatchOptions)
Lanjutkan permintaan pencarian alamat terbalik dengan status berseri dari poller lain.
Example
const serializedState = poller.toString()
const rehydratedPoller = resumeReverseSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeReverseSearchAddressBatch(restoreFrom: string, options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parameter
- restoreFrom
-
string
Negara berseri dari poller sebelumnya.
- options
- ReverseSearchAddressBatchOptions
Parameter opsional untuk operasi.
Mengembalikan
Promise<ReverseSearchAddressBatchPoller>
resumeSearchAddressBatch(string, SearchAddressBatchOptions)
Lanjutkan permintaan pencarian alamat dengan status berseri dari poller lain.
Example
const serializedState = poller.toString()
const rehydratedPoller = resumeSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeSearchAddressBatch(restoreFrom: string, options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parameter
- restoreFrom
-
string
Negara berseri dari poller sebelumnya.
- options
- SearchAddressBatchOptions
Parameter opsional untuk operasi.
Mengembalikan
Promise<FuzzySearchBatchPoller>
reverseSearchAddress(LatLon, ReverseSearchAddressOptions & OperationOptions)
Menerjemahkan koordinat ke dalam alamat jalan yang dapat dimengerti manusia.
function reverseSearchAddress(coordinates: LatLon, options?: ReverseSearchAddressOptions & OperationOptions): Promise<ReverseSearchAddressResult>Parameter
- coordinates
- LatLon
Koordinat untuk kueri pencarian terbalik
- options
Parameter opsional untuk operasi
Mengembalikan
Promise<ReverseSearchAddressResult>
reverseSearchCrossStreetAddress(LatLon, ReverseSearchCrossStreetAddressOptions)
Menerjemahkan koordinat menjadi persimpangan jalan yang dapat dimengerti manusia.
function reverseSearchCrossStreetAddress(coordinates: LatLon, options?: ReverseSearchCrossStreetAddressOptions): Promise<ReverseSearchCrossStreetAddressResult>Parameter
- coordinates
- LatLon
Koordinat untuk kueri pencarian terbalik
Parameter opsional untuk operasi
Mengembalikan
searchAddress(string, SearchAddressOptions & OperationOptions)
Geocode alamat.
function searchAddress(query: string, options?: SearchAddressOptions & OperationOptions): Promise<SearchAddressResult>Parameter
- query
-
string
Alamat yang akan dicari (misalnya, "1 cara Microsoft, Redmond, WA")
- options
Parameter opsional untuk operasi
Mengembalikan
Promise<SearchAddressResult>
searchAlongRoute(string, number, GeoJsonLineString, SearchAlongRouteOptions)
Melakukan pencarian kabur untuk POI di sepanjang rute tertentu.
function searchAlongRoute(query: string, maxDetourTimeInSeconds: number, route: GeoJsonLineString, options?: SearchAlongRouteOptions): Promise<SearchAddressResult>Parameter
- query
-
string
Nama POI untuk mencari (misalnya, "patung kebebasan", "starbucks", "pizza").
- maxDetourTimeInSeconds
-
number
Waktu memutar maksimum titik minat dalam hitungan detik. Nilai maksimum adalah 3600 detik
- route
- GeoJsonLineString
Ini mewakili rute untuk mencari dan harus berupa jenis yang valid GeoJSON LineString .
- options
- SearchAlongRouteOptions
Parameter opsional untuk operasi
Mengembalikan
Promise<SearchAddressResult>
searchInsideGeometry(string, SearchGeometry, SearchInsideGeometryOptions)
Melakukan pencarian bentuk bebas di dalam satu geometri atau banyak di antaranya.
function searchInsideGeometry(query: string, geometry: SearchGeometry, options?: SearchInsideGeometryOptions): Promise<SearchAddressResult>Parameter
- query
-
string
Nama POI untuk mencari (misalnya, "patung kebebasan", "starbucks", "pizza").
- geometry
- SearchGeometry
Ini mewakili geometri untuk satu atau beberapa fitur geografis (taman, batas negara bagian, dll.) untuk dicari dan harus berupa jenis yang sesuai dengan GeoJSON. Silakan lihat RFC 7946 untuk detailnya.
- options
- SearchInsideGeometryOptions
Parameter opsional untuk operasi
Mengembalikan
Promise<SearchAddressResult>
searchNearbyPointOfInterest(LatLon, SearchNearbyPointOfInterestOptions)
Meminta hasil tempat menarik (POI) di sekitar lokasi tertentu.
function searchNearbyPointOfInterest(coordinates: LatLon, options?: SearchNearbyPointOfInterestOptions): Promise<SearchAddressResult>Parameter
- coordinates
- LatLon
Koordinat untuk pencarian POI terdekat
Parameter opsional untuk operasi
Mengembalikan
Promise<SearchAddressResult>
searchPointOfInterest(SearchQuery, SearchPointOfInterestOptions)
Meminta hasil tempat menarik (POI) berdasarkan nama
function searchPointOfInterest(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parameter
- searchQuery
- SearchQuery
Kueri teks dan informasi lokasi untuk dicari
- options
- SearchPointOfInterestOptions
Opsi untuk POI pencarian
Mengembalikan
Promise<SearchAddressResult>
searchPointOfInterestCategory(SearchQuery, SearchPointOfInterestOptions)
Meminta hasil tempat menarik (POI) dari kategori tertentu.
function searchPointOfInterestCategory(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parameter
- searchQuery
- SearchQuery
Kueri teks dan informasi lokasi untuk dicari
- options
- SearchPointOfInterestOptions
Opsi untuk kategori POI pencarian
Mengembalikan
Promise<SearchAddressResult>
searchStructuredAddress(StructuredAddress, SearchStructuredAddressOptions)
Geokode alamat terstruktur.
function searchStructuredAddress(structuredAddress: StructuredAddress, options?: SearchStructuredAddressOptions): Promise<SearchAddressResult>Parameter
- structuredAddress
- StructuredAddress
Alamat terstruktur yang digunakan untuk geocoding
- options
- SearchStructuredAddressOptions
Parameter opsional untuk operasi
Mengembalikan
Promise<SearchAddressResult>
