new SearchBANAdvanced( [Control])
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
Control |
Object |
<optional> |
options. |
|
options.className |
string | classname qui sera appliqué à l'élément html portant le contrôle |
||
options.target |
Element | string |
<optional> |
Spécifie une cible, si l'on veut que le contrôle soit géré en dehors de la map |
|
options.reverseTitle |
string |
<optional> |
Cliquer sur la carte... | Titre à afficher sur le tooltip du bouton de géocodage inverse |
options.reverse |
boolean |
<optional> |
false | Affiche un outil de géocodage inverse d'adresse |
options.position |
boolean |
<optional> |
true | Priorise les résultats près du centre de la carte affichée |
options.label |
string |
<optional> |
Rechercher | Libellé affiché pour la zone de recherche |
options.placeholder |
string |
<optional> |
Rechercher une adresse | Placeholder de la zone de recherche |
options.typing |
number |
<optional> |
500 | le délais en ms pour lancer la recherche après une saisie utilisateur |
options.minLength |
integer |
<optional> |
3 | la longueur de la chaine de recherche à partir de laquelle lancer la recherche |
options.maxItems |
integer |
<optional> |
10 | Nombre de résultats affichés classés par score |
options.limit |
integer |
<optional> |
10 | Nombre de résultats recherchés (utile lorsque l'on va appliquer un filtre) |
options.resultZoom |
integer |
<optional> |
16 | Zoom minimal à appliquer lors de la localisation sur la carte d'un résultat |
options.citycodes |
Array.<string> |
<optional> |
[] | Liste de code insee sur lesquels on va lancer la recherche (attention, une requête sera réalisée par code insee) |
options.postfilters |
Array.<PostFilter> |
<optional> |
[] | Liste des filtres à appliquer sur les résultats (attention, il est possible qu'aucun résultat ne s'affiche) |
options.url |
string | undefined | Url de l'api BAN, défaut "https://api-adresse.data.gouv.fr/search/" |
||
options.getTitle |
function |
<optional> |
une fonction qui retourne la chaine à affichée pour un résultat, par défaut le label de ce dernier |
Fires:
- event:select
Extends
- ol-ext/control/SearchBAN
Methods
-
handleResponse(response)
Handle server response to pass the features array to the list
. -
Handle server response to pass the features array to the list
Parameters:
Name Type Description responseany server response
- Source:
Returns:
an array of feature
- Type
- Array.<any>
-
requestData(s)
-
Parameters:
Name Type Description sstring the search string
- Source:
Returns:
request data (as key:value)
- Type
- Object