SearchURL class

Element SearchURL reprezentuje adres URL operacji wyszukiwania Azure Maps.

Extends

Konstruktory

SearchURL(Pipeline, string)

Tworzy wystąpienie elementu SearchURL.

Właściwości dziedziczone

mapsUrl

Wartość podstawowego ciągu adresu URL.

Metody

searchAddress(Aborter, string, SearchAddressOptions)

Geokodowanie adresów W wielu przypadkach kompletna usługa wyszukiwania może być zbyt duża, na przykład jeśli interesuje Cię tylko tradycyjne geokodowanie. Search można również uzyskać dostęp do wyszukiwania adresów wyłącznie. Geokodowanie jest wykonywane przez naciśnięcie punktu końcowego kodu geograficznego przy użyciu tylko adresu lub adresu częściowego. Indeks wyszukiwania geokodowania zostanie zapytany o wszystkie elementy powyżej danych na poziomie ulicy. Nie zostaną zwrócone żadne interfejsy POI. Należy pamiętać, że geokoder jest bardzo odporny na literówki i niekompletne adresy. Będzie również obsługiwać wszystko, od dokładnych adresów ulicznych lub ulic lub skrzyżowania, a także lokalizacji geograficznych wyższego poziomu, takich jak centra miast, powiaty, stany itp. Używa interfejsu API pobierania adresów Search:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress

searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)

Odwracanie kodu geograficznego do adresu Czasami trzeba przetłumaczyć współrzędną (np. -122.3862, 37.786505) na zrozumiały dla człowieka adres ulicy. Najczęściej jest to potrzebne w aplikacjach do śledzenia, gdzie otrzymujesz kanał GPS z urządzenia lub zasobu i chcesz wiedzieć, jaki adres, gdzie znajduje się współrzędna. Ten punkt końcowy zwróci informacje o adresie dla danej współrzędnej. Używa interfejsu API odwrotnego pobierania adresu Search:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse

searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)

Odwracanie geokodowania do ulicy Krzyżowej Czasami trzeba przetłumaczyć współrzędną (na przykład: -122.3862, 37.786505) na zrozumiałą dla człowieka ulicę. Najczęściej jest to potrzebne w aplikacjach do śledzenia, gdzie otrzymujesz kanał GPS z urządzenia lub zasobu i chcesz wiedzieć, jaki adres, gdzie znajduje się współrzędna. Ten punkt końcowy zwróci informacje o ulicy dla danej współrzędnej. Używa interfejsu API Get Search Address Reverse Cross Street:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet

searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)

Geokodowanie adresów strukturalnych Dostęp do geokodowania adresów platformy Azure można również uzyskać w celu wyłącznego wyszukiwania adresów strukturalnych. Indeks wyszukiwania geokodowania zostanie zapytany o wszystkie elementy powyżej danych na poziomie ulicy. Nie zostaną zwrócone żadne interfejsy POI. Należy pamiętać, że geokoder jest bardzo odporny na literówki i niekompletne adresy. Będzie również obsługiwać wszystko, od dokładnych adresów ulicznych lub ulic lub skrzyżowania, a także lokalizacji geograficznych wyższego poziomu, takich jak centra miast, powiaty, stany itp. Używa interfejsu API ze strukturą uzyskiwania adresów Search:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured

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

Punkt końcowy Search wzdłuż trasy umożliwia wykonywanie rozmytego wyszukiwania punktów weryfikacji koncepcji wzdłuż określonej trasy. To wyszukiwanie jest ograniczone przez określenie miary ograniczającej maxDetourTime . Aby wysłać punkty trasy, należy użyć body obiektu, który będzie zawierać route obiekt reprezentowany jako GeoJSON LineString typ, a Content-Type nagłówek zostanie ustawiony na application/jsonwartość . Każdy punkt trasy w route elemecie GeoJSON Position jest reprezentowany jako typ, tj. tablica, w której następuje wartość długości geograficznej, a wartość szerokościgeograficznej jest ignorowana. Element route powinien zawierać co najmniej 2 punkty trasy. Istnieje możliwość, że oryginalna trasa zostanie zmieniona, niektóre z nich mogą zostać pominięte. Jeśli trasa przechodząca przez znaleziony punkt jest szybsza niż oryginalna, detourTime wartość w odpowiedzi jest ujemna. Używa interfejsu API post Search wzdłuż trasy:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute

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

Free Form Search Podstawowym domyślnym interfejsem API jest dowolny formularz Search, który obsługuje najbardziej rozmyte dane wejściowe obsługujące dowolną kombinację tokenów adresu lub interfejsu POI. Ten interfejs API wyszukiwania jest kanonicznym "wyszukiwaniem w jednym wierszu". Interfejs API Search formularza bezpłatnego to bezproblemowa kombinacja funkcji wyszukiwania poi i geokodowania. Interfejs API może być również ważony położeniem kontekstowym (lat./lon. para) lub w pełni ograniczonym przez współrzędną i promień albo można go wykonać bardziej ogólnie bez żadnego punktu zakotwiczenia stronniczego geograficznego. Zdecydowanie zalecamy użycie parametru "countrySet" w celu określenia tylko krajów, dla których aplikacja wymaga pokrycia, ponieważ domyślne zachowanie będzie dotyczyć przeszukiwania całego świata, co może spowodować zwrócenie niepotrzebnych wyników. Np.: countrySet=US,FR. Aby uzyskać pełną listę wszystkich obsługiwanych krajów, zobacz [Search Coverage] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage). Większość Search zapytania domyślne maxFuzzyLevel= 2, aby uzyskać wydajność, a także zmniejszyć nietypowe wyniki. To nowe ustawienie domyślne można przesłonić zgodnie z potrzebami dla żądania, przekazując parametr maxFuzzyLevelzapytania =3 lub 4. Używa interfejsu API pobierania Search rozmytego:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy

searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)

Punkt końcowy Search Geometry umożliwia wykonywanie wolnego wyszukiwania formularzy wewnątrz jednej geometrii lub wielu z nich. Zostaną zwrócone wyniki wyszukiwania, które mieszczą się wewnątrz geometrii/geometrii. Funkcje geograficzne, które mają być przeszukiwane, można modelować jako wielokąt i/lub geometrie okręgów reprezentowane przy użyciu dowolnego z następujących GeoJSON typów: GeoJSON FeatureCollection, Obiekt geometry może być reprezentowany jako GeoJSON FeatureCollection obiekt. Jest to zalecana opcja, jeśli geometria zawiera zarówno wielokąty, jak i okręgi. Obiekt FeatureCollection może zawierać maksymalnie 50 GeoJSON Feature obiektów. Każdy Feature obiekt powinien reprezentować wielokąt lub okrąg z następującymi warunkami: Feature obiekt geometrii wielokąta może mieć maksymalnie 50 współrzędnych i właściwości muszą być puste. Feature Obiekt geometrii Circle składa się z środka reprezentowanego przy użyciu GeoJSON Point typu i wartości promienia (w metrach), które muszą być określone we właściwościach obiektu wraz z właściwością subType, której wartość powinna być "Circle". Zobacz sekcję Przykłady poniżej, aby zapoznać się z przykładową FeatureCollection reprezentacją. GeoJSON GeometryCollection, geometry obiekt może być reprezentowany GeoJSON GeometryCollection jako obiekt. Jest to zalecana opcja, jeśli geometria zawiera tylko listę wielokątów. Obiekt GeometryCollection może zawierać maksymalnie 50 GeoJSON Polygon obiektów. Każdy Polygon obiekt może mieć maksymalnie 50 współrzędnych. Zobacz sekcję Przykłady poniżej, aby zapoznać się z przykładową GeometryCollection reprezentacją. GeoJSON Polygon ( Wielokąt GeoJSON) geometry obiekt może być reprezentowany GeoJSON Polygon jako obiekt. Jest to zalecana opcja, jeśli geometria zawiera pojedynczy wielokąt. Obiekt Polygon może mieć maksymalnie 50 współrzędnych. Używa interfejsu API post Search Inside Geometry:https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry

searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)

W pobliżu Search Jeśli masz przypadek użycia tylko do pobierania wyników weryfikacji koncepcji wokół określonej lokalizacji, metoda wyszukiwania w pobliżu może być właściwym wyborem. Ten punkt końcowy zwróci tylko wyniki weryfikacji koncepcji i nie będzie przyjmować parametru zapytania wyszukiwania. Używa interfejsu API Get Search Nearby:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby

searchPOI(Aborter, string, SearchPOIOptions)

Uzyskiwanie weryfikacji koncepcji według nazwy Jeśli przypadek użycia wyszukiwania wymaga tylko wyników weryfikacji koncepcji, możesz użyć punktu końcowego poi do wyszukiwania. Ten punkt końcowy zwróci tylko wyniki poi. Używa interfejsu API get Search POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi

searchPOICategory(Aborter, string, SearchPOICategoryOptions)

Pobieranie weryfikacji koncepcji według kategorii Jeśli przypadek użycia wyszukiwania wymaga tylko wyników weryfikacji koncepcji przefiltrowanych według kategorii, możesz użyć punktu końcowego kategorii. Ten punkt końcowy zwróci tylko wyniki weryfikacji koncepcji, które są podzielone na kategorie zgodnie z określonymi. Listę dostępnych kategorii można znaleźć tutaj. Używa interfejsu API kategorii Get Search POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory

searchPolygon(Aborter, string[])

Interfejs API Search Polygon umożliwia zażądanie danych geometrycznych, takich jak konspekt miasta lub kraju dla zestawu jednostek, pobranych wcześniej z żądania usługi Online Search w formacie GeoJSON. Identyfikator geometryczny jest zwracany w obiekcie dataSources w obszarze "geometry" i "id" w wywołaniu Search Address lub Search Fuzzy. Należy pamiętać, że każdy identyfikator geometrii pobrany z punktu końcowego usługi Online Search ma ograniczony okres istnienia. Klient nie powinien przechowywać identyfikatorów geometrii w magazynie trwałym na potrzeby późniejszego odwołania, ponieważ stabilność tych identyfikatorów nie jest gwarantowana przez długi czas. Oczekuje się, że żądanie do metody Polygon zostanie wykonane w ciągu kilku minut od żądania do metody online Search, która dostarczyła identyfikator. Usługa umożliwia obsługę żądań wsadowych do 20 identyfikatorów.

Używa interfejsu API uzyskiwania Search wielokąta:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon

Metody dziedziczone

newPipeline(Credential, INewPipelineOptions)

Metoda statyczna użyta do utworzenia nowego obiektu Pipeline z podanym poświadczenie.

Szczegóły konstruktora

SearchURL(Pipeline, string)

Tworzy wystąpienie elementu SearchURL.

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

Parametry

pipeline
Pipeline

Wywołaj metodę MapsURL.newPipeline(), aby utworzyć potok domyślny, lub podaj dostosowany potok.

mapsUrl

string

Ciąg adresu URL wskazujący usługę Azure Maps, wartość domyślna to "https://atlas.microsoft.com". Jeśli protokół nie zostanie określony, np. "atlas.microsoft.com", https zostanie przyjęty.

Szczegóły właściwości dziedziczonej

mapsUrl

Wartość podstawowego ciągu adresu URL.

mapsUrl: string

Wartość właściwości

string

Dziedziczone zbiblioteki MapsURL.mapsUrl

Szczegóły metody

searchAddress(Aborter, string, SearchAddressOptions)

Geokodowanie adresów W wielu przypadkach kompletna usługa wyszukiwania może być zbyt duża, na przykład jeśli interesuje Cię tylko tradycyjne geokodowanie. Search można również uzyskać dostęp do wyszukiwania adresów wyłącznie. Geokodowanie jest wykonywane przez naciśnięcie punktu końcowego kodu geograficznego przy użyciu tylko adresu lub adresu częściowego. Indeks wyszukiwania geokodowania zostanie zapytany o wszystkie elementy powyżej danych na poziomie ulicy. Nie zostaną zwrócone żadne interfejsy POI. Należy pamiętać, że geokoder jest bardzo odporny na literówki i niekompletne adresy. Będzie również obsługiwać wszystko, od dokładnych adresów ulicznych lub ulic lub skrzyżowania, a także lokalizacji geograficznych wyższego poziomu, takich jak centra miast, powiaty, stany itp. Używa interfejsu API pobierania adresów Search:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

query

string

Adres do wyszukania (np. "1 Microsoft way, Redmond, WA").

Zwraca

searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)

Odwracanie kodu geograficznego do adresu Czasami trzeba przetłumaczyć współrzędną (np. -122.3862, 37.786505) na zrozumiały dla człowieka adres ulicy. Najczęściej jest to potrzebne w aplikacjach do śledzenia, gdzie otrzymujesz kanał GPS z urządzenia lub zasobu i chcesz wiedzieć, jaki adres, gdzie znajduje się współrzędna. Ten punkt końcowy zwróci informacje o adresie dla danej współrzędnej. Używa interfejsu API odwrotnego pobierania adresu Search:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

position
GeoJSON.Position

Położenie do odwrócenia wyszukiwania, tablica [longitude, latitude] współrzędnych, np. [-122.125679, 47.641268].

Zwraca

searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)

Odwracanie geokodowania do ulicy Krzyżowej Czasami trzeba przetłumaczyć współrzędną (na przykład: -122.3862, 37.786505) na zrozumiałą dla człowieka ulicę. Najczęściej jest to potrzebne w aplikacjach do śledzenia, gdzie otrzymujesz kanał GPS z urządzenia lub zasobu i chcesz wiedzieć, jaki adres, gdzie znajduje się współrzędna. Ten punkt końcowy zwróci informacje o ulicy dla danej współrzędnej. Używa interfejsu API Get Search Address Reverse Cross Street:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet

function searchAddressReverseCrossStreet(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseCrossStreetOptions): Promise<SearchAddressReverseCrossStreetResponse>

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

position
GeoJSON.Position

Położenie do odwrócenia wyszukiwania, tablica [longitude, latitude] współrzędnych, np. [-122.125679, 47.641268].

Zwraca

searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)

Geokodowanie adresów strukturalnych Dostęp do geokodowania adresów platformy Azure można również uzyskać w celu wyłącznego wyszukiwania adresów strukturalnych. Indeks wyszukiwania geokodowania zostanie zapytany o wszystkie elementy powyżej danych na poziomie ulicy. Nie zostaną zwrócone żadne interfejsy POI. Należy pamiętać, że geokoder jest bardzo odporny na literówki i niekompletne adresy. Będzie również obsługiwać wszystko, od dokładnych adresów ulicznych lub ulic lub skrzyżowania, a także lokalizacji geograficznych wyższego poziomu, takich jak centra miast, powiaty, stany itp. Używa interfejsu API ze strukturą uzyskiwania adresów Search:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

countryCode

string

Część adresu w kodzie kraju 2 lub 3 ISO3166-1 . Np. Stany Zjednoczone.

Zwraca

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

Punkt końcowy Search wzdłuż trasy umożliwia wykonywanie rozmytego wyszukiwania punktów weryfikacji koncepcji wzdłuż określonej trasy. To wyszukiwanie jest ograniczone przez określenie miary ograniczającej maxDetourTime . Aby wysłać punkty trasy, należy użyć body obiektu, który będzie zawierać route obiekt reprezentowany jako GeoJSON LineString typ, a Content-Type nagłówek zostanie ustawiony na application/jsonwartość . Każdy punkt trasy w route elemecie GeoJSON Position jest reprezentowany jako typ, tj. tablica, w której następuje wartość długości geograficznej, a wartość szerokościgeograficznej jest ignorowana. Element route powinien zawierać co najmniej 2 punkty trasy. Istnieje możliwość, że oryginalna trasa zostanie zmieniona, niektóre z nich mogą zostać pominięte. Jeśli trasa przechodząca przez znaleziony punkt jest szybsza niż oryginalna, detourTime wartość w odpowiedzi jest ujemna. Używa interfejsu API post Search wzdłuż trasy:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute

function searchAlongRoute(aborter: Aborter, query: string, maxDetourTime: number, body: SearchAlongRouteRequestBody, options?: SearchAlongRouteOptions): Promise<SearchAlongRouteResponse>

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

query

string

Odpowiedni ciąg zapytania (np. "seattle", "pizza").

maxDetourTime

number

Maksymalny czas objazdu punktu orientacyjnego w sekundach. Maksymalna wartość to 3600 sekund

body
SearchAlongRouteRequestBody

Reprezentuje trasę do wyszukiwania i powinna być prawidłowym GeoJSON LineString typem. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Zwraca

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

Free Form Search Podstawowym domyślnym interfejsem API jest dowolny formularz Search, który obsługuje najbardziej rozmyte dane wejściowe obsługujące dowolną kombinację tokenów adresu lub interfejsu POI. Ten interfejs API wyszukiwania jest kanonicznym "wyszukiwaniem w jednym wierszu". Interfejs API Search formularza bezpłatnego to bezproblemowa kombinacja funkcji wyszukiwania poi i geokodowania. Interfejs API może być również ważony położeniem kontekstowym (lat./lon. para) lub w pełni ograniczonym przez współrzędną i promień albo można go wykonać bardziej ogólnie bez żadnego punktu zakotwiczenia stronniczego geograficznego. Zdecydowanie zalecamy użycie parametru "countrySet" w celu określenia tylko krajów, dla których aplikacja wymaga pokrycia, ponieważ domyślne zachowanie będzie dotyczyć przeszukiwania całego świata, co może spowodować zwrócenie niepotrzebnych wyników. Np.: countrySet=US,FR. Aby uzyskać pełną listę wszystkich obsługiwanych krajów, zobacz [Search Coverage] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage). Większość Search zapytania domyślne maxFuzzyLevel= 2, aby uzyskać wydajność, a także zmniejszyć nietypowe wyniki. To nowe ustawienie domyślne można przesłonić zgodnie z potrzebami dla żądania, przekazując parametr maxFuzzyLevelzapytania =3 lub 4. Używa interfejsu API pobierania Search rozmytego:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

query

string | GeoJSON.Position

Odpowiedni ciąg zapytania (np. "seattle", "pizza"). Można również określić jako tablicę [longitude, latitude] współrzędnych (np. [-122.125679, 47.641268]).

Zwraca

searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)

Punkt końcowy Search Geometry umożliwia wykonywanie wolnego wyszukiwania formularzy wewnątrz jednej geometrii lub wielu z nich. Zostaną zwrócone wyniki wyszukiwania, które mieszczą się wewnątrz geometrii/geometrii. Funkcje geograficzne, które mają być przeszukiwane, można modelować jako wielokąt i/lub geometrie okręgów reprezentowane przy użyciu dowolnego z następujących GeoJSON typów: GeoJSON FeatureCollection, Obiekt geometry może być reprezentowany jako GeoJSON FeatureCollection obiekt. Jest to zalecana opcja, jeśli geometria zawiera zarówno wielokąty, jak i okręgi. Obiekt FeatureCollection może zawierać maksymalnie 50 GeoJSON Feature obiektów. Każdy Feature obiekt powinien reprezentować wielokąt lub okrąg z następującymi warunkami: Feature obiekt geometrii wielokąta może mieć maksymalnie 50 współrzędnych i właściwości muszą być puste. Feature Obiekt geometrii Circle składa się z środka reprezentowanego przy użyciu GeoJSON Point typu i wartości promienia (w metrach), które muszą być określone we właściwościach obiektu wraz z właściwością subType, której wartość powinna być "Circle". Zobacz sekcję Przykłady poniżej, aby zapoznać się z przykładową FeatureCollection reprezentacją. GeoJSON GeometryCollection, geometry obiekt może być reprezentowany GeoJSON GeometryCollection jako obiekt. Jest to zalecana opcja, jeśli geometria zawiera tylko listę wielokątów. Obiekt GeometryCollection może zawierać maksymalnie 50 GeoJSON Polygon obiektów. Każdy Polygon obiekt może mieć maksymalnie 50 współrzędnych. Zobacz sekcję Przykłady poniżej, aby zapoznać się z przykładową GeometryCollection reprezentacją. GeoJSON Polygon ( Wielokąt GeoJSON) geometry obiekt może być reprezentowany GeoJSON Polygon jako obiekt. Jest to zalecana opcja, jeśli geometria zawiera pojedynczy wielokąt. Obiekt Polygon może mieć maksymalnie 50 współrzędnych. Używa interfejsu API post Search Inside Geometry:https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

query

string

Odpowiedni ciąg zapytania (np. "seattle", "pizza").

body
SearchInsideGeometryRequestBody

Reprezentuje to geometrię dla co najmniej jednej funkcji geograficznej (parków, granic stanu itp.), które mają być wyszukiwane i powinny być typem zgodnym ze standardem GeoJSON. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .

Zwraca

searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)

W pobliżu Search Jeśli masz przypadek użycia tylko do pobierania wyników weryfikacji koncepcji wokół określonej lokalizacji, metoda wyszukiwania w pobliżu może być właściwym wyborem. Ten punkt końcowy zwróci tylko wyniki weryfikacji koncepcji i nie będzie przyjmować parametru zapytania wyszukiwania. Używa interfejsu API Get Search Nearby:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

location
GeoJSON.Position

Lokalizacja, w której wyniki powinny być stronnicze. Powinna być tablicą , [longitude, latitude]np. [-121.89, 37.337].

Zwraca

searchPOI(Aborter, string, SearchPOIOptions)

Uzyskiwanie weryfikacji koncepcji według nazwy Jeśli przypadek użycia wyszukiwania wymaga tylko wyników weryfikacji koncepcji, możesz użyć punktu końcowego poi do wyszukiwania. Ten punkt końcowy zwróci tylko wyniki poi. Używa interfejsu API get Search POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

query

string

Nazwa interfejsu użytkownika do wyszukania (np. "statua wolności", "starbucks").

Zwraca

searchPOICategory(Aborter, string, SearchPOICategoryOptions)

Pobieranie weryfikacji koncepcji według kategorii Jeśli przypadek użycia wyszukiwania wymaga tylko wyników weryfikacji koncepcji przefiltrowanych według kategorii, możesz użyć punktu końcowego kategorii. Ten punkt końcowy zwróci tylko wyniki weryfikacji koncepcji, które są podzielone na kategorie zgodnie z określonymi. Listę dostępnych kategorii można znaleźć tutaj. Używa interfejsu API kategorii Get Search POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

query

string

Kategoria POI do wyszukania (np. "AIRPORT", "BEACH").

Zwraca

searchPolygon(Aborter, string[])

Interfejs API Search Polygon umożliwia zażądanie danych geometrycznych, takich jak konspekt miasta lub kraju dla zestawu jednostek, pobranych wcześniej z żądania usługi Online Search w formacie GeoJSON. Identyfikator geometryczny jest zwracany w obiekcie dataSources w obszarze "geometry" i "id" w wywołaniu Search Address lub Search Fuzzy. Należy pamiętać, że każdy identyfikator geometrii pobrany z punktu końcowego usługi Online Search ma ograniczony okres istnienia. Klient nie powinien przechowywać identyfikatorów geometrii w magazynie trwałym na potrzeby późniejszego odwołania, ponieważ stabilność tych identyfikatorów nie jest gwarantowana przez długi czas. Oczekuje się, że żądanie do metody Polygon zostanie wykonane w ciągu kilku minut od żądania do metody online Search, która dostarczyła identyfikator. Usługa umożliwia obsługę żądań wsadowych do 20 identyfikatorów.

Używa interfejsu API uzyskiwania Search wielokąta:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

geometries

string[]

Rozdzielona przecinkami lista identyfikatorów UUID geometrii pobrana wcześniej z żądania usługi Online Search.

Zwraca

Szczegóły metody dziedziczonej

newPipeline(Credential, INewPipelineOptions)

Metoda statyczna użyta do utworzenia nowego obiektu Pipeline z podanym poświadczenie.

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

Parametry

credential
Credential

Na przykład SubscriptionKeyCredential, TokenCredential i MapControlCredential.

pipelineOptions
INewPipelineOptions

Zwraca

Nowy obiekt Pipeline.

Dziedziczone zMapsURL.newPipeline