Titanium SDK

# Modules.Map.Camera

A camera object defines a point above the map's surface from which to view the map. Available in iOS 7.0 and later.

Availability
9.1.0
3.2.0
9.2.0
Extends
Titanium.Proxy

# Overview

Applying a camera to a map has the effect of giving the map a 3D-like appearance. You can use a camera to rotate the map so that it is oriented to match the user's heading or to apply a pitch angle to tilt the plane of the map.

If the app is run on pre iOS 7, camera functionality will not be available. After creating a Camera object, it can be applied to the map by setting the camera property of the Modules.Map.View.

Use the Modules.Map.createCamera method to create a camera.

If altitude, eyeCoordinate, and centerCoordinate are passed in on creation, a camera will be returned using the specified viewing angle information.

# Example:

var camera = Map.createCamera({
    altitude: 15.5,
    centerCoordinates: {
        longitude: 151.276417,
        latitude: -33.891614
    },
    heading: 45,
    pitch: 75
});
mapview.camera = camera;

# Properties

# altitude

Availability
9.1.0
3.2.0
9.2.0
altitude :Number

The altitude above the ground, measured in meters. On Android these zoom values are: 1: World 5: Landmass/continent 10: City 15: Streets 20: Buildings

# apiName READONLY

Availability
9.1.0
3.2.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
9.1.0
3.2.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

# centerCoordinate

Availability
9.1.0
3.2.0
9.2.0
centerCoordinate :MapPointType

The coordinate point on which the map should be centered.

# eyeCoordinate

Availability
9.1.0
3.2.0
9.2.0
eyeCoordinate :MapPointType

The coordinate point at which to place the camera. Only used on creation when altitude and centerCoordinate are also provided. Setting this property at anytime other time will have no effect.

If the value for this parameter is equal to the value in the centerCoordinate parameter, the map is displayed as if the camera is looking straight down. If this point is offset from the centerCoordinate value, the map is displayed with an appropriate heading and pitch angle. Not used on Android.

# heading

Availability
9.1.0
3.2.0
9.2.0
heading :Number

The heading of the camera (measured in degrees) relative to true north.

The value 0 means that the top edge of the map view corresponds to true north. The value 90 means the top of the map is pointing due east. The value 180 means the top of the map points due south, and so on.

# lifecycleContainer

Availability
9.1.0
lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

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.

# pitch

Availability
9.1.0
3.2.0
9.2.0
pitch :Number

The viewing angle of the camera, measured in degrees.

A value of 0 results in a camera pointed straight down at the map. Angles greater than 0 result in a camera that is pitched toward the horizon by the specified number of degrees. The value in this property may be clamped to a maximum value to maintain map readability. There is no fixed maximum value, though, because the actual maximum value is dependent on the current altitude of the camera.

# Methods

# addEventListener

Availability
9.1.0
3.2.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
9.1.0
3.2.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
9.1.0
3.2.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
9.1.0
3.2.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

Contents