How to use

Include the Locate.js in your project.

Use Code like this:

var location = new Locate({
    onLocate: function(position){
        // Do stuff with the position data
    }
});

Want to frequently get the position (watch your visitor move)?

var location = new Locate({
    loiType: 'watch',
    onLocate: function(position){
        // Do stuff with the position data
    }
});

Don't want to locate directly on initializing the Class? No problem!

var location = new Locate({
    loi: false
});

// start locating later in your code using this line
// you can also use location.watcher();
location.locate();

Want to get the distance from the current position to another? No problem, the function distanceTo() returns the distance in km:

var location = new Locate({
    loiType: 'watch',
    onLocate: function(position){
        $("distance").set('html', this.distanceTo(37.3316591,-122.0301778));
    }
});

Position Data

The position data given with the event 'locate' looks like this:

• position.latitude
• position.longitude
• position.altitude
  • null if not supported, meters above the WGS84 ellipsoid
• position.accuracy
  • specified in meters
• position.altitudeAccuracy
  • specified in meters
• position.heading
  • null if not supported, specified in degrees counting clockwise to true north
• position.cardinalDirection
  • not part of the official W3C specifications!
  • can be null
  • returns the heading direction as string (cardinal direction): "N", "NE", "E" etc.
• position.speed
  • null if not supported, specified in meters per second

If you use Locate.Extras, you can also use

• position.address
  • returns your current address based on GMaps
  • If you want to use this feature, use this.address() within the onLocate function
  • You have to use the watcher method atm, working on a fix

Todo

• make position.address work without watcher method
• find an alternative to GMaps

Discuss

A note on comments here: These comments are moderated. No comments will show up until they are approved. Comments that are not productive (i.e. inflammatory, rude, etc) will not be approved.

Found a bug in this plugin? Please report it this repository's Github Issues.