object:setRegion()

Type Function
Object Map
Library native.*
Return value none
Revision 2017.3145
Keywords setRegion
See also object:setCenter()

Overview

Moves the displayed map region to a new location, with the new center point and horizontal/vertical span distances given in degrees of latitude and longitude. This implicitly sets the zoom level. This function will "sanity-check" the span settings and will interpolate a consistent zoom level even if latitudeSpan and longitudeSpan are specified with radically different values. The final parameter is an optional boolean (default false) that determines whether the transition is animated or happens instantly.

Note that degrees of latitude and longitude cover large distances on the Earth, so fairly small changes will translate into big position changes in the map, especially at close zoom levels. Also note that most of the planet's map locations are fairly empty, so it will generally be easier to work with known latitude/longitude values when experimenting with maps. Try looking up your own address on a public geocoding site like http://geocoder.us (US addresses only) if you need a quick test location.

Syntax

object:setRegion( latitude, longitude, latitudeSpan, longitudeSpan [, isAnimated] )
latitude (required)

Number. The latitude of the region's center point.

longitude (required)

Number. The longitude of the region's center point.

latitudeSpan (required)

Number. The region's latitudinal span in degrees. This implicitly sets the map's zoom level.

longitudeSpan (required)

Number. The region's longitudinal span in degrees. This implicitly sets the map's zoom level.

isAnimated (optional)

Boolean. Specifies whether to animate the map from the current region to the new one. Default is false.

Example

local myMap = native.newMapView( 0, 0, display.contentWidth, display.contentHeight )
myMap:setRegion( 37.331692, -122.030456, 0.01, 0.01, false )