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

getLastPlacesInfo() Returns:

{Object[]} 

 






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

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

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"

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

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