native.newMapView()

General

• This feature is only supported on Android and iOS.

• Native map views are not part of the OpenGL canvas and do not obey the display object hierarchy, so they will always appear in front of normal display objects including images, text, and vector objects.

Android

On Android, you must add the INTERNET permission to the build.settings file in order to display a map. You may optionally add location permissions in order to display the current location in a map.

settings =
{
    android =
    {
        usesPermissions =
        {
            "android.permission.INTERNET",

            --optional permission used to display current location via the GPS
            "android.permission.ACCESS_FINE_LOCATION",

            --optional permission used to display current location via WiFi or cellular service
            "android.permission.ACCESS_COARSE_LOCATION",
        },
        usesFeatures =
        {
            -- If you set permissions "ACCESS_FINE_LOCATION" and "ACCESS_COARSE_LOCATION" above,
            -- you may want to set up your app to not require location services as follows.
            -- Otherwise, devices that do not have location sevices (such as a GPS) will be unable
            -- to purchase this app in the app store.
            { name = "android.hardware.location", required = false },
            { name = "android.hardware.location.gps", required = false },
            { name = "android.hardware.location.network", required = false }
        },
    },
}

In addition, you will need to add your API key to your config.lua:

application =
{
    license =
    {
        google =
        {
            mapsKey = "YOUR_MAPS_API_KEY",
        },
    },
}

iOS

On iOS, you must include the following keys/descriptions in the plist table of build.settings. When the system prompts the user to allow access, the associated description is displayed as part of the alert. Note that these descriptions can be customized to your preference and they can even be localized (guide).

settings =
{
    iphone =
    {
        plist =
        {
            NSLocationAlwaysUsageDescription = "This app would like to use location services.",
            NSLocationWhenInUseUsageDescription = "This app would like to use location services.",
        },
    },
}

x _^(required)

Number. The x coordinate that corresponds to the center of the map view object.

y _^(required)

Number. The y coordinate that corresponds to the center of the map view object.

width _^(required)

Number. Width of the map view object.

height _^(required)

Number. Height of the map view object.