Skip to content

Latest commit

 

History

History
139 lines (117 loc) · 5.86 KB

README.md

File metadata and controls

139 lines (117 loc) · 5.86 KB

M.plugin.Timeline

Plugin de línea del tiempo.

timelineType AbsoluteSimple timelineType Absolute Relative timelineType Absolute
Timeline Básico Timeline Dinámico Timeline Absoluto

Dependencias

Para que el plugin funcione correctamente es necesario importar las siguientes dependencias en el documento html:

  • timeline.ol.min.js
  • timeline.ol.min.css
 <link href="https://componentes.cnig.es/api-core/plugins/timeline/timeline.ol.min.css" rel="stylesheet" />
 <script type="text/javascript" src="https://componentes.cnig.es/api-core/plugins/timeline/timeline.ol.min.js"></script>

Uso del histórico de versiones

Existe un histórico de versiones de todos los plugins de API-CNIG en api-ign-legacy para hacer uso de versiones anteriores. Ejemplo:

 <link href="https://componentes.cnig.es/api-core/plugins/timeline/timeline-1.0.0.ol.min.css" rel="stylesheet" />
 <script type="text/javascript" src="https://componentes.cnig.es/api-core/plugins/timeline/timeline-1.0.0.ol.min.js"></script>

Parámetros

El constructor se inicializa con un JSON con los siguientes atributos:

  • position: Indica la posición donde se mostrará el plugin.

    • 'TL': (top left) - Arriba a la izquierda.
    • 'TR': (top right) - Arriba a la derecha (por defecto).
    • 'BL': (bottom left) - Abajo a la izquierda.
    • 'BR': (bottom right) - Abajo a la derecha.
  • intervals: Parámetro obligatorio. Array que contiene cada capa junto a sus datos, dependiendo del valor del timelinetype tendrá unos parámetros u otros.

  • timelineType: Determina el tipo del timeline.

    • absoluteSimple: Representación de las capas de manera lineal, sin consultas.
    • absolute: Representación de las capas de manera lineal, con consultas.
    • relative: Representación de las capas mediante intervalos, con consultas.

    AbsoluteSimple:

    • Nombre: nombre descriptivo de la capa.
    • Etiqueta: etiqueta o fecha de la capa.
    • Servicio en formato API-CNIG para insertar una capa a través de servicios WMS ó WMTS, o la capa como objeto, de cada intervalo.

    Ejemplos de uso Insertar intervalos a través de servicios WMS. La URL en formato API-CNIG sigue la siguiente estructura: Servicio,Leyenda,URL,Nombre. Separados por "*".

      const mp = new M.plugin.Timeline({
      position: 'TL',
      intervals: [
        ["NACIONAL 1981-1986", "1986", "WMS*NACIONAL_1981-1986*https://www.ign.es/wms/pnoa-historico*NACIONAL_1981-1986"],
        ["OLISTAT", "1998", "WMS*OLISTAT*https://www.ign.es/wms/pnoa-historico*OLISTAT"],
        ["SIGPAC", "2003", "WMS*SIGPAC*https://www.ign.es/wms/pnoa-historico*SIGPAC"],
        ["PNOA 2004", "2004", "WMS*pnoa2004*https://www.ign.es/wms/pnoa-historico*pnoa2004"],
        ["PNOA 2005", "2005", "WMS*pnoa2005*https://www.ign.es/wms/pnoa-historico*pnoa2005"],
        ["PNOA 2006", "2006", "WMS*pnoa2006*https://www.ign.es/wms/pnoa-historico*pnoa2006"],
        ["PNOA 2010", "2010", "WMS*pnoa2010*https://www.ign.es/wms/pnoa-historico*pnoa2010"]
      ]
    });
    
      map.addPlugin(mp);

    Absolute y Relative

    • id: ID del elemento del timeline.
    • init: Fecha inicial del filtro.
    • end: Fecha final del filtro.
    • layer: Capa a filtrar.
    • attributeParam: Define el atributo de tiempo para filtrar.
    • equalsTimeLine: Filtrar por fechas iguales o entre dos fechas.
    • grupo: Sirve para agrupar capas, tienen que tener el mismo nombre para pertenecer al grupo. Ejemplo:
    intervals:[
      {
        id: '1',
        init: '1918-05-12T23:39:58.767Z',
        end: '1951-01-16T12:47:07.530Z',
        layer: capaWMS,
        grupo: 'Vectorial_WMS'
        attributeParam: 'date',
        equalsTimeLine: true
      },
      {
        id: '1',
        init: '1918-05-12T23:39:58.767Z',
        end: '2000-01-16T12:47:07.530Z',
        layer: capaVectorial,
        grupo: 'Vectorial_WMS'
        attributeParam: 'date'
      },
    ],
  • speedDate: Opcional Velocidad del Step por segundo, por defecto 2.

  • paramsDate: Opcional Determina el Step, Segundo(sec), Minuto(min), Hora(hrs), Días(day), Meses (mos), Años(yr).

  • stepValue: Opcional Determina el valor del paramsDate, por ejemplo que el step sea de 5 años.

  • paramsDate: Opcional Determina la forma de moverte por el Slider, lineal, logarítmica o exponencial. Valor por defecto, linear.

    • Lineal: Valor String, linear. El valor del slider siempre será el mismo.
    • Exponencial: Valor String, exponential. Los valores iniciales del slider es mayor que los finales.
    • Logarítmica: Valor String, logarithmic. Los valores finales del slider es mayor que los iniciales.
  • formatMove: Opcional Determina el movimiento del slider cuando se hace play. Valor por defecto, continuous.

    • continua: Slider mueve inicio y fin, valor String continuous.
    • discreta: Slider mueve solo fin, valor String discrete.
  • sizeWidthDinamic: Opcional Determina el tamaño del panel, sin valor y por defecto el tamaño será pequeño.

    • Mediano: Valor String, sizeWidthDinamic_medium.
    • Grande: Valor String, sizeWidthDinamic_big.

    Ejemplos de uso

    const terremotos = 'WMS*Eventos sísmicos*https://www.ign.es/wms-inspire/geofisica*NZ.ObservedEvent'
    
    const pluginTimeline = new Timeline({
    position: 'TR',
    timelineType: 'relative',
    intervals: [
      {
        id: '1',
        init: '2013-11-14T23:22:21.799Z',
        end: '2013-11-15T01:29:43.421Z',
        layer: terremotos,
        attributeParam: 'date',
        // grupo: 'GRUPO'
      },
    ],
    formatValue: 'exponential',
    sizeWidthDinamic: 'sizeWidthDinamic_medium',
    formatMove: 'continuous',
    }); 
    
    map.addPlugin(pluginTimeline);