Modules.Map.Snapshotter
> Modules.Map.Snapshotter

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

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();
  • 6.0.0
  • 6.0.0
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

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, Button returns Ti.UI.Button.

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

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

  • 3.0.0
  • 3.0.0
  • 3.0.0

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

  • 3.6.0
Modules.Map.Snapshotter
: Number
Map type constant, either Modules.Map.NORMAL_TYPE, Modules.Map.SATELLITE_TYPE, Modules.Map.TERRAIN_TYPE, Modules.Map....
Modules.Map.Snapshotter
region : MapRegionTypev2

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

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

Modules.Map.Snapshotter
: Boolean
Determines whether building will be shown on the map. ...

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

Default: true

Modules.Map.Snapshotter
: Boolean
When this property is set to YES, the map displays icons and labels for restaurants, schools, and other relevant poi...

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

Default: true

Modules.Map.Snapshotter
size : SnapshotSize

A dictionary specifying the width and height of the snapshot.

A dictionary specifying the width and height of the snapshot.

Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Modules.Map.Snapshotter
( ) : Number
Gets the value of the mapType property. ...

Gets the value of the mapType property.

Returns

  • Number
Modules.Map.Snapshotter
( ) : MapRegionTypev2
Gets the value of the region property. ...

Gets the value of the region property.

Returns

Modules.Map.Snapshotter
( ) : Boolean
Gets the value of the showsBuildings property. ...

Gets the value of the showsBuildings property.

Returns

  • Boolean
Modules.Map.Snapshotter
( ) : Boolean
Gets the value of the showsPointsOfInterest property. ...

Gets the value of the showsPointsOfInterest property.

Returns

  • Boolean
Modules.Map.Snapshotter
( ) : SnapshotSize
Gets the value of the size property. ...

Gets the value of the size property.

Returns

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

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 : String

    Name of the event.

  • callback : Callback<Object>

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

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Modules.Map.Snapshotter
( mapType )
Sets the value of the mapType property. ...

Sets the value of the mapType property.

Parameters

  • mapType : Number

    New value for the property.

Returns

  • void
Modules.Map.Snapshotter
( region )
Sets the value of the region property. ...

Sets the value of the region property.

Parameters

Returns

  • void
Modules.Map.Snapshotter
( showsBuildings )
Sets the value of the showsBuildings property. ...

Sets the value of the showsBuildings property.

Parameters

  • showsBuildings : Boolean

    New value for the property.

Returns

  • void
Modules.Map.Snapshotter
( showsPointsOfInterest )
Sets the value of the showsPointsOfInterest property. ...

Sets the value of the showsPointsOfInterest property.

Parameters

  • showsPointsOfInterest : Boolean

    New value for the property.

Returns

  • void
Modules.Map.Snapshotter
( size )
Sets the value of the size property. ...

Sets the value of the size property.

Parameters

Returns

  • void
Modules.Map.Snapshotter
( 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 secon...

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

  • success : Callback<Titanium.Blob>

    Function to be called upon successful completion.

  • error : Callback

    Function to call upon receiving an error.

Returns