Skip to content

Latest commit

 

History

History
84 lines (67 loc) · 2.4 KB

README.md

File metadata and controls

84 lines (67 loc) · 2.4 KB

GitHub Release GitHub Actions Workflow Status codecov

maplibre-gl-temporal-control

examples

usage

npm install maplibre-gl-temporal-control
const map = new maplibregl.Map(mapOptions)

// anyLayer is maplibre layer-object
map.addLayer(anyLayer1_1)
map.addLayer(anyLayer1_2)
map.addLayer(anyLayer2_1)
map.addLayer(anyLayer2_2)
map.addLayer(anyLayer3_1)
map.addLayer(anyLayer3_2)
// some layers...

import TemporalControl from 'maplibre-gl-temporal-control';

const temporalFrames = [
    {
        title:'frame1', // shown on control panel
        layers:[anyLayer1_1, anyLayer1_2] // set layers you want to show at one frame...
    },
    {
        title:'frame2',
        layers:[anyLayer2_1, anyLayer2_2]
    },
    {
        title:'frame3',
        layers:[anyLayer3_1, anyLayer3_2]
    },
    // add frames...
]

const temporalControl = new TemporalControl(temporalFrames, {
    interval: 100, // duration a frame is shown, in miliseconds
    position: 'top-left',
    performance: true // set when rendering is too slow
});
map.addControl(temporalControl);

// you can control programatically
temporalControl.prev()
temporalControl.next()
temporalControl.play()
temporalControl.pause()
temporalControl.isPlaying()
temporalControl.isLoopEnabled()
temporalControl.setLoopEnabled(true)
temporalControl.goto(5)

via CDN

<script type="module">
    import TemporalControl from 'https://www.unpkg.com/[email protected]/build/index.js';
    const temporalControl = new TemporalControl(temporalFrames);
    map.addControl(temporalControl);
</script>

Tips

  • Layers set in frames must be added in the map
  • In each frames, You have to set layer-objects corresponding to the layers added to the map.
  • when performance: true, not-current frames are shown as opacity=0.000000000000000000001
    • this option may not be neccesary for ordinary usecases