1.4. Diagrama API CNIG - Desarrollos-IDEE/API-IDEE GitHub Wiki

El punto de partida para utilizar la API-CNIG es el objeto "M", este objeto contienen las clases necesarias para crear el mapa, crear las capas y realizar todas las acciones disponibles en la API-CORE.

diagrama

A continuación se detallan algunas de las clases disponibles en la API-CORE:

  • Plugin: permite crear extensiones que se añadirán al mapa para ampliar funcionalidades.
  • Style: permite crear estilos para aplicar a las capas.
  • Toast: permite añadir mensajes temporales al mapa.
  • Feature: permite crear entidades geográficas.
  • Popup: representa bocadillos asociados a unas coordenadas mostrando información.
  • Control: permite crear controles para añadir al mapa.
  • Label: permite añadir un mensaje con la información indicada en unas coordenadas específicas.
  • Map: permite crear controles para añadir al mapa.): permite la creación del mapa.
  • Layer: permite la creación de capas para añadirlas al mapa.
  • Filter: permite comprobar si los elementos geográficos cumplen o no determinadas condiciones.

Al estar en continuo desarrollo, el número de clases disponibles pueden ir aumentando y estarán documentadas en la sección correspondiente.

Para consultar todas las opciones disponibles podemos acceder a la consola del navegador y escribir "M." para mostrarlas: captura

Cada clase está compuesta, siempre que sea posible, por una fachada y una implementación. El flujo de trabajo de las clases es:

flujo

  • La fachada actúa como capa de abstracción sobre otras APIS de visualización como OpenLayers, Cesium,... aislando al desarrollador y usuario de la complejidad de estas trabajando sobre un mismo API con independencia de la librería base que se utilice por debajo. La fachada es común a todas las implementaciones y encontraremos código exclusivamente JS, CSS e imágenes.

  • La implementación se encarga de hacer uso de la librería base que le corresponda, en ella encontraremos uso de código de la librería base haciendo uso de sus clases y llamadas a métodos de la misma.

El objetivo de API-CNIG es proveer de una herramienta corporativa y horizontal para aunar los esfuerzos en la creación de visualizadores de mapas de forma simple y sencilla.