SearchURL class
SearchURL rappresenta un URL per le operazioni di ricerca Mappe di Azure.
- Extends
Costruttori
SearchURL(Pipeline, string) | Crea un'istanza di SearchURL. |
Proprietà ereditate
maps |
Valore stringa URL di base. |
Metodi
search |
Geocodifica degli indirizzi In molti casi, il servizio di ricerca completo potrebbe essere troppo, ad esempio se si è interessati solo alla geocodifica tradizionale. Search è anche possibile accedere esclusivamente alla ricerca dell'indirizzo. La geocodifica viene eseguita premendo l'endpoint del codice geografico con solo l'indirizzo o l'indirizzo parziale in questione. L'indice di ricerca di geocodifica verrà sottoposto a query per tutti gli elementi al di sopra dei dati a livello stradale. Non verrà restituito alcun poI. Si noti che il geocoder è molto tollerante di errori di digitazioni e indirizzi incompleti. Gestirà anche tutto da indirizzi stradali esatti, strade o intersezioni, nonché aree geografiche di livello superiore, ad esempio centri città, contee, stati e così via. Usa l'API Get Search Address:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress |
search |
Decodifica geografica inversa in un indirizzo Ci possono essere momenti in cui è necessario tradurre una coordinata (ad esempio: -122.3862, 37.786505) in un indirizzo comprensibile umano. Molto spesso questo è necessario nelle applicazioni di rilevamento in cui si riceve un feed GPS dal dispositivo o asset e si desidera sapere quale indirizzo si trova la coordinata. Questo endpoint restituirà le informazioni sull'indirizzo per una determinata coordinata. Usa l'API Get Search Address Reverse:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse |
search |
Geocodifica inversa in una cross street Ci possono essere momenti in cui è necessario tradurre una coordinata (ad esempio: -122.3862, 37.786505) in una via incrociata comprensibile umana. Molto spesso questo è necessario nelle applicazioni di rilevamento in cui si riceve un feed GPS dal dispositivo o asset e si desidera sapere quale indirizzo si trova la coordinata. Questo endpoint restituirà le informazioni sulla strada incrociata per una determinata coordinata. Usa l'API Get Search Address Reverse Cross Street:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet |
search |
Geocodifica degli indirizzi strutturati È anche possibile accedere alla geocodifica degli indirizzi di Azure per cercare in modo esclusivo l'indirizzo strutturato. L'indice di ricerca di geocodifica verrà sottoposto a query per tutti gli elementi al di sopra dei dati a livello stradale. Non verrà restituito alcun poI. Si noti che il geocoder è molto tollerante di errori di digitazioni e indirizzi incompleti. Gestirà anche tutto da indirizzi stradali esatti, strade o intersezioni, nonché aree geografiche di livello superiore, ad esempio centri città, contee, stati e così via. Usa l'API Get Search Address Structured:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured |
search |
L'endpoint Search Lungo la route consente di eseguire una ricerca fuzzy per le POI lungo una route specificata.
Questa ricerca è vincolata specificando la |
search |
Free Form Search L'API predefinita di base è free form Search che gestisce la maggior parte degli input che gestisce qualsiasi combinazione di token di indirizzo o poi.
Questa API di ricerca è la "ricerca a riga singola" canonica.
L'API Free Form Search è una combinazione semplice di ricerca e geocoding dei punti di controllo.
L'API può anche essere ponderata con una posizione contestuale (lat./lon. coppia) o completamente vincolata da una coordinata e un raggio, oppure può essere eseguita più in genere senza alcun punto di ancoraggio di distorsione geografica.
Consigliamo vivamente di usare il parametro "countrySet" per specificare solo i paesi per cui l'applicazione ha bisogno di copertura, in quanto il comportamento predefinito sarà quello di cercare in tutto il mondo, potenzialmente restituire risultati non necessari. Ad esempio: |
search |
L'endpoint geometry Search consente di eseguire una ricerca di moduli gratuiti all'interno di una singola geometria o molti di essi.
I risultati della ricerca che rientrano all'interno delle geometrie/geometrie verranno restituiti.
Le caratteristiche geografiche da cercare possono essere modellate come geometrie Polygon e/o Circle rappresentate usando uno dei tipi seguenti |
search |
Nelle vicinanze Search Se si ha un caso d'uso solo per recuperare i risultati di POI in una posizione specifica, il metodo di ricerca nelle vicinanze potrebbe essere la scelta giusta. Questo endpoint restituirà solo i risultati di POI e non accetta in un parametro di query di ricerca. Usa l'API Get Search Nelle vicinanze:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby |
searchPOI(Aborter, string, Search |
Ottieni POI per nome Se il caso d'uso della ricerca richiede solo risultati di poi, è possibile usare l'endpoint DI GESTIONE per la ricerca. Questo endpoint restituirà solo i risultati di POI. Usa l'API Get Search POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi |
search |
Ottenere POI per categoria Se il caso d'uso della ricerca richiede solo i risultati di POI filtrati in base alla categoria, è possibile usare l'endpoint categoria. Questo endpoint restituirà solo i risultati DI POI classificati come specificato. L'elenco delle categorie disponibili è disponibile qui. Usa l'API Get Search CATEGORIA POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory |
search |
L'API Polygon Search consente di richiedere i dati geometry, ad esempio una struttura di città o paese per un set di entità, recuperato in precedenza da una richiesta di Search online in formato GeoJSON. L'ID geometry viene restituito nell'oggetto dataSources in "geometry" e "id" in una chiamata Search Address o Search Fuzzy. Si noti che qualsiasi ID geometry recuperato da un endpoint di Search online ha una durata limitata. Il client non deve archiviare gli ID geometry nell'archiviazione persistente per una segnalazione successiva, poiché la stabilità di questi identificatori non è garantita per un lungo periodo di tempo. Si prevede che una richiesta al metodo Polygon venga effettuata entro pochi minuti dalla richiesta al metodo online Search che ha fornito l'ID. Il servizio consente richieste batch fino a 20 identificatori. Usa l'API Get Search Polygon:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon |
Metodi ereditati
new |
Metodo statico usato per creare un nuovo oggetto Pipeline con credenziali fornite. |
Dettagli costruttore
SearchURL(Pipeline, string)
Crea un'istanza di SearchURL.
new SearchURL(pipeline: Pipeline, mapsUrl?: string)
Parametri
- pipeline
- Pipeline
Chiamare MapsURL.newPipeline() per creare una pipeline predefinita o fornire una pipeline personalizzata.
- mapsUrl
-
string
Una stringa URL che punta a Mappe di Azure servizio, il valore predefinito è "https://atlas.microsoft.com"
.
Se non viene specificato alcun protocollo, ad esempio "atlas.microsoft.com"
, https
verrà assunto.
Dettagli proprietà ereditate
mapsUrl
Valore stringa URL di base.
mapsUrl: string
Valore della proprietà
string
Ereditato daMapsURL.mapsUrl
Dettagli metodo
searchAddress(Aborter, string, SearchAddressOptions)
Geocodifica degli indirizzi In molti casi, il servizio di ricerca completo potrebbe essere troppo, ad esempio se si è interessati solo alla geocodifica tradizionale. Search è anche possibile accedere esclusivamente alla ricerca dell'indirizzo. La geocodifica viene eseguita premendo l'endpoint del codice geografico con solo l'indirizzo o l'indirizzo parziale in questione. L'indice di ricerca di geocodifica verrà sottoposto a query per tutti gli elementi al di sopra dei dati a livello stradale. Non verrà restituito alcun poI. Si noti che il geocoder è molto tollerante di errori di digitazioni e indirizzi incompleti. Gestirà anche tutto da indirizzi stradali esatti, strade o intersezioni, nonché aree geografiche di livello superiore, ad esempio centri città, contee, stati e così via. Usa l'API Get Search Address:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- query
-
string
Indirizzo da cercare ,ad esempio "1 Microsoft way, Redmond, WA".
- options
- SearchAddressOptions
Restituisce
Promise<SearchAddressResponse>
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)
Decodifica geografica inversa in un indirizzo Ci possono essere momenti in cui è necessario tradurre una coordinata (ad esempio: -122.3862, 37.786505) in un indirizzo comprensibile umano. Molto spesso questo è necessario nelle applicazioni di rilevamento in cui si riceve un feed GPS dal dispositivo o asset e si desidera sapere quale indirizzo si trova la coordinata. Questo endpoint restituirà le informazioni sull'indirizzo per una determinata coordinata. Usa l'API Get Search Address Reverse:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse
function searchAddressReverse(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseOptions): Promise<SearchAddressReverseResponse>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- position
- GeoJSON.Position
Posizione in cui eseguire la ricerca inversa, matrice di coordinate, [longitude, latitude]
ad esempio [-122.125679, 47.641268]
.
- options
- SearchAddressReverseOptions
Restituisce
Promise<SearchAddressReverseResponse>
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)
Geocodifica inversa in una cross street Ci possono essere momenti in cui è necessario tradurre una coordinata (ad esempio: -122.3862, 37.786505) in una via incrociata comprensibile umana. Molto spesso questo è necessario nelle applicazioni di rilevamento in cui si riceve un feed GPS dal dispositivo o asset e si desidera sapere quale indirizzo si trova la coordinata. Questo endpoint restituirà le informazioni sulla strada incrociata per una determinata coordinata. Usa l'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>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- position
- GeoJSON.Position
Posizione in cui eseguire la ricerca inversa, matrice di coordinate, [longitude, latitude]
ad esempio [-122.125679, 47.641268]
.
Restituisce
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)
Geocodifica degli indirizzi strutturati È anche possibile accedere alla geocodifica degli indirizzi di Azure per cercare in modo esclusivo l'indirizzo strutturato. L'indice di ricerca di geocodifica verrà sottoposto a query per tutti gli elementi al di sopra dei dati a livello stradale. Non verrà restituito alcun poI. Si noti che il geocoder è molto tollerante di errori di digitazioni e indirizzi incompleti. Gestirà anche tutto da indirizzi stradali esatti, strade o intersezioni, nonché aree geografiche di livello superiore, ad esempio centri città, contee, stati e così via. Usa l'API Get Search Address Structured:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- countryCode
-
string
Parte del codice paese ISO3166-1 lettera 2 o 3 di un indirizzo. Ad esempio, Stati Uniti.
- options
- SearchAddressStructuredOptions
Restituisce
Promise<SearchAddressStructuredResponse>
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)
L'endpoint Search Lungo la route consente di eseguire una ricerca fuzzy per le POI lungo una route specificata.
Questa ricerca è vincolata specificando la maxDetourTime
misura di limitazione.
Per inviare i punti di route si userà un body
oggetto che conterrà l'oggetto route
rappresentato come GeoJSON LineString
tipo e l'intestazione Content-Type
verrà impostata su application/json
.
Ogni punto di route in route
è rappresentato come un tipo, ovvero una GeoJSON Position
matrice in cui il valore della longitudine è seguito dal valore di latitudine e il valore di altitudine viene ignorato.
Deve route
contenere almeno 2 punti di itinerario.
È possibile che il percorso originale venga modificato, alcuni punti potrebbero essere ignorati.
Se la route che passa attraverso il punto trovato è più veloce di quella originale, il detourTime
valore nella risposta è negativo.
Usa l'API Post Search Lungo route:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute
function searchAlongRoute(aborter: Aborter, query: string, maxDetourTime: number, body: SearchAlongRouteRequestBody, options?: SearchAlongRouteOptions): Promise<SearchAlongRouteResponse>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- query
-
string
Stringa di query applicabile (ad esempio, "seattle", "pizza").
- maxDetourTime
-
number
Tempo massimo di deviazione del punto di interesse in secondi. Il valore massimo è 3600 secondi
Rappresenta la route da cercare lungo e deve essere un tipo valido GeoJSON LineString
. Per informazioni dettagliate, vedere RFC 7946 .
- options
- SearchAlongRouteOptions
Restituisce
Promise<SearchAlongRouteResponse>
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)
Free Form Search L'API predefinita di base è free form Search che gestisce la maggior parte degli input che gestisce qualsiasi combinazione di token di indirizzo o poi.
Questa API di ricerca è la "ricerca a riga singola" canonica.
L'API Free Form Search è una combinazione semplice di ricerca e geocoding dei punti di controllo.
L'API può anche essere ponderata con una posizione contestuale (lat./lon. coppia) o completamente vincolata da una coordinata e un raggio, oppure può essere eseguita più in genere senza alcun punto di ancoraggio di distorsione geografica.
Consigliamo vivamente di usare il parametro "countrySet" per specificare solo i paesi per cui l'applicazione ha bisogno di copertura, in quanto il comportamento predefinito sarà quello di cercare in tutto il mondo, potenzialmente restituire risultati non necessari. Ad esempio: countrySet
=US,FR. Per un elenco completo di tutti i paesi supportati, vedere [Search Coverage] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage).
La maggior parte delle query Search predefinite è maxFuzzyLevel
=2 per ottenere prestazioni e ridurre anche risultati insoliti.
Questo nuovo valore predefinito può essere sottoposto a override in base alle esigenze per ogni richiesta passando la query param maxFuzzyLevel
=3 o 4.
Usa l'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>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- query
-
string | GeoJSON.Position
Stringa di query applicabile (ad esempio, "seattle", "pizza").
Può anche essere specificato come matrice di coordinate di [longitude, latitude]
(ad esempio, [-122.125679, 47.641268]
).
- options
- SearchFuzzyOptions
Restituisce
Promise<SearchFuzzyResponse>
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)
L'endpoint geometry Search consente di eseguire una ricerca di moduli gratuiti all'interno di una singola geometria o molti di essi.
I risultati della ricerca che rientrano all'interno delle geometrie/geometrie verranno restituiti.
Le caratteristiche geografiche da cercare possono essere modellate come geometrie Polygon e/o Circle rappresentate usando uno dei tipi seguenti GeoJSON
: GeoJSON FeatureCollection, Che geometry
può essere rappresentato come GeoJSON FeatureCollection
oggetto.
Questa è l'opzione consigliata se la geometria contiene sia poligoni che cerchi.
Può FeatureCollection
contenere un massimo di 50 GeoJSON Feature
oggetti.
Ogni Feature
oggetto deve rappresentare un Polygon o un Circle con le condizioni seguenti: un Feature
oggetto per la geometria Polygon può avere un massimo di 50 coordinate ed è necessario che le proprietà siano vuote.
Un Feature
oggetto per la geometria Circle è costituito da un centro rappresentato usando un tipo e un GeoJSON Point
valore radius (in metri) che deve essere specificato nelle proprietà dell'oggetto insieme alla proprietà subType il cui valore deve essere "Circle".
Per una rappresentazione di esempio FeatureCollection
, vedere la sezione Esempi di seguito.
GeoJSON GeometryCollection, può geometry
essere rappresentato come GeoJSON GeometryCollection
oggetto .
Questa è l'opzione consigliata se la geometria contiene solo un elenco di poligoni.
Può GeometryCollection
contenere un massimo di 50 GeoJSON Polygon
oggetti.
Ogni Polygon
oggetto può avere un massimo di 50 coordinate.
Per una rappresentazione di esempio GeometryCollection
, vedere la sezione Esempi di seguito.
GeoJSON Polygon, può geometry
essere rappresentato come GeoJSON Polygon
oggetto.
Questa è l'opzione consigliata se la geometria contiene un singolo poligono.
L'oggetto Polygon
può avere un massimo di 50 coordinate.
Usa l'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>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- query
-
string
Stringa di query applicabile (ad esempio, "seattle", "pizza").
Ciò rappresenta la geometria per una o più caratteristiche geografiche (parchi, limiti di stato e così via) da cercare e deve essere un tipo conforme a GeoJSON. Per informazioni dettagliate, vedere RFC 7946 .
- options
- SearchInsideGeometryOptions
Restituisce
Promise<SearchInsideGeometryResponse>
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)
Nelle vicinanze Search Se si ha un caso d'uso solo per recuperare i risultati di POI in una posizione specifica, il metodo di ricerca nelle vicinanze potrebbe essere la scelta giusta. Questo endpoint restituirà solo i risultati di POI e non accetta in un parametro di query di ricerca. Usa l'API Get Search Nelle vicinanze:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby
function searchNearby(aborter: Aborter, location: GeoJSON.Position, options?: SearchNearbyOptions): Promise<SearchNearbyResponse>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- location
- GeoJSON.Position
Posizione in cui i risultati devono essere distorsioni.
Deve essere una matrice di [longitude, latitude]
, ad esempio [-121.89, 37.337]
.
- options
- SearchNearbyOptions
Restituisce
Promise<SearchNearbyResponse>
searchPOI(Aborter, string, SearchPOIOptions)
Ottieni POI per nome Se il caso d'uso della ricerca richiede solo risultati di poi, è possibile usare l'endpoint DI GESTIONE per la ricerca. Questo endpoint restituirà solo i risultati di POI. Usa l'API Get Search POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
function searchPOI(aborter: Aborter, query: string, options?: SearchPOIOptions): Promise<SearchPOIResponse>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- query
-
string
Il nome POI per cercare (ad esempio, "statua della libertà", "starbucks").
- options
- SearchPOIOptions
Restituisce
Promise<SearchPOIResponse>
searchPOICategory(Aborter, string, SearchPOICategoryOptions)
Ottenere POI per categoria Se il caso d'uso della ricerca richiede solo i risultati di POI filtrati in base alla categoria, è possibile usare l'endpoint categoria. Questo endpoint restituirà solo i risultati DI POI classificati come specificato. L'elenco delle categorie disponibili è disponibile qui. Usa l'API Get Search CATEGORIA POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- query
-
string
Categoria POI da cercare (ad esempio, "AIRPORT", "BEACH").
- options
- SearchPOICategoryOptions
Restituisce
Promise<SearchPOICategoryResponse>
searchPolygon(Aborter, string[])
L'API Polygon Search consente di richiedere i dati geometry, ad esempio una struttura di città o paese per un set di entità, recuperato in precedenza da una richiesta di Search online in formato GeoJSON. L'ID geometry viene restituito nell'oggetto dataSources in "geometry" e "id" in una chiamata Search Address o Search Fuzzy. Si noti che qualsiasi ID geometry recuperato da un endpoint di Search online ha una durata limitata. Il client non deve archiviare gli ID geometry nell'archiviazione persistente per una segnalazione successiva, poiché la stabilità di questi identificatori non è garantita per un lungo periodo di tempo. Si prevede che una richiesta al metodo Polygon venga effettuata entro pochi minuti dalla richiesta al metodo online Search che ha fornito l'ID. Il servizio consente richieste batch fino a 20 identificatori.
Usa l'API Get Search Polygon:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon
function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>
Parametri
- aborter
- Aborter
Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta.
- geometries
-
string[]
Elenco delimitato da virgole di UUID geometry, recuperato in precedenza da una richiesta di Search online.
Restituisce
Promise<SearchPolygonResponse>
Dettagli dei metodi ereditati
newPipeline(Credential, INewPipelineOptions)
Metodo statico usato per creare un nuovo oggetto Pipeline con credenziali fornite.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline
Parametri
- credential
- Credential
Ad esempio SubscriptionKeyCredential, TokenCredential e MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Restituisce
Nuovo oggetto Pipeline.
Ereditato daMapsURL.newPipeline