Code Monkey home page Code Monkey logo

jquery-geolocation's Introduction

jQuery Geolocation

A small jQuery plugin which acts as a simplification of the Geolocation API.

Instead of using navigator.geolocation.getCurrentPosition you can now just use the jQuery methods $.geolocation.get() or $.geolocation.watch().

Contrary to the standard API the only parameter the functions expect is an object with three properties in no particular order: success, error, options. For success and error you can also use their alias properties win (or done) and fail: $.geolocation.get({win: function() {}, fail: function() {}, options);

You can also use $.geolocation.getCurrentPosition(success, error, options) to get native API feeling if this makes you happier. In conjunction with my Geolocation API polyfill this also works with some non-standard Geolocation APIs like Google Gears or Blackberry Location.

Usage

$.geolocation.clearWatch(integer watchID)

Stops tracking of the user for the according watchID.

$.geolocation.get(object config)

Get the current position of the user

Config properties

  • error
    Function to call if geolocation request failed
  • fail
    Alias for error
  • options Options for the geolocation request
    • enableHighAccuracy
    • maximumAge
    • timeout
  • success
    Function to call if geolocation request was successful
  • win
    Alias for success

$.geolocation.getCurrentPosition(callback success, callback error, object settings)

Get the current position of the user (API standard behavior)

Parameters

success Function to call if geolocation request was successful
error Function to call if geolocation request failed
options Options for the geolocation request

  • enableHighAccuracy
  • maximumAge
  • timeout

$.geolocation.stop(integer watchID)

Stops tracking of the user for the according watchID.

$.geolocation.stopAll()

Stops all running watchPosition callbacks.

$.geolocation.watch(object config)

Track the movement of the user Returns: watchID (Integer)

Config properties

  • error
    Function to call if geolocation request failed
  • fail
    Alias for error
  • settings Options for the geolocation request
    • enableHighAccuracy
    • maximumAge
    • timeout
  • success
    Function to call if geolocation request was successful
  • win
    Alias for success

$.geolocation.watchPosition(callback success, callback error, object settings)

Track the movement of the user (API standard behavior) Returns: watchID (Integer)

Parameters

success Function to call if geolocation request was successful
error Function to call if geolocation request failed
options Options for the geolocation request

  • enableHighAccuracy
  • maximumAge
  • timeout

Examples

function alertMyPosition(position) {
	alert("Your position is " + position.coords.latitude + ", " + position.coords.longitude);
}

function noLocation(error) {
	alert("No location info available. Error code: " + error.code);
}

$('#getPositionButton').on('click', function() {
	$.geolocation.get({win: alertMyPosition, fail: noLocation});
});

$('#watchPositionButton').on('click', function() {
	// alertMyPosition is called each time the user's position changes
	myPosition = $.geolocation.watch({win: alertMyPosition}); 
});

$('#stopButton').on('click', function() {
	$.geolocation.stop(myPosition);
});

Deferreds

New in 1.1.0: jQuery Deferreds are now supported for get and getCurrentPosition. Just use: $.geolocation.get().done(successCallback).fail(errorCallback);

Attention: Deferreds support is in beta state.

Demo

You can find a demo here

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.