Interface SearchEngineOptions

interface SearchEngineOptions {
    advancedSearch?: { target?: HTMLElement };
    apiKey?: string;
    autocompleteOptions?: {
        maximumEntries?: number;
        prettifyResults?: boolean;
        serviceOptions?: any;
        triggerDelay?: number;
        triggerGeocode?: boolean;
    };
    collapsed?: boolean;
    collapsible?: boolean;
    coordinateSearch?: { systems?: any[]; target?: HTMLElement; units?: any[] };
    coordinateSearchInAdvancedSearch?: boolean;
    direction?: string;
    displayButtonAdvancedSearch?: boolean;
    displayButtonClose?: boolean;
    displayButtonCoordinateSearch?: boolean;
    displayButtonGeolocate?: boolean;
    displayMarker?: boolean;
    geocodeOptions?: { serviceOptions?: any };
    id?: number;
    markerStyle?: string;
    markerUrl?: string;
    placeholder?: string;
    resources?: {
        autocomplete?: string[];
        geocode?: string | string[];
        search?: boolean;
    };
    searchOptions?: {
        addToMap?: boolean;
        filterLayers?: boolean;
        filterLayersList?: any;
        filterLayersPriority?: boolean;
        filterProjections?: string[];
        filterServices?: string[];
        filterTMS?: boolean;
        filterWMTSPriority?: string[];
        maximumEntries?: number;
        serviceOptions?: {
            fields?: string[];
            index?: string;
            maximumResponses?: number;
            size?: number;
            url?: string;
        };
    };
    splitResults?: boolean;
    ssl?: boolean;
    zoomTo?: string
    | number
    | Function;
}

Properties

`Optional`advancedSearch

advancedSearch?: { target?: HTMLElement }

Options de recherche avancée (voir geocodeOptions.filterOptions)

Type Declaration

Optionaltarget?: HTMLElement

Cible d'affichage des résultats

`Optional`apiKey

apiKey?: string

Clé API. "calcul" par défaut.

`Optional`autocompleteOptions

autocompleteOptions?: {
    maximumEntries?: number;
    prettifyResults?: boolean;
    serviceOptions?: any;
    triggerDelay?: number;
    triggerGeocode?: boolean;
}

Options du service d'autocomplétion (voir Gp.Services.autoComplete Gp.Services.autoComplete)

Type Declaration

OptionalmaximumEntries?: number

Nombre maximum de résultats d'autocomplétion à afficher
OptionalprettifyResults?: boolean

Nettoyer/embellir les résultats d'autocomplétion
OptionalserviceOptions?: any

Options du service d'autocomplétion
OptionaltriggerDelay?: number

Délai avant la requête de géocodage (ms)
OptionaltriggerGeocode?: boolean

Déclencher une requête de géocodage si aucune suggestion

`Optional`collapsed

collapsed?: boolean

Mode réduit (true par défaut)

`Optional`collapsible

collapsible?: boolean

Contrôle pliable ou non (true par défaut)

`Optional`coordinateSearch

coordinateSearch?: { systems?: any[]; target?: HTMLElement; units?: any[] }

Options de recherche par coordonnées

Type Declaration

Optionalsystems?: any[]

Systèmes de projection à afficher (objet avec crs, label, type)
Optionaltarget?: HTMLElement

Cible d'affichage des résultats
Optionalunits?: any[]

Unités de coordonnées à afficher ("DEC", "DMS", "M", "KM") Values may be "DEC" (decimal degrees), "DMS" (sexagecimal) for geographical coordinates, and "M" or "KM" for metric coordinates

`Optional`coordinateSearchInAdvancedSearch

coordinateSearchInAdvancedSearch?: boolean

Afficher la recherche par coordonnées dans la recherche avancée

`Optional`direction

direction?: string

Position du picto (loupe), "start" par défaut

`Optional`displayButtonAdvancedSearch

displayButtonAdvancedSearch?: boolean

Afficher le bouton de recherche avancée (false par défaut)

`Optional`displayButtonClose

displayButtonClose?: boolean

Afficher le bouton de fermeture (true par défaut)

`Optional`displayButtonCoordinateSearch

displayButtonCoordinateSearch?: boolean

Afficher le bouton de recherche par coordonnées (false par défaut)

`Optional`displayButtonGeolocate

displayButtonGeolocate?: boolean

Afficher le bouton de géolocalisation (false par défaut)

`Optional`displayMarker

displayMarker?: boolean

Afficher un marqueur sur le résultat (true par défaut)

`Optional`geocodeOptions

geocodeOptions?: { serviceOptions?: any }

Options du service de géocodage (voir Gp.Services.geocode Gp.Services.geocode))

Type Declaration

OptionalserviceOptions?: any

Options du service de géocodage

`Optional`id

id?: number

Identifiant du widget (option avancée)

`Optional`markerStyle

markerStyle?: string

Style du marqueur ("lightOrange", "darkOrange", "red", "turquoiseBlue")

`Optional`markerUrl

markerUrl?: string

URL du marqueur (prioritaire sur markerStyle)

`Optional`placeholder

placeholder?: string

Placeholder de la barre de recherche

`Optional`resources

resources?: {
    autocomplete?: string[];
    geocode?: string | string[];
    search?: boolean;
}

Ressources utilisées par les services

Type Declaration

Optionalautocomplete?: string[]

Ressources d'autocomplétion
Optionalgeocode?: string | string[]

Ressources de géocodage
Optionalsearch?: boolean

Activer le service de recherche (false par défaut)

`Optional`searchOptions

searchOptions?: {
    addToMap?: boolean;
    filterLayers?: boolean;
    filterLayersList?: any;
    filterLayersPriority?: boolean;
    filterProjections?: string[];
    filterServices?: string[];
    filterTMS?: boolean;
    filterWMTSPriority?: string[];
    maximumEntries?: number;
    serviceOptions?: {
        fields?: string[];
        index?: string;
        maximumResponses?: number;
        size?: number;
        url?: string;
    };
}

Options du service de recherche

Type Declaration

OptionaladdToMap?: boolean

Ajouter la couche automatiquement à la carte
OptionalfilterLayers?: boolean

Activer le filtrage automatique des couches
OptionalfilterLayersList?: any

Liste des couches à filtrer {"layerName": "service"}
OptionalfilterLayersPriority?: boolean

Filtrer sur les couches prioritaires
OptionalfilterProjections?: string[]

Filtrer sur une liste de projections
OptionalfilterServices?: string[]

Filtrer sur une liste de services ("WMTS,TMS" par défaut)
OptionalfilterTMS?: boolean

Garder les TMS avec style dans les métadonnées
OptionalfilterWMTSPriority?: string[]

Filtrer sur les couches WMTS prioritaires
OptionalmaximumEntries?: number

Nombre maximum de résultats à afficher
OptionalserviceOptions?: {
    fields?: string[];
    index?: string;
    maximumResponses?: number;
    size?: number;
    url?: string;
}

Options du service de recherche
- Optionalfields?: string[]
  
  Champs de recherche
- Optionalindex?: string
  
  Index de recherche
- OptionalmaximumResponses?: number
  
  Nombre de résultats à afficher
- Optionalsize?: number
  
  Nombre de réponses du service
- Optionalurl?: string
  
  URL du service

`Optional`splitResults

splitResults?: boolean

Désactiver la recherche par couches (false par défaut)

`Optional`ssl

ssl?: boolean

Utilisation du protocole https (true par défaut)

`Optional`zoomTo

zoomTo?: string | number | Function

Niveau de zoom à appliquer sur le résultat ("auto", niveau, ou fonction) Value possible : auto or zoom level. Possible to overload it with a function : zoomTo : function (info) { // do some stuff... return zoom; }

Interface SearchEngineOptions

Index

Properties

Properties

OptionaladvancedSearch

Type Declaration

Optionaltarget?: HTMLElement

OptionalapiKey

OptionalautocompleteOptions

Type Declaration

OptionalmaximumEntries?: number

OptionalprettifyResults?: boolean

OptionalserviceOptions?: any

OptionaltriggerDelay?: number

OptionaltriggerGeocode?: boolean

Optionalcollapsed

Optionalcollapsible

OptionalcoordinateSearch

Type Declaration

Optionalsystems?: any[]

Optionaltarget?: HTMLElement

Optionalunits?: any[]

OptionalcoordinateSearchInAdvancedSearch

Optionaldirection

OptionaldisplayButtonAdvancedSearch

OptionaldisplayButtonClose

OptionaldisplayButtonCoordinateSearch

OptionaldisplayButtonGeolocate

OptionaldisplayMarker

OptionalgeocodeOptions

Type Declaration

OptionalserviceOptions?: any

Optionalid

OptionalmarkerStyle

OptionalmarkerUrl

Optionalplaceholder

Optionalresources

Type Declaration

Optionalautocomplete?: string[]

Optionalgeocode?: string | string[]

Optionalsearch?: boolean

OptionalsearchOptions

Type Declaration

OptionaladdToMap?: boolean

OptionalfilterLayers?: boolean

OptionalfilterLayersList?: any

OptionalfilterLayersPriority?: boolean

OptionalfilterProjections?: string[]

OptionalfilterServices?: string[]

OptionalfilterTMS?: boolean

OptionalfilterWMTSPriority?: string[]

OptionalmaximumEntries?: number

OptionalserviceOptions?: { fields?: string[]; index?: string; maximumResponses?: number; size?: number; url?: string;}

Optionalfields?: string[]

Optionalindex?: string

OptionalmaximumResponses?: number

Optionalsize?: number

Optionalurl?: string

OptionalsplitResults

Optionalssl

OptionalzoomTo

Settings

On This Page

`Optional`advancedSearch

`Optional`target?: HTMLElement

`Optional`apiKey

`Optional`autocompleteOptions

`Optional`maximumEntries?: number

`Optional`prettifyResults?: boolean

`Optional`serviceOptions?: any

`Optional`triggerDelay?: number

`Optional`triggerGeocode?: boolean

`Optional`collapsed

`Optional`collapsible

`Optional`coordinateSearch

`Optional`systems?: any[]

`Optional`target?: HTMLElement

`Optional`units?: any[]

`Optional`coordinateSearchInAdvancedSearch

`Optional`direction

`Optional`displayButtonAdvancedSearch

`Optional`displayButtonClose

`Optional`displayButtonCoordinateSearch

`Optional`displayButtonGeolocate

`Optional`displayMarker

`Optional`geocodeOptions

`Optional`serviceOptions?: any

`Optional`id

`Optional`markerStyle

`Optional`markerUrl

`Optional`placeholder

`Optional`resources

`Optional`autocomplete?: string[]

`Optional`geocode?: string | string[]

`Optional`search?: boolean

`Optional`searchOptions

`Optional`addToMap?: boolean

`Optional`filterLayers?: boolean

`Optional`filterLayersList?: any

`Optional`filterLayersPriority?: boolean

`Optional`filterProjections?: string[]

`Optional`filterServices?: string[]

`Optional`filterTMS?: boolean

`Optional`filterWMTSPriority?: string[]

`Optional`maximumEntries?: number

`Optional`serviceOptions?: {
fields?: string[];
index?: string;
maximumResponses?: number;
size?: number;
url?: string;
}

`Optional`fields?: string[]

`Optional`index?: string

`Optional`maximumResponses?: number

`Optional`size?: number

`Optional`url?: string

`Optional`splitResults

`Optional`ssl

`Optional`zoomTo