Skip to main content

Vector Map Android SDK

Easy To Integrate Maps & Location APIs & SDKs For Web & Mobile Applications

Powered with India's most comprehensive and robust mapping functionalities.

  1. You can get your api key to be used in this document here: https://apis.mappls.com/console/

  2. The sample code is provided to help you understand the basic functionality of Mappls maps & REST APIs working on Android native development platform.

  3. Explore through 200 + nations with Global Search with Global Search, Routing and Mapping APIs & SDKs by Mappls.

Getting Started​

Mappls Maps SDK for Android lets you easily add Mappls Maps and web services to your own Android application. The SDK for Android supports API 16+. You can have a look at the map and features you will get in your own app by using the Mappls Maps SDK for Android.

Through customized tiles, you can add different map layers to your application and add bunch of controls and gestures to enhance map usability thus creating potent map based solutions for your customers. The SDK handles downloading of map tiles and their display along with a bunch of controls and native gestures.

API Usage​

Your Mappls Maps SDK usage needs a set of license keys (get them here) and is governed by the API terms and conditions. As part of the terms and conditions, you cannot remove or hide the Mappls logo and copyright information in your project.

The allowed SDK hits are described on the user dashboard page. Note that your usage is shared between platforms, so the API hits you make from a web application, Android app or an iOS app all add up to your allowed daily limit.

Setup your project​

Follow these steps to add the SDK to your project –

  • Create a new project in Android Studio

For older Build versions (i.e, Before gradle v7.0.0)

  • Add Mappls repository in your project level build.gradle
 allprojects {  
    repositories {  
  
        maven {  
            url 'https://maven.mappls.com/repository/mappls/'  
        }  
    }  
}

For Newer Build Versions (i.e, After gradle v7.0.0)

  • Add Mappls repository in your settings.gradle
dependencyResolutionManagement {  
//   repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)  
  repositories {  
        google()  
        mavenCentral()  
        maven {  
            url 'https://maven.mappls.com/repository/mappls/'  
        }  
    }  
   }  
}
  • Add below dependency in your app-level build.gradle
implementation 'com.mappls.sdk:mappls-android-sdk:8.0.0'
  • Add these permissions in your project
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.INTERNET"/>

Add Java 8 Support to the project​

add following lines in your app module's build.gradle

compileOptions {
    sourceCompatibility 1.8
    targetCompatibility 1.8
}

Add your API keys to the SDK​

Add your API keys to the SDK (in your application's onCreate() or before using map)

Java​

MapplsAccountManager.getInstance().setRestAPIKey("SET_REST_API_KEY");
MapplsAccountManager.getInstance().setMapSDKKey("SET_MAP_KEY");
MapplsAccountManager.getInstance().setAtlasClientId("SET_CLIENT_ID");
MapplsAccountManager.getInstance().setAtlasClientSecret("SET_CLIENT_SECRET");
Mappls.getInstance(getApplicationContext());

Kotlin​

MapplsAccountManager.getInstance().restAPIKey = "SET_REST_API_KEY"
MapplsAccountManager.getInstance().mapSDKKey = "SET_MAP_KEY"
MapplsAccountManager.getInstance().atlasClientId = "SET_CLIENT_ID"
MapplsAccountManager.getInstance().atlasClientSecret = "SET_CLIENT_SECRET"
Mappls.getInstance(applicationContext)

You cannot use the Mappls Map Mobile SDK without these function calls. You will find your keys in your API Dashboard.

Add a Mappls Map to your application​

<com.mappls.sdk.maps.MapView  
  android:id="@+id/map_view"  
  android:layout_width="match_parent"  
  android:layout_height="match_parent"/>
NOTE: All the lifecycle methods that need to be overridden:​

Initialize the mapView

Java​

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   setContentView(R.layout.base_layout);
   mapView = findViewById(R.id.map_view);
   mapView.onCreate(savedInstanceState);
}

@Override
protected void onStart() {
   super.onStart();
   mapView.onStart();
}

@Override
protected void onStop() {
   super.onStop();
   mapView.onStop();
}

@Override
protected void onDestroy() {
    super.onDestroy();
    mapView.onDestroy();
}

@Override
protected void onPause() {
    super.onPause();
    mapView.onPause();
}

@Override
protected void onResume() {
   super.onResume();
   mapView.onResume();
}

@Override
public void onLowMemory() {
   super.onLowMemory();
   mapView.onLowMemory();
}

@Override
protected void onSaveInstanceState(Bundle outState) {
   super.onSaveInstanceState(outState);
   mapView.onSaveInstanceState(outState);
}

Kotlin​

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.base_layout)
    mapView = findViewById(R.id.map_view)
    mapView.onCreate(savedInstanceState)
}

override fun onStart() {
    super.onStart()
    mapView.onStart()
}

override fun onResume() {
    super.onResume()
    mapView.onResume()
}

override fun onPause() {
    super.onPause()
    mapView.onPause()
}

override fun onStop() {
    super.onStop()
    mapView.onStop()
}

override fun onDestroy() {
    super.onDestroy()
    mapView.onDestroy()
}

override fun onLowMemory() {
    super.onLowMemory()
    mapView.onLowMemory()
}

override fun onSaveInstanceState(outState: Bundle) {
    super.onSaveInstanceState(outState)
    mapView.onSaveInstanceState(outState)
}

Map Interactions​

The Mappls Maps Android SDK allows you to define interactions that you can activate on the map to enable gestures and click events. The following interactions are supported –

Zoom Controls​

The map supports the familiar two-finger pinch and zooms to change zoom level as well as double tap to zoom in. Set zoom to 4 for country level display and 18 for house number display. In this SDK the camera position plays an important role

And following operations can be performed using the CameraPosition

Target​

The target is single latitude and longitude coordinate that the camera centers it on. Changing the camera's target will move the camera to the inputted coordinates. The target is a LatLng object. The target coordinate is always at the center of the viewport.

Tilt​

Tilt is the camera's angle from the nadir (directly facing the Earth) and uses unit degrees. The camera's minimum (default) tilt is 0 degrees, and the maximum tilt is 60. Tilt levels use six decimal point of precision, which enables you to restrict/set/lock a map's bearing with extreme precision.

The map camera tilt can also adjust by placing two fingertips on the map and moving both fingers up and down in parallel at the same time or

Bearing​

Bearing represents the direction that the camera is pointing in and measured in degrees clockwise from north.

The camera's default bearing is 0 degrees (i.e. "true north") causing the map compass to hide until the camera bearing becomes a non-zero value. Bearing levels use six decimal point precision, which enables you to restrict/set/lock a map's bearing with extreme precision. In addition to programmatically adjusting the camera bearing, the user can place two fingertips on the map and rotate their fingers.

Zoom​

Zoom controls scale of the map and consumes any value between 0 and 22. At zoom level 0, viewport shows continents and other world features. A middle value of 11 will show city level details.At a higher zoom level, map will begin to show buildings and points of interest. Camera can zoom in following ways:

  • Pinch motion two fingers to zoom in and out.
  • Quickly tap twice on the map with a single finger to zoom in.
  • Quickly tap twice on the map with a single finger and hold your finger down on the screen after the second tap.
  • Then slide the finger up to zoom out and down to zoom out.

Sdk provides a OnMapReadyCallback, implements this callback and override it's onMapReady() and set the Camera position inside this method

Java​

CameraPosition position = new CameraPosition.Builder()
        .target(new LatLng(22.8978, 77.3245)) // Sets the new camera position
        .zoom(14) // Sets the zoom to level 14
        .tilt(45) // Set the camera tilt to 45 degrees
        .build();
mapplsMap.setCameraPosition(position)

Kotlin​

val cameraPosition = CameraPosition.Builder()
    .target(LatLng(22.8978, 77.3245))
    .zoom(10.0)
    .tilt(0.0)
    .build()
mapplsMap?.cameraPosition = cameraPosition
Sdk allows various method to Move, ease,animate Camera to a particular location :​

Java​

mapplsMap.moveCamera(CameraUpdateFactory.newLatLngZoom(new LatLng(22.8978,77.3245),14);
mapplsMap.easeCamera(CameraUpdateFactory.newLatLngZoom(new LatLng(22.8978,77.3245),14);
mapplsMap.animateCamera(CameraUpdateFactory.newLatLngZoom(new LatLng(22.8978,77.3245),14);

Kotlin​

mapplsMap?.moveCamera(CameraUpdateFactory.newLatLngZoom(LatLng(22.8978,77.3245), 14.0))
mapplsMap?.easeCamera(CameraUpdateFactory.newLatLngZoom(LatLng(22.8978,77.3245), 14.0))
mapplsMap?.animateCamera(CameraUpdateFactory.newLatLngZoom(LatLng(22.8978,77.3245), 14.0))

Map Events​

The SDK allows you to listen to certain events on the map. It sets a callback that is invoked when camera movement has started.​

Java​

mapplsMap.addOnCameraMoveStartedListener(new MapplsMap.OnCameraMoveStartedListener() {
private final String[] REASONS = {
        "REASON_API_GESTURE",
        "REASON_DEVELOPER_ANIMATION",
        "REASON_API_ANIMATION"};

@Override
public void onCameraMoveStarted(int reason) {
        String string = String.format(Locale.US, "OnCameraMoveStarted: %s", REASONS[reason - 1]);
        Toast.makeText(MainActivity.this, string, Toast.LENGTH_LONG).show();
    }
});

Kotlin​

mapplsMap.addOnCameraMoveStartedListener(object : MapplsMap.OnCameraMoveStartedListener {
    private val REASONS: Array<String> = arrayOf(
        "REASON_API_GESTURE",
        "REASON_DEVELOPER_ANIMATION",
        "REASON_API_ANIMATION"
    )
    override fun onCameraMoveStarted(i: Int) {
        var string: String = String.format("OnCameraMoveStarted: %s", REASONS[i - 1])
        Toast.makeText(this@MainActivity, string, Toast.LENGTH_SHORT).show()
    }
})
It sets a callback that is invoked when camera movement was cancelled.​

Java​

mapplsMap.addOnCameraMoveCancelListener(new MapplsMap.OnCameraMoveCanceledListener() {
@Override
public void onCameraMoveCanceled() {
        Toast.makeText(MainActivity.this, "onCameraMoveCanceled", Toast.LENGTH_LONG).show();
   }
});

Kotlin​

mapplsMap.addOnCameraMoveCancelListener(object : MapplsMap.OnCameraMoveCanceledListener {
    override fun onCameraMoveCanceled() {
        Toast.makeText(this@MainActivity, "onCameraMoveCanceled", Toast.LENGTH_SHORT).show()
    }
})
It sets a callback that is invoked when camera movement has ended.​

Java​

mapplsMap.addOnCameraIdleListener(new MapplsMap.OnCameraIdleListener() {
@Override
public void onCameraIdle() {
        Toast.makeText(MainActivity.this, "onCameraIdle", Toast.LENGTH_LONG).show();
     }
});

Kotlin​

mapplsMap.addOnCameraIdleListener(object : MapplsMap.OnCameraIdleListener {
    override fun onCameraIdle() {
        Toast.makeText(this@MainActivity, "onCameraIdle", Toast.LENGTH_SHORT).show()
   }
})

Map Click/Long Press​

If you want to respond to a user tapping on a point on the map, you can use a MapEventsOverlay which you need to add on the map as an Overlay.

It sets a callback that's invoked when the user clicks on the map view.

Java​

mapplsMap.addOnMapClickListener(new MapplsMap.OnMapClickListener() {
@Override
public boolean onMapClick(@NonNull LatLng point) {
        String string = String.format(Locale.US, "User clicked at: %s", point.toString())
        Toast.makeText(MainActivity.this, string, Toast.LENGTH_LONG).show();
        return false;
        }
        });

Kotlin​

mapplsMap.addOnMapClickListener(object: MapplsMap.OnMapClickListener {
    override fun onMapClick(latLng: LatLng): Boolean {
        val string: String = String.format("User clicked at: %s", latLng.toString())
        Toast.makeText(this@MainActivity, string, Toast.LENGTH_LONG).show()
        return false
    }
})
Sets a callback that's invoked when the user long clicks on the map view.​

Java​

mapplsMap.addOnMapLongClickListener(new MapplsMap.OnMapLongClickListener() {
@Override
public boolean onMapLongClick(@NonNull LatLng point) {
        String string = String.format(Locale.US, "User long clicked at: %s", point.toString());
        Toast.makeText(MainActivity.this, string, Toast.LENGTH_LONG).show();
        return false;
   }
});

Kotlin​

mapplsMap.addOnMapLongClickListener(object: MapplsMap.OnMapLongClickListener {
    override fun onMapLongClick(latLng: LatLng): Boolean {
        var string: String = String.format("User long clicked at: %s", latLng.toString())
        Toast.makeText(this@MainActivity, string, Toast.LENGTH_LONG).show()
        return false
    }
})

Map Overlays​

Add A Marker​

Add markers to the map by following these steps –​

Java​

MarkerOptions markerOptions = new MarkerOptions().position(point).icon(IconFactory.getInstance(this).fromResource(R.drawable.ic_android));
markerOptions.setTitle("Marker");
markerOptions.setSnippet("This is a Marker");
Marker marker = mapplsMap.addMarker(markerOptions);

Kotlin​

val markerOptions: MarkerOptions = MarkerOptions().position(point).icon(IconFactory.getInstance(this).fromResource(R.drawable.ic_android))
markerOptions.title= "Marker"
markerOptions.snippet = "This is a Marker"
mapplsMap?.addMarker(markerOptions)

Remove A Marker​

Java​

mapplsMap.removeMarker(marker)

Kotlin​

mapplsMap?.removeMarker(marker)

Customize A Marker​

Java​

MarkerOptions markerOptions = new MarkerOptions().position(point).icon(IconFactory.getInstance(context).fromResource(R.drawable.ic_android));
Marker marker = mapplsMap.addMarker(markerOptions);
marker.setTitle("title");
mapplsMap.setInfoWindowAdapter(new MapplsMap.InfoWindowAdapter() {
    @Nullable
    @Override
    public View getInfoWindow(@NonNull Marker marker) {
        View view = getLayoutInflater().inflate(R.layout.layout, null);
        TextView text = view.findViewById(R.id.text);
        text.setText(marker.getTitle());
        return view;
    }
});

Kotlin​

val markerOptions: MarkerOptions = MarkerOptions().position(point).icon(IconFactory.getInstance(context).fromResource(R.drawable.ic_android))
markerOptions.title= "Marker"
mapplsMap?.addMarker(markerOptions)
mapplsMap?.setInfoWindowAdapter {
    val view: View? = getLayoutInflater().inflate(R.layout.layout, null)
    val textView: TextView = view?.findViewById(R.id.text)!!
    textView.text = it.title
    return@setInfoWindowAdapter view
}

Add A Polyline​

Draw polyline on the map​

Java​

mapplsMap.addPolyline(new PolylineOptions()
        .addAll(points)//list of LatLng   
        .color(Color.parseColor("#3bb2d0"))
        .width(2));

Kotlin​

mapplsMap.addPolyline(PolylineOptions()
    .addAll(points)
    .color(Color.parseColor("#3bb2d0"))
    .width(2f))

Remove Polyline​

To remove a polyline from map:

Java​

mapplsMap.removePolyline(polyline);

Kotlin​

mapplsMap.removePolyline(polyLine!!)

Add A Polygon​

Draw a polygon on the map​

Java​

mapplsMap.addPolygon(new PolygonOptions()
        .addAll(polygon)//list of LatLng.  
        .fillColor(Color.parseColor("#3bb2d0")));

Kotlin​

mapplsMap.addPolygon(PolygonOptions()
    .addAll(polygon)
    .fillColor(Color.parseColor("#3bb2d0")))

Remove Polygon​

To remove a polygon from map:

Java​

mapplsMap.removePolygon(polygon);

Kotlin​

mapplsMap.removePolygon(polygon!!)

Show User Location​

Show the current user location​

Implement LocationEngineCallback and override it's method

Java​

LocationComponentOptions options = LocationComponentOptions.builder(context)
        .trackingGesturesManagement(true)
        .accuracyColor(ContextCompat.getColor(this, R.color.colorAccent))
        .build();
// Get an instance of the component LocationComponent  
locationComponent = mapplsMap.getLocationComponent();
LocationComponentActivationOptions locationComponentActivationOptions = LocationComponentActivationOptions.builder(this, style)
        .locationComponentOptions(options)
        .build();
// Activate with options  
locationComponent.activateLocationComponent(context, locationComponentActivationOptions ;
// Enable to make component visible  
locationComponent.setLocationComponentEnabled(true);
locationEngine = locationComponent.getLocationEngine();
LocationEngineRequest request = new LocationEngineRequest.Builder(DEFAULT_INTERVAL_IN_MILLISECONDS)
        .setPriority(LocationEngineRequest.PRIORITY_HIGH_ACCURACY)
        .build();
locationEngine.requestLocationUpdates(request, locationEngineCallback, getMainLooper());
// Set the component's camera mode  
        locationComponent.setCameraMode(CameraMode.TRACKING);
        locationComponent.setRenderMode(RenderMode.COMPASS);

//LocationChange Listener  
LocationEngineCallback<LocationEngineResult> locationEngineCallback = new LocationEngineCallback<LocationEngineResult>() {
    @Override
    public void onSuccess(LocationEngineResult locationEngineResult) {
        if(locationEngineResult.getLastLocation() != null) {
            Location location = locationEngineResult.getLastLocation();
        }
    }

    @Override
    public void onFailure(@NonNull Exception e) {

    } 
};


    @Override
    protected void onDestroy() {
        super.onDestroy();
        // Prevent leaks  
        if (locationEngine != null) {
            locationEngine.removeLocationUpdates(locationEngineCallback);
        }
   }

Kotlin​

val options: LocationComponentOptions = LocationComponentOptions.builder(context)
    .trackingGesturesManagement(true)
    .accuracyColor(ContextCompat.getColor(this, R.color.colorAccent))
    .build()
locationComponent = mapplsMap.locationComponent
val locationComponentActivationOptions = LocationComponentActivationOptions.builder(this, style)
    .locationComponentOptions(options)
    .build()
locationComponent.activateLocationComponent(locationComponentActivationOptions)
locationComponent.isLocationComponentEnabled = true
locationEngine = locationComponent.locationEngine!!
val request = LocationEngineRequest.Builder(1000)
    .setPriority(LocationEngineRequest.PRIORITY_HIGH_ACCURACY)
    .build()
locationEngine?.requestLocationUpdates(request, locationEngineCallback, mainLooper)

locationComponent.cameraMode = CameraMode.TRACKING
locationComponent.renderMode = RenderMode.COMPASS

val locationEngineCallback = object : LocationEngineCallback<LocationEngineResult> {
    override fun onSuccess(result: LocationEngineResult?) {
        if(result?.lastLocation != null) {
            val location = result.lastLocation
        }
    }

    override fun onFailure(e: Exception) {

    }

}

override fun onDestroy() {
    super.onDestroy()
    if (locationEngine != null) {
        locationEngine?.removeLocationUpdates(locationEngineCallback)
    }
}

Calculate distance between two points​

To calculate aerial distance between two points:

Java​

LatLng firstLatLng = new LatLng(28, 77);
LatLng secondLatLng = new LatLng(28.67, 77.65);
firstLatLng.distanceTo(secondLatLng);

Kotlin​

val firstLatLng = LatLng(28.0, 77.0)
val secondLatLng = LatLng(28.67, 77.65)
firstLatLng.distanceTo(secondLatLng)

Proguard​

-keep class com.mappls.sdk.maps.GetStylesResponse {
    <fields>;
    <methods>;
}
-keep class com.mappls.sdk.maps.StyleData {
    <fields>;
    <methods>;
}