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 or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

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 the view.

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}

Indicate the bound status of the view.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the 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 or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

Example

MyView.setEnabled(false); //Make MyView read-only

Inherited setLabelVisible(visible)

Show or hide the view label.

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 or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter 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 or hide the view.

Name Type Default Description

visible {boolean} Visibility flag (true to show the view, false to hide it)

collapse {boolean} Set it to true to collapse the view space when the option 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.

Example

MyView.show();

Inherited triggerFormulaUpdates([phase])

Broadcast 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