Skip to content

Latest commit

 

History

History
206 lines (155 loc) · 10.1 KB

Geoanalytics.md

File metadata and controls

206 lines (155 loc) · 10.1 KB

Mappls GeoAnalytics

Introduction

This API gives the users the power to display, style, and edit the data which is archived in
Mappls Database and overlay it on the user created maps.

  • Enables data selection, visualization, queries & styling with rich base map available at various level of granularity
  • Build maps quickly and easily without coordinates, using country, pin codes or simply place names
  • Drill and analyze different type of map layers such as districts, pincode, villages, city etc at Pan India level or restricted to limited bound /Area of interest
  • Allows user to set their own styling parameters such as label color scheme, geometry color schemes, opacity, width, stroke etc.
  • Allows to create rich thematic visuals using combination of value ranges

This API gets the layer specified which is stored in Mappls Database and gives a WMS layer as an output with any filters or styles specified by the user.

Add the dependency

Add below dependency in app level build.gradle file

implementation 'com.mappls.sdk:geoanalytics-plugin:1.1.0'
implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
implementation 'com.squareup.retrofit2:adapter-rxjava:2.6.2'

Available Geoanalytics Layer

  1. MapplsGeoAnalyticsType.STATE
  2. MapplsGeoAnalyticsType.DISTRICT
  3. MapplsGeoAnalyticsType.SUB_DISTRICT
  4. MapplsGeoAnalyticsType.WARD
  5. MapplsGeoAnalyticsType.LOCALITY
  6. MapplsGeoAnalyticsType.PANCHAYAT
  7. MapplsGeoAnalyticsType.BLOCK
  8. MapplsGeoAnalyticsType.PINCODE
  9. MapplsGeoAnalyticsType.TOWN
  10. MapplsGeoAnalyticsType.CITY
  11. MapplsGeoAnalyticsType.VILLAGE
  12. MapplsGeoAnalyticsType.SUB_LOCALITY
  13. MapplsGeoAnalyticsType.SUB_SUB_LOCALITY

To get the detailed list of available layer's and attribute's names, please use the Listing API available here.

Now that you’re all caught up with the features, let's get down right to them and look at how you can integrate our Geoanlytics API to add data on your map in few simple steps.

Step-1 Initialize GeoAnalytics Manager

Java

MapplsGeoAnalyticsPlugin geoAnalyticsPlugin = new MapplsGeoAnalyticsPlugin(mapView, mapplsMap);

Kotlin

val geoAnalyticsPlugin = MapplsGeoAnalyticsPlugin(mapView, mapplsMap)

Step-2 Show GeoAnalytics layer

Java

geoAnalyticsPlugin.showGeoAnalytics(MapplsGeoAnalyticsType.STATE, MapplsGeoAnalyticsRequest.builder().attribute("t_p").query(">0").geoboundType("stt_nme").geoBound("HARYANA", "KERALA")  
        .propertyNames("stt_nme", "stt_id").style(new GeoAnalyticsAppearanceOption().fillColor("42a5f4").fillOpacity(0.5).strokeColor("000000").labelSize(10).strokeWidth(0).labelColor("000000")).build());

Kotlin

geoAnalyticsPlugin.showGeoAnalytics(MapplsGeoAnalyticsType.STATE, MapplsGeoAnalyticsRequest.builder().attribute("t_p").query(">0").geoboundType("stt_nme").geoBound("HARYANA", "KERALA")  
        .propertyNames("stt_nme", "stt_id").style(new GeoAnalyticsAppearanceOption().fillColor("42a5f4").fillOpacity(0.5).strokeColor("000000").labelSize(10).strokeWidth(0).labelColor("000000")).build()))

Step-3 MapplsGeoAnalyticsRequest

  1. geoboundType(String...)(Mandatory): The type of geographical extents on which data would be bound, i.e. the parent layer types (India, State, District, Sub District, etc.)

  2. geoBound(String...)(Mandatory): The values of the extent depending on the GeoBoundType.

  3. propertyNames(String...)(Mandatory): Attribute names that user wants to show in info window or in click callback

  4. attribute(String): The name of Attribute to filter the output, such as population or number of households.

  5. query(String): A string containing an operator and a value which would be applied to the attribute filter. Applicable queries include < (Less than) OR > (Greater then) OR <> (Between). Example 1: ‘> 10000’ Example 2: BETWEEN value1 AND value2
    *Note: Query is mandatory if Attribute is given.

  6. style(GeoAnalyticsStyleOption): Options to set the style of Layer

    GeoAnalyticsAppearanceOption

    1. labelColor(String): Value of the color of label.
    2. labelSize(Integer): Size of labels to be displayed.
    3. fillColor(String): Value of the polygon/point color. e.g., fillColor("42a5f4")
    4. pointSize(Integer): Size of point data. (Applicable for Point geometry only)
    5. strokeColor(String): Value of the color of the label.
    6. strokeWidth(Double): Width of the polygon border.
    7. fillOpacity(Double): Opacity value of whole layer. (Any range between 0 & 1) *Note: All starred parameters are mandatory if Style is given.

That's All!

Other Methods Available are:

1. Remove Geoanalytics Layer

Java

geoAnalyticsPlugin.removeGeoAnalytics(MapplsGeoAnalyticsType.STATE);

Kotlin

geoAnalyticsPlugin.removeGeoAnalytics(MapplsGeoAnalyticsType.STATE)

2. GeoAnalytics Layer Click

geoAnalyticsPlugin.setGeoAnalyticsCallback(new MapplsGeoAnalyticsCallback() {  
    @Override  
  public void getSelectedFeatures(List<MapplsGeoAnalyticsDetail> result) {  
  
    }  
});

3. Custom Info Window

geoAnalyticsPlugin.setCustomGeoAnalyticsInfoWindowAdapter(new CustomGeoAnalyticsInfoWindowAdapter() {  
    @Override  
  public View setCustomInfoWindow(List<MapplsGeoAnalyticsDetail> result) {  
        return view;  
  }  
});

Mappls GeoAnalytics Listing API

Geo-Analytics API is an API set that gives the users the power to display & style the data which is archived in Mappls pan-India database and overlay it on Mappls Interactive Maps JS API for web.

Listing API is an API that gives the users information on the different layers & attributes available within Geo-Analytics Core APIs. This API acts as an assisting API to quickly get the necessary details that are required to accurately fetch the required overlays from the core Geo-Analytics APIs.

It that provide list of attributes along with unique ID. User can get bounding box of the required feature/area as well.

MapplsGeoAnalyticsList mapplsGeoAnalyticsList = MapplsGeoAnalyticsList.builder()  
        .api("state")  
        .attributes("b_box")  
        .geoBound(geobound)  
        .geoBoundType(geoboundType)  
        .build();
        //To call in a Foreground Thread
MapplsGeoAnalyticsListManager.newInstance(mapplsGeoAnalyticsList).call(new OnResponseCallback<GeoAnalyticsListResponse>() {  
    @Override  
  public void onSuccess(GeoAnalyticsListResponse geoAnalyticsListResponse) {
  //Handle response
  } 
    
    @Override  
    public void onError(int i, String s) {  
  
    }  
});
            //OR
            //To call in a Background Thread
 MapplsGeoAnalyticsListManager.newInstance(mapplsGeoAnalyticsList).execute();

Request Parameters

  1. api(String): api layer name (such as state, district, subdistrict, village, pincode etc)
  2. geoBoundType(String): Single valued parent type, for example: stt_nme, dst_nme, sdb_nme etc.
    Note: For parent type reference, contact apisupport@mappls.com
  3. geoBound(String...): child values, for example: Haryana, Maharashtra, Goa etc
  4. attributes(String...): field name/bounding Box requested w.r.t api (api) & parent type (geo_bound_type). Bounding box can be requested as "b_box" variable.

Response Parameters

  1. responseCode(Integer): The response code of the operation. The 400 series is for client side (application end) error while 500 series is for server side (Mappls) error, 200 series is for success.
  2. version(String): The version of the API you’re connected to.
  3. totalFeatureCount(Integer): total number of features in the request.
  4. results(GeoAnalyticsListResult)

GeoAnalyticsListResult

  1. apiName(String): as requested
  2. attribute(String): as requested
  3. getAttrValues(List<GeoAnalyticsValue>)

GeoAnalyticsValue

  1. geoBound(String): child value
  2. getAttrValues(List<Map<String, Object>>): list of names/b_box requested




For any queries and support, please contact:

Email us at apisupport@mappls.com

Support Need support? contact us!





@ Copyright 2024 CE Info Systems Ltd. All Rights Reserved.