Class IGNSearchService

Hierarchy (View Summary)

AbstractSearchService
- IGNSearchService

Constructors

constructor

new IGNSearchService(options: AbstractSearchServiceOptions): IGNSearchService
Constructeur du service IGN.
Parameters
- options: AbstractSearchServiceOptions
  Options du service IGN (clé API, index, etc.)
Returns IGNSearchService
Overrides AbstractSearchService.constructor
- Defined in src/packages/Services/IGNSearchService.js:33

Properties

_autocompleteLocations

_autocompleteLocations: undefined | any[]

_currentGeocodingLocation

_currentGeocodingLocation: string

Label du géocodage / de la recherche

_locations

_locations: undefined | any[]

_suggestedLocations

_suggestedLocations: AutocompleteResult[]

Liste de résultats d'autocomplétion

_triggerHandler

_triggerHandler: undefined | null | Timeout

AUTOCOMPLETE_EVENT

AUTOCOMPLETE_EVENT: undefined | string

`Protected`disposed

disposed: boolean

The object has already been disposed.

ERROR_EVENT

ERROR_EVENT: undefined | string

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | undefined
    | {
        autocomplete: boolean;
        autocompleteOptions: {
            prettifyResults: boolean;
            serviceOptions: { maximumResponses: number };
            triggerDelay: number;
            triggerGeocode: boolean;
        };
        geocodeOptions: { serviceOptions: {} };
        searchOptions: {
            filterLayers: boolean;
            maximumEntries: number;
            serviceOptions: { maximumResponses: number };
        };
    }

SEARCH_EVENT

SEARCH_EVENT: undefined | string

un

un: ObjectOnSignature<void>

Methods

_clearResults

_clearResults(): void
Returns void
- Defined in src/packages/Services/IGNSearchService.js:393

_onFailureAutoComplete

_onFailureAutoComplete(error: ErrorService): void
Fonction appelée en cas d'erreur sur le service d'autocomplétion
Parameters
- error: ErrorService
  Erreur renvoyée par le service
Returns void
- Defined in src/packages/Services/IGNSearchService.js:270

_onFailureSearch

_onFailureSearch(location: AutocompleteResult, error: ErrorService): void
Fonction appelée en cas d'erreur renvoyée par le service de géocodage.
Parameters
- location: AutocompleteResult
  Localisation de l'autocomplétion.
- error: ErrorService
  Erreur renvoyée par le service.
Returns void
- Defined in src/packages/Services/IGNSearchService.js:626

_onSuccessAutoComplete

_onSuccessAutoComplete(
results: { suggestedLocations: AutocompleteResult[] },
): void
Fonction appelée en cas de succès de l'autocomplétion.
Parameters
- results: { suggestedLocations: AutocompleteResult[] }
  Résultats de la requête.
  - suggestedLocations: AutocompleteResult[]
    Tableau de suggestions.
Returns void
- Defined in src/packages/Services/IGNSearchService.js:223

addChangeListener

addChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from AbstractSearchService.addChangeListener
- Defined in node_modules/ol/Object.d.ts:146

addEventListener

addEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from AbstractSearchService.addEventListener
- Defined in node_modules/ol/events/Target.d.ts:50

`Protected`applyProperties

applyProperties(source: BaseObject): void
Protected
Apply any properties from another object without triggering events.
Parameters
- source: BaseObject
  The source object.
Returns void
Inherited from AbstractSearchService.applyProperties
- Defined in node_modules/ol/Object.d.ts:175

autocomplete

autocomplete(value: string): void
Lance une autocomplétion via le service IGN.
Parameters
- value: string
  Texte à envoyer
Returns void
Overrides AbstractSearchService.autocomplete
- Defined in src/packages/Services/IGNSearchService.js:148

changed

changed(): void
Increases the revision counter and dispatches a 'change' event.

Returns void
Api
Inherited from AbstractSearchService.changed
- Defined in node_modules/ol/Observable.d.ts:65

dispatchEvent

dispatchEvent(event: string | BaseEvent): undefined | boolean
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.
Parameters
- event: string | BaseEvent
  Event object.
Returns undefined | boolean
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Api
Inherited from AbstractSearchService.dispatchEvent
- Defined in node_modules/ol/events/Target.d.ts:61

dispose

dispose(): void
Clean up.

Returns void
Inherited from AbstractSearchService.dispose
- Defined in node_modules/ol/Disposable.d.ts:19

`Protected`disposeInternal

disposeInternal(): void
Protected
Extension point for disposable objects.

Returns void
Inherited from AbstractSearchService.disposeInternal
- Defined in node_modules/ol/Disposable.d.ts:24

get

get(key: string): any
Gets a value.
Parameters
- key: string
  Key name.
Returns any
Value.

Api
Inherited from AbstractSearchService.get
- Defined in node_modules/ol/Object.d.ts:111

getAutocompleteLocations

getAutocompleteLocations(
index?: number,
): AutocompleteResult | AutocompleteResult[]
Récupère la liste des résultats d'autocomplétion.
Parameters
- Optionalindex: number
  Index du résultat (optionnel). Si non fourni, retourne tous les résultats.
Returns AutocompleteResult | AutocompleteResult[]
Un tableau de résultats ou un résultat unique
Inherited from AbstractSearchService.getAutocompleteLocations
- Defined in src/packages/Services/AbstractSearchService.js:69

getItemTitle

getItemTitle(obj: AutocompleteResult): string
Parameters
- obj: AutocompleteResult
  Objet dont le titre dérive
Returns string
Titre à afficher
Overrides AbstractSearchService.getItemTitle
- Defined in src/packages/Services/IGNSearchService.js:169

getKeys

getKeys(): string[]
Get a list of object property names.

Returns string[]
List of property names.

Api
Inherited from AbstractSearchService.getKeys
- Defined in node_modules/ol/Object.d.ts:117

getListeners

getListeners(type: string): undefined | Listener[]
Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.
Parameters
- type: string
  Type.
Returns undefined | Listener[]
Listeners.
Inherited from AbstractSearchService.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getProperties

getProperties(): { [x: string]: any }
Get an object of all property names and values.

Returns { [x: string]: any }
Object.

Api
Inherited from AbstractSearchService.getProperties
- Defined in node_modules/ol/Object.d.ts:123

getPropertiesInternal

getPropertiesInternal(): null | { [x: string]: any }
Get an object of all property names and values.

Returns null | { [x: string]: any }
Object.
Inherited from AbstractSearchService.getPropertiesInternal
- Defined in node_modules/ol/Object.d.ts:130

getResult

getResult(index?: number): SearchResult | SearchResult[]
Récupère la liste des résultats de recherche finale.
Parameters
- Optionalindex: number
  Index du résultat (optionnel). Si non fourni, retourne tous les résultats.
Returns SearchResult | SearchResult[]
Un tableau de résultats ou un résultat unique
Inherited from AbstractSearchService.getResult
- Defined in src/packages/Services/AbstractSearchService.js:82

getResultFeatures

getResultFeatures(index: number): any
Get features based on current search result
Parameters
- index: number
  Index of the result
Returns any
Object containing feature and extent (if any)
- Defined in src/packages/Services/IGNSearchService.js:546

getRevision

getRevision(): number
Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns number
Revision.

Api
Inherited from AbstractSearchService.getRevision
- Defined in node_modules/ol/Observable.d.ts:72

hasListener

hasListener(type?: string): boolean
Parameters
- Optionaltype: string
  Type. If not provided, true will be returned if this event target has any listeners.
Returns boolean
Has listeners.
Inherited from AbstractSearchService.hasListener
- Defined in node_modules/ol/events/Target.d.ts:75

hasProperties

hasProperties(): boolean
Returns boolean
The object has properties.
Inherited from AbstractSearchService.hasProperties
- Defined in node_modules/ol/Object.d.ts:136

`Protected`initialize

initialize(options: AbstractSearchServiceOptions): void
Protected
Initialise le service avec les options fournies.
Parameters
- options: AbstractSearchServiceOptions
  Options de configuration du service
Returns void
Overrides AbstractSearchService.initialize
- Defined in src/packages/Services/IGNSearchService.js:57

notify

notify(key: string, oldValue: any): void
Parameters
- key: string
  Key name.
- oldValue: any
  Old value.
Returns void
Inherited from AbstractSearchService.notify
- Defined in node_modules/ol/Object.d.ts:141

`Protected`onceInternal

onceInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from AbstractSearchService.onceInternal
- Defined in node_modules/ol/Observable.d.ts:86

`Protected`onInternal

onInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from AbstractSearchService.onInternal
- Defined in node_modules/ol/Observable.d.ts:79

removeChangeListener

removeChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from AbstractSearchService.removeChangeListener
- Defined in node_modules/ol/Object.d.ts:151

removeEventListener

removeEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from AbstractSearchService.removeEventListener
- Defined in node_modules/ol/events/Target.d.ts:80

`Abstract`search

search(object: IGNSearchObject): void
Lance une recherche sur les services de géocodage de l'IGN
Parameters
- object: IGNSearchObject
  Recherche
Returns void
See
- https://data.geopf.fr/geocodage/search
- https://data.geopf.fr/geocodage/openapi
Overrides AbstractSearchService.search
- Defined in src/packages/Services/IGNSearchService.js:405

set

set(key: string, value: any, silent?: boolean): void
Sets a value.
Parameters
- key: string
  Key name.
- value: any
  Value.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void
Api
Inherited from AbstractSearchService.set
- Defined in node_modules/ol/Object.d.ts:159

setProperties

setProperties(values: { [x: string]: any }, silent?: boolean): void
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Parameters
- values: { [x: string]: any }
  Values.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void
Api
Inherited from AbstractSearchService.setProperties
- Defined in node_modules/ol/Object.d.ts:167

`Protected`unInternal

unInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): void
Protected
Unlisten for a certain type of event.
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns void
Inherited from AbstractSearchService.unInternal
- Defined in node_modules/ol/Observable.d.ts:93

unset

unset(key: string, silent?: boolean): void
Unsets a property.
Parameters
- key: string
  Key name.
- Optionalsilent: boolean
  Unset without triggering an event.
Returns void
Api
Inherited from AbstractSearchService.unset
- Defined in node_modules/ol/Object.d.ts:182

Class IGNSearchService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IGNSearchService

Properties

_autocompleteLocations

_currentGeocodingLocation

_locations

_suggestedLocations

_triggerHandler

AUTOCOMPLETE_EVENT

Protecteddisposed

ERROR_EVENT

on

once

options

SEARCH_EVENT

un

Methods

_clearResults

Returns void

_onFailureAutoComplete

Parameters

Returns void

_onFailureSearch

Parameters

Returns void

_onSuccessAutoComplete

Parameters

suggestedLocations: AutocompleteResult[]

Returns void

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

ProtectedapplyProperties

Parameters

Returns void

autocomplete

Parameters

Returns void

changed

Returns void

Api

dispatchEvent

Parameters

Returns undefined | boolean

Api

dispose

Returns void

ProtecteddisposeInternal

Returns void

get

Parameters

Returns any

Api

getAutocompleteLocations

Parameters

Returns AutocompleteResult | AutocompleteResult[]

getItemTitle

Parameters

Returns string

getKeys

Returns string[]

Api

getListeners

Parameters

Returns undefined | Listener[]

getProperties

Returns { [x: string]: any }

Api

getPropertiesInternal

`Protected`disposed

`Protected`applyProperties

`Protected`disposeInternal

`Protected`initialize

`Protected`onceInternal

`Protected`onInternal

`Abstract`search

`Protected`unInternal