Class SearchEngineAdvanced

Hierarchy (View Summary)

Constructors

constructor

Properties

_popupBtns _popupContent _popupDiv _searchForms advancedBtn advancedContainer baseSearchEngine description disposed element eraseBtn geolocation layer listable listenerKeys listenToClick locationBtn on once popup selectInteraction un

Methods

_createCustomPopupButton _onDocumentClick _setPopupInfo addChangeListener addEventListener addResultToMap applyProperties changed closeAllSections createEvent dispatchEvent dispose disposeInternal get getKeys getLayer getListeners getMap getProperties getPropertiesInternal getRevision hasListener hasProperties notify onceInternal onInternal removeChangeListener removeEventListener render set setMap setPopupContent setPosition setProperties setTarget unInternal unset updatePosition

Constructors

constructor

Properties

_popupBtns

_popupBtns: undefined | HTMLDivElement

_popupContent

_popupContent: undefined | HTMLDivElement

_popupDiv

_popupDiv: undefined | HTMLDivElement

_searchForms

_searchForms: AbstractAdvancedSearch[]

advancedBtn

advancedBtn: undefined | HTMLButtonElement

advancedContainer

advancedContainer: undefined | HTMLDivElement

baseSearchEngine

baseSearchEngine: undefined | SearchEngineGeocodeIGN

description

description: any

Protecteddisposed

disposed: boolean

The object has already been disposed.

Protectedelement

element: HTMLElement

eraseBtn

eraseBtn: undefined | HTMLButtonElement

geolocation

geolocation: Geolocation

layer

layer: VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>>

listable

listable: boolean

ProtectedlistenerKeys

listenerKeys: EventsKey[]

listenToClick

listenToClick: undefined | boolean

Si vrai, écoute les clics sur le document pour gérer la modale de recherche avancée

locationBtn

locationBtn: undefined | HTMLButtonElement

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

popup

popup: Overlay

selectInteraction

selectInteraction: Select

un

un: ObjectOnSignature<void>

Methods

_createCustomPopupButton

_onDocumentClick

_setPopupInfo

addChangeListener

  • addChangeListener(key: string, listener: Listener): void

    Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

addEventListener

  • addEventListener(type: string, listener: Listener): void

    Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

addResultToMap

ProtectedapplyProperties

  • applyProperties(source: BaseObject): void
    Protected

    Apply any properties from another object without triggering events.

    Parameters

    • source: BaseObject

      The source object.

    Returns void

changed

  • changed(): void

    Increases the revision counter and dispatches a 'change' event.

    Returns void

    Api

closeAllSections

createEvent

  • createEvent(obj: any, info?: string): any

    Crée un événement de recherche à partir d'un objet (Feature ou Point).

    Parameters

    • obj: any

      Objet à afficher (Feature ou Point)

    • Optionalinfo: string

      Texte affiché dans la popup

    Returns any

    Événement normalisé de type "search"

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

dispose

  • dispose(): void

    Clean up.

    Returns void

ProtecteddisposeInternal

  • disposeInternal(): void
    Protected

    Extension point for disposable objects.

    Returns void

get

  • get(key: string): any

    Gets a value.

    Parameters

    • key: string

      Key name.

    Returns any

    Value.

    Api

getKeys

  • getKeys(): string[]

    Get a list of object property names.

    Returns string[]

    List of property names.

    Api

getLayer

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.

getMap

  • getMap(): null | Map

    Get the map associated with this control.

    Returns null | Map

    Map.

    Api

getProperties

  • getProperties(): { [x: string]: any }

    Get an object of all property names and values.

    Returns { [x: string]: any }

    Object.

    Api

getPropertiesInternal

  • getPropertiesInternal(): null | { [x: string]: any }

    Get an object of all property names and values.

    Returns null | { [x: string]: any }

    Object.

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

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.

hasProperties

  • hasProperties(): boolean

    Returns boolean

    The object has properties.

notify

  • notify(key: string, oldValue: any): void

    Parameters

    • key: string

      Key name.

    • oldValue: any

      Old value.

    Returns void

ProtectedonceInternal

  • 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.

ProtectedonInternal

  • 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.

removeChangeListener

  • removeChangeListener(key: string, listener: Listener): void

    Parameters

    • key: string

      Key name.

    • listener: Listener

      Listener.

    Returns void

removeEventListener

  • removeEventListener(type: string, listener: Listener): void

    Parameters

    • type: string

      Type.

    • listener: Listener

      Listener.

    Returns void

render

  • render(mapEvent: MapEvent): void

    Renders the control.

    Parameters

    • mapEvent: MapEvent

      Map event.

    Returns void

    Api

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

setMap

setPopupContent

setPosition

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

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

ProtectedunInternal

  • 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

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

updatePosition

Settings

Member Visibility

On This Page

Constructors
Properties
Methods