import GPS from '@mobilizing/library/js/Mobilizing/input/GPS.js'GPS
Extends:
Constructor Summary
| Public Constructor | ||
| public | constructor(params: Object) | |
Member Summary
| Public Members | ||
| public | true if the GPS is available on the device, false otherwise | |
| public | ||
| public | maximumAge: * | |
| public | timeout: * | |
Method Summary
| Public Methods | ||
| public | returns the most recent location data. | |
| public | off() Deactivate the component | |
| public | on() Activates the component | |
| public | setup() Set the GPS up. | |
| Private Methods | ||
| private | this method was deprecated. reset the location object to avoid bugs | |
| private | updateLocationCallBack(position: Object) Listener for the update of the location object with the most recent data. | |
| private | updateLocationErrorCallBack(error: *) Listener for the update errors of the location object with the most recent data. | |
Inherited Summary
| From class Component | ||
| public | ||
| public | context: * | |
| public | events: * | |
| public | id: * | |
| public | name: * | |
| private | _nexts: *[] | |
| private | ||
| public | byPass() | |
| public | Adds a component to this chained component array | |
| public | Returns the array of attached children components | |
| public | off() Deactivate the component | |
| public | on() Activate the component A call to this method calls the setup method if it has not been run yet | |
| public | Run code after the update of all components is run This empty method is usually overriden to perform post-update actions for the component It is called periodically by an internal Mobilizing mechanism | |
| public | preLoad() preLoad the component This empty method is usually overriden to perform preLoad actions for the component. | |
| public | Run code before the update of all components is run This empty method is usually overriden to perform pre-update actions for the component It is called once per component by an internal Mobilizing mechanism | |
| public | prepare() prepare the component This empty method is usually overriden to perform preparation actions for the component, from external process as a server. | |
| public | setup() Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly | |
| public | update() Update the component This empty method is usually overriden to perform update actions for the component It is called periodically by an internal Mobilizing mechanism | |
Public Constructors
public constructor(params: Object) source
Override:
Component#constructorParams:
| Name | Type | Attribute | Description |
| params | Object | Parameters object, given by the constructor. | |
| params.enableHighAccuracy | Boolean | Boolean to activate accurate location (eats more battery and takes time) | |
| params.maximumAge | Number | Number of millisecond to define the maximum age of the geolocation data (default = 500000) | |
| params.timeout | Number | timeout of the location service in millisecond |
Public Members
public enableHighAccuracy: * source
public maximumAge: * source
public timeout: * source
Private Members
private _watchID: * source
Public Methods
public getLocation(): Object source
returns the most recent location data. Location service MUST be activated on the device, or errors will get out from the callbacks! The return objects contains the standard HTML5 properties for geolocation :
location.longitude
location.latitude
location.altitude
location.accuracy
location.altitudeAccuracy
location.heading
location.speed
location.timestamp
Return:
| Object | the location object updated with the most recent data. |
Private Methods
private updateLocationCallBack(position: Object) source
Listener for the update of the location object with the most recent data.
Params:
| Name | Type | Attribute | Description |
| position | Object | the HTML5 position object to use for the Mobilizing location object's update |
private updateLocationErrorCallBack(error: *) source
Listener for the update errors of the location object with the most recent data.
Params:
| Name | Type | Attribute | Description |
| error | * |