You are reading 12.6.1. See this page in 13.4.1.
Titanium.Accelerometer
Extends Titanium.ModuleTitanium.Proxy
The top-level Accelerometer module, used to determine the device's physical position.
An accelerometer is a hardware unit integrated into a mobile device, that detects when the
device has moved, and returns its new orientation in a three-dimensional space. With its
single update event, this module provides an interface to access the output positional data.
An accelerometer needs to be switched on in order for it to report to the operating system, which consumes a lot of power that will deplete the battery over time. This is why it is recommended that the accelerometer is switched off when not in use.
The accelerometer may be switched on and off by simply adding and removing the update
event listener function. See the example for a demonstration.
Examples
Basic Accelerometer Event
Adds an accelerometer update event listener, and displays the x, y and z axis in the window when the device is moved. On Android, the accelerometer is switched off and on when the application is paused and resumed.
var win = Ti.UI.createWindow({
backgroundColor: 'white',
exitOnClose:true,
layout: 'vertical'
});
opts = {
color:'black',
font:{fontSize:20},
text:'-',
top:20, left:10,
width:300
};
var labelTimestamp = Ti.UI.createLabel(opts);
win.add(labelTimestamp);
var labelx = Ti.UI.createLabel(opts);
win.add(labelx);
var labely = Ti.UI.createLabel(opts);
win.add(labely);
var labelz = Ti.UI.createLabel(opts);
win.add(labelz);
win.open();
var accelerometerCallback = function(e) {
labelTimestamp.text = 'timestamp: ' + e.timestamp;
labelx.text = 'x: ' + e.x;
labely.text = 'y: ' + e.y;
labelz.text = 'z: ' + e.z;
};
if (Ti.Platform.model === 'Simulator' || Ti.Platform.model.indexOf('sdk') !== -1 ) {
alert('Accelerometer does not work on a virtual device');
} else {
Ti.Accelerometer.addEventListener('update', accelerometerCallback);
if (Ti.Platform.name === 'android') {
win.addEventListener("open", function(e) {
win.activity.addEventListener("pause", function() {
Ti.API.info("removing accelerometer callback on pause");
Ti.Accelerometer.removeEventListener('update', accelerometerCallback);
});
win.activity.addEventListener("resume", function() {
Ti.API.info("adding accelerometer callback on resume");
Ti.Accelerometer.addEventListener('update', accelerometerCallback);
});
});
}
}
Properties 3
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
Inherited from Titanium.Proxy
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
Methods 4
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | 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. |
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|
Events 1
Fired when the accelerometer changes.
| Event properties | Type | Description |
|---|---|---|
| timestamp | Number | Reference timestamp since the previous change. This is not a valid timestamp and should simply be used to determine the number of milliseconds between events. |
| y | Number | Current |
| x | Number | Current |
| z | Number | Current |