MapsSearchClient class
Clientklasse voor interactie met Azure Maps Search Service.
Constructors
| Maps |
Hiermee maakt u een exemplaar van MapsSearchClient op basis van een abonnementssleutel. Voorbeeld |
| Maps |
Hiermee maakt u een exemplaar van MapsSearchClient op basis van een Azure-identiteit Voorbeeld |
Methoden
| begin |
Hiermee worden batches met fuzzy zoekaanvragen verzonden. De methode retourneert een poller om het resultaat later op te halen. |
| begin |
Hiermee worden batches met aanvragen voor omgekeerde geocodering verzonden. De methode retourneert een poller om het resultaat later op te halen. |
| begin |
Hiermee worden batches geocoderingsaanvragen verzonden. De methode retourneert een poller om het resultaat later op te halen. |
| fuzzy |
Voert een zoekopdracht in vrije vorm uit die de meest fuzzy invoer verwerkt die elke combinatie van adres- of POI-tokens verwerkt. |
| get |
Vraagt de geometriegegevens op, zoals een plaats- of landoverzicht voor een set entiteiten. |
| get |
Hiermee wordt een volledige lijst met ondersteunde nuttige plaatsen (POI)-categorieën aangevraagd. |
| resume |
Ga door met de fuzzy zoekaanvraag met een geserialiseerde status van een andere poller. Voorbeeld |
| resume |
Ga door met de zoekaanvraag voor omgekeerde adressen met een geserialiseerde status van een andere poller. Voorbeeld |
| resume |
Ga door met de adreszoekaanvraag met een geserialiseerde status van een andere poller. Voorbeeld |
| reverse |
Vertaalt een coördinaten in een voor mensen begrijpelijk adres. |
| reverse |
Vertaalt een coördinaten in een door mensen begrijpelijke kruising. |
| search |
Geocodeert een adres. |
| search |
Voert een fuzzy zoekopdracht uit naar POI's langs een opgegeven route. |
| search |
Hiermee voert u een vrije vormzoekopdracht uit binnen één geometrie of veel van deze geometrien. |
| search |
Hiermee worden nuttige plaatsen (POI)-resultaten rond een specifieke locatie aangevraagd. |
| search |
Vraagt nuttige plaatsen (POI) resultaten op naam |
| search |
Points of interest (POI)-resultaten van opgegeven categorie aanvragen. |
| search |
Geocodeert een gestructureerd adres. |
Constructordetails
MapsSearchClient(AzureKeyCredential, MapsSearchClientOptions)
Hiermee maakt u een exemplaar van MapsSearchClient op basis van een abonnementssleutel.
Voorbeeld
import { MapsSearchClient, AzureKeyCredential } from "@azure/maps-search";
const credential = new AzureKeyCredential("<subscription-key>");
const client = new MapsSearchClient(credential);
new MapsSearchClient(credential: AzureKeyCredential, options?: MapsSearchClientOptions)Parameters
- credential
- AzureKeyCredential
Een AzureKeyCredential-exemplaar dat wordt gebruikt om aanvragen voor de service te verifiëren
- options
- MapsSearchClientOptions
Opties die worden gebruikt om de zoekclient te configureren
MapsSearchClient(TokenCredential, string, MapsSearchClientOptions)
Hiermee maakt u een exemplaar van MapsSearchClient op basis van een Azure-identiteit TokenCredential.
Voorbeeld
import { MapsSearchClient } from "@azure/maps-search";
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential();
const client = new MapsSearchClient(credential, "<maps-account-client-id>");
new MapsSearchClient(credential: TokenCredential, mapsAccountClientId: string, options?: MapsSearchClientOptions)Parameters
- credential
- TokenCredential
Een TokenCredential-exemplaar dat wordt gebruikt om aanvragen voor de service te verifiëren
- mapsAccountClientId
-
string
De Azure Maps client-id van een specifieke toewijzingsresource
- options
- MapsSearchClientOptions
Opties die worden gebruikt om de zoekclient te configureren
Methodedetails
beginFuzzySearchBatch(FuzzySearchRequest[], FuzzySearchBatchOptions)
Hiermee worden batches met fuzzy zoekaanvragen verzonden. De methode retourneert een poller om het resultaat later op te halen.
function beginFuzzySearchBatch(requests: FuzzySearchRequest[], options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parameters
- requests
De matrix met zoekaanvragen die moeten worden verwerkt. De matrix kan maximaal 10.000 aanvragen bevatten en moet ten minste één aanvraag bevatten.
- options
- FuzzySearchBatchOptions
Optionele parameters voor de bewerking
Retouren
Promise<FuzzySearchBatchPoller>
beginReverseSearchAddressBatch(ReverseSearchAddressRequest[], ReverseSearchAddressBatchOptions)
Hiermee worden batches met aanvragen voor omgekeerde geocodering verzonden. De methode retourneert een poller om het resultaat later op te halen.
function beginReverseSearchAddressBatch(requests: ReverseSearchAddressRequest[], options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parameters
- requests
De matrix met zoekaanvragen die moeten worden verwerkt. De matrix kan maximaal 10.000 aanvragen bevatten en moet ten minste één aanvraag bevatten.
- options
- ReverseSearchAddressBatchOptions
Optionele parameters voor de bewerking
Retouren
Promise<ReverseSearchAddressBatchPoller>
beginSearchAddressBatch(SearchAddressRequest[], SearchAddressBatchOptions)
Hiermee worden batches geocoderingsaanvragen verzonden. De methode retourneert een poller om het resultaat later op te halen.
function beginSearchAddressBatch(requests: SearchAddressRequest[], options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parameters
- requests
De matrix met zoekaanvragen die moeten worden verwerkt. De matrix kan maximaal 10.000 aanvragen bevatten en moet ten minste één aanvraag bevatten.
- options
- SearchAddressBatchOptions
Optionele parameters voor de bewerking
Retouren
Promise<FuzzySearchBatchPoller>
fuzzySearch(SearchQuery, FuzzySearchBaseOptions & OperationOptions)
Voert een zoekopdracht in vrije vorm uit die de meest fuzzy invoer verwerkt die elke combinatie van adres- of POI-tokens verwerkt.
function fuzzySearch(searchQuery: SearchQuery, options?: FuzzySearchBaseOptions & OperationOptions): Promise<SearchAddressResult>Parameters
- searchQuery
- SearchQuery
Tekstquery en locatiegegevens om te zoeken
- options
Opties voor fuzzy zoeken
Retouren
Promise<SearchAddressResult>
getGeometries(string[], OperationOptions)
Vraagt de geometriegegevens op, zoals een plaats- of landoverzicht voor een set entiteiten.
function getGeometries(geometryIds: string[], options?: OperationOptions): Promise<EntityGeometry[]>Parameters
- geometryIds
-
string[]
Door komma's gescheiden lijst met geometrie-UUID's, die eerder zijn opgehaald uit een onlinezoekaanvraag.
- options
- OperationOptions
Optionele parameters voor de bewerking
Retouren
Promise<EntityGeometry[]>
getPointOfInterestCategories(GetPointOfInterestCategoriesOptions)
Hiermee wordt een volledige lijst met ondersteunde nuttige plaatsen (POI)-categorieën aangevraagd.
function getPointOfInterestCategories(options?: GetPointOfInterestCategoriesOptions): Promise<PointOfInterestCategory[]>Parameters
Optionele parameters voor de bewerking
Retouren
Promise<PointOfInterestCategory[]>
resumeFuzzySearchBatch(string, FuzzySearchBatchOptions)
Ga door met de fuzzy zoekaanvraag met een geserialiseerde status van een andere poller.
Voorbeeld
const serializedState = poller.toString()
const rehydratedPoller = resumeFuzzySearchBatch(serializedState)
rehydratedPoller.poll()
function resumeFuzzySearchBatch(restoreFrom: string, options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parameters
- restoreFrom
-
string
De geserialiseerde status van de vorige poller.
- options
- FuzzySearchBatchOptions
Optionele parameters voor de bewerking.
Retouren
Promise<FuzzySearchBatchPoller>
resumeReverseSearchAddressBatch(string, ReverseSearchAddressBatchOptions)
Ga door met de zoekaanvraag voor omgekeerde adressen met een geserialiseerde status van een andere poller.
Voorbeeld
const serializedState = poller.toString()
const rehydratedPoller = resumeReverseSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeReverseSearchAddressBatch(restoreFrom: string, options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parameters
- restoreFrom
-
string
De geserialiseerde status van de vorige poller.
- options
- ReverseSearchAddressBatchOptions
Optionele parameters voor de bewerking.
Retouren
Promise<ReverseSearchAddressBatchPoller>
resumeSearchAddressBatch(string, SearchAddressBatchOptions)
Ga door met de adreszoekaanvraag met een geserialiseerde status van een andere poller.
Voorbeeld
const serializedState = poller.toString()
const rehydratedPoller = resumeSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeSearchAddressBatch(restoreFrom: string, options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parameters
- restoreFrom
-
string
De geserialiseerde status van de vorige poller.
- options
- SearchAddressBatchOptions
Optionele parameters voor de bewerking.
Retouren
Promise<FuzzySearchBatchPoller>
reverseSearchAddress(LatLon, ReverseSearchAddressOptions & OperationOptions)
Vertaalt een coördinaten in een voor mensen begrijpelijk adres.
function reverseSearchAddress(coordinates: LatLon, options?: ReverseSearchAddressOptions & OperationOptions): Promise<ReverseSearchAddressResult>Parameters
- coordinates
- LatLon
De coördinaten voor de omgekeerde zoekquery
- options
Optionele parameters voor de bewerking
Retouren
Promise<ReverseSearchAddressResult>
reverseSearchCrossStreetAddress(LatLon, ReverseSearchCrossStreetAddressOptions)
Vertaalt een coördinaten in een door mensen begrijpelijke kruising.
function reverseSearchCrossStreetAddress(coordinates: LatLon, options?: ReverseSearchCrossStreetAddressOptions): Promise<ReverseSearchCrossStreetAddressResult>Parameters
- coordinates
- LatLon
De coördinaten voor de omgekeerde zoekquery
Optionele parameters voor de bewerking
Retouren
searchAddress(string, SearchAddressOptions & OperationOptions)
Geocodeert een adres.
function searchAddress(query: string, options?: SearchAddressOptions & OperationOptions): Promise<SearchAddressResult>Parameters
- query
-
string
Het adres waarnaar moet worden gezocht (bijvoorbeeld '1 Microsoft way, Redmond, WA')
- options
Optionele parameters voor de bewerking
Retouren
Promise<SearchAddressResult>
searchAlongRoute(string, number, GeoJsonLineString, SearchAlongRouteOptions)
Voert een fuzzy zoekopdracht uit naar POI's langs een opgegeven route.
function searchAlongRoute(query: string, maxDetourTimeInSeconds: number, route: GeoJsonLineString, options?: SearchAlongRouteOptions): Promise<SearchAddressResult>Parameters
- query
-
string
De POI-naam die moet worden gezocht (bijvoorbeeld 'vrijheidsbeeld', 'starbucks', 'pizza').
- maxDetourTimeInSeconds
-
number
Maximale omleidingstijd van de nuttige plaats in seconden. De maximale waarde is 3600 seconden
- route
- GeoJsonLineString
Dit vertegenwoordigt de route om langs te zoeken en moet een geldig GeoJSON LineString type zijn.
- options
- SearchAlongRouteOptions
Optionele parameters voor de bewerking
Retouren
Promise<SearchAddressResult>
searchInsideGeometry(string, SearchGeometry, SearchInsideGeometryOptions)
Hiermee voert u een vrije vormzoekopdracht uit binnen één geometrie of veel van deze geometrien.
function searchInsideGeometry(query: string, geometry: SearchGeometry, options?: SearchInsideGeometryOptions): Promise<SearchAddressResult>Parameters
- query
-
string
De POI-naam die moet worden gezocht (bijvoorbeeld 'vrijheidsbeeld', 'starbucks', 'pizza').
- geometry
- SearchGeometry
Dit vertegenwoordigt de geometrie voor een of meer geografische kenmerken (parken, staatsgrens, enzovoort) om in te zoeken en moet een GeoJSON-compatibel type zijn. Raadpleeg RFC 7946 voor meer informatie.
- options
- SearchInsideGeometryOptions
Optionele parameters voor de bewerking
Retouren
Promise<SearchAddressResult>
searchNearbyPointOfInterest(LatLon, SearchNearbyPointOfInterestOptions)
Hiermee worden nuttige plaatsen (POI)-resultaten rond een specifieke locatie aangevraagd.
function searchNearbyPointOfInterest(coordinates: LatLon, options?: SearchNearbyPointOfInterestOptions): Promise<SearchAddressResult>Parameters
- coordinates
- LatLon
De coördinaten voor de nabijgelegen POI-zoekopdracht
Optionele parameters voor de bewerking
Retouren
Promise<SearchAddressResult>
searchPointOfInterest(SearchQuery, SearchPointOfInterestOptions)
Vraagt nuttige plaatsen (POI) resultaten op naam
function searchPointOfInterest(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parameters
- searchQuery
- SearchQuery
Tekstquery en locatiegegevens om te zoeken
- options
- SearchPointOfInterestOptions
Opties voor zoeken poi
Retouren
Promise<SearchAddressResult>
searchPointOfInterestCategory(SearchQuery, SearchPointOfInterestOptions)
Points of interest (POI)-resultaten van opgegeven categorie aanvragen.
function searchPointOfInterestCategory(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parameters
- searchQuery
- SearchQuery
Tekstquery en locatiegegevens om te zoeken
- options
- SearchPointOfInterestOptions
Opties voor zoeken poi-categorie
Retouren
Promise<SearchAddressResult>
searchStructuredAddress(StructuredAddress, SearchStructuredAddressOptions)
Geocodeert een gestructureerd adres.
function searchStructuredAddress(structuredAddress: StructuredAddress, options?: SearchStructuredAddressOptions): Promise<SearchAddressResult>Parameters
- structuredAddress
- StructuredAddress
Gestructureerd adres dat wordt gebruikt voor geocodering
- options
- SearchStructuredAddressOptions
Optionele parameters voor de bewerking
Retouren
Promise<SearchAddressResult>
