Class ReverseGeocode

Hierarchy (View Summary)

Constructors

constructor

Properties

_inputFeaturesSources _resultsDefaultStyle _resultsFeatures _resultsFeaturesLayer _resultsFeaturesSource _resultsSelectedStyle _uid collapsed container description disposed draggable element listable listenerKeys on once options un

Methods

addChangeListener addEventListener applyProperties changed dispatchEvent dispose disposeInternal get getCollapsed getContainer getData getKeys getListeners getMap getProperties getPropertiesInternal getRevision hasListener hasProperties notify onceInternal onInternal removeChangeListener removeEventListener render set setCollapsed setMap setPosition setProperties setTarget unInternal unset updatePosition

Constructors

constructor

  • new ReverseGeocode(
        options: {
            apiKey?: string;
            collapsed?: boolean;
            delimitations?: any;
            draggable?: boolean;
            id?: number;
            layerDescription?: { description?: string; title?: string };
            resources?: any;
            reverseGeocodeOptions?: any;
            ssl?: string;
        },
    ): ReverseGeocode

    Parameters

    • options: {
          apiKey?: string;
          collapsed?: boolean;
          delimitations?: any;
          draggable?: boolean;
          id?: number;
          layerDescription?: { description?: string; title?: string };
          resources?: any;
          reverseGeocodeOptions?: any;
          ssl?: string;
      }

      ReverseGeocode control options

      • OptionalapiKey?: string

        API key for services call (reverse geocode service). The key "calcul" is used by default.

      • Optionalcollapsed?: boolean

        Specify if widget has to be collapsed (true) or not (false) on map loading. Default is true.

      • Optionaldelimitations?: any

        delimitations for reverse geocoding, by default : ["Point", "Circle", "Extent"]. Possible values are : "Point", "Circle", "Extent". Delimitations will be displayed in the same order in widget list.

      • Optionaldraggable?: boolean

        Specify if widget is draggable

      • Optionalid?: number

        Ability to add an identifier on the widget (advanced option)

      • OptionallayerDescription?: { description?: string; title?: string }

        Layer informations to be displayed in LayerSwitcher widget (only if a LayerSwitcher is also added to the map)

        • Optionaldescription?: string

          Layer description to be displayed in LayerSwitcher

        • Optionaltitle?: string

          Layer title to be displayed in LayerSwitcher

      • Optionalresources?: any

        resources for geocoding, by default : ["StreetAddress", "PositionOfInterest", "CadastralParcel"]. Possible values are : "StreetAddress", "PositionOfInterest", "CadastralParcel". Resources will be displayed in the same order in widget list.

      • OptionalreverseGeocodeOptions?: any

        reverse geocode service options. see Gp.Services.reverseGeocode() to know all reverse geocode options.

      • Optionalssl?: string

        use of ssl or not (default true, service requested using https protocol)

    Returns ReverseGeocode

    Fires

    reversegeocode:compute

    Fires

    reversegeocode:onclickresult

    Example

    var iso = ol.control.ReverseGeocode({
         "collapsed" : false,
         "draggable" : true,
         "resources" : ["StreetAddress", "PositionOfInterest"],
         "delimitations" : ["Point", "Circle"],
         "reverseGeocodeOptions" : {}
     });

Properties

_inputFeaturesSources

_inputFeaturesSources: any

_resultsDefaultStyle

_resultsDefaultStyle: undefined | Style

_resultsFeatures

_resultsFeatures: undefined | Collection<any>

_resultsFeaturesLayer

_resultsFeaturesLayer: undefined | null | VectorLayer<VectorSource<any>, any>

_resultsFeaturesSource

_resultsFeaturesSource: undefined | VectorSource<any>

_resultsSelectedStyle

_resultsSelectedStyle: undefined | Style

_uid

_uid: any

collapsed

collapsed: undefined | boolean

{Boolean} specify if reverseGeocoding control is collapsed (true) or not (false)

container

container: HTMLElement

description

description: any

Protecteddisposed

disposed: boolean

The object has already been disposed.

draggable

draggable: undefined | boolean

{Boolean} specify if reverseGeocoding control is draggable (true) or not (false)

element

element: HTMLElement

listable

listable: boolean

ProtectedlistenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | undefined
    | {
        collapsed: boolean;
        delimitations: string[];
        draggable: boolean;
        layerDescription: { description: string; title: string };
        resources: string[];
        reverseGeocodeOptions: {};
    }

un

un: ObjectOnSignature<void>

Methods

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

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

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

getCollapsed

getContainer

getData

getKeys

  • getKeys(): string[]

    Get a list of object property names.

    Returns string[]

    List of property names.

    Api

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

setCollapsed

setMap

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