Todos los métodos de la API son plugins de jQuery que trabajan sobre el mapa instanciado en una etiqueta HTML. De tal manera, si instanciamos un mapa en un div:

<div id="mapa" style="height:300px"></div>
<script>
$('#mapa').argenmap();
</script>

<script>
$('#mapa').centro(-34.1445,-58.84);
$('#mapa').agregarMarcador({nombre:'Mi casa',lat:-34.216,lon:-58.719});
</script>

$(selector).argenmap()

Crea una instancia de mapa sobre un elemento HTML. Preferentemente divs con un alto definido en píxels, pero cualquier elemento de tipo block con un alto definido puede usarse.

Argenmap puede instanciarse pasando un objeto como argumento. El objeto puede tener opciones de inicialización. A continuación puedes ver el detalle de las opciones con las que puede inicializarse Argenmap

Argumentos

Opciones

Aún configurando mostrarBarraDeZoom en true, si el alto del mapa no es suficiente, la barra de zoom se ocultará automáticamente.

IMPORTANTE: Las capas satelitales y base están preparadas para mostrarse en EPSG:3857, si necesitás instanciar un mapa en EPSG:4326 para luego importar capas WMS que necesiten esa proyección, deberás hacerlo tipo blanco y luego agregar las capas WMS que necesites.

$(selector).centro()

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

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

Argumentos

Cuando se usa .centro() para pedir las coordenadas del centro del mapa se rompe la encadenabilidad de jQuery y este devuelve un array

$(selector).zoom()

Aumenta, disminuye o devuelve el nivel de zoom.

Si llamás a zoom() sin parámetros, devuelve un int que representa el nivel de escala del mapa.

Argumentos

Cuando se usa .zoom() para pedir el nivel de zoom del mapa se rompe la encadenabilidad de jQuery y este devuelve un int.

$(selector).capaBase()

Cambia a la capa base suministrada como parámetro.

Si no se provee ningún nombre de capa, devuelve el nombre de la capa base actual.

Argumentos

Cuando se usa .capaBase() para pedir la capa base actual del mapa se rompe la encadenabilidad de jQuery y este devuelve un string indicando el nombre de la capa base actual del mapa.

$(selector).agregarCapaWMS()

Superpone una capa desde un servicio WMS al mapa

Argumentos

Opciones

El nombre que uses para la capa también será el que uses para hacer referencia a la capa en otros métodos como quitarCapa o modificarCapa. Podés dejarlo vacío, pero si vas a necesitar modificar o quitar la capa es buena práctica que le asignes un nombre

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.

$(selector).agregarCapaBaseWMS()

Agrega una capa base desde un servicio WMS al mapa. Esta función es igual a agregarCapaWMS pero con todas las opciones configuradas por defecto para conformar una capa base.

Argumentos

Opciones

El nombre que uses para la capa también será el que uses para hacer referencia a la capa en otros métodos como quitarCapa o modificarCapa. Podés dejarlo vacío, pero si vas a necesitar modificar o quitar la capa es buena práctica que le asignes un nombre

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.

$(selector).agregarCapaKML()

Superpone una capa KML en el mapa

Argumentos

Opciones

Atención: El archivo KML y, de ser provisto, el archivo SLD deben estar en el mismo dominio, de lo contrario recibirás un error de Política del mismo origen (Same origin policy).

Para evitar el error de Política del mismo origen (Same origin policy) Argenmap utiliza un proxy simple en PHP configurado a través de la opción proxy de la instancia de Argenmap. Una vez asignado, todos los requests pasan por este proxy. Vos podés utilizar un script de proxy propio y configurarlo asignando su url a proxy.

$(selector).agregarImagen()

Superpone una imagen en el mapa

Argumentos

Opciones

$(selector).quitarCapa()

Quita una capa del mapa.

La referencia a la capa a quitar es a través del nombre asignado a la capa.

Argumentos

$(selector).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.

Argumentos

Opciones

Este valor se actualiza con cada marcador que se agrega, por esto, podés optar por configurarlo en cada marcador que agregues o, si te sentís aventurero, sólo en el último marcador que agregues a la capa.

Si agregás un marcador con el mismo nombre que otro, el más nuevo reemplazará al anterior. Este comportamiento provoca que al agregar más de un marcador sin nombre, empiecen a pisarse entre sí (por adoptar el nombre por defecto 'Marcador'). Esto no es un error, está hecho así intencionalmente.

$(selector).modificarMarcador()

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.

Argumentos

$(selector).quitarMarcador()

Quita un marcador del mapa.

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

Argumentos

$(selector).agregarMarcadores()

Crea varios marcadores sobre el mapa a partir de un array de objetos que definen las opciones de cada marcador.

Cada objeto es igual al que recibe agregarMarcador()

Argumentos

API OpenLayers

Argenmap 2 utiliza la API de OpenLayers versión 2.12.

Una vez que se instancia argenmap en un selector, se guarda una instancia de clase Argenmap asociado al mismo a través de la funcionalidad $.data() de jQuery.

Asimismo, la clase Argenmap guarda una instancia de clase OpenLayers.Map en la propiedad mapa. Referenciando a esta propiedad podés acceder a cualquier otra funcionalidad que necesites de OpenLayers para realizar operaciones y aplicaciones más complejas:

var claseOpenLayersMap = $('#mapa').data('argenmap').mapa;
claseOpenLayersMap.getZoom(); //devuelve el nivel de zoom actual del mapa

Documentación de OpenLayers 2.12: http://dev.openlayers.org/releases/OpenLayers-2.12/doc/apidocs/files/OpenLayers-js.html

Ejemplos de OpenLayers: http://openlayers.org/dev/examples/

Galería de íconos

La galería de íconos es un diccionario de conveniencia para utilizar marcadores predeterminados. En lugar de suministrar la URL de una imagen que fueras a utilizar como ícono de un marcador, podes usar el nombre de uno de estos íconos.

El diccionario está compuesto por íconos de la librería Map Icons Collection de Nicolas Mollet.

Por ejemplo, estas dos llamadas a .agregarMarcador() tienen el mismo resultado:
$('#mapa').agregarMarcador({icono:"tornado"})
$('#mapa').agregarMarcador({icono:"http://ign.gob.ar/argenmap2/argenmap.jquery/img/iconos/tornado.png"})

Íconos disponibles:

nombre	ícono	descripción
Establecimientos
aeropuerto		Aeropuertos y pistas de aterrizaje
cajero		ATM / Cajero electrónico
correo		Correo
restaurante		Comedor / Restaurante
hospital		Hospital / Clínica
policia		Comisaría / Estación de policía
estacionDeServicio		Estación de servicio
tren		Estación de tren
Eventos
manifestacion		Manifestación / Turba
peligro		Atención / Peligro
delito		Delito / Crimen
inundacion		Inundaciones
tormenta		Tormenta
tornado		Tornado
terremoto		Terremoto / Derrumbe
volcan		Erupción volcánica / Cenizas
corteDeLuz		Corte de luz / Apagón
Terreno
pico		Montaña / Cerro / Pico
cascada		Cascada / Salto
glaciar		Glaciar