# jQuery Geo docs

## Welcome!

jQuery Geo is an open-source, geospatial mapping jQuery plugin from Applied Geographics developed with the intention of making spatial web mapping significantly simpler than it may initially seem. We would like to point out the term "open-source" to explictly state that Google, Bing, & Esri are generally free but not open.

- project source on GitHub

Please read the following sections for more information and examples, and thank you for considering us! If you have any questions feel free to ask the lead developer on Twitter.

- ryanttb on Twitter

If you would like only release notifications, you can follow the project itself on Twitter.

- jQueryGeo on Twitter

## docs

- what?
- quickstart
- html
- geomap widget
- geo namespace

This project takes pride in having easy-to-use, up-to-date documentation. Before any code is committed, these docs are updated with any public API changes and sometimes internal design decisions. The side effect is that the documenation may be ahead of the code at times. Also, any undocumented features you find in the source should be ignored or asked about.

## examples

Now that that's out of the way, here are some code examples! Use these as a suppliment to reading the above sections but above all, have fun!

### "everything" examples

These first two examples attempt to let you test as many of jQuery Geo's features as possible on one page. The first link is a tiled map, i.e., it has a tilingScheme, set-in-stone zoom levels, and uses at least one tiled map service object. The second link is a dynamic map, i.e., it does not have a tilingScheme, displays fully dynamic data from MassGIS, and uses all shingled map service objects. The second type of map usually redraws slower but allows for more accurate zooming.

- tiled
- shingled

You can find isolated examples of individual jQuery Geo features in the component examples section at the bottom of this page.

### demos

The examples in this second set of use the features of jQuery Geo in a more interesting way. They attempt to show & test how you can use different parts jQuery Geo together to build apps and how we can integrate with external data and libraries.

- Inset map
- jQuery Geo logos!
- USA states
- Twitter heat map
- GPS tracking
- Hurricane tracking
- MA Voting District Demographics

### showcase

This third set are more complete examples using jQuery Geo. These try to implement slimmed-down versions of an existing applications and test how jQuery Geo can be used in real-world situations.

- ### Atlas Utah!

  implementation of Utah map cache viewer

- ### Twheat !

  full implementation of our Twitter heat map demo

### component examples

This last set of examples attempts to test various components of jQuery Geo in an insolated way.

- simplest
- mobile
- proj
- bbox
- center, zoom, & pixelSize options
- static mode
- zoom mode
- zoom method
- pannable & scroll options
- refresh
- deferred tiles
- destroy
- another inset map
- tiled services
- shingled (dynamic) services
- string service src
- tilingScheme
- opacity & toggle
- events
- append
- shapeStyle
- find
- remove
- empty
- drag
- draw
- measure
- drawStyle
- label
- geometry functions

## internals

Lastly, short of looking through the source code you can read a bit about the internal design decisions we made in the following section.

- internals