Class: Places

Places

The Places control will display desired places based on location coordinates, location type, and radius. A Places control provides the following configuration properties in Process Designer:

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
Articles
Places

new Places()

This constructor is never used explicitly.

Extends

Members

Methods

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

getLastPlacesInfo(){Array.<Object>}

Get the different location that was previously requested.
Returns:
Type Description
Array.<Object> returns a list of Objects that contains the different location that was previously requested.
JSON Structure of the Object
{
"geometry": {},
      "location" : {
            "A": -- ,
            "F":--
      }    
},
"html_attributes": {
      "icon": --,
      "id": --,
      "name": --
},
"opening_hours": --,
      "place_id": --,
      "types": {} ,
      "vicinity" : --
}

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string
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();
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
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);

requestNearbySearch(latitude, longitude, search)

Get the different location that was previously requested
Name Type 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
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
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);
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"
Show this view/control
Example
MyView.show();
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();