Titanium SDK # Modules.CoreMotion.Altimeter
Allows Titanium client applications to access CoreMotion's Altimeter APIs. Note: This API is only available in iOS 8 and later.
8.3.0# Properties
# apiName READONLY
8.3.0The 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
8.3.0Indicates 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
# Methods
# addEventListener
8.3.0Adds 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
8.3.0Applies 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
# authorizationStatus
8.3.0Returns the current authorization status for altimeter.
Returns
- Type
- Number
# fireEvent
8.3.0Fires 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
# hasAltimeterPermissions
8.3.0Determines whether the device supports reporting relative altitude changes.
Returns
- Type
- Boolean
# isRelativeAltitudeAvailable
8.3.0Returns a Boolean value indicating whether the altimeter is supported on the current device.
Returns
- Type
- Boolean
# isSupported DEPRECATED
8.3.0DEPRECATED SINCE 8.3.0
This API is supported on IOS 8+ and this module is now targeting iOS 8 as minimum, so this method will always return true.
Returns a Boolean value indicating whether the altimeter is supported on the current device. Returns true for iOS 8+.
Returns
- Type
- Boolean
# removeEventListener
8.3.0Removes 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 |
Returns
- Type
- void
# startRelativeAltitudeUpdates
8.3.0Starts relative altitude updates, providing data to the given handler on the given queue every few seconds. The first altitude update will be established as the reference altitude and have relative altitude 0.
Calls to start must be balanced with calls to stopRelativeAltitudeUpdates even if an error is returned to the handler.
Parameters
| Name | Type | Description |
|---|---|---|
callback | Callback<CoreMotionAltimeterData> | The method to be called when there is an update. |
Returns
- Type
- void
# stopRelativeAltitudeUpdates
8.3.0Stops relative altitude updates.
Returns
- Type
- void