Skip to content

martinclavell/donde.js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

donde.js v0.3.2

Donde.js es una bibloteca de JavaScript que facilita el uso del servicio GoogleMaps para acciones como:

  • Agregar un mapa al sitio.
  • Centrar el mapa en la locación actual del usuario.
  • Agregar marcadores al mapa.
  • Permitir al usuario filtrar los marcadores.

Instalación

Bajar desde la pagina del projecto.

Utilizando Bower: bower install donde.js.

API

La forma más simple del codigo se reduce a: new Donde(options).init(); siendo "options" un objecto con cualquiera de los siguientes attributos:

idMap

Un string con la id del elemento en el cual se va a renderear el mapa. Por defecto buscamos la id "map": mapId: 'map'.

defaultLocation

En caso de que no se pueda obtener la geo-localización del usuario, el mapa se centrará en base a este objeto. El mismo debe de tener 2 attributos: "latitude" y "longitude".

Por defecto lo centramos en la terminal de Tres Cruces en Montevideo, Uruguay:

defaultLocation: {
  latitude: -34.8937720817105
, longitude: -56.1659574508667
}

markers

Un array de objectos, cada uno va a ser agregado al mapa como un marcador. Es necesario que contengan la información sobre el lugar a ser colocados. En caso de querer asociar el marcador a una imagen, debe de tener un "type".

Ejemplo:

markers: [
  {latitude: -34.790626820565095, longitude: -56.352119473107685, type: 'Super'}
, {latitude: -34.79742147359551, longitude: -56.24659744591109, type: 'Baile'}
, {latitude: -34.81001579769451, longitude: -56.221292252489484, type: 'Super'}
, {latitude: -34.81661616310021, longitude: -56.13930858324866, type: 'Kiosco'}
  ...
]

mapping

Es posible que la data de los marcadores no se encuentre en el formato deseado, en esos casos usamos el atributo mapping para mapear los valores de los datos con los requeridos por la bibloteca.

Ejemplo:

mapping: {
  latitude: function (marker)
  {
    return marker.geometry.coordinates[1]
  }
, longitude: function (marker)
  {
    return marker.geometry.coordinates[0]
  }
, type: function (marker)
  {
    return item.properties.NAME;
  }
}

icons

Un objeto que mapea el tipo de marcador ("type") con la imagen a utilizar en el mapa. Ejemplo:

icons: {
  Super: 'img/marker-super.png'
, Baile: 'img/marker-baile.png'
, Kiosco: 'img/marker-kiosco.png'
  ...
}

Recordar: la url de la imagen es relativa al lugar donde llaman al script.


Por más detalles sobre los posibles attributos y metodos disponibles, ver los ejemplos.

Contribuidores

Cualquier tipo de colaboración o comentario es agradecido :)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published