Qué se puede hacer con la API

Para un acceso más sencillo a las funcionalidades que ofrece la API vamos a agrupar, listar y explicar las mas importantes de ellas. Las siguientes son las funcionalidades de uso común, para ver más detalle sobre una funcionalidad haga scroll hasta la sección correspondiente o haga en el nombre de la funcionalidad.

Funcionalidad Descripción / métodos
Interacciones Engloba las funciones de interacción con el mapa cómo el zoom y las que nos permiten añadir elementos visuales simples al mapa. Las mas importantes son: Zoom a coordenadas, Zoom a extensión, Añadir marcador, Añadir geometría
Capas base Nos permite cambiar o añadir capas base, las capas que se visualizan como fondo en los mapas. Cambiar la capa base, Añadir una capa base,
Capas de datos Añadir capas con datos que se visualizarán sobre las capas base. Podremos añadir capas de varios tipos diferentes: GeoJSON, KML, WMS, WFS, Capas GeoEuskadi
Herramientas Nos permite cargar botones sobre el mapa que nos añaden funcionalidades extras. Las herramientas que podremos activar son las siguientes:
  • Mi posición
  • Pantalla completa
  • Selector de Capas Base
  • Selector de Capas
  • Superposición de Capas
  • Transparencia de Capas
Todas las herramientas se activan/desactivan con los mismos métodos a los que pasaremos como parámetro que herramienta queremos activar/desactivar: Activar Herramienta y Desactivar Herramienta

Interacciones

Engloba las funciones de interacción básica con el mapa. Movernos en el mapa realizando zooms a coordenadas o a extensión y dibujar elementos simples sobre el mismo.

Zooms

Para realizar un zoom debemos saber primero donde queremos centrarnos. Para centrarnos sobre un punto usaremos el método de zoomToCoordinates al que pasaremos unas coordenadas del punto conreto al que queremos desplazarnos. Usando este método podemos, por ejemplo centrar nuestro mapa sobre el centro de Vitoria:

En cambio si en vez de en un punto queremos centrarnos en un área usaremos el método de zoomToExtent al que pasaremos cuatro coordenadas (esquinas superior izquierda, superior derecha, inferior izquierda e inferior derecha). De este modo podríamos, por ejemplo, encuadrar el mapa sobre el municipio de Vitoria completo:

Dibujado

La API nos permite también añadir elementos gráficos al mapa. Con estos elementos podemos aclarar la interacción con el mapa, señalizar elementos de relevancia, acotar radios de acción, etc... Podremos incluir en el mapa marcadores y geometrías.

Para añadir un marcador usaremos el método addMarker, nos basta con saber las coordenadas, aunque también podemos darle estilo, cambiando el icono y el tamaño del mismo y añadirle datos, de manera que cuando el usuario pinche sobre el mismo se le abra una ventana con los datos:

Para añadir una geometría usaremos addGeometry, a este método le tendremos que establecer la geometría dando todos los parámetros necesarios. En el caso de dibujar un circulo estos serán unas coordenadas de centro y un radio en metros. Además de los necesarios también podremos establecer los que dan estilo al círculo cómo grosor del perímetro, color de relleno, etc.

Capas Base

Con esta funcionalidad de la API tenemos control sobre la capa que usaremos de fondo en el mapa. Podremos usar una de las capas base que ofrece GeoEuskadi:

Cartografía
Ortofoto
Híbrido
Topográfico
Mapa Gris

Para cambiar de capa base usaremos el método setBaseLayer al cual le estableceremos como parámetro el nombre de la capa base.

También podemos añadir una capa base de una fuente externa adecuada. Si queremos añadir una capa base propia de un servicio externo tendrémos que hacer uso del método addBaseLayer que nos permitirá añadirla al catálogo de las elegibles.

Las capas base añadidas por los usuarios también se deben visualizar con el método setBaseLayer mencionado anteriormente

Capas de Datos

Las capas de datos se representarán en el mapa sobre las capas base para añadir datos georeferenciados y añadir más información al mismo. Para añadir una capa necesitamos tener una fuente de datos que pasaremos a las funciones de creación de capas. Tendrémos funciones diferentes para cada tipo de origen:

Origen Descripción Método API
GeoJSON Origenes que cumplen con el formato GeoJSON addGeoJSONLayer
KML Origenes que cumplen con el formato KML addKMLLayer
WMS Servicios que exportan capas bajo el estándar Web Map addWMSLayer
WFS Servicios que exportan capas bajo el estándar Web Feature addWFSLayer
GeoEuskadiLayer Otros tipos de servicios agrupados bajo la nomenclatura de GeoEuskadiLayer, ver el método para más detalles. addGeoEuskadiLayer

Herramientas

Además del mapa la API también nos permite agregar ciertos botones que activan herramientas extra. Estás herramientas permiten al usuario interactuar con el mapa de diferentes maneras. Podremos habilitarlos/deshabilitarlos con los métodos: enableOne y disableOne.

Explicamos las herramientas más importantes:

Mi Posición

Esta herramienta aparecerá en pantalla como un botón con el icono de una mira. Al pulsarlo desplazará el mapa al lugar en el que nos encontramos nosotros. Hay que tener en cuenta que para que GeoEuskadi pueda acceder a nuestra ubicación deberemos permitir a la página contenedora acceder a nuestra ubicación. Depende de la configuración del navegador puede requerir que el usuario acepte este acceso al entrar en la página, en el momento de usar la herramienta o no preguntar en ningún momento.

Pantalla Completa

Esta herramienta aparecerá en pantalla como un botón con un icono de encuadre rectangular y nos permitirá agrandar el mapa para que sea visualizado a pantalla completa. El mismo botón nos permitirá volver al estado inicial.

Selector de Capa Base

Esta herramienta aparecerá en pantalla como un botón con un icono de 3 capas apiladas. Al pincharlo se nos abrirá una ventana con todas las capas base disponibles para seleccionar y cambiar la que estamos visualizando actualmente por la seleccionada.

Selector de Capas

Esta herramienta aparecerá en pantalla como un botón con un icono de hamburguesa. Al pincharlo se nos abrirá una ventana con todas las capas añadidas al mapa y nos permitirá ocultarlas/visualizarlas.

Superposición de capas

Esta herramienta aparecerá en pantalla como un botón con un icono de dos rectángulos que intersectan. Al pincharlo se nos abrirá una ventana que nos permite elegir la forma para superponer las capas (verticalmente, horizontalmente o en forma de cuadrado). Además no aparecerá un arbol de capas para que seleccionemos que capa queremos superponer a nuestro mapa. Una vez superpuesta una capa podremos desplazar la barra vertical, la horizontal o el cuadrado para modificar el área que ocupa la capa superpuesta.

Transparencia de capas

Esta herramienta aparecerá en pantalla como un deslizable que nos permite controlar las transparencias de las capas base y las capas de datos.

Poner el deslizable en el centro (valor por defecto) nos establece tanto las capas como las capas base visibles.

Desplazar el deslizable a la derecha va aumentando la transparencia de las capas de datos y llevarlo al tope derecho oculta las capas de datos

Desplazar el deslizable a la izquierda va aumentando la transparencia de las capas base y llevarlo al tope izquierdo oculta las capas base


Ahora que ya hemos dado un repaso generalizado a la API prueba a acceder a los métodos de tu interés para recibir más información y ayuda para implantarlos en tu aplicación. Puedes usar el menú lateral, el buscador ubicado en la parte superior izquierda de la pantalla o los hipervínculos de esta página para encontrar los métodos que necesites.

Zer egin daiteke API-arekin

Para un acceso más sencillo a las funcionalidades que ofrece la API vamos a agrupar, listar y explicar las mas importantes de ellas. Las siguientes son las funcionalidades de uso común, para ver más detalle sobre una funcionalidad haga scroll hasta la sección correspondiente o haga en el nombre de la funcionalidad.

API-aren funtzionalitateak modu erraz batetan azaltzeko hauek multzokatu, listatu eta azalduko ditugu. Hurrengoak gehien erabiltzen diren funtzionalitateak dira, hauei buruzko xehetasunak ikusteko egin klik segidan erakusten den taulan edo scroll egin orri honetan.

Funtzionalitatea Deskribapena / metodoak
Interakzioak Maparekin interakzioak burutzeko funtzioak barne hartzen ditu. Mapan zoom egin eta bertan elementu sinpleak gehitzea baimentzen du. Garrantzitsuenak hauek dira: Koodenatu batetan zoom egin, Estentsio batetan zoom egin, Markatzailea gehitu, Geometria gehitu
Oinarri-geruzak Oinarri-geruza (maparen hondoan erakusten den geruza) aldatu edo berri bat gehitzea ahalbidetzen du. Oinarri-geruza aldatu, Oinarri-geruza bat gehitu
Datu geruzak Oinarri-geruzen gainean erakutsiko diren geruzak. Geruzak mota anitzetakoak izan daiteke: GeoJSON, KML, WMS, WFS, GeoEuskadi geruzak
Tresnak Tresnak mapari botoi batzuk gehitzen ditu. Botoi hauek maparekin eragiten duten funtzionalitateak erabiltzea ahalbidetzen dute. Aktibatu daitezkeen tresnak honako hauek dira:
  • Nire kokapena
  • Pantaila osoa
  • Oinarri-geruzen hautatzailea
  • Geruzen hautatzailea
  • Geruzen gainezarpena
  • GEruzen gardentasuna
Tresna guztiak bi metodo bidez aktibatu/desacktibatu egiten dira: Tresna aktibatu eta Desactivar Herramienta

Interakzioak

Maparekin interakzio basikoak barnean hartzen ditu: mapan zehar mugitu koordenatuetara edo estentsioetara zoom eginez eta mapan elementuak marraztu

Zoom

Zoom egiteko lehenengo pausua zentratu nahi dugun kokapena jakitea da. Puntu batetan zentratzeko zoomToCoordinates metodoa erabili behar da. Metodo honi puntu konkretu baten koordenatuak pasatu behar diogu. Honen bidez zentratu gaiteke, adibidez, Gasteizen zentruak kaokatu gaitezke:

Bestalde zonalde batetan zentratzeko zoomToExtent metodoa erabili behar da. Metodoari lau koordenatu pasatu behar dizkiogu (goi-eskuin izkina, goi-ezker, behe-ezker eta behe-eskuina). Lau koordenatu hauekin, adibidez, gasteiz udalerri osoa erakutsi deszakegu:

Marrazketa

API-a elementu grafikoak mapan marraztea baimentzen digu ere. Elementu hauekin egin ditzakeguna: mapari informazio gehitu, interakzioak argitu, elementu garrantzitsuak nabarmendu, akzio-eremuak mugatu, eta abar... Mapan markatzaileak eta geometriak gehitu ditzakegu.

Markatzaile bat gehitzeko addMarker metodoa erabili behar da. Beharrezko parametroa koordenatuak dira baina, horretaz gain, ikonoa eta tamaina aldatu eta datuak esleitu ditzakegu. Datu hauek erabiltzaileak ikustarazi ditzake markatzailean klik eginez.

Geometría bat marrazteko metodoa addGeometry da. Parametro gisa geometría definituko duten koordenatu puntuen segida pasatu beharko diogu. Adibidez, zirkulu bat marrazteko , bere zentrua eta erradioa adierazi behar diogu. Horretaz gain, estiloa aldatu diezaiokegu: perimetroaren lodiera, barrutiaren kolorea aldatu, eta abar.

Oinarri-geruzak

Funtzionalitate honekin maparen hondoan bistaratuko diren geruzen kontrola daukagu. GeoEuskadik eskaintzen dituen oinarri-geruzak erabili ditzakegu:

Kartografia
Ortoargazkia
Hibridoa
Topografikoa
Mapa grisa

Oinarri-geruza aldatzeko metodoa setBaseLayer da. Parámetro moduan kargatu nahi dugun geruzaren izena pasatu behar diogu.

GeoEuskadikoak aparte beste oinarri-geruzak gehitu ditzakegu. Gure oinarri-geruza gehitzeko addBaseLayer metodoa erabili behar da kanpo oinarri-geruzen zerbitzu egoki bat parametro bezala pasatuz.

Behin geruza gehituta, hau mapan ikusteko setBaseLayer funtzioa deitu behar da ere.

Datu geruza

Datu geruzak mapan kargatuko dira oinarri geruzen gainean. Datu geoerreferentziatuak eta informazioa gehitzen diote mapari. Mota honetako geruza bat gehitzeko jatorri geruza-zerbitzu bat beharrezkoa da, jatorri hau geruzak sortzeko funtzioei pasatuko zaie. Funtzio bat edukiko dugu jatorri mota bakoitzerako:

Jatorria Deskribapena API metodoa
GeoJSON GeoJSON formatua betetzen duten jatorrientzat. addGeoJSONLayer
KML KML formatua betetzen duten jatorrientzat. addKMLLayer
WMS Web Map estandarpean geruzak esportatzen duten zerbitzuentzat addWMSLayer
WFS Web Feature estandarpean geruzak esportatzen duten zerbitzuentzat addWFSLayer
GeoEuskadiLayer Beste motako geruza zerbitzuak, GeoEuskadiLayer izenpean multzokatuak, xehetasun gehiagorako ikusi metodoa. addGeoEuskadiLayer

Tresnak

Mapaz aparte API-ak tresnak aktibatzeko botoiak gehitzea ahalbidetzen du. Tresna hauek interakzio ezberdinak eskaintzen diote erabiltzaileari. Aktibatu/desaktibatzeko bi metodo erabiltzen dira enableOne y disableOne.

Tresna garrantzitsuenk azalduko ditugu:

Nire kokapena

Tresna hau mira ikono batekin agertuko da mapan. Botoi hau sakatzerakoan mapa gure kokapenara mugituko da. Gure kokapena atzitzeko gure arakatzaileari eman behar diogu permisua. Permisu hau emateko modua desberdina izan daiteke arakatzaile edo konfigurazio desberdinetarako. Permisua ez ematekotan tresna hau ezingo du kokapena aurkitu.

Pantaila osoa

Tresna honen botoia laukiratze ikono batekin agertuko da. Botoia sakatuz gure web-orrian txertatutako mapa pantaila osoa beteko du. Botoi bera sakatuko dugu aurreko egoerara bueltatzeko.

Oinarri-geruzen hautatzailea

Tresna honen botoia pilaratutako hiru geruzen ikonoa erakusten du. Botoia erabiliz oinarri-geruzak aukeratzeko leiho bat agertuko da. Lehio honekin mapan ikusten den oinarri geruza alda daiteke.

Geruza hautatzailea

Tresna honen botoia hanburgesa ikono bat dauka. Klik egiterakoan, pantailan, geruzen lista bat erakusten dituen leiho bat agertuko da. Honen bitartez kargatutako geruzak ikusi/ezkutatu daitezke.

Geruzen gainezarpena

Tresna honen botoia elkar ebakitzen diren bi laukizuzen ikonoa dauka. Botoia sakatuz leiho bat irekiko da. Lehio honetan aukeragarri dauzkagu gainezarpenaren formak (horizontala, bertikala edo karratua) eta gainezarri daitezkeen geruzak. Behin gainezarrita agertuko den barra bertikala/barra horizontala/karratua desplazatu dezakegu arratoia bidez.

Geruzen gardentasuna

Tresna hau pantailan agertuko da irristagarri bat bezala. Honekin geruzak esta oinarri-geruzen gardentasuna kontrola dezakegu.

Irristagarria zentruan jartzea (defektuzko balorea) geruzak eta oinarri geruzak batera ikusgai dira.

Irristagarria eskuinera desplazatuz datu geruzen gardentasuna handitzen du, eskuin topera eramatea datu geruzak ezkutatzen ditu.

Irristagarria ezkerrera desplazatuz oinarri-geruzen gardentasuna handitzen du, ezker topera eramatea oinarri geruzak ezkutatzen ditu.


API-aren metodoak errepaso generala egin eta gero sartu zaitez metodoen orrietan xehetasun gehiagoren bila. Bertan metodoari buruzko informazioaz gain zure aplikazioan txertatzeko laguntza izango duzu eskuragarri. Behar duzun metodoa aurkitzeko erabili ezkerreko menua, bilatzailea edota orri honetan aurki dtzakezun estekak.