Geo location

Displays a user's location on a map instead of a static location. It can be used with the Map and OpenLayers API views.

Geo Location

Monitoring mode:	When true the geolocation of the device is continuously monitored, when false the Timeout option determines how often the location is updated.\r\nNote\: This option can impact battery life {Once on Load \| Continuous \| Initially Stopped}	`GeoMonitoringMode`
High accuracy:	Enable high accuracy location detection. Note\: This option can impact battery life for mobile devices	`Boolean`
Timeout:	When true, specifies the timeout interval in ms. The default is 6000, i.e. 6 seconds	`Integer`
Max age of data:	The maximum age (in milliseconds) of the geolocation data. The default is 0 ms.	`Integer`

Events

On Load:

Description:	This event is triggered when the Geo Location control is loaded on the page
Example:	`me.calculateDistance(location.latitude, location.latitude, 15.13213, 15.455512);`

On Location Requested:

Description:	This event is triggered when there is a requested location
Example:	`me.getPollCount()`

On Location Resolved:

Description:	This event is triggered when a location is resolved.
Example:	`${Map}.setCenter(location.latitude, location.longitude)`

Context Variables	location
Properties	accuracy
	altitude
	altitudeAccuracy
	heading
	latitude
	longitude
	speed
	time
	timestamp

On Location Error:

Description:	This event is triggered when there is a error on finding a location or set of coordinates.
Example:	`if(error.code == 1){alert("You must allow Geolocation access in order to use this app");}`
Error Code:	{0 : Error Unknown \| 1: User denied request for Geolocation \| 2: Location information unavailable \| 3: Request to get user location timed out}

Context Variables	error
Properties	code
message text

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add/replace CSS class(es) for this control

Name	Type	Default	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}`		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");

calculateDistance(lat1, lon1, lat2, lon2) Returns: {decimal}

Calculates the difference between two sets of latitudes and longitudes

Name	Type	Default	Description
lat1	`{decimal}`		the first latitude
lon1	`{decimal}`		the first longitude
lat2	`{decimal}`		the second latitude
lon2	`{decimal}`		the second longitude

Inherited getData() Returns: {Object}

Retrieve bound data associated this view/control. Only works for views/controls with bound data.

Example

var dec1 = MyDecimal.getData();

getPollCount() Returns: {integer}

Gets the poll count

getType() Returns: {string}

Get descriptive string representing the type of control/section

Inherited isBound() Returns: {boolean}

Indicates bound status of control.

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagates value change of control up through parent views

Name	Type	Default	Description
event	`{Event}`		Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

requestUpdate()

Requests an update on the geo location

Inherited setViewData(data, createPseudoBinding)

Set/update bound data associated this view/control. Only works for views/controls with bound data.

Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options

Name	Type	Default	Description
data	`{Object}`		Value of bound data. The type of this parameter must match the type of the bound data.
createPseudoBinding	`{boolean}`		If set to true, creates a pseudo binding if there is no current binding.

Example

MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'

Inherited triggerFormulaUpdates([phase])

Broadcasts the expression trigger for the specified view

Name	Type	Default	Description
phase	`{int}`	bpmext.ui.PHASE_NORMAL	The phase we are currently in

Example

MyView.triggerFormulaUpdates();

Methods

Parent

Helpers