Class LocationSelector

Hierarchy

Control
- LocationSelector

Constructors

constructor

new LocationSelector(
    options?: {
        apiKey?: string;
        autocompleteOptions?: any;
        displayInfo?: boolean;
        ssl?: boolean;
        tag?: {
            addOption?: boolean;
            display?: boolean;
            groupId?: number;
            id?: number;
            label?: string;
            markerOpts?: { offset?: any[]; url?: string };
            removeOption?: boolean;
        };
    },
): LocationSelector
Parameters
- Optionaloptions: {
      apiKey?: string;
      autocompleteOptions?: any;
      displayInfo?: boolean;
      ssl?: boolean;
      tag?: {
          addOption?: boolean;
          display?: boolean;
          groupId?: number;
          id?: number;
          label?: string;
          markerOpts?: { offset?: any[]; url?: string };
          removeOption?: boolean;
      };
  }
  component options
  - OptionalapiKey?: string
    API key for autocomplete service call. The key "calcul" is used by default.
  - OptionalautocompleteOptions?: any
    autocomplete service options (see Gp.Services.autoComplete() to know all autocomplete options)
  - OptionaldisplayInfo?: boolean
    whether to display info in a popup or not (not implemented yet) Default is true
  - Optionalssl?: boolean
    use of ssl or not (default true, service requested using https protocol)
  - Optionaltag?: {
        addOption?: boolean;
        display?: boolean;
        groupId?: number;
        id?: number;
        label?: string;
        markerOpts?: { offset?: any[]; url?: string };
        removeOption?: boolean;
    }
    tag options
    
    OptionaladdOption?: boolean
    whether to display picto to add another LocationSelector (in case of route control)
    
    Optionaldisplay?: boolean
    whether to display or hide component. Default is true
    
    OptionalgroupId?: number
    locationSelector global component id (in case locationSelector is called by another graphic component, e.g. route control)
    
    Optionalid?: number
    order id number in a locations group, in case several LocationSelector are used. For instance in route case : departure tag id should be 0, arrival tag id should be 1, and other ones : 2, 3, ...
    
    Optionallabel?: string
    text to display in component (e.g. "Departure"). Default is ">"
    
    OptionalmarkerOpts?: { offset?: any[]; url?: string }
    options to use your own marker. Default is a lightOrange marker.
    
    Optionaloffset?: any[]
    Offsets in pixels used when positioning the overlay. The first element in the array is the horizontal offset. A positive value shifts the overlay right. The second element in the array is the vertical offset. A positive value shifts the overlay down. Default is [0, 0]. (see ol.Overlay)
    
    Optionalurl?: string
    marker base64 encoded url (ex "data:image/png;base64,...""). Mandatory for a custom marker
    
    OptionalremoveOption?: boolean
    whether to display picto to remove a LocationSelector (in case of route control)
Returns LocationSelector
Example
```
var locationselector = new LocationSelector({
     apiKey : "",
     tag : {
        id : 1,
        groupId : null,
        label : "Départ",
        markerOpts : {
             url : "...",
             offset : [0,0]
        },
        display : true
     },
     autocompleteOptions : {}
 });
```
Overrides Control.constructor
- Defined in src/packages/Controls/LocationSelector/LocationSelector.js:65

Properties

_container

_container: HTMLElement

_uid

_uid: undefined | number

uuid

`Protected`disposed

disposed: boolean

The object has already been disposed.

element

element: HTMLElement

listenerKey

listenerKey: undefined | null | EventsKey

`Protected`listenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | undefined
    | {
        autocompleteOptions: {};
        displayInfo: boolean;
        tag: {
            addOption: boolean;
            display: boolean;
            groupId: null;
            id: number;
            label: string;
            removeOption: boolean;
        };
    }

un

un: ObjectOnSignature<void>

Methods

addChangeListener

addChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from Control.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 Control.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 Control.applyProperties
- Defined in node_modules/ol/Object.d.ts:175

changed

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

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

clear

clear(): void
clean all and input

Returns void
- Defined in src/packages/Controls/LocationSelector/LocationSelector.js:261

clearResults

clearResults(): void
clear all results and the marker.

Returns void
- Defined in src/packages/Controls/LocationSelector/LocationSelector.js:269

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 Control.dispatchEvent
- Defined in node_modules/ol/events/Target.d.ts:61

dispose

dispose(): void
Clean up.

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

`Protected`disposeInternal

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

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

getCoordinate

getCoordinate(): any[]
get coordinate

Returns any[]
this._coordinate - point coordinate (EPSG:4326) : [lon, lat]
- Defined in src/packages/Controls/LocationSelector/LocationSelector.js:231

getKeys

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

Returns string[]
List of property names.

Api
Inherited from Control.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 Control.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getMap

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

Returns null | Map
Map.

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

getProperties

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

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

Api
Inherited from Control.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 Control.getPropertiesInternal
- Defined in node_modules/ol/Object.d.ts:130

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

hasProperties

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

notify

notify(key: string, oldValue: any): void
Parameters
- key: string
  Key name.
- oldValue: any
  Old value.
Returns void
Inherited from Control.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 Control.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 Control.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 Control.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 Control.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 Control.render
- Defined in node_modules/ol/control/Control.d.ts:86

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

setCoordinate

setCoordinate(coordinate: any, crs: string): void
set coordinate
Parameters
- coordinate: any
  Coordinate in the map projection by default, otherwise, the projection is entered in the following parameter
- crs: string
  Coordinate projection
Returns void
- Defined in src/packages/Controls/LocationSelector/LocationSelector.js:240

setMap

setMap(map: null | Map): 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: null | Map
  Map.
Returns void
Api
Inherited from Control.setMap
- Defined in node_modules/ol/control/Control.d.ts:101

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 Control.setProperties
- Defined in node_modules/ol/Object.d.ts:167

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 Control.setTarget
- Defined in node_modules/ol/control/Control.d.ts:111

`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 Control.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 Control.unset
- Defined in node_modules/ol/Object.d.ts:182

Class LocationSelector

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalapiKey?: string

OptionalautocompleteOptions?: any

OptionaldisplayInfo?: boolean

Optionalssl?: boolean

Optionaltag?: { addOption?: boolean; display?: boolean; groupId?: number; id?: number; label?: string; markerOpts?: { offset?: any[]; url?: string }; removeOption?: boolean;}

OptionaladdOption?: boolean

Optionaldisplay?: boolean

OptionalgroupId?: number

Optionalid?: number

Optionallabel?: string

OptionalmarkerOpts?: { offset?: any[]; url?: string }

Optionaloffset?: any[]

Optionalurl?: string

OptionalremoveOption?: boolean

Returns LocationSelector

Example

Properties

_container

_uid

Protecteddisposed

element

listenerKey

ProtectedlistenerKeys

on

once

options

un

Methods

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

ProtectedapplyProperties

Parameters

Returns void

changed

Returns void

Api

clear

Returns void

clearResults

Returns void

dispatchEvent

Parameters

Returns undefined | boolean

Api

dispose

Returns void

ProtecteddisposeInternal

Returns void

get

Parameters

Returns any

Api

getCoordinate

Returns any[]

getKeys

Returns string[]

Api

getListeners

Parameters

Returns undefined | Listener[]

getMap

Returns null | Map

Api

getProperties

Returns { [x: string]: any }

Api

getPropertiesInternal

`Optional`apiKey?: string

`Optional`autocompleteOptions?: any

`Optional`displayInfo?: boolean

`Optional`ssl?: boolean

`Optional`tag?: {
addOption?: boolean;
display?: boolean;
groupId?: number;
id?: number;
label?: string;
markerOpts?: { offset?: any[]; url?: string };
removeOption?: boolean;
}

`Optional`addOption?: boolean

`Optional`display?: boolean

`Optional`groupId?: number

`Optional`id?: number

`Optional`label?: string

`Optional`markerOpts?: { offset?: any[]; url?: string }

`Optional`offset?: any[]

`Optional`url?: string

`Optional`removeOption?: boolean

`Protected`disposed

`Protected`listenerKeys

`Protected`applyProperties

`Protected`disposeInternal

`Protected`onceInternal

`Protected`onInternal

`Protected`unInternal