SearchURL class
Adresa SearchURL představuje adresu URL operací hledání Azure Maps.
- Extends
Konstruktory
| SearchURL(Pipeline, string) | Vytvoří instanci SearchURL. |
Zděděné vlastnosti
| maps |
Hodnota základního řetězce adresy URL. |
Metody
| search |
Geokódování adresy V mnoha případech může být kompletní vyhledávací služba příliš mnoho, například pokud vás zajímá pouze tradiční geokódování. Search lze také získat přístup pro výhradní vyhledávání adres. Geokódování se provádí tak, že se do koncového bodu geografického kódu trefí jenom s příslušnou adresou nebo částečnou adresou. Index vyhledávání geokódování se bude dotazovat na vše nad daty na úrovni ulice. Nebudou vráceny žádné BŽ. Všimněte si, že geokódér je velmi tolerantní k překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo křižovatek, stejně jako vyšší úrovně geografických míst, jako jsou centra měst, okresy, státy atd. Používá rozhraní API Get Search Address:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress |
| search |
Obrácení geografického kódu na adresu Někdy potřebujete přeložit souřadnici (například -122.3862, 37.786505) na srozumitelnou adresu. Nejčastěji je to potřeba ve sledovacích aplikacích, kde přijímáte informační kanál GPS ze zařízení nebo prostředku a chcete vědět, na jaké adrese se souřadnice nachází. Tento koncový bod vrátí informace o adrese pro danou souřadnici. Používá rozhraní Get Search Address Reverse API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse |
| search |
Obrácení geografického kódu na křížovou ulici Může se stát, že budete potřebovat přeložit souřadnici (například -122.3862, 37.786505) na srozumitelnou křižovatku. Nejčastěji je to potřeba ve sledovacích aplikacích, kde přijímáte informační kanál GPS ze zařízení nebo prostředku a chcete vědět, na jaké adrese se souřadnice nachází. Tento koncový bod vrátí informace o křížové ulici pro danou souřadnici. Používá rozhraní API Get Search Address Reverse Cross Street:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet |
| search |
Geokódování strukturovaných adres Geokódování adres Azure je také přístupné pro výhradní strukturované vyhledávání adres. Index vyhledávání geokódování se bude dotazovat na vše nad daty na úrovni ulice. Nebudou vráceny žádné BŽ. Všimněte si, že geokódér je velmi tolerantní k překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo křižovatek, stejně jako vyšší úrovně geografických míst, jako jsou centra měst, okresy, státy atd. Používá rozhraní API Get Search Address Structured:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured |
| search |
Koncový bod Search Podél trasy umožňuje provést přibližné hledání BS na zadané trase.
Toto hledání je omezeno zadáním |
| search |
Free Form Search Základním výchozím rozhraním API je free form Search který zpracovává nejvíce přibližných vstupů, které zpracovávají jakoukoli kombinaci adres nebo tokenů poi.
Toto rozhraní API pro vyhledávání je kanonické jednořádkové vyhledávání.
Rozhraní FREE FORM Search API je bezproblémovou kombinací vyhledávání poi a geokódování.
Rozhraní API může být také vážené kontextovou pozicí (dvojice lat./lon. ) nebo plně omezené souřadnicí a poloměrem, nebo může být provedeno obecněji bez jakéhokoli geografického zkreslení kotevního bodu.
Důrazně doporučujeme, abyste pomocí parametru countrySet určili jenom země, pro které vaše aplikace potřebuje pokrytí, protože výchozí chování bude hledat po celém světě a potenciálně vracet zbytečné výsledky. Např.: |
| search |
Koncový bod geometrie Search umožňuje provádět vyhledávání volného tvaru uvnitř jedné geometrie nebo mnoha z nich.
Vrátí se výsledky hledání, které spadají do geometrie nebo geometrie.
Hledané geografické prvky lze modelovat jako geometrie mnohoúhelníku a/nebo kruhů reprezentované pomocí některého z následujících |
| search |
Blízká Search Pokud máte případ použití pro načtení výsledků BZ pouze v určitém umístění, může být vhodnou volbou metoda hledání v okolí. Tento koncový bod vrátí pouze výsledky poi a nepřebere parametr vyhledávacího dotazu. Používá rozhraní API Get Search Nearby:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby |
| searchPOI(Aborter, string, Search |
Získání poi podle názvu Pokud váš případ použití hledání vyžaduje pouze výsledky bodů poi, můžete k vyhledávání použít koncový bod poi. Tento koncový bod vrátí pouze výsledky bodů poi. Používá rozhraní API Get Search POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi |
| search |
Získat poi podle kategorie Pokud váš případ použití hledání vyžaduje pouze výsledky poi filtrované podle kategorie, můžete použít koncový bod kategorie. Tento koncový bod vrátí pouze výsledky bodů poi, které jsou kategorizovány tak, jak jsou zadány. Seznam dostupných kategorií najdete tady. Používá rozhraní API Get Search POI Category:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory |
| search |
Rozhraní SEARCH Polygon API umožňuje vyžádat si data geometrie, jako je obrys města nebo země, pro sadu entit, které byly dříve načteny z požadavku online Search ve formátu GeoJSON. ID geometrie je vráceno v objektu dataSources v části "geometry" a "id" v Search Address nebo Search Fuzzy volání. Mějte na paměti, že každé ID geometrie načtené z koncového bodu online Search má omezenou životnost. Klient by neměl ukládat ID geometrie v trvalém úložišti pro pozdější doporučení, protože stabilita těchto identifikátorů není zaručena po dlouhou dobu. Očekává se, že požadavek na metodu Mnohoúhelník se provede během několika minut od požadavku na metodu Online Search, která poskytla ID. Služba umožňuje dávkové požadavky s maximálně 20 identifikátory. Používá rozhraní API Get Search Polygon:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon |
Zděděné metody
| new |
Statická metoda použitá k vytvoření nového objektu kanálu se zadanými přihlašovacími údaji. |
Podrobnosti konstruktoru
SearchURL(Pipeline, string)
Vytvoří instanci SearchURL.
new SearchURL(pipeline: Pipeline, mapsUrl?: string)Parametry
- pipeline
- Pipeline
Zavolejte MapsURL.newPipeline() a vytvořte výchozí kanál nebo poskytněte vlastní kanál.
- mapsUrl
-
string
Řetězec adresy URL odkazující na službu Azure Maps, výchozí hodnota je "https://atlas.microsoft.com".
Pokud není zadán žádný protokol, například "atlas.microsoft.com", https pak se předpokládá.
Podrobnosti zděděných vlastností
mapsUrl
Hodnota základního řetězce adresy URL.
mapsUrl: stringHodnota vlastnosti
string
Zděděno zMapsURL.mapsUrl
Podrobnosti metody
searchAddress(Aborter, string, SearchAddressOptions)
Geokódování adresy V mnoha případech může být kompletní vyhledávací služba příliš mnoho, například pokud vás zajímá pouze tradiční geokódování. Search lze také získat přístup pro výhradní vyhledávání adres. Geokódování se provádí tak, že se do koncového bodu geografického kódu trefí jenom s příslušnou adresou nebo částečnou adresou. Index vyhledávání geokódování se bude dotazovat na vše nad daty na úrovni ulice. Nebudou vráceny žádné BŽ. Všimněte si, že geokódér je velmi tolerantní k překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo křižovatek, stejně jako vyšší úrovně geografických míst, jako jsou centra měst, okresy, státy atd. Používá rozhraní API Get Search Address:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
- query
-
string
Adresa, kterou chcete vyhledat (např. "1 Microsoft way, Redmond, WA").
- options
- SearchAddressOptions
Návraty
Promise<SearchAddressResponse>
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)
Obrácení geografického kódu na adresu Někdy potřebujete přeložit souřadnici (například -122.3862, 37.786505) na srozumitelnou adresu. Nejčastěji je to potřeba ve sledovacích aplikacích, kde přijímáte informační kanál GPS ze zařízení nebo prostředku a chcete vědět, na jaké adrese se souřadnice nachází. Tento koncový bod vrátí informace o adrese pro danou souřadnici. Používá rozhraní 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>Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
- position
- GeoJSON.Position
Pozice pro zpětné vyhledávání, pole [longitude, latitude] souřadnic, např. [-122.125679, 47.641268]
- options
- SearchAddressReverseOptions
Návraty
Promise<SearchAddressReverseResponse>
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)
Obrácení geografického kódu na křížovou ulici Může se stát, že budete potřebovat přeložit souřadnici (například -122.3862, 37.786505) na srozumitelnou křižovatku. Nejčastěji je to potřeba ve sledovacích aplikacích, kde přijímáte informační kanál GPS ze zařízení nebo prostředku a chcete vědět, na jaké adrese se souřadnice nachází. Tento koncový bod vrátí informace o křížové ulici pro danou souřadnici. Používá rozhraní 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
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
- position
- GeoJSON.Position
Pozice pro zpětné vyhledávání, pole [longitude, latitude] souřadnic, např. [-122.125679, 47.641268]
Návraty
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)
Geokódování strukturovaných adres Geokódování adres Azure je také přístupné pro výhradní strukturované vyhledávání adres. Index vyhledávání geokódování se bude dotazovat na vše nad daty na úrovni ulice. Nebudou vráceny žádné BŽ. Všimněte si, že geokódér je velmi tolerantní k překlepům a neúplným adresům. Bude také zpracovávat vše od přesných adres ulic nebo ulic nebo křižovatek, stejně jako vyšší úrovně geografických míst, jako jsou centra měst, okresy, státy atd. Používá rozhraní API Get Search Address Structured:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
- countryCode
-
string
2 nebo 3 písmena ISO3166-1 část adresy s kódem země. Např. USA.
- options
- SearchAddressStructuredOptions
Návraty
Promise<SearchAddressStructuredResponse>
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)
Koncový bod Search Podél trasy umožňuje provést přibližné hledání BS na zadané trase.
Toto hledání je omezeno zadáním maxDetourTime omezující míry.
K odeslání směrovacích bodů použijete body objekt, který bude obsahovat route objekt reprezentovaný jako GeoJSON LineString typ a hlavička Content-Type se nastaví na application/json.
Každý bod trasy v route souboru je reprezentován jako GeoJSON Position typ, tj. pole, kde za hodnotou zeměpisné délky následuje hodnota zeměpisné šířky a hodnota nadmořské výšky se ignoruje.
Hodnota route by měla obsahovat alespoň 2 body trasy.
Je možné, že původní trasa bude změněna, některé z těchto bodů mohou být vynechány.
Pokud je trasa, která prochází nalezený bod, rychlejší než původní, detourTime hodnota v odpovědi je záporná.
Použije rozhraní API 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>Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), další příklady zrušení požadavku najdete v dokumentech Aborter.
- query
-
string
Příslušný řetězec dotazu (např. "seattle", "pizza").
- maxDetourTime
-
number
Maximální doba objížďky bodu zájmu v sekundách. Maximální hodnota je 3600 sekund.
Představuje trasu, po které se má hledat, a měla by být platným GeoJSON LineString typem. Podrobnosti najdete v dokumentu RFC 7946 .
- options
- SearchAlongRouteOptions
Návraty
Promise<SearchAlongRouteResponse>
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)
Free Form Search Základním výchozím rozhraním API je free form Search který zpracovává nejvíce přibližných vstupů, které zpracovávají jakoukoli kombinaci adres nebo tokenů poi.
Toto rozhraní API pro vyhledávání je kanonické jednořádkové vyhledávání.
Rozhraní FREE FORM Search API je bezproblémovou kombinací vyhledávání poi a geokódování.
Rozhraní API může být také vážené kontextovou pozicí (dvojice lat./lon. ) nebo plně omezené souřadnicí a poloměrem, nebo může být provedeno obecněji bez jakéhokoli geografického zkreslení kotevního bodu.
Důrazně doporučujeme, abyste pomocí parametru countrySet určili jenom země, pro které vaše aplikace potřebuje pokrytí, protože výchozí chování bude hledat po celém světě a potenciálně vracet zbytečné výsledky. Např.: countrySet=US,FR. Úplný seznam všech podporovaných zemí najdete v tématu [Search Coverage] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage).
Většina Search dotazů je ve výchozím nastavení =2, maxFuzzyLevelaby se získal výkon a snížily neobvyklé výsledky.
Toto nové výchozí nastavení je možné podle potřeby přepsat pro jednotlivé požadavky předáním maxFuzzyLevelparametru dotazu =3 nebo 4.
Používá rozhraní API Get Search Fuzzy:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy
function searchFuzzy(aborter: Aborter, query: string | GeoJSON.Position, options?: SearchFuzzyOptions): Promise<SearchFuzzyResponse>Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), další příklady zrušení požadavku najdete v dokumentech Aborter.
- query
-
string | GeoJSON.Position
Příslušný řetězec dotazu (např. "seattle", "pizza").
Lze také zadat jako pole [longitude, latitude] souřadnic (např. [-122.125679, 47.641268]).
- options
- SearchFuzzyOptions
Návraty
Promise<SearchFuzzyResponse>
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)
Koncový bod geometrie Search umožňuje provádět vyhledávání volného tvaru uvnitř jedné geometrie nebo mnoha z nich.
Vrátí se výsledky hledání, které spadají do geometrie nebo geometrie.
Hledané geografické prvky lze modelovat jako geometrie mnohoúhelníku a/nebo kruhů reprezentované pomocí některého z následujících GeoJSON typů: GeoJSON FeatureCollection, The geometry může být reprezentován jako GeoJSON FeatureCollection objekt.
Tato možnost se doporučuje, pokud geometrie obsahuje mnohoúhelníky i kruhy.
Objekt FeatureCollection může obsahovat maximálně 50 GeoJSON Feature objektů.
Každý Feature objekt by měl představovat mnohoúhelník nebo kruh s následujícími podmínkami: Feature Objekt pro geometrii mnohoúhelníku může mít maximálně 50 souřadnic a jeho vlastnosti musí být prázdné.
Objekt Feature pro geometrii Kruh se skládá ze středu reprezentovaného pomocí GeoJSON Point typu a hodnoty poloměru (v metrech), která musí být zadána ve vlastnostech objektu spolu s vlastností subType , jejíž hodnota by měla být "Circle".
Ukázkovou FeatureCollection reprezentaci najdete v části Příklady níže.
GeoJSON GeometryCollection, Může geometry být reprezentován jako GeoJSON GeometryCollection objekt.
Tato možnost se doporučuje, pokud geometrie obsahuje pouze seznam mnohoúhelníků.
Objekt GeometryCollection může obsahovat maximálně 50 GeoJSON Polygon objektů.
Každý Polygon objekt může mít maximálně 50 souřadnic.
Ukázkovou GeometryCollection reprezentaci najdete v části Příklady níže.
GeoJSON Mnohoúhelník, může geometry být reprezentován jako GeoJSON Polygon objekt.
Tato možnost se doporučuje, pokud geometrie obsahuje jeden mnohoúhelník.
Objekt Polygon může mít maximálně 50 souřadnic.
Použije 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>Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), další příklady zrušení požadavku najdete v dokumentech Aborter.
- query
-
string
Příslušný řetězec dotazu (např. "seattle", "pizza").
To představuje geometrii jednoho nebo více geografických prvků (parky, hranice států atd.), ve které se má hledat, a měl by být typem kompatibilním se standardem GeoJSON. Podrobnosti najdete v dokumentu RFC 7946 .
- options
- SearchInsideGeometryOptions
Návraty
Promise<SearchInsideGeometryResponse>
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)
Blízká Search Pokud máte případ použití pro načtení výsledků BZ pouze v určitém umístění, může být vhodnou volbou metoda hledání v okolí. Tento koncový bod vrátí pouze výsledky poi a nepřebere parametr vyhledávacího dotazu. Používá rozhraní 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
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), další příklady zrušení požadavku najdete v dokumentech Aborter.
- location
- GeoJSON.Position
Umístění, kde by výsledky měly být zkreslené.
Mělo by to být pole [longitude, latitude], například [-121.89, 37.337].
- options
- SearchNearbyOptions
Návraty
Promise<SearchNearbyResponse>
searchPOI(Aborter, string, SearchPOIOptions)
Získání poi podle názvu Pokud váš případ použití hledání vyžaduje pouze výsledky bodů poi, můžete k vyhledávání použít koncový bod poi. Tento koncový bod vrátí pouze výsledky bodů poi. Používá rozhraní 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
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), další příklady zrušení požadavku najdete v dokumentech Aborter.
- query
-
string
Název poi, který chcete vyhledat (např. "socha svobody", "starbucks").
- options
- SearchPOIOptions
Návraty
Promise<SearchPOIResponse>
searchPOICategory(Aborter, string, SearchPOICategoryOptions)
Získat poi podle kategorie Pokud váš případ použití hledání vyžaduje pouze výsledky poi filtrované podle kategorie, můžete použít koncový bod kategorie. Tento koncový bod vrátí pouze výsledky bodů poi, které jsou kategorizovány tak, jak jsou zadány. Seznam dostupných kategorií najdete tady. Používá rozhraní API Get Search POI Category:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), další příklady zrušení požadavku najdete v dokumentech Aborter.
- query
-
string
Kategorie poi, která se má hledat (např. "LETIŠTĚ", "PLÁŽ").
- options
- SearchPOICategoryOptions
Návraty
Promise<SearchPOICategoryResponse>
searchPolygon(Aborter, string[])
Rozhraní SEARCH Polygon API umožňuje vyžádat si data geometrie, jako je obrys města nebo země, pro sadu entit, které byly dříve načteny z požadavku online Search ve formátu GeoJSON. ID geometrie je vráceno v objektu dataSources v části "geometry" a "id" v Search Address nebo Search Fuzzy volání. Mějte na paměti, že každé ID geometrie načtené z koncového bodu online Search má omezenou životnost. Klient by neměl ukládat ID geometrie v trvalém úložišti pro pozdější doporučení, protože stabilita těchto identifikátorů není zaručena po dlouhou dobu. Očekává se, že požadavek na metodu Mnohoúhelník se provede během několika minut od požadavku na metodu Online Search, která poskytla ID. Služba umožňuje dávkové požadavky s maximálně 20 identifikátory.
Používá rozhraní API Get Search Polygon:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon
function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), další příklady zrušení požadavku najdete v dokumentech Aborter.
- geometries
-
string[]
Čárkami oddělený seznam identifikátorů UUID geometrie, který se dříve načítal z online požadavku na Search.
Návraty
Promise<SearchPolygonResponse>
Podrobnosti zděděných metod
newPipeline(Credential, INewPipelineOptions)
Statická metoda použitá k vytvoření nového objektu kanálu se zadanými přihlašovacími údaji.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParametry
- credential
- Credential
Například SubscriptionKeyCredential, TokenCredential a MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Návraty
Nový objekt kanálu.
Zděděno zMapsURL.newPipeline