Titanium Mobile

# Modules.Map.Snapshotter

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

Availability
6.0.0
9.2.0
Extends
Titanium.Proxy

# 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();

# Properties

# mapType CREATION ONLY

Availability
6.0.0
9.2.0
mapType :Number

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

Default: NORMAL_TYPE

# region CREATION ONLY

Availability
6.0.0
9.2.0
region :MapRegionTypev2

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

# showsBuildings CREATION ONLY

Availability
6.0.0
9.2.0
showsBuildings :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.

Default: true

# showsPointsOfInterest CREATION ONLY

Availability
6.0.0
9.2.0
showsPointsOfInterest :Boolean

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

Default: true

# size CREATION ONLY

Availability
6.0.0
9.2.0
size :SnapshotSize

A dictionary specifying the width and height of the snapshot.

# Methods

# takeSnapshot

Availability
6.0.0
9.2.0
takeSnapshot(success, error) → Titanium.Blob

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 Description
success Callback<Titanium.Blob>

Function to be called upon successful completion.

error Callback

Function to call upon receiving an error.

Returns

Type
Titanium.Blob

Contents