flutter_osm_plugin 0.25.0-rc.3

openStreetMap plugin for flutter apps ( iOS available in alpha version,web is under-dev)

flutter_osm_plugin

Platform Support

Android	iOS	Web
supported ✔️	supported ✔️ (min iOS supported : 12)	under-development

osm plugin for flutter apps

• current position (Android/iOS)
• change position (Android/iOS)
• create Marker manually (Android/iOS)
• tracking user location (Android/iOS)
• customize Icon Marker (Android/iOS)
• customize user Marker (Android/iOS)
• assisted selection position (Android/iOS)
• set BoundingBOx (Android)
• draw Road,recuperate information (duration/distance) of the current road (Android/iOS)
• draw Road manually (Android/iOS)
• ClickListener on Marker (Android/iOS)
• ClickListener on Map (Android/iOS)
• calculate distance between 2 points
• address suggestion
• draw shapes (Only Android)
• simple dialog location picker (Android/iOS)

Getting Started

Installing

Add the following to your pubspec.yaml file:

dependencies:
  flutter_osm_plugin: ^0.25.0-rc.3

Migration to 0.16.0 (Android Only)

if you are using this plugin before Flutter 2

you should make some modification in build.gradle before that run flutter clean && flutter pub get

open file build.gradle inside android file

* change kotlin version from `1.4.21` to `1.5.21`
* change gradle version from `4.1.1` to `7.0.2`

Simple Usage

Creating a basic OSMFlutter :

 OSMFlutter( 
        controller:mapController,
        trackMyPosition: false,
        initZoom: 12,
        minZoomLevel: 8,
        maxZoomLevel: 14,
        stepZoom: 1.0,
        userLocationMarker: UserLocationMaker(
            personMarker: MarkerIcon(
                icon: Icon(
                    Icons.location_history_rounded,
                    color: Colors.red,
                    size: 48,
                ),
            ),
            directionArrowMarker: MarkerIcon(
                icon: Icon(
                    Icons.double_arrow,
                    size: 48,
                ),
            ),
        ),
        road: Road(
                startIcon: MarkerIcon(
                  icon: Icon(
                    Icons.person,
                    size: 64,
                    color: Colors.brown,
                  ),
                ),
                roadColor: Colors.yellowAccent,
        ),
        markerOption: MarkerOption(
            defaultMarker: MarkerIcon(
                icon: Icon(
                  Icons.person_pin_circle,
                  color: Colors.blue,
                  size: 56,
                  ),
                )
        ),
    );

MapController

Declare MapController to control OSM map

1) Initialisation

 MapController controller = MapController(
                            initMapWithUserPosition: false,
                            initPosition: GeoPoint(latitude: 47.4358055, longitude: 8.4737324),
                            areaLimit: BoundingBox( east: 10.4922941, north: 47.8084648, south: 45.817995, west: 5.9559113,),
                       );

2) Dispose

     controller.dispose();

3) Properties of MapController

Properties	Description
initMapWithUserPosition	(bool) initialize map with user position (default:true
initPosition	(GeoPoint) if it isn't null, the map will be pointed at this position
areaLimit	(Bounding) set area limit of the map (default BoundingBox.world())

4) Set map on user current position

 await controller.currentPosition();

5) Zoom IN

 await controller.setZoom(stepZoom: 2);
 // or 
 await controller.zoomIn();

5.1) Zoom Out

 await controller.setZoom(stepZoom: -2);
 // or 
 await controller.zoomOut();
 

5.2) change zoom level

zoomLevel should be between minZoomLevel and maxZoomLevel

 await controller.setZoom(zoomLevel: 8);

6) get current zoom level b>

await controller.getZoom();

7) BoundingBox

set bounding box in the map

await controller.limitAreaMap(BoundingBox( east: 10.4922941, north: 47.8084648, south: 45.817995, west: 5.9559113,));

remove bounding box in the map

await controller.removeLimitAreaMap();

8) Track user current position

for iOS,you should add those line in your info.plist file

   <key>NSLocationWhenInUseUsageDescription</key>
	<string>any text you want</string>
	<key>NSLocationAlwaysUsageDescription</key>
	<string>any text you want</string>

 await controller.enableTracking();

9) Disable tracking user position

 await controller.disabledTracking();

10) update the location

this method will create marker on that specific position

 await controller.changeLocation(GeoPoint(latitude: 47.35387, longitude: 8.43609));

Change the location without create marker

 await controller.goToLocation(GeoPoint(latitude: 47.35387, longitude: 8.43609));

11) recuperation current position

 GeoPoint geoPoint = await controller.myLocation();

12) get center map b>

GeoPoint centerMap = await controller.centerMapasync;

13) select/create new position

• we have 2 way to select location in map

13.1 Manual selection (deprecated)

a) select without change default marker

 GeoPoint geoPoint = await controller.selectPosition();

b) select position with dynamic marker

• Flutter widget

 GeoPoint geoPoint = await controller.selectPosition(
     icon: MarkerIcon(
                      icon: Icon(
                        Icons.location_history,
                        color: Colors.amber,
                        size: 48,
          ), 
);

• image from network

 GeoPoint geoPoint = await controller.selectPosition(  
         imageURL: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/back/1.png"
);

c) select using listener from controller directly

• for more example see home_example.dart c.1) single tap listener

controller.listenerMapSingleTapping.addListener(() {
      if (controller.listenerMapSingleTapping.value != null) {
        /// put you logic here
      }
    });

c.2) long tap listener

controller.listenerMapLongTapping.addListener(() {
      if (controller.listenerMapLongTapping.value != null) {
        /// put you logic here
      }
    });

13.2 Assisted selection (for more details see example)

 /// To Start assisted Selection
 await controller.advancedPositionPicker();
 /// To get location desired
  GeoPoint p = await controller.getCurrentPositionAdvancedPositionPicker();
  /// To get location desired and close picker
 GeoPoint p = await controller.selectAdvancedPositionPicker();
 /// To cancel assisted Selection
 await controller.cancelAdvancedPositionPicker();

14) Create Marker Programmatically

you can change marker icon by using attribute markerIcon

await controller.addMarker(GeoPoint,markerIcon:MarkerIcon,angle:pi/3);

14.1) Remove marker

 await controller.removeMarker(geoPoint);

• PS : static position cannot be removed by this method

15) Draw road,recuperate distance in km and duration in sec

you can add an middle position to pass your route through them

 RoadInfo roadInfo = await controller.drawRoad( 
   GeoPoint(latitude: 47.35387, longitude: 8.43609),
   GeoPoint(latitude: 47.4371, longitude: 8.6136),
   roadType: RoadType.car,
   intersectPoint : [ GeoPoint(latitude: 47.4361, longitude: 8.6156), GeoPoint(latitude: 47.4481, longitude: 8.6266)]
   roadOption: RoadOption(
       roadWidth: 10,
       roadColor: Colors.blue,
       showMarkerOfPOI: false
   ),
);
 print("${roadInfo.distance}km");
 print("${roadInfo.duration}sec");

15.b) draw road manually

await controller.drawRoadManually(
        waysPoint,
        Colors.purpleAccent,
        6.0,
      )

16) Delete last road

 await controller.removeLastRoad();

17) Change static GeoPoint position

add new staticPoints with empty list of geoPoints (notice: if you add static point without marker,they will get default maker used by plugin)

change their position over time

change orientation of the static GeoPoint with GeoPointWithOrientation

 await controller.setStaticPosition(List<GeoPoint> geoPoints,String id );

18) Change/Add Marker old/new static GeoPoint position

add marker of new static point

change their marker of existing static geoPoint over time

 await controller.setMarkerOfStaticPoint(String id,MarkerIcon markerIcon );

19) change orientation of the map

 await controller.rotateMapCamera(degree);

20) Draw Shape in the map

• Circle

 /// to draw
 await controller.drawCircle(CircleOSM(
              key: "circle0",
              centerPoint: GeoPoint(latitude: 47.4333594, longitude: 8.4680184),
              radius: 1200.0,
              color: Colors.red,
              strokeWidth: 0.3,
            ));
 /// to remove Circle using Key
 await controller.removeCircle("circle0");

 /// to remove All Circle in the map 
 await controller.removeAllCircle();

• Rect

 /// to draw
 await controller.drawRect(RectOSM(
              key: "rect",
              centerPoint: GeoPoint(latitude: 47.4333594, longitude: 8.4680184),
              distance: 1200.0,
              color: Colors.red,
              strokeWidth: 0.3,
            ));
 /// to remove Rect using Key
 await controller.removeRect("rect");

 /// to remove All Rect in the map 
 await controller.removeAllRect();

• remove all shapes in the map

 await controller.removeAllShapes();

Interfaces:

• OSMMixinObserver :

override mapIsReady to implement your own logic after initialisation of the map

mapIsReady will replace listenerMapIsReady

Methods	Description
mapIsReady	(callback) should be override this method, to get notified when map is ready to go or not

** example

class YourOwnStateWidget extends State<YourWidget> with OSMMixinObserver {

   //etc
  @override
  void initState() {
    super.initState();
    controller.addObserver(this);
  }
    @override
    Future<void> mapIsReady(bool isReady) async {
      if (isReady) {
        /// put you logic
      }
    }
    
    //etc
}

OSMFlutter

Properties	Description
mapIsLoading	(Widget) show custom widget when the map finish initialization
trackMyPosition	enable tracking user position.
showZoomController	show default zoom controller.
userLocationMarker	change user marker or direction marker icon in tracking location
markerOption	configure marker of osm map
stepZoom	set step zoom to use in zoomIn()/zoomOut() (default 1)
initZoom	set init zoom level in the map (default 10)
maxZoomLevel	set maximum zoom level in the map (2 <= x <= 19)
minZoomLevel	set minimum zoom level in the map (2 <= x <= 19 )
road	set color and start/end/middle markers in road
staticPoints	List of Markers you want to show always ,should every marker have unique id
onGeoPointClicked	(callback) listener triggered when marker is clicked ,return current geoPoint of the marker
onLocationChanged	(callback) it is fired when you activate tracking and user position has been changed
onMapIsReady	(callback) listener trigger to get map is initialized or not
showDefaultInfoWindow	(bool) enable/disable default infoWindow of marker (default = false)
isPicker	(bool) enable advanced picker from init of the map (default = false)
showContributorBadgeForOSM	(bool) enable to show copyright widget of osm in the map

Custom Controller

To create your own MapController to need to extends from BaseMapController, if you want to make a custom initialization to need to call init() and put your code after super.init()

• example

class CustomMapController extends BaseMapController {

  @override
  void dispose() {
    /// TODO put you logic here
    super.dispose();
  }

  @override
  void init() {
    super.init();
    /// TODO put you logic here
  }
}

STATIC METHODS:

1) Calculate distance between 2 geoPoint position

 double distanceEnMetres = await distance2point(GeoPoint(longitude: 36.84612143139903,latitude: 11.099388684927824,),
        GeoPoint( longitude: 36.8388023164018, latitude: 11.096959785428027, ),);

2) Get search Suggestion of text

you should know that i'm using public api, don't make lot of request

    List<SearchInfo> suggestions = await addressSuggestion("address");

show dialog picker

simple dialog location picker to selected user location

GeoPoint p = await showSimplePickerLocation(
                      context: context,
                      isDismissible: true,
                      title: "Title dialog",
                      textConfirmPicker: "pick",
                      initCurrentUserPosition: true,
                    )

CustomLocationPicker

customizable widget to build search location

you should use PickerMapController as controller for the widget see example : search widget

Properties of CustomLocationPicker

Properties	Description
controller	(PickerMapController) controller of the widget
appBarPicker	(AppBar) appbar for the widget
topWidgetPicker	(Widget?) widget will be show on top of osm map,for example to show address suggestion
bottomWidgetPicker	(Widget?) widget will be show at bottom of screen for example to show more details about selected location or more action

NOTICE:

For now the map working only for android,iOS will be available soon

If you get ssl certfiction exception,use can use http by following instruction below

If you want to use http in Android PIE or above :

• enable useSecureURL and add android:usesCleartextTraffic="true" in your manifest like example below :

  • <application ... android:usesCleartextTraffic="true">

if you faced build error in fresh project you need to follow those instruction #40

1) remove flutter_osm_plugin from pubspec, after that pub get
2) open android module in android studio ( right click in name of project -> flutter-> open android module in android studio)
3) update gradle version to 4.1.1 ( IDE will show popup to make update)
4) update kotlin version to 1.4.21 & re-build the project
5) re-add flutter_osm_plugin in pubspec , pub get ( or flutter clean & pub get )

Before you publish your application using this library, you should take care about copyright of openStreetMap Data, that's why i add CopyrightOSMWidget see example and this issue #101

MIT LICENCE