IMPORTANT: This plugin is no longer under development
Why?
We initially built this plugin to fill an early gap in flutter. Since then, Google has made progress on their Google Map plugin.
Meanwhile, at AppTree, we've moved on to building a pure Dart implementation for mapping based off of leaflet, which you can find here. This plugin has the following important features:
- Allows inline maps within your Widget hierarchy (rather than full screen)
- Pins are just widgets. Very easy to customize
- 0 dependencies on native libraries. No more Google Play or Cocoapod dependencies!
- You can use any OpenStreetMap tiles as well as paid tile providers like MapBox and ESRI. Unfortunately, Google Map tiles are not available. You can find more about available tile providers here.
map_view
A flutter plugin for displaying google maps on iOS and Android
Please note: API changes are likely as we continue to develop this plugin.
Getting Started
Generate your API Key
- Go to: https://console.developers.google.com/
- Enable
Maps SDK for Android - Enable
Maps SDK for iOS - Under
Credentials, chooseCreate Credential.- Note: For development, you can create an unrestricted API key that can be used on both iOS & Android. For production it is highly recommended that you restrict.
- More detailed instructions for Android can be found here: https://developers.google.com/maps/documentation/android-sdk/signup
- More detailed instructions for iOS can be found here: https://developers.google.com/maps/documentation/ios-sdk/get-api-key
The way you register your API key on iOS vs Android is different. Make sure to read the next sections carefully.
iOS
The maps plugin will request your users location when needed. iOS requires that you explain this usage in the Info.plist file
- Set the NSLocationWhenInUseUsageDescription in
ios/Runner/Info.plist. Example:
<key>NSLocationWhenInUseUsageDescription</key>
<string>Using location to display on a map</string>
- Prior to using the Map plugin, you must call MapView.setApiKey(String apiKey). Example:
import 'package:map_view/map_view.dart';
void main() {
MapView.setApiKey("<your_api_key>");
runApp(new MyApp());
}
Note: If your iOS and Android API key are different, be sure to use your iOS API key here.
-
Add code to show the MapView.
//Create an instance variable for the mapView var _mapView = new MapView(); //Add a method to call to show the map. void showMap() { _mapView.show(new MapOptions(showUserLocation: true)); }
-
Run your application on an iOS device or simulator. Confirm that when you display the map you see map detail. If you only see a beige screen it's possible that your API key is incorrect. When your API key is incorrect you'll see messages like this in the console:
ClientParametersRequest failed, 7 attempts remaining (0 vs 12). Error Domain=com.google.HTTPStatus Code=400 "(null)" UserInfo={data=<>}
Common API Key problems for iOS
-
Your Bundle ID does not match what is registered in the Google API Console. When you create an restricted API key in the Google API console it asks you to specify your iOS bundle ID. Make sure that your iOS Bundle Identifier matches the one you registered in the console.
-
Using the wrong key. If you made a separate key for iOS and Android, make sure you are using the iOS key in the MapView.setApiKey() call.
Android
You will be making multiple edits to your AndroidManifest.xml file. In your Flutter project, you can find this file location under android/app/src/main
-
In your
AndroidManifest.xml, add the following uses-permission above the tag.<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/> <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
-
In your AndroidManifest.xml, add the following lines inside of the
applicationtag. Be sure to replaceyour_api_keywith the one you generated.<meta-data android:name="com.google.android.maps.v2.API_KEY" android:value="your_api_key"/> <meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version"/>
-
Add the MapActivity to your AndroidManifest.xml
<activity android:name="com.apptreesoftware.mapview.MapActivity" android:theme="@style/Theme.AppCompat.Light.DarkActionBar"/>
-
In your
android/build.gradlefile. UnderbuildScriptdependenciesadd:classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.1.2-4' -
Run your application on an Android device or simulator. Confirm that when you display the map you see map detail. If you only see a beige screen it's possible that your API key is incorrect.
Static Maps for Inline display
This plugin does not currently support displaying a Google Map within the Flutter widget hierarchy. A common workaround for this is to show a static image using the Google Static Maps API. Included in this Plugin is the StaticMapProvider class which will allow you to easily generate a static map. The Static Maps API also requires an API Key and you must enable the API within the Google API Console.
- Go to: https://console.developers.google.com/
- Enable
Maps Static API - Once enabled, you can use the same API key you generated for iOS/Android.
- Initialize the StaticMapProvider
var provider = new StaticMapProvider('your_api_key');
- The StaticMapProvider offers a few different APIs for generating static maps. If you want to generate an image for the current viewport of your full screen interactive map you can use:
var uri = staticMapProvider.getImageUriFromMap(mapView,
width: 900, height: 400);
You can refer to the example project if you run into any issues with these steps.
 |
 |
Features
- iOS Support
- Android Support
- Toolbar support
- Update Camera position
- Add Map pins
- Receive map pin touch callbacks
- Receive map touch callbacks
- Receive location change callbacks
- Receive camera change callbacks
- Zoom to a set of annotations
- Customize Pin color
- Polyline support
- Polygon support
- Customize pin image
- Remove markers, polylines & polygons.
Upcoming
- Bounds geometry functions
Usage examples
Show a map ( with a toolbar )
mapView.show(
new MapOptions(
mapViewType: MapViewType.normal,
showUserLocation: true,
initialCameraPosition: new CameraPosition(
new Location(45.5235258, -122.6732493), 14.0),
title: "Recently Visited"),
toolbarActions: [new ToolbarAction("Close", 1)]);
Get notified when the map is ready
mapView.onMapReady.listen((_) {
print("Map ready");
});
Add multiple pins to the map
mapView.setMarkers(<Marker>[
new Marker("1", "Work", 45.523970, -122.663081, color: Colors.blue),
new Marker("2", "Nossa Familia Coffee", 45.528788, -122.684633),
]);
Add a single pin to the map
mapView.addMarker(new Marker("3", "10 Barrel", 45.5259467, -122.687747,
color: Colors.purple));
Edit custom Marker image
First add your assets to a folder in your project directory. The name of the folder could be any but "images" or "assets" are the more common. It should look like this.
- project_name
|-android
|-images
|-flower_vase.png
|-ios
|-lib
# Rest of project folders and files
Then add asset to the pubspec.yaml under flutter tag.
flutter:
# Code already existent
# Added asset.
assets:
- images/flower_vase.png
Finally use the asset name as icon for your marker. If the width or height is not set or is equals to 0, the image original value of said attribute will be used.
new Marker(
"1",
"Something fragile!",
45.52480841512737,
-122.66201455146073,
color: Colors.blue,
draggable: true, //Allows the user to move the marker.
markerIcon: new MarkerIcon(
"images/flower_vase.png", //Asset to be used as icon
width: 112.0, //New width for the asset
height: 75.0, // New height for the asset
),
);
Set a Marker draggable and listening to position changes
First set the draggable attribute of a marker to true.
Marker marker=new Marker(
"1",
"Something fragile!",
45.52480841512737,
-122.66201455146073,
draggable: true, //Allows the user to move the marker.
);
Now add listeners for the events.
// This listener fires when the marker is long pressed and could be moved.
mapView.onAnnotationDragStart.listen((markerMap) {
var marker = markerMap.keys.first;
var location = markerMap[marker]; // The original location of the marker before moving it. Use it if needed.
print("Annotation ${marker.id} dragging started");
});
// This listener fires when the user releases the marker.
mapView.onAnnotationDragEnd.listen((markerMap) {
var marker = markerMap.keys.first;
var location = markerMap[marker]; // The actual position of the marker after finishing the dragging.
print("Annotation ${marker.id} dragging ended");
});
// This listener fires every time the marker changes position.
mapView.onAnnotationDrag.listen((markerMap) {
var marker = markerMap.keys.first;
var location = markerMap[marker]; // The updated position of the marker.
print("Annotation ${marker.id} moved to ${location.latitude} , ${location
.longitude}");
});
Add a single polyline to the map
mapView.addPolyline(new Polyline(
"12",
<Location>[
new Location(45.519698, -122.674932),
new Location(45.516687, -122.667014),
],
width: 15.0));
Add multiple polylines to the map
mapView.setPolylines(<Polyline>[
new Polyline(
"11",
<Location>[
new Location(45.523970, -122.663081),
new Location(45.528788, -122.684633),
new Location(45.528864, -122.667195),
],
jointType: FigureJointType.round,
width: 15.0,
color: Colors.orangeAccent,
),
new Polyline(
"12",
<Location>[
new Location(45.519698, -122.674932),
new Location(45.516687, -122.667014),
],
width: 15.0,
),
]);
Add a single polygon to the map
mapView.addPolygon(new Polygon(
"111",
<Location>[
new Location(45.5231233, -122.6733130),
new Location(45.5233225, -122.6732969),
new Location(45.5232398, -122.6733506),
new Location(45.5231233, -122.6733130),
],
jointType: FigureJointType.round,
strokeWidth: 5.0,
strokeColor: Colors.red,
fillColor: Color.fromARGB(75, 255, 0, 0),
));
Add multiple polygons to the map
mapView.setPolygons(<Polygon>[
new Polygon(
"111",
<Location>[
new Location(42.9274334, -72.2811234),
new Location(42.9258230, -72.2808444),
new Location(42.9261294, -72.2779906),
new Location(42.9275120, -72.2779155),
],
//you can add a hole inside the polygon
holes: <Hole>[
new Hole(
<Location>[
new Location(42.9270721, -72.2797287),
new Location(42.9266400, -72.2796750),
new Location(42.9267186, -72.2790956),
new Location(42.9270014, -72.2790956),
],
),
],
jointType: FigureJointType.round,
strokeWidth: 5.0,
strokeColor: Colors.red,
fillColor: Color.fromARGB(75, 255, 0, 0)),
new Polygon(
"111",
<Location>[
new Location(45.5231233, -122.6733130),
new Location(45.5233225, -122.6732969),
new Location(45.5232398, -122.6733506),
new Location(45.5231233, -122.6733130),
],
jointType: FigureJointType.round,
strokeWidth: 5.0,
strokeColor: Colors.red,
fillColor: Color.fromARGB(75, 255, 0, 0)),
]);
Remove elements from the map
//Remove all markers
mapView.clearA
Zoom to fit all the pins on the map
mapView.zoomToFit(padding: 100);
Receive location updates of the users current location
mapView.onLocationUpdated
.listen((location) => print("Location updated $location"));
Receive marker, polyline & polygon touches
//Marker
mapView.onTouchAnnotation.listen((annotation) => print("annotation ${annotation.id} tapped"));
//Polyline
mapView.onTouchPolyline.listen((polyline) => print("polyline ${polyline.id} tapped"));
//Polygon
mapView.onTouchPolygon.listen((polygon) => print("polygon ${polygon.id} tapped"));
Receive map touches
mapView.onMapTapped
.listen((location) => print("Touched location $location"));
mapView.onMapLongTapped
.listen((location) => print("Long tapped location $location"));
Receive indoor building & indoor level
mapView.onIndoorBuildingActivated.listen(
(indoorBuilding) => print("Activated indoor building $indoorBuilding"));
mapView.onIndoorLevelActivated.listen(
(indoorLevel) => print("Activated indoor level $indoorLevel"));
Receive camera change updates
mapView.onCameraChanged.listen((cameraPosition) =>
this.setState(() => this.cameraPosition = cameraPosition));
Receive toolbar actions
mapView.onToolbarAction.listen((id) {
if (id == 1) {
_handleDismiss();
}
});
Get the current zoom level
double zoomLevel = await mapView.zoomLevel;
Get the maps center location
Location centerLocation = await mapView.centerLocation;
Get the visible markers on screen
List<Marker> visibleAnnotations = await mapView.visibleAnnotations;
1 Jul 15, 2022
415 Dec 29, 2022
86 Sep 26, 2022
75 Oct 25, 2022
5 Nov 13, 2022
85 Nov 30, 2022
1 Mar 18, 2022
2 Apr 19, 2022
127 Oct 22, 2022
69 Jul 19, 2022
178 Dec 16, 2022
97 Dec 30, 2022
0 Nov 23, 2022
6 Oct 31, 2022
1 Mar 28, 2022
16 Dec 31, 2022
2 Jan 6, 2023
4 Jul 26, 2022
0 Nov 1, 2021