Places

Provides users with relevant places of interest for more convenient maps by displaying locations that are defined by their coordinates, location type, and radius.

Events

On Load:

Description: This event is triggered when the Places control is loaded on the page

Example:

me.requestNearbySearch(${Geo}.getData().latitude, ${Geo}.getData().longitude, ["bank"], true);

On Place Requested:

Description: This event is triggered when a place is requested

Example:

${Map}.addMarker(location)

On Place Resolved:

Description: This event is triggered when the Geo Location control has a location

Example:

for(var i = 0; i < places.length; i++){console.log("Place: " + places[i].name + " -- " + places[i].vicinity);}

Context Variables	places
Properties	geometry
	html_attributions
	icon
	id
	name
	opening_hours
	place_id
	types
	vicinity

On Place Error:

Description: This event is triggered when a place cannot resolve a location, error.

Example:

${Map}.setCenter(${Geo}.getData().latitude, ${Geo}.getData().longitude); console.log("Maps cannot be reached at this time.")

Place Types: Place Types

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

getLastPlacesInfo() Returns:

{Object[]} 

 






 
  
 JSON Structure of the Object 
  
  
  

 		  { 
 

 		  "geometry": {},
 

 		    	  	    "location" : {
 

 			    	  	    	  	   "A": -- , 
 

 			    	  	    	  	   "F":-- 
 

 		    	  	   } 

 			  	   
}, 

 			
	 

 			  "html_attributes": {
 

 			 	  	  	     "icon": --, 
 

 			 	  	  		 "id": --, 
 

 			 	  	  		 "name": -- 

 			
		 

 			  }, 
 

 			  "opening_hours": --,
 

 		 	  	  	  "place_id": --,
 

 		 	  	  	  "types": {} ,
 

 		 	  	  	  "vicinity" : --
  

 		  }

JSON Structure of the Object
{ "geometry": {}, "location" : { "A": -- , "F":-- } }, "html_attributes": { "icon": --, "id": --, "name": -- }, "opening_hours": --, "place_id": --, "types": {} , "vicinity" : -- }

Get the different location that was previously requested.

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

requestNearbySearch(latitude, longitude, search)

Get the different location that was previously requested

Name Type Default Description

latitude {decimal} the latitude of the location

longitude {decimal} the longitude of the location

search {object} this object contains the items radius and types of businesses that you are searching for. Max radius is 15km. For acceptable types, see Place Types

Example

var aPlace = page.ui.get("Places1"); aPlace.requestNearbySearch(38.577523, -121.463390, {radius: 10000, types:["bank"]}, true); //Places Types are located at: http://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases/EN

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

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"

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