Modules.Map.Snapshotter

Snapshotter is used to allow screen shots to be taken of a specified region or a mapview.

Extends: Titanium.Proxy · Since: 6.0.0, 6.0.0, 9.2.0 · Platforms: iphone, ipad, macos

Properties

mapType

creation only

0.9

0.9

0.9

9.2.0

Type: Number

Map type constant, either Modules.Map.NORMAL_TYPE, Modules.Map.SATELLITE_TYPE,
Modules.Map.HYBRID_TYPE, Modules.Map.HYBRID_FLYOVER_TYPE or Modules.Map.SATELLITE_FLYOVER_TYPE.

region

creation only

0.9

0.9

0.9

9.2.0

Type: MapRegionTypev2

A dictionary specifying the location and zoom level of the map.

showsBuildings

creation only

0.9

0.9

0.9

9.2.0

Type: Boolean

Determines whether building will be shown on the map. The mapType property must be set
to Modules.Map.STANDARD_TYPE for extruded buildings to be displayed.

showsPointsOfInterest

creation only

0.9

0.9

0.9

9.2.0

Type: Boolean

When this property is set to YES, the map displays icons and labels for
restaurants, schools, and other relevant points of interest.

size

creation only

0.9

0.9

0.9

9.2.0

Type: SnapshotSize

A dictionary specifying the width and height of the snapshot.

Methods

takeSnapshot

0.9

0.9

0.9

9.2.0

Takes a snap shot of of the map corresponding to the region property or a snap of the mapView if
passed in as a second parameter.

Parameters:

Name	Type	Summary	Optional
success	Callback<Titanium.Blob>	Function to be called upon successful completion.	No
error	Callback	Function to call upon receiving an error.	No

Returns: Titanium.Blob

Examples

Taking a simple snapshot

This is a map-example which creates a simple snapshot of the specified map-area.

var MapModule = require('ti.map');

var win = Ti.UI.createWindow({
    backgroundColor: 'white'
});

var Snapshotter = MapModule.createSnapshotter({
    mapType: MapModule.HYBRID_TYPE,
    region: {
        latitude: 37.3382,
        longitude: -121.8863,
        latitudeDelta: 0.4,
        longitudeDelta: 0.4
    },
    size: {
        width: 300, 
        height: 200
    }
});

Snapshotter.takeSnapshot({
    success: function(e) {
        var imageView = Ti.UI.createImageView({
            image: e.image
        });
        win.add(imageView);
    },
    error: function(e) {
        Ti.API.error("The snapshot could not be taken: " + e.error);
    }
});

win.open();