https://github.com/mappls-api/mappls-geoanalytics-ios-distribution
Mappls Geoanalytics Native for iOS distributed via the SPM (Swift Package Manager).
https://github.com/mappls-api/mappls-geoanalytics-ios-distribution
Last synced: 8 months ago
JSON representation
Mappls Geoanalytics Native for iOS distributed via the SPM (Swift Package Manager).
- Host: GitHub
- URL: https://github.com/mappls-api/mappls-geoanalytics-ios-distribution
- Owner: mappls-api
- License: other
- Created: 2025-05-20T06:38:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-11T12:19:50.000Z (12 months ago)
- Last Synced: 2025-10-21T07:56:32.935Z (8 months ago)
- Language: Swift
- Size: 6.84 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
[
](https://www.mapmyindia.com/api)
# MapplsGeoanalytics Plugin for iOS
## [Introduction](#Introduction)
`MapplsGeoanalytics` is a plugin over Mappls's `GeoAnalytics APIs`. Geoanalytics APIs gives the users the power to display, style, and edit the data which is archived in Mappls's 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 plugin gets the layer specified which is stored in Mappls’s Database and gives a WMS layer as an output with any filters or styles specified by the user.
## [Installation](#Installation)
To add a package dependency to your Xcode project, select File > Swift Packages > Add Package Dependency and enter its repository URL. See [Adding Package Dependencies to Your App](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app).
#### [Dependencies](#Dependencies)
This library depends upon several Mappls's own libraries. All dependent libraries will be automatically installed on using SPM.
Below are list of dependcies which are required to run this SDK:
- [MapplsAPICore](MapplsAPICore.md)
- [MapplsAPIKit](MapplsAPIKit.md)
- [MapplsMaps](MapplsMap.md)
### [Version History](#Version-History)
| Version | Dated | Description |
| :---- | :---- | :---- |
| `2.0.0`| 11 Jun 2025 | - Updated minimum iOS deployment target to 13.0
- Authentication and authorization mechanisms have been revised. |
| --- | --- | --- |
| `1.0.0` | 20 June 2022 | Initial version release with a Mappls geoanalytics. |
#### [Dependencies](#Dependencies)
This library depends upon several Mappls's own libraries. All dependent libraries will be automatically installed using CocoaPods.
Below are list of dependencies which are required to run this SDK:
- [MapplsAPICore](https://github.com/mappls-api/mappls-ios-sdk/docs/v1.0.0/MapplsAPICore.md)
- [MapplsAPIKit](https://github.com/mappls-api/mappls-ios-sdk/docs/v1.0.0/MapplsAPIKit.md)
- [MapplsMaps](https://github.com/mappls-api/mappls-ios-sdk/docs/v1.0.0/MapplsMap.md)
## [Authorization](#Authorization)
### [MapplsAPICore](#MapplsAPICore)
It is required to set MAPPLS's keys to use any MAPPL's SDK. Please see [here](MapplsAPICore.md) to achieve this.
## [Precap](#Precap)
### [Geoanalytics Layer Types](#Geoanalytics-Layer-Types)
An enum `MapplsGeoanalyticsLayerType` can be used to get different types of layers. Below are different types which are available:
1. `MapplsGeoanalyticsLayerTypeState`
2. `MapplsGeoanalyticsLayerTypeDistrict`
3. `MapplsGeoanalyticsLayerTypeSubDistrict`
4. `MapplsGeoanalyticsLayerTypeCity`
5. `MapplsGeoanalyticsLayerTypeTown`
6. `MapplsGeoanalyticsLayerTypeLocality`
7. `MapplsGeoanalyticsLayerTypeSubLocality`
8. `MapplsGeoanalyticsLayerTypeSubSubLocality`
9. `MapplsGeoanalyticsLayerTypePanchayat`
10. `MapplsGeoanalyticsLayerTypeVillage `
11. `MapplsGeoanalyticsLayerTypeWard`
12. `MapplsGeoanalyticsLayerTypePincode`
13. `MapplsGeoanalyticsLayerTypeBlock`
**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 GeoAnalytics plugin to add data on your map in few simple steps.**
## [Initialization MapplsGeoanalyticsPlugin](#Initialization-MapplsGeoanalyticsPlugin)
```swift
var geoanalyticsPlugin : MapplsGeoanalyticsPlugin = MapplsGeoanalyticsPlugin(mapView: mapView)
```
## [Use of GeoAnalytics API](#Use-of-GeoAnalytics-API)
Use instance of `MapplsGeoanalyticsPlugin` to show response of GeoAnalytics API as Map Layers.
**For infomation about `GeoAnalytics API` go [here](https://about.mappls.com/api/advanced-maps/geoanalytics-web-js/geo-analytics-mapmyindia-js).**
### Step 1 - Get GeoAnalytics layers
To get response of GeoAnalytics API, Create an instance of `MapplsGeoanalyticsLayerRequest`. Below is code snipet for this.
``` swift
let apperenceState = GeoanalyticsLayerAppearance()
apperenceState.fillColor = "42a5f4"
apperenceState.fillOpacity = "0.5"
apperenceState.labelColor = "000000"
apperenceState.labelSize = "10"
apperenceState.strokeColor = "000000"
apperenceState.strokeWidth = "0"
let geoboundArray = [MapplsGeoanalyticsGeobound(geobound: "HARYANA", appearance: apperenceState), MapplsGeoanalyticsGeobound(geobound: "UTTAR PRADESH", appearance: apperenceState),MapplsGeoanalyticsGeobound(geobound: "KERALA", appearance: apperenceState)]
let layerRequestState = MapplsGeoanalyticsLayerRequest(geoboundType: "stt_nme", geobound: geoboundArray, propertyName: ["stt_nme","stt_id","t_p"], layerType: .state)
layerRequestState.attribute = "t_p";
layerRequestState.query = ">0";
layerRequestState.transparent = true;
```
#### [MapplsGeoanalyticsLayerRequest](#MapplsGeoanalyticsLayerRequest)
Below are parameters of `MapplsGeoanalyticsLayerRequest` class.
- **geoboundType** (mandatory): It is of type `String`. It accepts type of geographical extents on which data would be bound. eg. "India", "State", "District" etc.
- **geobound** (mandatory): It is an array of type `MapplsGeoanalyticsGeobound`. For more info see [here](#MapplsGeoanalyticsGeobound).
- **propertyName** (mandatory): It is an array of type `String`. eg. ["stt_nme"], ["stt_id"], ["t_p"].
- **layerType** (mandatory): It is the type of layer that user want to show on map it is an enum of type `MapplsGeoanalyticsLayerType`.
The following are optional parameters
- **query** (optional): A string containing an operator and a value which would be applied to
the attribute filter. < (Less than)/ > (Greater then)/ <> (Between).
Note: (*) Mandatory if Attribute is given. Example-I: ‘> 10000’, Example-II: BETWEEN
‘value1’ AND ‘value2’
- **attribute** (optional): The name of Attribute to filter the output. For eg: Population/Household
- **transparent:** (optional): It is the property to make the layer transparent.
#### [MapplsGeoanalyticsGeobound](#MapplsGeoanalyticsGeobound)
Instance of `MapplsGeoanalyticsGeobound` is used as a parameter in class `MapplsGeoanalyticsLayerRequest`. It has two properties `geobound` and `appearance`(optional). Where appearance is of type `GeoanalyticsLayerAppearance`.
##### [GeoanalyticsLayerAppearance](#GeoanalyticsLayerAppearance):
This is the class used to set the appearance of the layer, i.e layerColor, textColor, border color etc. it has following properties:
- fillColor
- fillOpacity
- labelColor
- labelSize
- strokeColor
- strokeWidth
### Step 2 - Adding GeoAnalytics layer on Map
A function `showGeoanalyticsLayer` available in `MapplsGeoanalyticsPlugin` which accepts a parameter of type `MapplsGeoanalyticsLayerRequest`.
Plugin internally consume that request to get response and plot layer on Map accordingly.
``` swift
self.geoanalyticsPlugin.showGeoanalyticsLayer(layerRequestState)
```
### Other Methods Available:
**1. Remove GeoAnalytics Layer**
`removeGeonalyticsLayer` is a function which accepts request of type `MapplsGeoanalyticsLayerRequest` to remove related layer from map.
``` swift
geoanalyticsPlugin.removeGeoanalyticsLayer(layerRequestState))
```
**2. GeoAnalytics Layer Info**
A delegate function can be used for information of layer where map is tapped.
Below is the delegate function which returns response of feature info api.
```swift
func didGetFeatureInfoResponse(_ featureInfoResponse:GeoanalyticsGetFeatureInfoResponse) {
print(featureInfoResponse.features)
}
```
**3. Layer Popup**
A popup will be shown for information of layer where map is tapped. There is a property `shouldShowPopupForGeoanalyticsLayer` available to enable or disable that popup. It is of type Bool by default its value is `false`.
```swift
geoanalyticsPlugin.shouldShowPopupForGeoanalyticsLayer = true
```
**4. Custom Popup**
A delegate function can be used to show custom popup for layer information. Below is delegate function for the same.
```swift
// To show default popup return nil.
func view(forGeoanalyticsInfo response: GeoanalyticsGetFeatureInfoResponse) -> UIView? {
return nil
}
```
Delegate gives information of layer and accepts to return an instance of `UIView` to show as custom popup.
## [Use of Listing API](#Use-of-Listing-API)
### Introduction:
MapplsGeoanalytics plugin contains a manager class to consume Mappls's `Listing API`. Listing API is an API that gives the user's 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 provides list of attributes along with unique ID. User can get bounding box of the required feature/area as well.
For more information about `Listing API` see [here](https://www.Mappls.com/api/advanced-maps/geoanalytics-web-js/listingapi).
### Step 1 - Create Request
First create an instance of `GeoanalyticsListingAPIRequest` as shown below.
```swift
let listingRequest = GeoanalyticsListingAPIRequest(geoboundType: "stt_nme", geobound: ["HARYANA","UTTAR PRADESH","ANDHRA PRADESH","KERALA"], attribute: "b_box", api: .state)
```
Possible request parameters in class of `GeoanalyticsListingAPIRequest` are listed below.
#### GeoanalyticsListingAPIRequest
- **geoboundType:** It is of type string which accepts the type of geobound.
- **geobound:** Single valued parent type, for example: stt_nme, dst_nme, sdb_nme etc.
**Note**: For parent type reference, contact [apisupport@Mappls.com](mailto:apisupport@Mappls.com)
- **attribute:** field name/bounding Box requested w.r.t api (api) & parent type (geo_bound_type). Bounding box can be requested as "b_box" variable.
- **api:** It is an enum of type `MapplsGeoanalyticsLayerType` which specifie type of listing api.
### Step 2 - Send Request
Use shared instance of `MapplsGeoanalyticsListingManager` and call `getListingInfo` method which accepts request parameter of type `GeoanalyticsListingAPIRequest` as created in previous step. Method `getListingInfo` returns response of type `GeoanalyticsListingAPIsResponse` and error of type `NSError` in completion code block.
``` swift
let listingManager = MapplsGeoanalyticsListingManager.shared()
listingManager.getListingInfo(listingRequest) { (response, error) in
if (error != nil) {
print(error.code)
} else {
print(response)
}
}
```
#### GeoanalyticsListingAPIsResponse
`GeoanalyticsListingAPIsResponse` contains following properties.
- ***responseCode:*** It is of type `NSString`
- ***version:*** It is the response attribute of type `NSString`
- ***totalFeatureCount:*** IT is the response attribute of type `NSString`.
- ***results:*** It is the response parameter which is of type
`GeoanalyticsListingAPIsResult`.
GeoanalyticsListingAPIsResult is the class which contains following property.
- ***apiName:*** it the parameter of type `NSString`
- ***attribute:*** it is the parameter of type `NSString`
- ***getAttrValues:*** it is an array of type `GeoanalyticsGetAttrValues`
GeoanalyticsGetAttrValues is class which contains following attribute.
- ***geo_bound:*** It is of type `NSSting`.
- ***getAttrValues:*** It is the array of type `NSDictionary`.
## Our many happy customers:
For any queries and support, please contact:
[
](https://about.mappls.com/api/)
Email us at [apisupport@mappls.com](mailto:apisupport@mappls.com)
[Support](https://about.mappls.com/contact/)
Need support? contact us!
[
](https://stackoverflow.com/questions/tagged/mappls-api)[](https://about.mappls.com/blog/)[](https://github.com/mappls-api)[
](https://www.npmjs.com/org/mapmyindia)
[
](https://www.facebook.com/Mapplsofficial)[](https://twitter.com/mappls)[](https://www.linkedin.com/company/mappls/)[](https://www.youtube.com/channel/UCAWvWsh-dZLLeUU7_J9HiOA)
@ Copyright 2020 CE Info Systems Pvt. Ltd. All Rights Reserved.
Terms & Conditions | Privacy Policy | Supplier Sustainability Policy | Health & Safety Policy | Environmental Policy & CSR Report
Customer Care: +91-9999333223