Flutter MapLibre GL

Pub Version likes Pub Points stars

This Flutter plugin allows to show embedded interactive and customizable vector maps as a Flutter widget.

  • This project is a fork of flutter-mapbox-gl, replacing its usage of Mapbox GL libraries with the open source MapLibre GL libraries.
  • The repository has been transferred to the MapLibre organization. You shouldn't see any negative effects, as GitHub automatically redirects references from the old URL to the new URL. Please see #221 for more information.

Supported Platforms

This project only supports a subset of the API exposed by these libraries.

Supported API

Feature Android iOS Web
Style ✅ ✅ ✅
Camera ✅ ✅ ✅
Gesture ✅ ✅ ✅
User Location ✅ ✅ ✅
Symbol ✅ ✅ ✅
Circle ✅ ✅ ✅
Line ✅ ✅ ✅
Fill ✅ ✅ ✅
Fill Extrusion ✅ ✅ ✅
Heatmap Layer ✅ ✅ ✅

Get Started

Add as a dependency

Add maplibre_gl to your project by running this command:

flutter pub add maplibre_gl

or add it directly as a dependency to your pubspec.yaml file:

dependencies:
  maplibre_gl: ^0.19.0

iOS

There is no specific setup for iOS needed any more to use the package. If you added specific lines in an earlier version, you'll have to remove them or your project won't build.

View obsolete code 
source 'https://cdn.cocoapods.org/'
source 'https://github.com/m0nac0/flutter-maplibre-podspecs.git'

pod 'MapLibre'
pod 'MapLibreAnnotationExtension'

Use the location feature

If you access your users' location, you should also add the following key to ios/Runner/Info.plist to explain why you need access to their location data:

<dict>
  <key>NSLocationWhenInUseUsageDescription</key>
  <string>[Your explanation here]</string>
</dict>

A possible explanation could be: "Shows your location on the map".

Android

There is no specific setup for android needed to use the package.

Use the location feature

If you want to show the user's location on the map you need to add the ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION permission in the application manifest android/app/src/main/AndroidManifest.xml.:

<manifest>
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
</manifest>

Starting from Android API level 23 you also need to request it at runtime. This plugin does not handle this for you. Our example app uses the flutter "location" plugin for this.

Web

Include the following JavaScript and CSS files in the <head> of your web/index.html file:

<script src='https://unpkg.com/maplibre-gl@^4.3/dist/maplibre-gl.js'></script>
<link href='https://unpkg.com/maplibre-gl@^4.3/dist/maplibre-gl.css'
      rel='stylesheet'/>

Map Styles

Map styles can be supplied by setting the styleString in the MapLibreMap constructor. The following formats are supported:

  1. Passing the URL of the map style. This should be a custom map style served remotely using a URL that start with http(s)://
  2. Passing the style as a local asset. Create a JSON file in the assets and add a reference in pubspec.yml. Set the style string to the relative path for this asset in order to load it into the map.
  3. Passing the style as a local file. create an JSON file in app directory (e.g. ApplicationDocumentsDirectory). Set the style string to the absolute path of this JSON file.
  4. Passing the raw JSON of the map style. This is only supported on Android.

Tile sources requiring an API key

If your tile source requires an API key, we recommend directly specifying a source url with the API key included. For example:

https://tiles.example.com/{z}/{x}/{y}.vector.pbf?api_key={your_key}

Documentation

Getting Help

  • Need help with your code?: Check the discussions on this repo or open a new one. Or look for previous questions on the #maplibre tag — or ask a new question.
  • Have a bug to report? Open an issue. If possible, include a full log, code 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.

Common problems & frequent questions

Loading .mbtiles tile files or sprites/glyphs from the assets shipped with the app

Click here to expand / hide.

One approach that has been used successfully to do that is to copy the files from the app's assets directory to another directory, e.g. the app's cache directory, and then reference that location. See e.g. issues https://github.com/maplibre/flutter-maplibre-gl/issues/338 and https://github.com/maplibre/flutter-maplibre-gl/issues/318

Avoid Android UnsatisfiedLinkError

Click here to expand / hide.

Update buildTypes in android\app\build.gradle

buildTypes {
    release {
        // other configs
        ndk {
            abiFilters 'armeabi-v7a','arm64-v8a','x86_64', 'x86'
        }
    }
}

iOS app crashes when using location based features

Click here to expand / hide.

Please include the NSLocationWhenInUseUsageDescription as described here

Layer is not displayed on IOS, but no error

Click here to expand / hide.

Have a look in your LayerProperties object, if you supply a lineColor argument, (or any color argument) the issue might come from here. Android supports the following format : 'rgba(192, 192, 255, 1.0)', but on iOS, this doesn't work!

You have to have the color in the following format : #C0C0FF

iOS crashes with error: 'NSInvalidArgumentException', reason: 'Invalid filter value: filter property must be a string'

Click here to expand / hide.

Check if one of your expression is : ["!has", "value"]. Android support this format, but iOS does not. You can replace your expression with : ["!",["has", "value"] ] which works both in Android and iOS.

Note : iOS will display the error : NSPredicate: Use of 'mgl_does:have:' as an NSExpression function is forbidden, but it seems like the expression still works well.

Contributing

Feedback, contributing pull requests and bug reports are very welcome!

Libraries

maplibre_gl
This library contains the MapLibre GL plugin for Flutter.