| --- |
| license: Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --- |
| |
| accelerometer.getCurrentAcceleration |
| ==================================== |
| |
| Get the current acceleration along the _x_, _y_, and _z_ axes. |
| |
| navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError); |
| |
| Description |
| ----------- |
| |
| The accelerometer is a motion sensor that detects the change (_delta_) |
| in movement relative to the current device orientation, in three |
| dimensions along the _x_, _y_, and _z_ axis. |
| |
| These acceleration values are returned to the `accelerometerSuccess` |
| callback function. |
| |
| Supported Platforms |
| ------------------- |
| |
| - Android |
| - BlackBerry WebWorks (OS 5.0 and higher) |
| - iOS |
| - Tizen |
| - Windows Phone 7 and 8 |
| - Windows 8 |
| |
| Quick Example |
| ------------- |
| |
| function onSuccess(acceleration) { |
| alert('Acceleration X: ' + acceleration.x + '\n' + |
| 'Acceleration Y: ' + acceleration.y + '\n' + |
| 'Acceleration Z: ' + acceleration.z + '\n' + |
| 'Timestamp: ' + acceleration.timestamp + '\n'); |
| }; |
| |
| function onError() { |
| alert('onError!'); |
| }; |
| |
| navigator.accelerometer.getCurrentAcceleration(onSuccess, onError); |
| |
| Full Example |
| ------------ |
| |
| <!DOCTYPE html> |
| <html> |
| <head> |
| <title>Acceleration Example</title> |
| |
| <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> |
| <script type="text/javascript" charset="utf-8"> |
| |
| // Wait for device API libraries to load |
| // |
| document.addEventListener("deviceready", onDeviceReady, false); |
| |
| // device APIs are available |
| // |
| function onDeviceReady() { |
| navigator.accelerometer.getCurrentAcceleration(onSuccess, onError); |
| } |
| |
| // onSuccess: Get a snapshot of the current acceleration |
| // |
| function onSuccess(acceleration) { |
| alert('Acceleration X: ' + acceleration.x + '\n' + |
| 'Acceleration Y: ' + acceleration.y + '\n' + |
| 'Acceleration Z: ' + acceleration.z + '\n' + |
| 'Timestamp: ' + acceleration.timestamp + '\n'); |
| } |
| |
| // onError: Failed to get the acceleration |
| // |
| function onError() { |
| alert('onError!'); |
| } |
| |
| </script> |
| </head> |
| <body> |
| <h1>Example</h1> |
| <p>getCurrentAcceleration</p> |
| </body> |
| </html> |
| |
| iOS Quirks |
| ------------- |
| |
| - iOS doesn't recognize the concept of getting the current acceleration at any given point. |
| - You must watch the acceleration and capture the data at given time intervals. |
| - Thus, the `getCurrentAcceleration` function yields the last value reported from a `watchAccelerometer` call. |
