Map

Allows users to place a map on a page, set a static location, or use the user's location obtained using a Geo location view.

Appearance

Map Type:	Type of map to display eg\: Roadmap, Satellite, Hybrid {Roadmap \| Satellite \| Hybrid}	`MapType`
Zoom level:	0 - 19 (Lowest zoom is 0 [whole world], highest is 19 [includes individual buildings when available])	`Integer`
Width:	Width in px, %, em\r\nFor example\: 50px, 20%, 4em. If no unit is specified, px is assumed.	`String`
Height:	Height in px, %, em\r\nFor example\: 50px, 20%, 4em. If no unit is specified, px is assumed	`String`

Behavior

Disable panning:	Disables map panning	`Boolean`
Hide Zoom view:	Hides the zoom view, preventing zooming in and out.	`Boolean`
Hide Map Type view:	Prevents the user from changing map type.	`Boolean`
Hide scale view:	Hides the scale from view	`Boolean`
Hide rotate view:	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 view)	`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}	`MapSource`

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

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");

addMarker(location)

adds a marker to the map

Name	Type	Default	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()

returns the map provider {osm | mapquest | bing}

getType() Returns: {string}

Get descriptive string representing the type of control

Inherited hide(collapseFlag)

Hide this view/control

Name	Type	Default	Description
collapseFlag	`{boolean}`		Set to `true` to collapse the view (equivalent to a view setting of "NONE")

Example

MyView.hide();

Inherited isBound() Returns: {boolean}

Indicates bound status of control.

Inherited isEnabled() Returns: {boolean}

Checks if the view is enabled or not

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Checks if control label is visible

Example

var labelVisible = MyView.isLabelVisible();

Inherited isVisible() Returns: {boolean}

Checks whether or not view is visible

Example

var visible = MyView.isVisible();

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);

redraw()

Redraws the map

setCenter(latitude, longitude)

Set the center of the map

Name	Type	Default	Description
latitude	`{decimal}`		the latitude
longitude	`{decimal}`		the longitude

Inherited setEnabled(enabled, required)

Enable/disable this view/control

Name	Type	Default	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)

Show/hide the label of this view/control

Name	Type	Default	Description
visible	`{boolean}`		Label visibility flag (`true` to show view label, `false` to hide)

Example

MyView.setLabelVisible(false);

setMapSource(null)

Sets the map source to one of {osm | mapquest | bing}

Name	Type	Default	Description
	`{string}`

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 setVisible(visible, collapse)

Show/hide this view/control

Name	Type	Default	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)

Set size of map (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name	Type	Default	Description
width	`{string}`		the width of the map

Inherited show()

Show this view/control

Example

MyView.show();

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