SearchInsideGeometryOptions interface
Options de recherche dans les géométries
Propriétés
| extended |
Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats |
| index |
Liste séparée par des virgules d’index qui doivent être utilisés pour la recherche. L’ordre des articles n’a pas d’importance. Les index disponibles sont les suivants :
|
| language | Langue dans laquelle les résultats de recherche doivent être retournés. |
Propriétés héritées
| abort |
Signal qui peut être utilisé pour abandonner les demandes. |
| 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 : |
| 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. |
| operating |
Heures d’opération pour un point d’intérêt (points d’intérêt). |
| 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. |
| 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é
extendedPostalCodesFor
Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats
extendedPostalCodesFor?: string[]
Valeur de propriété
string[]
indexFilter
Liste séparée par des virgules d’index qui doivent être utilisés pour la recherche. L’ordre des articles n’a pas d’importance. Les index disponibles sont les suivants :
- Addr = Interpolation de plage d’adresses,
- Geo = Zones géographiques, PAD = Adresses de point,
- POI = Points d’intérêt, Str = Rues,
- Xstr = Rues croisées (intersections)
indexFilter?: string[]
Valeur de propriété
string[]
language
Langue dans laquelle les résultats de recherche doivent être retournés.
language?: string
Valeur de propriété
string
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
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[]
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
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
operatingHours
Heures d’opération pour un point d’intérêt (points d’intérêt).
operatingHours?: string
Valeur de propriété
string
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
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é deSearchGeometryBaseOptions.top
tracingOptions
Options utilisées lorsque le suivi est activé.
tracingOptions?: OperationTracingOptions
Valeur de propriété
héritée de OperationOptions.tracingOptions