kony.map Namespace

The Map Provider Constants enable your app to select which map provider to use.

Use the Map View Mode Constants to configure which map view your app selects.

The following table lists the error codes that the Map widget generates.

The Pin Image Anchor Constants define the positions that your app can anchor a pin image to on a map. The image positions are illustrated in the image below.

These constants define the types of images that can be used with maps.

The following constants identify the shapes that can be drawn on maps.

This function tests to see whether a specified location is within a circle or polygon on a map or whether it lies along a polyline on a map.

Syntax

kony.map.containsLocation(shapeType, location, shapeData);

Input Parameters

Examples

Example 1: Polyline

//Defining the shapeData parameter
  var shapeData = {
    locations: [{
        lat: "17.451759",
        lon: "78.380806"
    }, {
        lat: "17.473305",
        lon: "78.425191"
    }],
    tolerance: 200,
};
//Defining the location parameter
var location = {
    lat: "17.427789",
    lon: "78.451751"
};
//Checking if the location mentioned falls on the polyline
var value = kony.map.containsLocation(kony.map.SHAPE_TYPE_POLYLINE, location, shapeData);	

Example 2: Circle

//Defining the shapeData parameter      
    var shapeData = {
    locations: [{
        lat: "17.451759", 
        lon: "78.380806"
    }],
    radius: 1000
};
//Defining the location parameter
    var location ={
      lat: "17.451759", 
      lon: "78.380806"
    };
//Checking if the location mentioned falls inside the circle           
var b = kony.map.containsLocation(kony.map.SHAPE_TYPE_CIRCLE, location, shapeData);	

Return Values

True if the location is within the circle or polygon, or if it lies along the polyline. Otherwise, false.

Remarks

For detailed information on how to use this function and what parameter values are valid, please see Map API.

Platform Availability

• Android
• iOS

This function finds the linear distance between two locations on a map.

Syntax

kony.map.distanceBetween(location1, location2);

Input Parameters

Example

//Defining pin 1.      
var pin1 = {
    id: "id1", // id is mandatory for every pin in dictionary
    lat: "17.4947934",
    lon: "78.3996441",
    name: "KPHB",
    image: "pinb.png",
    focusImage: "focusImage.png", //focus image will be shown when map pin is selected
    desc: "Kukatpally",
    showCallout: true,
    meta: {
        color: "green",
        label: "A"
    }
};
//Defining pin 2.
var pin2 = {
    id: "id2", // id is mandatory for every pin in dictionary
    lat: "17.3616",
    lon: "78.4747",
    name: "Charminar",
    image: "pinb.png",
    focusImage: "focusImage.png",
    //focus image will be shown when map pin is selected
    desc: "In Hyderabad",
    showCallout: true,
    meta: {
        color: "green",
        label: "B"
    }
};

//Adding pins.
this.view.MainMap.addPins([pin1, pin2]);
//Calculating the distance between the two pins.    
var distanceInMeters = kony.map.distanceBetween(pin1, pin2);

Return Values

A number that specifies the distance between the two input locations.

Platform Availability

• Android
• iOS

This function enables apps to to decode the encoded polyline points which are provided in search route results. In Android, each step in the search results contains a key.

Syntax

kony.map.decode(encodedPolylinePoints);

Input Parameters

Return Values

An array containing only the lat/lon values.

Example

var polylineConfig = {
    lineColor: "0x0000ffff",
    lineWidth: "2"
};
var bool = kony.map.decode(polylineconfig);

Platform Availability

• Android

This function searches for routes between the start and destination locations.

Syntax

kony.map.searchRoutes(searchCriteria, successCallback, errorCallback);

Input Parameters

Example

/* @ function callSearchRoutefunc * @description invokes searchRoutes API * /
  callSearchRoutefunc:function()
  {
    try{
      var searchCriteriaObj = {
        alternatives : true, 
        directionServiceUrl : "https:/ / maps.googleapis.com / maps / api / directions / json ",
        destination : {lat: MAPCONSTANTS.dest3Lat, lon: MAPCONSTANTS.dest3Lon},
        origin :  {lat: MAPCONSTANTS.originLat, lon : MAPCONSTANTS.originLon}, 
        transportMode : "driving ",
        apiKey:""
      };
      if (this.index === null || this.index === undefined) {
        alert('Please select any one destination');
      }
      switch (this.index) {
        case "Kony Foster City ":
          searchCriteriaObj.destination = {lat: MAPCONSTANTS.dest1Lat, lon: MAPCONSTANTS.dest1Lon};
          break;
        case "Kony Austin ":
          searchCriteriaObj.destination = {lat: MAPCONSTANTS.dest2Lat, lon: MAPCONSTANTS.dest2Lon};
          break;
        default :
          kony.print("@@@@
destination is Orlando ");
          break;
      } 

      kony.map.searchRoutes(searchCriteriaObj, this.searchRouteSuccesCallback, this.errorRouteSuccesCallback); 
    }catch(error){
      kony.print("
frmMapSearchResult Controller "+JSON.stringify(error));
    }
  },
  /**
* @function searchRouteSuccesCallback
* @description success callback for searchRoutes API
* @private
* @param routes-> routes available in the given source and destination
			 */
  searchRouteSuccesCallback:function(routes)
  {
    try{   
      this.displySearchRoutes(routes);
    }catch(error){
      kony.print("
frmMapSearchResult Controller "+JSON.stringify(error));
    }
  },
  /**
* @function errorRouteSuccesCallback
* @description error callback for searchRoutes API
*/
  errorRouteSuccesCallback:function(){
    try{
      alert("
Search result failed ");
    }catch(error){
      kony.print("
frmMapSearchResult Controller "+JSON.stringify(error));
    }
  },
  /**

Return Values

None.

Remarks

Applications which use the apiKey in search criteria must enable the “Directions API” in Google Developer Console. Google API’s usage quota is counted against the apiKey. For activating and deactivating Google API’s, please follow the below link for detailed procedure. For an overview on searching for routes on maps, please see Map API.

This API is not supported on Huawei devices.

Platform Availability

• Android
• iOS