API versión 1.4

Lista rápida de los métodos del plugin

Eventos disparados por argenmap.jquery

Los eventos disparados por argenmap.jquery se atienen a la interfaz de eventos de Jquery.

Estos eventos se pueden aprovechar haciendo uso del método .on() del objeto jQuery creado con .argenmap().

Estos son los eventos disponbiles:

zoomend
moveend

.on('zoomend', function ( event , zoomActual ) {} )

El evento zoomend se dispara cuando el mapa modificó su nivel de zoom

event: (jQuery Event): El objeto de evento lanzado por jQuery
zoomActual: (int): número indicando el nuevo nivel de zoom

.on('moveend', function ( event , zoomActual, centro[lat, lng] ) {} )

El evento moveend se dispara cuando termina de arrastrarse el mapa, o se modifica el centro o se modifica el zoom de la vista actual.

event: (jQuery Event): El objeto de evento lanzado por jQuery
zoomActual: (int): número indicando el nuevo nivel de zoom
centro: (Array): centro[0] tiene la latitud actual del centro del mapa y centro[1], la longitud del centro.

Descripción de los métodos

argenmap()

Crea un mapa simple sobre un elemento HTML. Preferentemente divs con un alto definido en píxels. Este método inicializa el mapa y se llama una sola vez. Todos los demás métodos se usan después de usar éste y pueden concatenarse $('#mapa').argenmap().centro(-34,-59)

centro( lat:float, lng:float )

Luego de instanciar un mapa, puede usarse .centro(lat,lng) para cambiar el centro del mapa.

lat: (float): número indicando los grados decimales de latitud
lng: (float): número indicando los grados decimales de longitud

Si llamás a centro() sin parámetros, devuelve el centro actual. Una array del tipo [lat,lng].

zoom(zoom:int)

Aumenta o disminuye la escala del mapa.

zoom: (int): Un entero de 1 a 22 indicando el nivel de zoom al que se quiere visualizar el mapa.

Si llamás a zoom() sin parámetros, devuelve el nivel de zoom actual

agregarCapaWMS(opciones:Object)

Ver ejemplo de agregarCapaWMS »

Superpone una capa WMS sobre las capas base.

opciones

(objeto simple): un set de pares de key/valor que configura el pedido a la capa WMS.
Las keys que pueden pasarse son los parámetros que pueden pasarse a cualquier WMS:

url: (string). La URL del servidor WMS. Ejemplo: https://wms.ign.gob.ar/geoserver/wms?. La URL debe finalizar con el signo ? o con el signo &.
capas: (string). Los nombres de las capas separados por comas. (corresponde al formato del parámetro LAYERS de WMS) de las capas que se quieren pedir al servidor WMS, separadas por coma. Ejemplo: "departamentos,rios,ciudades"
nombre: (string, opcional). El nombre interno que tendrá la capa. Recordá que es importante definir el nombre y que sea entre para todas las capas que superpongas.
formato: (string, opcional). Valor por defecto: "image/png" el formato MIME de archivo: "image/jpeg", "image/jpg", "image/png", "image/png8", "image/gif".

El servicio WMS tiene que estar configurado para poder generar las imágenes con el sistema de referencia EPSG:3857 que es el código que define la proyección de OpenStreetMap, Google Maps, Bing Maps, ESRI WEB Maps y demás mapas web populares.

agregarCapaBaseWMS(opciones:Object)

Esta función te permite agregar una capa base al mapa que salga de un servicio WMS.

opciones

(objeto simple): un set de pares de key/valor que configura el pedido a la capa WMS.
Las opciones que pueden pasarse son los parámetros que pueden pasarse a cualquier WMS:

url: (string). Cadena de texto indicando la url del servidor WMS. Ejemplo: https://wms.ign.gob.ar/geoserver/wms?.
La URL debe finalizar con el signo ? o con el signo &.
capas: (string). Cadena de texto con los nombres (el parámetro LAYERS de WMS) de las capas que se quieren pedir al servidor WMS, separadas por coma. Ejemplo: "departamentos,rios,ciudades"
nombre: (string, opcional). Cadena de texto indicando el nombre internoque tendrá la capa. Recordá que es importante definir el nombre y que sea único para todas las capas que superpongas.
formato: (string, opcional). Valor por defecto: "image/png" Cadena de texto indicando un formato MIME de archivo: "image/jpeg", "image/jpg", "image/png", "image/png8", "image/gif".

capaBase(nombre:string)

Ver ejemplo de capaBase »

Cambia la capa base actualmente visible en el mapa por la capa especificada por el parámetro nombre. Si no se le pasan parámetros devuelve el nombre de la capa base actualmente visible.

nombre: (string): El nombre de una de las capas estándar (satellite o IGN) o el nombre de una capa superpuesta previamente con agregarCapaBaseWMS().

agregarCapaKML(opciones:Object)

Ver ejemplo de agregarCapaKML »

Superpone una capa que se importa desde un archivo .kml que esté online accesible por URL.

opciones

(objeto simple): un set de pares de key/valor que configura el pedido a la capa WMS.
Las opciones son:

url: (string) la URL del KML.
nombre: (string - opcional) el nombre que tendrá la capa. Recordá que es importante definir el nombre e intentar que sea único.

El archivo KML tiene que estar accesible públicamente. Este requerimiento de argenmap.jquery va a cambiar en la versión 2.0.

agregarMarcador(marcador:Object)

Ver ejemplo de agregarMarcador »

Para crear un marcador se puede suministrar un objeto con opciones o simplemente hacer la llamada $(selector).agregarMarcador() y por defecto el marcador se agregará en el centro del mapa.

Para personalizar el comportamiento del marcador pueden utilizarse estas opciones

marcador

(objeto simple, opcional): un set de pares de key/valor que configura opciones extra para el marcador que va a ser creado:

lat: (float). La latitud para el marcador (Coordenadas geográficas).
lng: (float). La longitud para el marcador (Coordenadas geográficas).
icono: (string, opcional). La URL de la imagen PNG a utilizar como ícono del marcador.
El marcador utiliza como punto de anclaje el centro horizontal y el borde inferior de la imagen. Ver Map Icons Collection.
nombre: (string, opcional). El nombre que tendrá el marcador. Recordá que si bien es opcional, es importante definir el nombre e intentar que sea único para luego poder accederlo si necesitaras modificarlo.
contenido: (string, opcional). Contenido HTML que se mostrará al hacer click sobre el marcador en un globo de texto.

$(selector).modificarMarcador(nombre, opciones)

Modifica un marcador previamente creado. Las opciones para modificar el marcador son las mismas que al momento de crear uno.

La referencia del marcador a modificar es el nombre asignado al marcador y es el primer parámetro de este método:

nombre: (string). El nombre asignado al marcador cuando fue creado.
opciones: (objeto simple): set de pares de key/valor que el usado para crear un marcador.

$(selector).quitarMarcador(nombre)

Quita un marcador del mapa.

La referencia del marcador a modificar es a través del nombre asignado al marcador.

nombre: (string). El nombre asignado al marcador cuando fue creado.

agregarMarcadores([marcador1:Object, marcador2:Object,..., marcadorN:Object])

Ver ejemplo de agregarMarcadores »

Crea varios marcadores sobre el mapa a partir de una array de objetos que definen marcadores.

Cada objeto es igual al que recibe agregarMarcador()

API versión 1.4

Lista rápida de los métodos del plugin

Crear el mapa

Cambiar la vista actual

Superponer tus datos

Agregar marcadores

Capas Base

Eventos disparados por argenmap.jquery

.on('zoomend', function ( event , zoomActual ) {} )

.on('moveend', function ( event , zoomActual, centro[lat, lng] ) {} )

Descripción de los métodos

argenmap()

centro( lat:float, lng:float )

zoom(zoom:int)

agregarCapaWMS(opciones:Object)

agregarCapaBaseWMS(opciones:Object)

capaBase(nombre:string)

agregarCapaKML(opciones:Object)

agregarMarcador(marcador:Object)

$(selector).modificarMarcador(nombre, opciones)

$(selector).quitarMarcador(nombre)

agregarMarcadores([marcador1:Object, marcador2:Object,..., marcadorN:Object])