Type Function Library native.* Return value Map Revision 2017.3060 Keywords maps, map view, map object See also mapAddress mapLocation mapMarker
Renders a map view within the specified boundaries and returns a display object wrapper. On the map view, touch events are available when you add a mapLocation event listener.
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.
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 } }, }, }
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.", }, }, }
native.newMapView( centerX, centerY, width, height )
Numbers. The x and y coordinates that correspond to the center of the map view object.
Numbers. Width and height of the map view object.
See the Map documentation for a list of methods and properties.
See the mapAddress, mapLocation, and mapMarker event documentation for properties related to various Map object events.
-- Create a native map view local myMap = native.newMapView( 20, 20, 280, 360 ) myMap.x = display.contentCenterX myMap.y = display.contentCenterY -- Display map as vector drawings of streets (other options are "satellite" and "hybrid") myMap.mapType = "standard" -- Initialize map to a real location myMap:setCenter( 37.331692, -122.030456 )