Allows Titanium client applications to access CoreMotion's Magnetometer APIs.
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.
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
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.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
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.
A dictionary of properties to apply.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Returns the latest sample of magnetometer data.
An app that is receiving magnetometer data after calling startMagnetometerUpdates with no callback, needs to periodically check the value returned by this method and process the magnetometer data.
Returns a Boolean indicating whether magnetometer updates are currently happening.
Indicates whether startMagnetometerUpdates has been called since
Returns a Boolean indicating whether a magnetometer is available on the device.
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);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
The interval in milliseconds, for providing magnetometer updates to the callback.
The interval in milliseconds
Starts magnetometer updates.
If a callback is passed to this method, it will be called whenever there is an update. The frequency of these updates can be controlled using the setMagnetometerUpdateInterval method. If no callback is passed, the magnetometer data can be accessed using the getMagnetometerData method. You must call stopMagnetometerUpdates when you no longer want your app to process magnetometer updates.
The method to be called when there is an update.