Titanium SDK

# 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

# apiName READONLY

Availability
6.0.0
9.2.0
apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability
6.0.0
9.2.0
bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# 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

# addEventListener

Availability
6.0.0
9.2.0
addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# applyProperties

Availability
6.0.0
9.2.0
applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# fireEvent

Availability
6.0.0
9.2.0
fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name Type Description
name String

Name of the event.

event Dictionary

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

Type
void

# removeEventListener

Availability
6.0.0
9.2.0
removeEventListener(name, callback) → void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

Returns

Type
void

# 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