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

advancedSearch? apiKey? autocompleteOptions? collapsed? collapsible? coordinateSearch? coordinateSearchInAdvancedSearch? direction? displayButtonAdvancedSearch? displayButtonClose? displayButtonCoordinateSearch? displayButtonGeolocate? displayMarker? geocodeOptions? id? markerStyle? markerUrl? placeholder? resources? searchOptions? splitResults? ssl? zoomTo?

Properties

OptionaladvancedSearch

advancedSearch?: { target?: HTMLElement }

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

Type declaration

  • Optionaltarget?: HTMLElement

    Cible d'affichage des résultats

OptionalapiKey

apiKey?: string

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

OptionalautocompleteOptions

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

Optionalcollapsed

collapsed?: boolean

Mode réduit (true par défaut)

Optionalcollapsible

collapsible?: boolean

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

OptionalcoordinateSearch

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

OptionalcoordinateSearchInAdvancedSearch

coordinateSearchInAdvancedSearch?: boolean

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

Optionaldirection

direction?: string

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

OptionaldisplayButtonAdvancedSearch

displayButtonAdvancedSearch?: boolean

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

OptionaldisplayButtonClose

displayButtonClose?: boolean

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

OptionaldisplayButtonCoordinateSearch

displayButtonCoordinateSearch?: boolean

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

OptionaldisplayButtonGeolocate

displayButtonGeolocate?: boolean

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

OptionaldisplayMarker

displayMarker?: boolean

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

OptionalgeocodeOptions

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

Optionalid

id?: number

Identifiant du widget (option avancée)

OptionalmarkerStyle

markerStyle?: string

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

OptionalmarkerUrl

markerUrl?: string

URL du marqueur (prioritaire sur markerStyle)

Optionalplaceholder

placeholder?: string

Placeholder de la barre de recherche

Optionalresources

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)

OptionalsearchOptions

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

OptionalsplitResults

splitResults?: boolean

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

Optionalssl

ssl?: boolean

Utilisation du protocole https (true par défaut)

OptionalzoomTo

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; }

Settings

Member Visibility

On This Page

Properties