MPowerKit.GoogleMaps 1.0.1

MPowerKit.GoogleMaps

Google Maps SDK library for .NET MAUI. Very easy to use. Allows to interact with map in MVVM manner through bindings or with map control directly.

This library is designed for the .NET MAUI. The main control of this library GoogleMap implements every single feature that Google Maps SDK for Android and iOS provides. Every feature of the SDK is represented as BindableProperty, so you can build very flexible solutions that require usage of Google Maps.

Setup

First of all you need to make sure you have set up Google Cloud Console and obtained Google Maps API key.

Then you need to set up your project to be able to use Google Maps SDK. In your MainProgram.cs add next:

builder
    .UseMauiApp<App>()
    .UseMPowerKitGoogleMaps(
#if IOS
        "Your iOS API key here"
#endif
    );

and in Android's MainApplication.cs:

[Application]
[MetaData("com.google.android.maps.v2.API_KEY", Value = "Your Android API key here")]
public class MainApplication : MauiApplication
{
    public MainApplication(IntPtr handle, JniHandleOwnership ownership) : base(handle, ownership)
    { }
    
    protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
}

or in you Android's AndroidManifest.xml:

<application>
    
    <meta-data android:name="com.google.android.geo.API_KEY" android:value="Your Android API key here" />
</application>

Also, be sure you have added permissions to your Android's AndroidManifest.xml if you want to show 'My location' on the map:

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-feature android:name="android.hardware.location" android:required="false" />
<uses-feature android:name="android.hardware.location.gps" android:required="false" />
<uses-feature android:name="android.hardware.location.network" android:required="false" />

Usage

To use this library in you MAUI projects just add GoogleMap control you your xaml file as next:

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             x:Class="Sample.Views.MainPage"
             xmlns:gm="clr-namespace:MPowerKit.GoogleMaps;assembly=MPowerKit.GoogleMaps">
    <gm:GoogleMap />
</ContentPage>

The full list of all properties and features you can find here. Also every single feature is shown in Sample project, so it is better to download it and there you can find how to use feature you need.

API definition

!!! Important: If you cannot find documentation about some methods, event or properties here, then you can search some at offical Google Maps SDK web site.

API of this library is devided into 9 logical groups: Map features, Camera, UI Settings, Pins, Circles, Polylines, Polygons, Tiles, Ground overlays. Each logic group is represented as separate manager and responsible only for that part of logic, and preregistered in the public static dictionary inside the handler:

public static Dictionary<string, Func<IMapFeatureManager<GoogleMap, NativeMapView, GoogleMapHandler>>> ManagerMapper = new()
{
    { nameof(MapManager), () => new MapManager() },
    { nameof(CameraManager), () => new CameraManager() },
    { nameof(UiSettingsManager), () => new UiSettingsManager() },
    { nameof(PolylineManager), () => new PolylineManager() },
    { nameof(PolygonManager), () => new PolygonManager() },
    { nameof(CircleManager), () => new CircleManager() },
    { nameof(TileOverlayManager), () => new TileOverlayManager() },
    { nameof(GroundOverlayManager), () => new GroundOverlayManager() },
    { nameof(PinManager), () => new PinManager() },
};

Note: NativeMapView is different for Android and iOS

This approach is very flexible and gives you possibility to operate with different logics in a very simple way, and it is very easy understand, add, change or remove already registered implementations by your's. For example: if you want to remove some logic, you just need to remove registration from ManagerMapper dictionary, as next:

GoogleMapHandler.ManagerMapper.Remove(nameof(GroundOverlayManager));

If you want to change implementation, you can do next:

GoogleMapHandler.ManagerMapper[nameof(Pins)] = () => new YourPinManager();

If you want to add absolutely new logic to your map, you can do next:

GoogleMapHandler.ManagerMapper["YourManagerUniqueName"] = () => new YourNewLogicManager();

and your YourNewLogicManager should be typeof(IMapFeatureManager<GoogleMap, NativeMapView, GoogleMapHandler>)

Note: You can do it in your MauiProgram.cs or in any other place in your code. But you should understand, that this changes can be applied to the map only before navigating to the page with map.

Events and commands

Public methods, actions, funcs

Bindable properties

There are some readonly properties, which are not visible in XAML editor, but you can bind them. One condition, they can be bound only with Mode=OneWayToSource, otherwise it will not work. This means that value can be passed only from map control to the viewmodel. Example of usage:

<gm:GoogleMap MapCapabilities="{Binding MapCapabilities, Mode=OneWayToSource}" />

Map objects

There 6 types of objects that can be added to the map: Pin, Circle, Polyline, Polygon, TileOverlay, GroundOverlay. To simplify implementation of the library for polylines and polygons were used classes from Microsoft.Maui.Controls.Shapes namespace. Circle is derived from Shape class. Pin, TileOverlay, GroundOverlay are derived from VisualElement class.