Map.ir Flutter Plugin based on Mapbox GL

This Flutter plugin for Map.ir Map SDKs enables embedded interactive and customizable vector maps inside a Flutter widget by embedding Android and iOS views.

screenshot.png

Install

This project is available on pub.dartlang, follow the instructions to integrate a package into your flutter application.

Running example app

  • Install Flutter and validate its installation with flutter doctor
  • Clone this repository with git clone git@github.com:map-ir/mapir-flutter-map-sdk.git
  • Run the app with cd mapir-flutter-map-sdk/example && flutter run

Mapir Api Key

This project uses Map.ir vector tiles, which requires a Map.ir account and an API key. Obtain a free access token on Map.ir App Registration.

Android

Add Mapi.ir read token value in the application manifest android/app/src/main/AndroidManifest.xml:

  <application ...
    <meta-data android:name="ir.map.apikey" android:value="YOUR_TOKEN_HERE" />

iOS

Add these lines to your Info.plist

<key>io.flutter.embedded_views_preview</key>
<true/>
<key>MapirAPIKey</key>
<string>YOUR_TOKEN_HERE</string>

Supported API

FeatureAndroidiOS
Style:white_check_mark::white_check_mark:
Camera:white_check_mark::white_check_mark:
Gesture:white_check_mark::white_check_mark:
User Location:white_check_mark::white_check_mark:
Symbol:white_check_mark::white_check_mark:
Circle:white_check_mark::white_check_mark:
Line:white_check_mark::white_check_mark:
Fill

Offline Sideloading

Support for offline maps is available by "side loading" the required map tiles and including them in your assets folder.

  • Place the tiles.db file generated in step one in your assets directory and add a reference to it in your pubspec.yml file.
   assets:
     - assets/cache.db
  • Call installOfflineMapTiles when your application starts to copy your tiles into the location where Mapir can access them. NOTE: This method should be called before the Map widget is loaded to prevent collisions when copying the files into place.
    try {
      await installOfflineMapTiles(join("assets", "cache.db"));
    } catch (err) {
      print(err);
    }

Documentation

Please visit Map.ir Support for this flutter plugin, iOS Maps SDK docs and Android Maps SDK docs for more info about native SDKs.

Visit Map.ir/developers/android if you'd like more information about the Mapir Maps SDK for Android and Map.ir/ios-sdk for more information about the Mapir Maps SDK for iOS.

Getting Help

  • Need help with your code?: Look for previous questions on the #mapir tag — or ask a new question.
  • Have a bug to report? Open an issue. If possible, include a full log and information which shows the issue.
  • Have a feature request? Open an issue. Tell us what the feature should do and why you want the feature.

Sample code

This repository's example library is currently the best place for you to find reference code for this project. See other samples at Flutter docs.

Libraries

mapbox_gl