Partager via

SearchPointOfInterestBaseOptions interface

  • Référence
Paquet:
@azure/maps-search

Options de base pour la recherche de points d’intérêt

Extends

SearchAddressBaseOptions,SearchExtraFilterOptions

Propriétés

operatingHours

Heures d’opération pour un point d’intérêt (points d’intérêt).

Propriétés héritées

boundingBox

Zone englobante de la plage de recherche
brandFilter

Liste séparée par des virgules des noms de marque qui peuvent être utilisés pour restreindre le résultat à des marques spécifiques. L’ordre des articles n’a pas d’importance. Lorsque plusieurs marques sont fournies, seuls les résultats qui appartiennent à (au moins) l’une des listes fournies sont retournés. Les marques qui contiennent un « », dans leur nom doivent être placées entre guillemets.

Exemples d’utilisation : brandSet=FoobrandSet=Foo,BarbrandSet="A,B,C Comma",Bar
categoryFilter

Liste séparée par des virgules d’ID d’ensemble de catégories, qui peut être utilisée pour limiter le résultat à des catégories de points d’intérêt spécifiques. L’ordre d’ID n’a pas d’importance. Lorsque plusieurs identificateurs de catégorie sont fournis, seules les API appartenant à (au moins) une des catégories de la liste fournie sont retournées. La liste des catégories prises en charge peut être découverte à l’aide de 'API Catégories POI.

Exemples d’utilisation : categorySet=7315(Search Points of Interest from category Restaurant) categorySet=7315025,7315017(Search Points of Interest de catégorie Italien ou Français Restaurant)
electricVehicleConnectorFilter

Liste séparée par des virgules des types de connecteurs qui pourraient être utilisés pour limiter le résultat à la station de véhicules électriques prenant en charge des types de connecteurs spécifiques. L’ordre des articles n’a pas d’importance. Lorsque plusieurs types de connecteurs sont fournis, seuls les résultats qui appartiennent à (au moins) l’une des listes fournies sont retournés.

Exemples d’utilisation : connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
extendedPostalCodesFor

Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats
isTypeAhead

Indique si la requête doit être interprétée comme une entrée partielle et que la recherche entre en mode prédictif
language

Langue dans laquelle les résultats de recherche doivent être retournés.
localizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région pour les régions géopolitiquement contestées.
radiusInMeters

Rayon en mètres pour que les résultats soient limités à la zone définie
skip

Décalage de départ des résultats retournés dans le jeu de résultats complet. Valeur par défaut : 0, minimum : 0 et maximum : 1900
top

Nombre maximal de réponses qui seront retournées. Valeur par défaut : 10, minimum : 1 et maximum : 100

Détails de la propriété

operatingHours

Heures d’opération pour un point d’intérêt (points d’intérêt).

operatingHours?: string

Valeur de propriété

string

Détails de la propriété héritée

boundingBox

Zone englobante de la plage de recherche

boundingBox?: BoundingBox

Valeur de propriété

BoundingBox

héritée deSearchAddressBaseOptions.boundingBox

brandFilter

Liste séparée par des virgules des noms de marque qui peuvent être utilisés pour restreindre le résultat à des marques spécifiques. L’ordre des articles n’a pas d’importance. Lorsque plusieurs marques sont fournies, seuls les résultats qui appartiennent à (au moins) l’une des listes fournies sont retournés. Les marques qui contiennent un « », dans leur nom doivent être placées entre guillemets.

Exemples d’utilisation : brandSet=FoobrandSet=Foo,BarbrandSet="A,B,C Comma",Bar

brandFilter?: string[]

Valeur de propriété

string[]

héritée deSearchExtraFilterOptions.brandFilter

categoryFilter

Liste séparée par des virgules d’ID d’ensemble de catégories, qui peut être utilisée pour limiter le résultat à des catégories de points d’intérêt spécifiques. L’ordre d’ID n’a pas d’importance. Lorsque plusieurs identificateurs de catégorie sont fournis, seules les API appartenant à (au moins) une des catégories de la liste fournie sont retournées. La liste des catégories prises en charge peut être découverte à l’aide de 'API Catégories POI.

Exemples d’utilisation : categorySet=7315(Search Points of Interest from category Restaurant) categorySet=7315025,7315017(Search Points of Interest de catégorie Italien ou Français Restaurant)

categoryFilter?: number[]

Valeur de propriété

number[]

héritée deSearchExtraFilterOptions.categoryFilter

electricVehicleConnectorFilter

Liste séparée par des virgules des types de connecteurs qui pourraient être utilisés pour limiter le résultat à la station de véhicules électriques prenant en charge des types de connecteurs spécifiques. L’ordre des articles n’a pas d’importance. Lorsque plusieurs types de connecteurs sont fournis, seuls les résultats qui appartiennent à (au moins) l’une des listes fournies sont retournés.

Exemples d’utilisation : connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

electricVehicleConnectorFilter?: string[]

Valeur de propriété

string[]

héritée deSearchExtraFilterOptions.electricVehicleConnectorFilter

extendedPostalCodesFor

Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats

extendedPostalCodesFor?: string[]

Valeur de propriété

string[]

héritée deSearchAddressBaseOptions.extendedPostalCodesFor

isTypeAhead

Indique si la requête doit être interprétée comme une entrée partielle et que la recherche entre en mode prédictif

isTypeAhead?: boolean

Valeur de propriété

boolean

héritée deSearchAddressBaseOptions.isTypeAhead

language

Langue dans laquelle les résultats de recherche doivent être retournés.

language?: string

Valeur de propriété

string

héritée deSearchAddressBaseOptions.language

localizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région pour les régions géopolitiquement contestées.

localizedMapView?: string

Valeur de propriété

string

héritée deSearchAddressBaseOptions.localizedMapView

radiusInMeters

Rayon en mètres pour que les résultats soient limités à la zone définie

radiusInMeters?: number

Valeur de propriété

number

héritée deSearchAddressBaseOptions.radiusInMeters

skip

Décalage de départ des résultats retournés dans le jeu de résultats complet. Valeur par défaut : 0, minimum : 0 et maximum : 1900

skip?: number

Valeur de propriété

number

héritée deSearchAddressBaseOptions.skip

top

Nombre maximal de réponses qui seront retournées. Valeur par défaut : 10, minimum : 1 et maximum : 100

top?: number

Valeur de propriété

number

héritée deSearchAddressBaseOptions.top