SearchURL class

Skapar en instans av SearchURL.

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

Parametrar

Bas-URL-strängvärde.

mapsUrl: string

Egenskapsvärde

Ärvd frånMapsURL.mapsUrl

Adressgeokodning I många fall kan den fullständiga söktjänsten vara för mycket, till exempel om du bara är intresserad av traditionell geokodning. Search kan också användas enbart för adresssökning. Geokodningen utförs genom att du trycker på geokodslutpunkten med bara adressen eller den partiella adressen i fråga. Sökindexet för geokodning efterfrågas för allt över gatunivådata. Inga POI:er returneras. Observera att geokodaren är mycket tolerant mot skrivfel och ofullständiga adresser. Det kommer också att hantera allt från exakta gatuadresser eller gatu- eller korsningar samt geografiska områden på högre nivå som stadskärnor, län, stater etc. Använder API:et Get Search Address:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress

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

Parametrar

Returer

Omvänd geokod till en adress Det kan finnas tillfällen när du behöver översätta en koordinat (exempel: -122.3862, 37.786505) till en gatuadress som är begriplig för människor. Oftast behövs detta för att spåra program där du får ett GPS-flöde från enheten eller tillgången och vill veta vilken adress där koordinaten finns. Den här slutpunkten returnerar adressinformation för en viss koordinat. Använder api:et Get Search Address Reverse:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse

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

Parametrar

Returer

Omvänd geokod till en korsgata Det kan finnas tillfällen när du behöver översätta en koordinat (exempel: -122.3862, 37.786505) till en mänsklig begriplig korsgata. Oftast behövs detta för att spåra program där du får ett GPS-flöde från enheten eller tillgången och vill veta vilken adress där koordinaten finns. Den här slutpunkten returnerar gatuinformation för en viss koordinat. Använder API:et 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>

Parametrar

Returer

Geokodning av strukturerad adress Azure Address Geocoding kan också nås för strukturerad adresssökning exklusivt. Sökindexet för geokodning efterfrågas för allt över gatunivådata. Inga POI:er returneras. Observera att geokodaren är mycket tolerant mot skrivfel och ofullständiga adresser. Det kommer också att hantera allt från exakta gatuadresser eller gatu- eller korsningar samt geografiska områden på högre nivå som stadskärnor, län, stater etc. Använder api:et Get Search Address Structured:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured

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

Parametrar

Returer

Med slutpunkten Search Längs vägen kan du utföra en fuzzy-sökning efter URI:er längs en angiven väg. Den här sökningen begränsas genom att ange det begränsande måttet maxDetourTime . För att skicka routningspunkterna använder du en body som innehåller objektet route som representeras som en GeoJSON LineString typ och Content-Type rubriken anges till application/json. Varje vägpunkt i route representeras som en GeoJSON Position typ, dvs. en matris där longitudvärdet följs av latitudvärdet och höjdvärdet ignoreras. route ska innehålla minst 2 routningspunkter. Det är möjligt att den ursprungliga vägen ändras, och vissa av dess punkter kan hoppas över. Om den väg som passerar genom den hittade punkten är snabbare än den ursprungliga detourTime är värdet i svaret negativt. Använder API:et Post Search Along Route:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute

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

Parametrar

Returer

Kostnadsfritt formulär Search Det grundläggande standard-API:et är Kostnadsfritt formulär Search som hanterar de mest fuzzy-indata som hanterar alla kombinationer av adress- eller POI-token. Det här sök-API:et är den kanoniska "enkelradssökningen". Det kostnadsfria Search-API:et är en sömlös kombination av POI-sökning och geokodning. API:et kan också viktas med en sammanhangsbaserad position (lat./lon. pair) eller helt begränsas av en koordinat och radie, eller köras mer allmänt utan någon geo-partisk fästpunkt. Vi rekommenderar starkt att du använder parametern "countrySet" för att endast ange de länder som programmet behöver täckning för, eftersom standardbeteendet är att söka i hela världen och eventuellt returnera onödiga resultat. T.ex.: countrySet=US,FR. En fullständig lista över alla länder som stöds finns i [Search Täckning] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage). De flesta Search frågor är som standard maxFuzzyLevel=2 för att få prestanda och minska ovanliga resultat. Den här nya standardinställningen kan åsidosättas efter behov per begäran genom att skicka frågan param maxFuzzyLevel=3 eller 4. Använder Api:et Get Search Fuzzy:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy

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

Parametrar

Returer

Med slutpunkten Search geometri kan du utföra en fri formulärsökning i en enda geometri eller många av dem. Sökresultaten som faller inuti geometrin/geometrierna returneras. De geografiska funktioner som ska genomsökas kan modelleras som polygon- och/eller cirkelgeometrier som representeras med någon av följande GeoJSON typer: GeoJSON FeatureCollection, The geometry kan representeras som ett GeoJSON FeatureCollection -objekt. Det här är det rekommenderade alternativet om geometrin innehåller både polygoner och cirklar. FeatureCollection kan innehålla högst 50 GeoJSON Feature objekt. Varje Feature objekt ska representera antingen en polygon eller en cirkel med följande villkor: Ett Feature objekt för polygongeometrin kan ha högst 50 koordinater och dess egenskaper måste vara tomma. Ett Feature objekt för cirkelgeometrin består av ett centrum som representeras med hjälp av en GeoJSON Point typ och ett radievärde (i meter) som måste anges i objektets egenskaper tillsammans med subType-egenskapen vars värde ska vara "Cirkel". Se avsnittet Exempel nedan för en exempelrepresentation FeatureCollection . GeoJSON GeometryCollection, geometry kan representeras som ett GeoJSON GeometryCollection objekt. Detta är det rekommenderade alternativet om geometrin endast innehåller en lista över polygoner. GeometryCollection kan innehålla högst 50 GeoJSON Polygon objekt. Varje Polygon objekt kan ha högst 50 koordinater. Se avsnittet Exempel nedan för en exempelrepresentation GeometryCollection . GeoJSON Polygon, geometry Kan representeras som ett GeoJSON Polygon objekt. Detta är det rekommenderade alternativet om geometrin innehåller en enda polygon. Objektet Polygon kan ha högst 50 koordinater. Använder API:et 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>

Parametrar

Returer

Närliggande Search Om du har ett användningsfall för att endast hämta POI-resultat runt en viss plats kan den närliggande sökmetoden vara rätt val. Den här slutpunkten returnerar endast RESULTAT FRÅN INTRESSEPUNKTER och tar inte in en sökfrågeparameter. Använder API:et Get Search i närheten:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby

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

Parametrar

Returer

Hämta POI efter namn Om ditt sökanvändningsfall endast kräver POI-resultat kan du använda POI-slutpunkten för sökning. Den här slutpunkten returnerar endast RESULTAT FRÅN INTRESSEPUNKTER. Använder API:et Get Search POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi

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

Parametrar

Returer

Hämta POI efter kategori Om ditt sökanvändningsfall endast kräver POI-resultat filtrerade efter kategori kan du använda kategorislutpunkten. Den här slutpunkten returnerar endast POI-resultat som kategoriseras enligt angiven. En lista över tillgängliga kategorier finns här. Använder API:et Get Search POI Category:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory

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

Parametrar

Returer

Med Search Polygon-API:et kan du begära geometridata, till exempel en stads- eller landsdisposition för en uppsättning entiteter, som tidigare hämtats från en Online-Search-begäran i GeoJSON-format. Geometri-ID:t returneras i dataSources-objektet under "geometri" och "id" i antingen ett Search adress eller Search Fuzzy-anrop. Observera att alla geometri-ID:t som hämtats från en Online-Search-slutpunkt har en begränsad livslängd. Klienten bör inte lagra geometri-ID:t i beständig lagring för senare referens, eftersom stabiliteten hos dessa identifierare inte garanteras under en längre tidsperiod. Det förväntas att en begäran till Polygon-metoden görs inom några minuter efter begäran till metoden Online Search som tillhandahöll ID:t. Tjänsten tillåter batchbegäranden upp till 20 identifierare.

Använder API:et Get Search Polygon:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon

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

Parametrar

Returer

En statisk metod som används för att skapa ett nytt Pipeline-objekt med tillhandahållna autentiseringsuppgifter.

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

Parametrar

Returer

Ett nytt Pipeline-objekt.

Ärvd frånMapsURL.newPipeline