Class InseeAdvancedSearch

Hierarchy (View Summary)

AbstractAdvancedSearch
- InseeAdvancedSearch

Constructors

constructor

new InseeAdvancedSearch(
options?: AbstractAdvancedSearchOptions,
): InseeAdvancedSearch
Parameters
- Optionaloptions: AbstractAdvancedSearchOptions
  Options du contrôle.
Returns InseeAdvancedSearch
Overrides AbstractAdvancedSearch.constructor
- Defined in src/packages/Controls/SearchEngine/InseeAdvancedSearch.js:25

Properties

_inputPattern

_inputPattern: RegExp | undefined

btnGroup

btnGroup: HTMLDivElement | undefined

description

description: any

`Protected`disposed

disposed: boolean

The object has already been disposed.

element

element: HTMLFormElement

eraseBtn

eraseBtn: HTMLButtonElement | undefined

inputs

inputs: any[] | undefined

inseeInput

inseeInput: SearchEngineGeocodeIGN | undefined

listable

listable: boolean

`Protected`listenerKeys

listenerKeys: EventsKey[]

name

name: string | undefined

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

searchBtn

searchBtn: HTMLButtonElement | undefined

un

un: ObjectOnSignature<void>

Methods

`Protected`_initContainer

_initContainer(options: AbstractAdvancedSearchOptions): HTMLFormElement
Protected
Crée le conteneur DOM du formulaire.
Parameters
- options: AbstractAdvancedSearchOptions
  Options d'initialisation
Returns HTMLFormElement
Élément du formulaire
Inherited from AbstractAdvancedSearch._initContainer
- Defined in src/packages/Controls/SearchEngine/AbstractAdvancedSearch.js:96

`Protected`_initEvents

_initEvents(options: AbstractAdvancedSearchOptions): void
Protected
Initialise les événements DOM spécifiques.
Parameters
- options: AbstractAdvancedSearchOptions
  Options d'initialisation (transmises depuis le parent).
Returns void
Overrides AbstractAdvancedSearch._initEvents
- Defined in src/packages/Controls/SearchEngine/InseeAdvancedSearch.js:99

`Protected`_onErase

_onErase(e: any): void
Protected
Permet de supprimer les messages d'erreur, en plus du fonctionnement initial.
Parameters
- e: any
Returns void
Overrides AbstractAdvancedSearch._onErase
- Defined in src/packages/Controls/SearchEngine/InseeAdvancedSearch.js:115

`Protected`_onSearch

_onSearch(e: Event | PointerEvent): void
Protected
Handler de la recherche déclenchée (bouton / submit). Valide le code INSEE puis lance la recherche via le SearchEngine associé.
Parameters
- e: Event | PointerEvent
  Événement de recherche.
Returns void
Overrides AbstractAdvancedSearch._onSearch
- Defined in src/packages/Controls/SearchEngine/InseeAdvancedSearch.js:126

addChangeListener

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

addEventListener

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

`Protected`addInputs

addInputs(options: any): void
Protected
Ajoute les inputs spécifiques au contrôle (surcouche du parent). Crée et configure l'input INSEE.
Parameters
- options: any
  Options à passer au searchEngineGeocodeIGN
Returns void
Overrides AbstractAdvancedSearch.addInputs
- Defined in src/packages/Controls/SearchEngine/InseeAdvancedSearch.js:66

`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 AbstractAdvancedSearch.applyProperties
- Defined in node_modules/ol/Object.d.ts:172

changed

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

Returns void

Api
Inherited from AbstractAdvancedSearch.changed
- Defined in node_modules/ol/Observable.d.ts:74

dispatchEvent

dispatchEvent(event: string | BaseEvent): boolean | undefined
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 boolean | undefined
false if anyone called preventDefault on the event object or if any of the listeners returned false.

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

dispose

dispose(): void
Clean up.

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

`Protected`disposeInternal

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

Returns void
Inherited from AbstractAdvancedSearch.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 AbstractAdvancedSearch.get
- Defined in node_modules/ol/Object.d.ts:114

getContent

getContent(): HTMLFormElement
Retourne le formulaire de la recherche avancée

Returns HTMLFormElement
Formulaire de la recherche
Inherited from AbstractAdvancedSearch.getContent
- Defined in src/packages/Controls/SearchEngine/AbstractAdvancedSearch.js:85

getKeys

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

Returns string[]
List of property names.

Api
Inherited from AbstractAdvancedSearch.getKeys
- Defined in node_modules/ol/Object.d.ts:120

getListeners

getListeners(type: string): Listener[] | undefined
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 Listener[] | undefined
Listeners.
Inherited from AbstractAdvancedSearch.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getMap

getMap(): Map | null
Get the map associated with this control.

Returns Map | null
Map.

Api
Inherited from AbstractAdvancedSearch.getMap
- Defined in node_modules/ol/control/Control.d.ts:94

getName

getName(): string
Retourne le nom du la recherche avancée

Returns string
Nom de la recherche avancée
Inherited from AbstractAdvancedSearch.getName
- Defined in src/packages/Controls/SearchEngine/AbstractAdvancedSearch.js:77

getProperties

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

Returns NoInfer<{ [x: string]: any }>
Object.

Api
Inherited from AbstractAdvancedSearch.getProperties
- Defined in node_modules/ol/Object.d.ts:126

getPropertiesInternal

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

Returns Partial<NoInfer<{ [x: string]: any }>> | null
Object.
Inherited from AbstractAdvancedSearch.getPropertiesInternal
- Defined in node_modules/ol/Object.d.ts:131

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 AbstractAdvancedSearch.getRevision
- Defined in node_modules/ol/Observable.d.ts:81

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 AbstractAdvancedSearch.hasListener
- Defined in node_modules/ol/events/Target.d.ts:75

hasProperties

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

`Protected`initialize

initialize(options: AbstractAdvancedSearchOptions): void
Protected
Parameters
- options: AbstractAdvancedSearchOptions
  Options de recherche avancée
Returns void
Overrides AbstractAdvancedSearch.initialize
- Defined in src/packages/Controls/SearchEngine/InseeAdvancedSearch.js:44

notify

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

`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 AbstractAdvancedSearch.onceInternal
- Defined in node_modules/ol/Observable.d.ts:95

`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 AbstractAdvancedSearch.onInternal
- Defined in node_modules/ol/Observable.d.ts:88

removeChangeListener

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

removeEventListener

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

render

render(mapEvent: MapEvent): void
Renders the control.
Parameters
- mapEvent: MapEvent
  Map event.
Returns void

Api
Inherited from AbstractAdvancedSearch.render
- Defined in node_modules/ol/control/Control.d.ts:88

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 AbstractAdvancedSearch.set
- Defined in node_modules/ol/Object.d.ts:158

setMap

setMap(map: any): void
Remove the control from its current map and attach it to the new map. Pass null to just remove the control from the current map. Subclasses may set up event handlers to get notified about changes to the map here.
Parameters
- map: any
  Map.
Returns void

Api
Inherited from AbstractAdvancedSearch.setMap
- Defined in src/packages/Controls/SearchEngine/AbstractAdvancedSearch.js:47

setPosition

setPosition(pos: any): void
Parameters
- pos: any
Returns void
Inherited from AbstractAdvancedSearch.setPosition
- Defined in src/packages/Controls/Control.js:27

setProperties

setProperties(values: Partial<NoInfer<Properties>>, 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: Partial<NoInfer<Properties>>
  Values.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void

Api
Inherited from AbstractAdvancedSearch.setProperties
- Defined in node_modules/ol/Object.d.ts:166

setTarget

setTarget(target: string | HTMLElement): void
This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.
Parameters
- target: string | HTMLElement
  Target.
Returns void

Api
Inherited from AbstractAdvancedSearch.setTarget
- Defined in node_modules/ol/control/Control.d.ts:113

`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 AbstractAdvancedSearch.unInternal
- Defined in node_modules/ol/Observable.d.ts:102

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 AbstractAdvancedSearch.unset
- Defined in node_modules/ol/Object.d.ts:179

updatePosition

updatePosition(pos: any): void
Parameters
- pos: any
Returns void
Inherited from AbstractAdvancedSearch.updatePosition
- Defined in src/packages/Controls/Control.js:34

Class InseeAdvancedSearch

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InseeAdvancedSearch

Properties

_inputPattern

btnGroup

description

Protecteddisposed

element

eraseBtn

inputs

inseeInput

listable

ProtectedlistenerKeys

name

on

once

searchBtn

un

Methods

Protected_initContainer

Parameters

Returns HTMLFormElement

Protected_initEvents

Parameters

Returns void

Protected_onErase

Parameters

Returns void

Protected_onSearch

Parameters

Returns void

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

ProtectedaddInputs

Parameters

Returns void

ProtectedapplyProperties

Parameters

Returns void

changed

Returns void

Api

dispatchEvent

Parameters

Returns boolean | undefined

Api

dispose

Returns void

ProtecteddisposeInternal

Returns void

get

Parameters

Returns any

Api

getContent

Returns HTMLFormElement

getKeys

Returns string[]

Api

getListeners

Parameters

Returns Listener[] | undefined

getMap

Returns Map | null

Api

getName

Returns string

getProperties

`Protected`disposed

`Protected`listenerKeys

`Protected`_initContainer

`Protected`_initEvents

`Protected`_onErase

`Protected`_onSearch

`Protected`addInputs

`Protected`applyProperties

`Protected`disposeInternal

`Protected`initialize

`Protected`onceInternal

`Protected`onInternal

`Protected`unInternal