Class: Map

Map

The Map and Google API controls will allow the use of a map to be placed on a Coach, a static location can be set or the user's location can be used.  To get a user's location, a Geo Location control must be used. A Map control provides the following configuration properties in Process Designer:

Behavior
Disable Panning: Disables map panning boolean
Hide Zoom Control: Hides the zoom control, preventing zooming in and out boolean
Hide Map Type Control: Prevents the user from changing map type boolean
Hide Scale Control: Hides the scale from view boolean
Hide Rotate Control: Prevent users from rotating the map boolean
Show Marker: This is to indicate whether to show the marker or not (note: must set longitude and latitude within control) boolean
Latitude: Latitude to center the map on decimal
Longitude: Longitude to center map on decimal
Map Source: Map Provider eg: OpenStreetMap and Bing Maps
{OpenStreetMap | Bing Maps}		 string

Appearance
Map Type: Type of map to display eg: Roadmap, Satellite, Hybrid
{Roadmap | Satellite | Hybrid}		 string
Zoom Level: 0 - 19 (Lowest zoom is 0 [whole world], highest is 19 [includes individual buildings when available]) integer
Width: Width in px, %, em For example: 50px, 20%, 4em. If no unit is specified, px is assumed string
Height: Height in px, %, em For example: 50px, 20%, 4em. If no unit is specified, px is assumed string

Events
On Load:
Description: This event is fired when the map is loaded.
Example: 
me.setWidth("100%")
On Click:
Description: This event is fired when the user clicks anywhere on the map.
Example: 
${Map}.addMarker(latLng)
Context Variables latLng {object}
Properties lng
lat
On Marker Click:
Description: This event is fired when the user clicks the marker on the map.
Example: 
console.log(marker.lng, marker.lat)
Context Variables marker {object}
Properties lng
lat
Articles Map & OpenLayers API

new Map()

Map.js, line 42
This constructor is never used explicitly.

Extends

Members

uibpmext.ui.View

Methods

inherited addClass(name, replaced)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2466
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");

addMarker(location)

Map.js, line 259
adds a marker to the map
Name Type Description
location object the object that includes the latitude and longitude
Example
var latLng = {"lat": 38.5, "lng": -121.5}; var map = page.ui.get("Map"); map.addMarker(latLng); //note lat and lng variables are in decimal formatting.

getMapSource(){string}

Map.js, line 251
returns the map provider {osm | mapquest | bing}
Returns:
Type Description
string

getType(){string}

Map.js, line 235
Get descriptive string representing the type of control
Returns:
Type Description
string

inherited hide(collapseFlag)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1861
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();

inherited isBound(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2088
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.

inherited isEnabled(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2034
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();

inherited isLabelVisible(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1835
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();

inherited isVisible(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1943
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();

inherited propagateUpValueChange(event){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2403
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);

redraw()

Map.js, line 228
Redraws the map

setCenter(latitude, longitude)

Map.js, line 219
Set the center of the map
Name Type Description
latitude decimal the latitude
longitude decimal the longitude

inherited setEnabled(enabled, required)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1959
Enable/disable this view/control
Name Type Description
enabled boolean Enabled/read-only flag (true to enable view, false to disable/make read-only)
required boolean Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only

inherited setLabelVisible(visible)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1874
Show/hide the label of this view/control
Name Type Description
visible boolean Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);

setMapSource()

Map.js, line 243
Sets the map source to one of {osm | mapquest | bing}
Type Description
string

inherited setVisible(visible, collapse)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1887
Show/hide this view/control
Name Type Description
visible boolean Visibility flag (true to show view, false to hide)
collapse boolean Set to true to collapse the control space when visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"

setWidth(width)

Map.js, line 211
Set size of map (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string the width of the map

inherited show()

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1849
Show this view/control
Example
MyView.show();

inherited triggerFormulaUpdates(phase)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 4229
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();