SearchNearbyPointOfInterestOptions interface
Options de recherche à proximité des points d’intérêt
Propriétés
| country |
Filtres de compteurs qui limitent la recherche aux pays spécifiés |
| radius |
Rayon en mètres pour que les résultats soient limités à la zone définie, la valeur min est 1, la valeur maximale est 5 0000. |
Propriétés héritées
| abort |
Signal qui peut être utilisé pour abandonner les demandes. |
| brand |
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 : |
| category |
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 l’API POI Categories. Exemples d’utilisation : |
| electric |
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 |
| extended |
Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats |
| language | Langue dans laquelle les résultats de recherche doivent être retournés. |
| localized |
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. |
| on |
Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois. |
| request |
Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération. |
| serializer |
Options permettant de remplacer le comportement de sérialisation/de désérialisation. |
| 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 |
| tracing |
Options utilisées lorsque le suivi est activé. |
Détails de la propriété
countryCodeFilter
Filtres de compteurs qui limitent la recherche aux pays spécifiés
countryCodeFilter?: string[]
Valeur de propriété
string[]
radiusInMeters
Rayon en mètres pour que les résultats soient limités à la zone définie, la valeur min est 1, la valeur maximale est 5 0000.
radiusInMeters?: number
Valeur de propriété
number
Détails de la propriété héritée
abortSignal
Signal qui peut être utilisé pour abandonner les demandes.
abortSignal?: AbortSignalLike
Valeur de propriété
héritée de OperationOptions.abortSignal
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é 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 l’API POI Categories.
Exemples d’utilisation : categorySet=7315(Recherche de points d’intérêt à partir de la catégorie Restaurant) categorySet=7315025,7315017(Recherche de points d’intérêt de catégorie Restaurant italien ou français)
categoryFilter?: number[]
Valeur de propriété
number[]
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é 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 deSearchBaseOptions.extendedPostalCodesFor
language
Langue dans laquelle les résultats de recherche doivent être retournés.
language?: string
Valeur de propriété
string
héritée deSearchBaseOptions.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 deSearchBaseOptions.localizedMapView
onResponse
Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
onResponse?: RawResponseCallback
Valeur de propriété
héritée de OperationOptions.onResponse
requestOptions
Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
requestOptions?: OperationRequestOptions
Valeur de propriété
héritée de OperationOptions.requestOptions
serializerOptions
Options permettant de remplacer le comportement de sérialisation/de désérialisation.
serializerOptions?: SerializerOptions
Valeur de propriété
héritée de OperationOptions.serializerOptions
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 deSearchBaseOptions.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 deSearchBaseOptions.top
tracingOptions
Options utilisées lorsque le suivi est activé.
tracingOptions?: OperationTracingOptions
Valeur de propriété
héritée de OperationOptions.tracingOptions