MapplsMap 6.0.0

Maintained by MapmyIndia, MapmyIndia, MapmyIndia, MapmyIndia.

You want to add pod 'MapplsMap', '~> 6.0' similar to the following to your Podfile:

target 'MyApp' do
  pod 'MapplsMap', '~> 6.0'
end

Then run a pod install inside your terminal, or from CocoaPods.app.

Alternatively to give it a test run, run the command:

pod try MapplsMap

MapplsMap 6.0.0

By
MAPPLS
mappls

Mappls Map SDK

Introduction

This repository contains a sample project of an app built for iOS, which is based on Mappls's Map and other differennt SDKs.

Welcome to the Mappls iOS SDK

Explore the largest directory of APIs & SDKs for maps, routes and search.

Mappls's APIs, SDKs, and live updating map data available for 238 nations give developers tools to build better mapping, navigation, and search experiences across platforms.

In this section you will find documentation for :-

Detailed information about integration of Vector iOS Map.
REST APIs module is a custom module for developers to consume our RESTful APIs within their applications, easily, and without having to develop such\nfunctionality from scratch.
Detailed information related to how to integrate Mappls Widgets.

Map SDK

MapplsMap is a SDK to display map, mark locations, enhance with custom data and even draw routes or other shapes on top.

Getting Started

Mappls's Map SDK for iOS lets you easily add Mappls Map and web services to your own iOS app. Mappls's Map SDK for iOS supports iOS SDK 9.0 and above and Xcode 10.1 or later. You can have a look at the map and features you will get in your own app by using the Mappls's Maps app for iOS. The SDK handles map tiles download and their display along with a bunch of controls and native gestures.

Version History

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Version	Dated	Description
`5.13.9`	07 Jun, 2023	Bug fixes & Improvements.
`5.13.8`	30 May, 2023	Domain of APIs changed.
`5.13.7`	02 May, 2023	Performance improvements and optimization.
`5.13.6`	20 Mar, 2023	Performance improvements and optimization.
`5.13.5`	31 Jan, 2023	Fixed ¨C6C not getting called and added a class ¨C7C which can be used to initialize SDK using the method ¨C8C
¨C9C	13 Oct, 2022	Give ¨C10C in delegate function ¨C11C on map tap. Performance improvements and optimization.
¨C12C	08 Sep, 2022	Issue Resolved: Tiles not loading on CarPlay when phone is in locked state.
¨C13C	18 Aug, 2022	Bug Resolved: Session not resetting.
¨C14C	20 Jul, 2022	Bug Resolved: Duplicate Bundle Id.
¨C15C	11 June, 2022	Initial Mappls Map Release.

Setup your Project

Create a new project in Xcode.

\n¨C97C\n¨C98C\n\n

¨C99C

\n¨C100C\n¨C101C\n\n\n¨C102C\n\n

Authorization

MapplsAPICore

It is required to set Mappls keys to use any MAPPL's SDK. Please refer to documenatation here.

MapplsMap

A class ¨C22C can be used to authorize the Map.

It is recommended to call this method before initilizing ¨C23C.

Swift

¨C103C

Objective - C

¨C104C

Note: Although authorization of Map is done internally on initilizing ¨C24C, ¨C105C

Usage

Add a Mappls Map View

Map View on view controller can be added either using interface builder or programmatically.

By Interface Builder

In a storyboard, add a view to your View Controller. In the Identity inspector, change its class to ¨C25C.
\n¨C106C Map style url need to be set at the time of load map

By Programmatically

To add map on view Controller create an instance of ¨C26C. and add this to view of ¨C27C.

Objective C

¨C107C

Swift

¨C108C

¨C109C Also to handle app transport security exception add ¨C28C in Info.plist of your project. As follows:

¨C29C

Map Interactions

Set Zoom Level

Set zoom to 4 for country level display and 18 for house number display.

Objective C

¨C110C

Swift

¨C111C

Set Map Center

To set Center of map reference code is below:

Objective C

¨C112C

Swift

¨C113C

Map Features

Current Location

To show user's current location on map, use property ¨C30C and set its value to true.

Objective C

¨C114C

Swift

¨C115C

Tracking Mode

To move map with user location change use property ¨C31C. Its an enum property of type ¨C32C. You can set any value from following:

\n¨C116C\n¨C117C\n¨C118C\n\n

Objective C

¨C119C

Swift

¨C120C

Map Events

The Map object should implement the methods of the ¨C36C protocol corresponding to the events you wish it to receive. This delegate can also be used to detect map overlays selection. Delegate handles gesture events, tap on annotation (marker) and map center coordinates.

Map Position Changes Events

¨C37C

Loading the Map Events

-authorizationCompleted:withError:

This delegate function will be called whenever authorization process of map completed. It gives either sucess or error

¨C121C

¨C122C

¨C123C

¨C124C

-mapViewWillStartLoadingMap:

Tells the delegate that the map view will begin to load.

This method is called whenever the map view starts loading, including when a new style has been set and the map must reload.

¨C125C

¨C126C

¨C127C

¨C128C

-mapViewDidFinishLoadingMap:

Tells the delegate that the map view has finished loading.

This method is called whenever the map view finishes loading, either after the initial load or after a style change has forced a reload.

¨C129C

¨C130C

¨C131C

¨C132C

-mapViewDidFailLoadingMap:withError:

Tells the delegate that the map view was unable to load data needed for displaying the map.

This method may be called for a variety of reasons, including a network connection failure or a failure to fetch the style from the server. You can use the given error message to notify the user that map data is unavailable.

¨C133C

¨C134C

¨C135C

¨C136C

-mapViewWillStartRenderingFrame:

Tells the delegate that the map view is about to redraw.

This method is called any time the map view needs to redraw due to a change in the viewpoint or style property transition. This method may be called very frequently. Therefore, your implementation of this method should be as lightweight as possible to avoid affecting performance.

¨C137C

¨C138C

¨C139C

¨C140C

-mapViewDidFinishRenderingFrame:fullyRendered:

Tells the delegate that the map view has just redrawn.

¨C141C

¨C142C

¨C143C

¨C144C

-mapViewDidBecomeIdle:

Tells the delegate that the map view is entering an idle state, and no more drawing will be necessary until new data is loaded or there is some interaction with the map.

¨C145C

¨C146C

¨C147C

¨C148C

-mapView:didFinishLoadingStyle:

Tells the delegate that the map has just finished loading a style.

This method is called during the initialization of the map view and after any subsequent loading of a new style.

¨C149C

¨C150C

¨C151C

¨C152C

-mapView:didTapPlaceWithMapplsPin:

This delegate function gives ¨C38C.

This method is called on tap on map and gives either string value (Mappls Pin) or nil value (if no Mappls Pin found).

¨C153C

¨C154C

¨C155C

¨C156C

SDK Error Codes

Map will fail with following error codes

\n¨C157C\n¨C158C\n¨C159C\n¨C160C\n¨C161C\n¨C162C\n¨C163C\n\n

Tracking User Location Events

¨C39C

Appearance of Annotations Events

¨C40C

Annotation Views Events

¨C41C

Selecting Annotations Events

¨C42C

Callout Views Events

¨C43C

Map Tap Events

Single Tap Gesture

To capture single tap on map events add a tap gesture to instance of ¨C44C. Tapped CGPoint on map can be converted to CLLocationCoordinate object. Also if there is any mareker in tapped area that can also be retrieved. Code for reference to explain above features is below:

Objective C

¨C164C

Swift

@objc func didTapMap(tap: UITapGestureRecognizer) {\n if tap.state == .ended {\n let point = tap.location(in: mapView)\n\n // Convert tapped area point to a CLLocationCoordinate object\n let coordinate = mapView.convert(point, toCoordinateFrom: mapView)\n\n // Also existing annotation or features can be checked on tapped area point\n let visibleFeatures = mapView.visibleFeatures(at: point)\n if visibleFeatures.count > 0 {\n\n }\n }\n}\">¨C165C

Long Tap Gesture

To capture long press on map events add a long press gesture to instance of ¨C45C.

Objective C

¨C166C

Swift

¨C167C

Map Overlays

Add marker

To show an annotation on map create an instance of ¨C46C and add that object to instance of ¨C47C using method ¨C48C.

After creating instance of ¨C49C, set coordinate and title property values.

Objective C

¨C168C

Swift

¨C169C

Remove marker

Objective C

¨C170C

Swift

¨C171C

Custom Marker (Change Default Marker Icon)

To change image for default marker you can use delegate methods of protocol
\n¨C50C.\nEither you can override whole view of marker by using below method of delegate:

¨C51C

or you can override image of marker by using below method of delegate:

¨C52C

Show Info Window (Callout)

To enable info window on tap of marker return true from below delegate method:

¨C172C

Custom Info Window(#Custom-Info-Window)

To change default callout view of annotation use delegate function of ¨C53C protocol and return custom view of callout from that function.

¨C173C

To create custom callout view create a class inherited from ¨C54C and ¨C55C. Override draw function of ¨C56C to design your own callout view.

Polylines

Add a Polyline

To show a polyline on map create an instance of ¨C57C and add that object to instance of ¨C58C using method ¨C59C.

To create instance of ¨C60C an array of ¨C61C will be required so first create an array of ¨C62C.

Objective C

¨C174C

Swift

¨C175C

Remove a Polyline

Objective C

¨C176C

Swift

¨C177C

Polyline Width

Line width in points can be set when rendering the outline of a polyline annotation. It cab be achieve by using delegate method ¨C63C.

By default, the polyline is outlined with a line 3.0 points wide.

Objective C

¨C178C

Swift

¨C179C

Polygons

Add a Polygon

To show a polygon on map create an instance of ¨C64C and add that object to instance of ¨C65C using method ¨C66C.

To create instance of ¨C67C an array of ¨C68C will be required so first create an array of ¨C69C.

Objective C

¨C180C

Swift

¨C181C

Remove a Polygon

Objective C

¨C182C

Swift

¨C183C

Map Camera

Fit Map Camera

¨C70C function sets the visible region so that the map displays the specified annotations.

Swift

¨C184C

Create Camera For Shape

A camera object that best fits the given shape with some additional padding on each side while looking in the specified direction can be retrieved using function ¨C71C of ¨C72C.

After creating a camera object using above function it can be set to fit map visible area.

Objective C

¨C185C

Swift

¨C186C

Miscellaneous

Shape Stroke Color

Color of ¨C73C and stroke color of ¨C74C can be changed by using delegate method ¨C75C.

The default stroke color is the map view’s tint color.

Objective C

¨C187C

Swift

¨C188C

Shape Fill Color

Fill Color of ¨C76C can be changed by using delegate method ¨C77C.

The default fill color is the map view’s tint color.

Objective C

¨C189C

Swift

¨C190C

Shape Opacity

To change opacity of a shape i.e polyline or polygon, delegate method ¨C78C can be used.

It sets the opacity of an entire shape, inclusive of its stroke and fill.

Objective C

¨C191C

Swift

¨C192C

Safety Status Strip

A safety status strip can be show on map based on user's location. COVID-19 status will be shown on map currently, It will show whether user's location lies in a containment zone or not and conaintment zone info like Containment Zone Name, District etc. For more info about how to use go to Safety Strip.

Cluster Based Authentication

Map SDK can be configured such that it can work only for specified unique identifier of a device and will show an error accordingly.

Set Cluster Device

Cluster Identifier can be set and retrieve using singelton class ¨C79C which is part of Map SDK's dependency ¨C80C.

Below is code for reference to set and get cluster identifier.

Objective C

¨C193C

Swift

¨C194C

SwiftUI

Create Map View

\n¨C195C\n¨C196C\n¨C197C\n¨C198C\n\n

To add map annoations at design time add an ¨C85C property in ¨C86C struct as below:

¨C87C

Use below code to add marker at design time by setting annotations property.

@State var annotations: [MGLPointAnnotation] = [\n MGLPointAnnotation(title: "MAPPLS", coordinate: .init(latitude: 28.550679, longitude: 77.268949))\n ]\n \n var body: some View {\n MapView(annotations: $annotations).centerCoordinate(.init(latitude: 28.550679, longitude: 77.268949)).zoomLevel(16)\n }\n}\">

¨C88C

Respond To Map Events

In order to to respond to map events, for example perform an action after MapView initialization finished. In SwiftUI, a Coordinator can be used with delegates, data sources, and user events. The UIViewRepresentable protocol defines makeCoordinator() method which creates coordinator instance. Add the following code to declare coordinator class:

¨C89C

And then add the following method to the SwiftUI view:

¨C90C

And finally set the reference coordinator on Mappls map view.

¨C91C

Our many happy customers:

$\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$ $\"\"$

\n
\n

For any queries and support, please contact:

Email us at [email protected]

$\"\"$ \nSupport\nNeed support? contact us!

$\"\"$ $\"\"$

$\"\"$ $\"\"$ $\"\"$

Terms & Conditions | Privacy Policy | Supplier Sustainability Policy | Health & Safety Policy | Environmental Policy & CSR Report\n

Customer Care: +91-9999333223

","renderedFileInfo":null,"shortPath":null,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"repoOwner":"mappls-api","repoName":"mappls-ios-sdk","showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","showDependabotConfigurationBanner":false,"actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timedOut":false,"notAnalyzed":true,"symbols":[]}},"copilotInfo":null,"csrf_tokens":{"/mappls-api/mappls-ios-sdk/branches":{"post":"34BCoosN16A3PfDmQRnmqi6S6QW5CAfZvuaYQXMnlylrwE9J-vdHLTFMr4xBRDYR7hRi3cKRIHkTdI3-FU12tQ"},"/repos/preferences":{"post":"Jvjw2wG4gvlg_JgMX9NSJRUt38J3hT4aA21j1-6_fLLTP4hG95AcwMONMuYOMrxfQq-cmEfO_5UhuOusxraBTg"}}},"title":"mappls-ios-sdk/docs/v1.0.14/MapplsMap.md at main · mappls-api/mappls-ios-sdk"}