Class: GeoCoder

GeoCoder

The Geo Coder control will display a user's address based on their physical location, or a static location using latitude and longitude coordinates can be used as well. This control needs to be used with the Map, OpenLayers API, and Geo Location controls.   A GeoCoder control provides the following configuration properties in Process Designer:

Location: Latitude and longitude of default location LatLong
Latitude Location latitude decimal
Longitude Location longitude decimal

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.requestAddressLookup(${Geolocation}.getData().latitude, ${GeoLocation}.getData().longitude)
On Address Requested:
Description: Triggers when an address is requested
Example:
console.log("Address requested")
On Address Resolved:
Description: Triggers when an address is returned.
Example:
${Location}.setText(address.formatted);
Context Variables address{object}
Properties streetNumber
route
locality
postalCode
country
components {locality, postal_code, country}
formatted
On Address Error:
Description: Triggers when there is an error getting the address.
Example:
${LocationErrorText}.setVisible(true)
Context Variables error {object}
Properties message
code
status
Articles
Geo Coder

new GeoCoder()

This constructor is never used explicitly.

Extends

Members

Methods

Add/replace CSS class(es) for this control
Name Type Description
name string CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced string optional CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.
Example
Button.addClass("green");

getLastAddressInfo(){string}

Get the information of the last address
Returns:
Type Description
string

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Propagates value change of control up through parent views
Name Type Description
event Event Value change event (usually an onchange event)
Returns:
Type Description
boolean True if a formula update was triggered on the control's parent, otherwise false
Example
MyView.propagateUp(event);
Broadcasts the expression trigger for the specified view
Name Type Default Description
phase int bpmext.ui.PHASE_NORMAL optional The phase we are currently in
Example
MyView.triggerFormulaUpdates();