Share via

SearchURL class

  • Referensi
Paket:
azure-maps-rest

SearchURL mewakili URL ke operasi pencarian Azure Maps.

Extends
MapsURL

Konstruktor

SearchURL(Pipeline, string)

Membuat instans SearchURL.

Properti yang Diwariskan

mapsUrl

Nilai string URL dasar.

Metode

searchAddress(Aborter, string, SearchAddressOptions)

Geocoding Alamat Dalam banyak kasus, layanan pencarian lengkap mungkin terlalu banyak, misalnya jika Anda hanya tertarik dengan geocoding tradisional. Search juga dapat diakses untuk pencarian alamat secara eksklusif. Geocoding dilakukan dengan menekan titik akhir geocode hanya dengan alamat atau alamat parsial yang dimaksud. Indeks pencarian geocoding akan dikueri untuk segala sesuatu di atas data tingkat jalan. Tidak ada POI yang akan dikembalikan. Perhatikan bahwa geocoder sangat toleran terhadap kesalahan ketik dan alamat yang tidak lengkap. Ini juga akan menangani semuanya dari alamat jalan atau jalan atau persimpangan yang tepat serta geografi tingkat yang lebih tinggi seperti pusat kota, kabupaten, negara bagian, dll. Menggunakan Get Search Address API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)

Membalikkan Geocode ke Alamat Mungkin ada kalanya Anda perlu menerjemahkan koordinat (misalnya: -122.3862, 37.786505) ke alamat jalan yang dapat dimengerti manusia. Paling sering ini diperlukan dalam melacak aplikasi di mana Anda menerima umpan GPS dari perangkat atau aset dan ingin mengetahui alamat apa yang koordinat berada. Titik akhir ini akan mengembalikan informasi alamat untuk koordinat tertentu. Menggunakan Get Search Address Reverse API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)

Reverse Geocode ke Cross Street Mungkin ada kalanya Anda perlu menerjemahkan koordinat (misalnya: -122.3862, 37.786505) ke dalam lintas jalan yang dapat dimengerti manusia. Paling sering ini diperlukan dalam melacak aplikasi di mana Anda menerima umpan GPS dari perangkat atau aset dan ingin mengetahui alamat apa yang koordinat berada. Titik akhir ini akan mengembalikan informasi lintas jalan untuk koordinat tertentu. Menggunakan GET Search Address Reverse Cross Street API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)

Geocoding Alamat Terstruktur Azure Address Geocoding juga dapat diakses untuk pencarian alamat terstruktur secara eksklusif. Indeks pencarian geocoding akan dikueri untuk segala sesuatu di atas data tingkat jalan. Tidak ada POI yang akan dikembalikan. Perhatikan bahwa geocoder sangat toleran terhadap kesalahan ketik dan alamat yang tidak lengkap. Ini juga akan menangani semuanya dari alamat jalan atau jalan atau persimpangan yang tepat serta geografi tingkat yang lebih tinggi seperti pusat kota, kabupaten, negara bagian, dll. Menggunakan Get Search Address Structured API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)

Titik akhir Search Along Route memungkinkan Anda melakukan pencarian fuzzy untuk POI di sepanjang rute tertentu. Pencarian ini dibatasi dengan menentukan maxDetourTime ukuran pembatasan. Untuk mengirim titik rute, Anda akan menggunakan body yang akan berisi route objek yang diwakili sebagai GeoJSON LineString jenis dan Content-Type header akan diatur ke application/json. Setiap titik rute di route direpresentasikan sebagai GeoJSON Position jenis yaitu array di mana nilai bujur diikuti oleh nilai lintangdan nilai ketinggian diabaikan. route harus berisi setidaknya 2 titik rute. Ada kemungkinan bahwa rute asli akan diubah, beberapa titiknya dapat dilewati. Jika rute yang melewati titik yang ditemukan lebih cepat daripada yang asli, detourTime nilai dalam respons negatif. Menggunakan Post Search Along Route API:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)

Formulir Gratis Search API default dasar adalah Search Formulir Gratis yang menangani paling fuzzy input yang menangani kombinasi alamat atau token POI. API pencarian ini adalah 'pencarian baris tunggal' kanonis. Free Form Search API adalah kombinasi yang mulus dari pencarian POI dan geocoding. API juga dapat ditimbang dengan posisi kontekstual (pasangan lat./lon. ), atau sepenuhnya dibatasi oleh koordinat dan radius, atau dapat dijalankan lebih umum tanpa titik jangkar bias geografis. Kami sangat menyarankan Anda untuk menggunakan parameter 'countrySet' untuk menentukan hanya negara yang aplikasi Anda membutuhkan cakupan, karena perilaku defaultnya adalah mencari di seluruh dunia, yang berpotensi mengembalikan hasil yang tidak perlu. Misalnya: countrySet=US,FR. Silakan lihat [Search Cakupan] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) untuk daftar lengkap semua negara yang didukung. Sebagian besar kueri Search default ke maxFuzzyLevel=2 untuk mendapatkan performa dan juga mengurangi hasil yang tidak biasa. Default baru ini dapat ditimpa sesuai kebutuhan per permintaan dengan meneruskan param maxFuzzyLevelkueri =3 atau 4. Menggunakan Get Search Fuzzy API:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)

Titik akhir geometri Search memungkinkan Anda melakukan pencarian formulir gratis di dalam satu geometri atau banyak dari mereka. Hasil pencarian yang termasuk dalam geometri/geometri akan dikembalikan. Fitur geografis yang akan dicari dapat dimodelkan sebagai geometri Poligon dan/atau Lingkaran yang diwakili menggunakan salah satu jenis berikut GeoJSON : GeoJSON FeatureCollection, Dapat geometry direpresentasikan sebagai GeoJSON FeatureCollection objek. Ini adalah opsi yang direkomendasikan jika geometri berisi Poligon dan Lingkaran. FeatureCollection dapat berisi maksimal 50 GeoJSON Feature objek. Setiap Feature objek harus mewakili Poligon atau Lingkaran dengan kondisi berikut: Objek Feature untuk geometri Poligon dapat memiliki maksimal 50 koordinat dan propertinya harus kosong. Objek Feature untuk geometri Lingkaran terdiri dari pusat yang diwakili menggunakan GeoJSON Point jenis dan nilai radius (dalam meter) yang harus ditentukan dalam properti objek bersama dengan properti subType yang nilainya harus 'Lingkaran'. Silakan lihat bagian Contoh di bawah ini untuk representasi sampel FeatureCollection . GeometryCollection GeoJSON, geometry dapat direpresentasikan sebagai GeoJSON GeometryCollection objek. Ini adalah opsi yang direkomendasikan jika geometri hanya berisi daftar Poligon. GeometryCollection dapat berisi maksimal 50 GeoJSON Polygon objek. Setiap Polygon objek dapat memiliki maksimal 50 koordinat. Silakan lihat bagian Contoh di bawah ini untuk representasi sampel GeometryCollection . Poligon GeoJSON, geometry Dapat direpresentasikan sebagai GeoJSON Polygon objek. Ini adalah opsi yang direkomendasikan jika geometri berisi satu Poligon. Objek Polygon dapat memiliki maksimal 50 koordinat. Menggunakan Post Search Inside Geometry API:https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)

Search Terdekat Jika Anda memiliki kasus penggunaan hanya untuk mengambil hasil POI di sekitar lokasi tertentu, metode pencarian terdekat mungkin merupakan pilihan yang tepat. Titik akhir ini hanya akan mengembalikan hasil POI, dan tidak mengambil parameter kueri pencarian. Menggunakan Get Search Nearby API:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby
searchPOI(Aborter, string, SearchPOIOptions)

Dapatkan POI berdasarkan Nama Jika kasus penggunaan pencarian Anda hanya memerlukan hasil POI, Anda dapat menggunakan titik akhir POI untuk pencarian. Titik akhir ini hanya akan mengembalikan hasil POI. Menggunakan Get Search POI API:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
searchPOICategory(Aborter, string, SearchPOICategoryOptions)

Dapatkan POI berdasarkan Kategori Jika kasus penggunaan pencarian Anda hanya memerlukan hasil POI yang difilter menurut kategori, Anda dapat menggunakan titik akhir kategori. Titik akhir ini hanya akan mengembalikan hasil POI yang dikategorikan sebagaimana ditentukan. Daftar kategori yang tersedia dapat ditemukan di sini. Menggunakan Get Search POI Category API:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
searchPolygon(Aborter, string[])

SEARCH Polygon API memungkinkan Anda meminta data geometri seperti kerangka kota atau negara untuk sekumpulan entitas, yang sebelumnya diambil dari permintaan online Search dalam format GeoJSON. ID geometri dikembalikan dalam objek dataSources di bawah "geometri" dan "id" di Alamat Search atau panggilan Fuzzy Search. Harap dicatat bahwa SETIAP ID geometri yang diambil dari titik akhir online Search memiliki masa pakai terbatas. Klien tidak boleh menyimpan ID geometri dalam penyimpanan persisten untuk rujukan nanti, karena stabilitas pengidentifikasi ini tidak dijamin untuk jangka waktu yang lama. Diharapkan bahwa permintaan ke metode Poligon dibuat dalam beberapa menit setelah permintaan ke metode Search Online yang memberikan ID. Layanan ini memungkinkan permintaan batch hingga 20 pengidentifikasi.

Menggunakan Get Search Polygon API:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon

Metode yang Diwarisi

newPipeline(Credential, INewPipelineOptions)

Metode statis yang digunakan untuk membuat objek Alur baru dengan Kredensial yang disediakan.

Detail Konstruktor

SearchURL(Pipeline, string)

Membuat instans SearchURL.

new SearchURL(pipeline: Pipeline, mapsUrl?: string)

Parameter

pipeline
Pipeline

Panggil MapsURL.newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.

mapsUrl

string

String URL yang menunjuk ke layanan Azure Maps, defaultnya adalah "https://atlas.microsoft.com". Jika tidak ada protokol yang ditentukan, misalnya "atlas.microsoft.com", maka https akan diasumsikan.

Detail Properti yang Diwariskan

mapsUrl

Nilai string URL dasar.

mapsUrl: string

Nilai Properti

string

Diwarisi DariMapsURL.mapsUrl

Detail Metode

searchAddress(Aborter, string, SearchAddressOptions)

Geocoding Alamat Dalam banyak kasus, layanan pencarian lengkap mungkin terlalu banyak, misalnya jika Anda hanya tertarik dengan geocoding tradisional. Search juga dapat diakses untuk pencarian alamat secara eksklusif. Geocoding dilakukan dengan menekan titik akhir geocode hanya dengan alamat atau alamat parsial yang dimaksud. Indeks pencarian geocoding akan dikueri untuk segala sesuatu di atas data tingkat jalan. Tidak ada POI yang akan dikembalikan. Perhatikan bahwa geocoder sangat toleran terhadap kesalahan ketik dan alamat yang tidak lengkap. Ini juga akan menangani semuanya dari alamat jalan atau jalan atau persimpangan yang tepat serta geografi tingkat yang lebih tinggi seperti pusat kota, kabupaten, negara bagian, dll. Menggunakan Get Search Address API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress

function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

query

string

Alamat yang akan dicari (misalnya, "1 Microsoft way, Redmond, WA").

options
SearchAddressOptions

Mengembalikan

Promise<SearchAddressResponse>

searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)

Membalikkan Geocode ke Alamat Mungkin ada kalanya Anda perlu menerjemahkan koordinat (misalnya: -122.3862, 37.786505) ke alamat jalan yang dapat dimengerti manusia. Paling sering ini diperlukan dalam melacak aplikasi di mana Anda menerima umpan GPS dari perangkat atau aset dan ingin mengetahui alamat apa yang koordinat berada. Titik akhir ini akan mengembalikan informasi alamat untuk koordinat tertentu. Menggunakan Get Search Address Reverse API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse

function searchAddressReverse(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseOptions): Promise<SearchAddressReverseResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

position
GeoJSON.Position

Posisi untuk pencarian terbalik, array koordinat [longitude, latitude] misalnya [-122.125679, 47.641268].

options
SearchAddressReverseOptions

Mengembalikan

Promise<SearchAddressReverseResponse>

searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)

Reverse Geocode ke Cross Street Mungkin ada kalanya Anda perlu menerjemahkan koordinat (misalnya: -122.3862, 37.786505) ke dalam lintas jalan yang dapat dimengerti manusia. Paling sering ini diperlukan dalam melacak aplikasi di mana Anda menerima umpan GPS dari perangkat atau aset dan ingin mengetahui alamat apa yang koordinat berada. Titik akhir ini akan mengembalikan informasi lintas jalan untuk koordinat tertentu. Menggunakan GET Search 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>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

position
GeoJSON.Position

Posisi untuk pencarian terbalik, array koordinat [longitude, latitude] misalnya [-122.125679, 47.641268].

options
SearchAddressReverseCrossStreetOptions

Mengembalikan

Promise<SearchAddressReverseCrossStreetResponse>

searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)

Geocoding Alamat Terstruktur Azure Address Geocoding juga dapat diakses untuk pencarian alamat terstruktur secara eksklusif. Indeks pencarian geocoding akan dikueri untuk segala sesuatu di atas data tingkat jalan. Tidak ada POI yang akan dikembalikan. Perhatikan bahwa geocoder sangat toleran terhadap kesalahan ketik dan alamat yang tidak lengkap. Ini juga akan menangani semuanya dari alamat jalan atau jalan atau persimpangan yang tepat serta geografi tingkat yang lebih tinggi seperti pusat kota, kabupaten, negara bagian, dll. Menggunakan Get Search Address Structured API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured

function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

countryCode

string

Bagian kode negara 2 atau 3 huruf ISO3166-1 dari alamat. Misalnya AS.

options
SearchAddressStructuredOptions

Mengembalikan

Promise<SearchAddressStructuredResponse>

searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)

Titik akhir Search Along Route memungkinkan Anda melakukan pencarian fuzzy untuk POI di sepanjang rute tertentu. Pencarian ini dibatasi dengan menentukan maxDetourTime ukuran pembatasan. Untuk mengirim titik rute, Anda akan menggunakan body yang akan berisi route objek yang diwakili sebagai GeoJSON LineString jenis dan Content-Type header akan diatur ke application/json. Setiap titik rute di route direpresentasikan sebagai GeoJSON Position jenis yaitu array di mana nilai bujur diikuti oleh nilai lintangdan nilai ketinggian diabaikan. route harus berisi setidaknya 2 titik rute. Ada kemungkinan bahwa rute asli akan diubah, beberapa titiknya dapat dilewati. Jika rute yang melewati titik yang ditemukan lebih cepat daripada yang asli, detourTime nilai dalam respons negatif. Menggunakan Post Search 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>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

query

string

String kueri yang berlaku (misalnya, "seattle", "pizza").

maxDetourTime

number

Waktu memutar maksimum titik minat dalam hitungan detik. Nilai maksimum adalah 3600 detik

body
SearchAlongRouteRequestBody

Ini mewakili rute untuk dicari dan harus merupakan jenis yang valid GeoJSON LineString . Silakan merujuk ke RFC 7946 untuk detailnya.

options
SearchAlongRouteOptions

Mengembalikan

Promise<SearchAlongRouteResponse>

searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)

Formulir Gratis Search API default dasar adalah Search Formulir Gratis yang menangani paling fuzzy input yang menangani kombinasi alamat atau token POI. API pencarian ini adalah 'pencarian baris tunggal' kanonis. Free Form Search API adalah kombinasi yang mulus dari pencarian POI dan geocoding. API juga dapat ditimbang dengan posisi kontekstual (pasangan lat./lon. ), atau sepenuhnya dibatasi oleh koordinat dan radius, atau dapat dijalankan lebih umum tanpa titik jangkar bias geografis. Kami sangat menyarankan Anda untuk menggunakan parameter 'countrySet' untuk menentukan hanya negara yang aplikasi Anda membutuhkan cakupan, karena perilaku defaultnya adalah mencari di seluruh dunia, yang berpotensi mengembalikan hasil yang tidak perlu. Misalnya: countrySet=US,FR. Silakan lihat [Search Cakupan] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) untuk daftar lengkap semua negara yang didukung. Sebagian besar kueri Search default ke maxFuzzyLevel=2 untuk mendapatkan performa dan juga mengurangi hasil yang tidak biasa. Default baru ini dapat ditimpa sesuai kebutuhan per permintaan dengan meneruskan param maxFuzzyLevelkueri =3 atau 4. Menggunakan Get Search Fuzzy API:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy

function searchFuzzy(aborter: Aborter, query: string | GeoJSON.Position, options?: SearchFuzzyOptions): Promise<SearchFuzzyResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

query

string | GeoJSON.Position

String kueri yang berlaku (misalnya, "seattle", "pizza"). Juga dapat ditentukan sebagai array koordinat [longitude, latitude] (misalnya, [-122.125679, 47.641268]).

options
SearchFuzzyOptions

Mengembalikan

Promise<SearchFuzzyResponse>

searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)

Titik akhir geometri Search memungkinkan Anda melakukan pencarian formulir gratis di dalam satu geometri atau banyak dari mereka. Hasil pencarian yang termasuk dalam geometri/geometri akan dikembalikan. Fitur geografis yang akan dicari dapat dimodelkan sebagai geometri Poligon dan/atau Lingkaran yang diwakili menggunakan salah satu jenis berikut GeoJSON : GeoJSON FeatureCollection, Dapat geometry direpresentasikan sebagai GeoJSON FeatureCollection objek. Ini adalah opsi yang direkomendasikan jika geometri berisi Poligon dan Lingkaran. FeatureCollection dapat berisi maksimal 50 GeoJSON Feature objek. Setiap Feature objek harus mewakili Poligon atau Lingkaran dengan kondisi berikut: Objek Feature untuk geometri Poligon dapat memiliki maksimal 50 koordinat dan propertinya harus kosong. Objek Feature untuk geometri Lingkaran terdiri dari pusat yang diwakili menggunakan GeoJSON Point jenis dan nilai radius (dalam meter) yang harus ditentukan dalam properti objek bersama dengan properti subType yang nilainya harus 'Lingkaran'. Silakan lihat bagian Contoh di bawah ini untuk representasi sampel FeatureCollection . GeometryCollection GeoJSON, geometry dapat direpresentasikan sebagai GeoJSON GeometryCollection objek. Ini adalah opsi yang direkomendasikan jika geometri hanya berisi daftar Poligon. GeometryCollection dapat berisi maksimal 50 GeoJSON Polygon objek. Setiap Polygon objek dapat memiliki maksimal 50 koordinat. Silakan lihat bagian Contoh di bawah ini untuk representasi sampel GeometryCollection . Poligon GeoJSON, geometry Dapat direpresentasikan sebagai GeoJSON Polygon objek. Ini adalah opsi yang direkomendasikan jika geometri berisi satu Poligon. Objek Polygon dapat memiliki maksimal 50 koordinat. Menggunakan Post Search Inside Geometry API:https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry

function searchInsideGeometry(aborter: Aborter, query: string, body: SearchInsideGeometryRequestBody, options?: SearchInsideGeometryOptions): Promise<SearchInsideGeometryResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

query

string

String kueri yang berlaku (misalnya, "seattle", "pizza").

body
SearchInsideGeometryRequestBody

Ini mewakili geometri untuk satu atau beberapa fitur geografis (taman, batas status, dll.) untuk mencari dan harus menjadi jenis yang sesuai dengan GeoJSON. Silakan merujuk ke RFC 7946 untuk detailnya.

options
SearchInsideGeometryOptions

Mengembalikan

Promise<SearchInsideGeometryResponse>

searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)

Search Terdekat Jika Anda memiliki kasus penggunaan hanya untuk mengambil hasil POI di sekitar lokasi tertentu, metode pencarian terdekat mungkin merupakan pilihan yang tepat. Titik akhir ini hanya akan mengembalikan hasil POI, dan tidak mengambil parameter kueri pencarian. Menggunakan Get Search Nearby API:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby

function searchNearby(aborter: Aborter, location: GeoJSON.Position, options?: SearchNearbyOptions): Promise<SearchNearbyResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

location
GeoJSON.Position

Lokasi di mana hasil harus bias. Harus berupa array , [longitude, latitude]misalnya [-121.89, 37.337].

options
SearchNearbyOptions

Mengembalikan

Promise<SearchNearbyResponse>

searchPOI(Aborter, string, SearchPOIOptions)

Dapatkan POI berdasarkan Nama Jika kasus penggunaan pencarian Anda hanya memerlukan hasil POI, Anda dapat menggunakan titik akhir POI untuk pencarian. Titik akhir ini hanya akan mengembalikan hasil POI. Menggunakan Get Search POI API:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi

function searchPOI(aborter: Aborter, query: string, options?: SearchPOIOptions): Promise<SearchPOIResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

query

string

Nama POI yang akan dicari (misalnya, "patung kebebasan", "starbucks").

options
SearchPOIOptions

Mengembalikan

Promise<SearchPOIResponse>

searchPOICategory(Aborter, string, SearchPOICategoryOptions)

Dapatkan POI berdasarkan Kategori Jika kasus penggunaan pencarian Anda hanya memerlukan hasil POI yang difilter menurut kategori, Anda dapat menggunakan titik akhir kategori. Titik akhir ini hanya akan mengembalikan hasil POI yang dikategorikan sebagaimana ditentukan. Daftar kategori yang tersedia dapat ditemukan di sini. Menggunakan Get Search POI Category API:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory

function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

query

string

Kategori POI yang akan dicari (misalnya, "AIRPORT", "BEACH").

options
SearchPOICategoryOptions

Mengembalikan

Promise<SearchPOICategoryResponse>

searchPolygon(Aborter, string[])

SEARCH Polygon API memungkinkan Anda meminta data geometri seperti kerangka kota atau negara untuk sekumpulan entitas, yang sebelumnya diambil dari permintaan online Search dalam format GeoJSON. ID geometri dikembalikan dalam objek dataSources di bawah "geometri" dan "id" di Alamat Search atau panggilan Fuzzy Search. Harap dicatat bahwa SETIAP ID geometri yang diambil dari titik akhir online Search memiliki masa pakai terbatas. Klien tidak boleh menyimpan ID geometri dalam penyimpanan persisten untuk rujukan nanti, karena stabilitas pengidentifikasi ini tidak dijamin untuk jangka waktu yang lama. Diharapkan bahwa permintaan ke metode Poligon dibuat dalam beberapa menit setelah permintaan ke metode Search Online yang memberikan ID. Layanan ini memungkinkan permintaan batch hingga 20 pengidentifikasi.

Menggunakan Get Search Polygon API:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon

function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>

Parameter

aborter
Aborter

Buat instans Aborter baru dengan Aborter.none atau Aborter.timeout(), goto dokumen Aborter untuk contoh selengkapnya tentang pembatalan permintaan.

geometries

string[]

Daftar UUID geometri yang dipisahkan koma, yang sebelumnya diambil dari permintaan Search Online.

Mengembalikan

Promise<SearchPolygonResponse>

Detail Metode yang Diwarisi

newPipeline(Credential, INewPipelineOptions)

Metode statis yang digunakan untuk membuat objek Alur baru dengan Kredensial yang disediakan.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

Parameter

credential
Credential

Seperti SubscriptionKeyCredential, TokenCredential, dan MapControlCredential.

pipelineOptions
INewPipelineOptions

Mengembalikan

Pipeline

Objek Alur baru.

Diwarisi DariMapsURL.newPipeline