geopf-extensions-openlayers
    Preparing search index...

    Class ReverseGeocode

    Hierarchy (View Summary)

    Index
    constructor
    _inputFeaturesSources _resultsDefaultStyle _resultsFeatures _resultsFeaturesLayer _resultsFeaturesSource _resultsSelectedStyle _uid collapsed container description disposed draggable element listable listenerKeys on once options un
    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

    • 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

      reversegeocode:compute

      reversegeocode:onclickresult

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

    _inputFeaturesSources

    _inputFeaturesSources: any

    _resultsDefaultStyle

    _resultsDefaultStyle: Style | undefined

    _resultsFeatures

    _resultsFeatures: Collection<any> | undefined

    _resultsFeaturesLayer

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

    _resultsFeaturesSource

    _resultsFeaturesSource: VectorSource<any> | undefined

    _resultsSelectedStyle

    _resultsSelectedStyle: Style | undefined

    _uid

    _uid: any
    collapsed: boolean | undefined

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

    container: HTMLElement
    description: any
    disposed: boolean

    The object has already been disposed.

    draggable: boolean | undefined

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

    element: HTMLElement
    listable: boolean
    listenerKeys: EventsKey[]
    on: ObjectOnSignature<EventsKey>
    once: ObjectOnSignature<EventsKey>
    options:
        | {
            collapsed: boolean;
            delimitations: string[];
            draggable: boolean;
            layerDescription: { description: string; title: string };
            resources: string[];
            reverseGeocodeOptions: {};
        }
        | undefined
    un: ObjectOnSignature<void>

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Protected

      Apply any properties from another object without triggering events.

      Parameters

      • source: BaseObject

        The source object.

      Returns void

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

      Returns void

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

    • Clean up.

      Returns void

    • Protected

      Extension point for disposable objects.

      Returns void

    • Gets a value.

      Parameters

      • key: string

        Key name.

      Returns any

      Value.

    • Get a list of object property names.

      Returns string[]

      List of property names.

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

    • Get the map associated with this control.

      Returns Map | null

      Map.

    • Get an object of all property names and values.

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

      Object.

    • Get an object of all property names and values.

      Returns Partial<NoInfer<{ [x: string]: any }>> | null

      Object.

    • Get the version number for this object. Each time the object is modified, its version number will be incremented.

      Returns number

      Revision.

    • Parameters

      • Optionaltype: string

        Type. If not provided, true will be returned if this event target has any listeners.

      Returns boolean

      Has listeners.

    • Returns boolean

      The object has properties.

    • Parameters

      • key: string

        Key name.

      • oldValue: any

        Old value.

      Returns void

    • Protected

      Parameters

      • type: string | string[]

        Type.

      • listener: (arg0: Event | BaseEvent) => unknown

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Protected

      Parameters

      • type: string | string[]

        Type.

      • listener: (arg0: Event | BaseEvent) => unknown

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Renders the control.

      Parameters

      • mapEvent: MapEvent

        Map event.

      Returns void

    • Sets a value.

      Parameters

      • key: string

        Key name.

      • value: any

        Value.

      • Optionalsilent: boolean

        Update without triggering an event.

      Returns 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

    • 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

    • Protected

      Unlisten for a certain type of event.

      Parameters

      • type: string | string[]

        Type.

      • listener: (arg0: Event | BaseEvent) => unknown

        Listener.

      Returns void

    • Unsets a property.

      Parameters

      • key: string

        Key name.

      • Optionalsilent: boolean

        Unset without triggering an event.

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods