veldt-js

High performance on-demand tile-based rendering library

Installation

npm install veldt

Example

// WebSocket endpoint for initiating tiling request
const WS_ENDPOINT = 'ws/tile';

// HTTP endpoint for pulling the finished tile.
const HTTP_ENDPOINT = 'tile';

// Open WebSocket connection for requesting tiles.
const requestor = new veldt.Requestor(WS_ENDPOINT, HTTP_ENDPOINT, err => {
    // Check for error
    if (err) {
        console.error(err);
        return;
    }

    // Create the central map object.
    const map = new veldt.Map('#map', {
        zoom: 3
    });

    // Create a CARTO base layer using a REST proxy tile.
    const carto = new veldt.Layer.Rest();
    carto.setPipeline('rest');
    carto.setURI('dark_nolabels');
    carto.setScheme('http');
    carto.setEndpoint('a.basemaps.cartocdn.com');
    carto.setExt('png');
    carto.useXYZ();
    carto.setRequestor(requestor);

    // Create a Macro point layer.
    const macro = new veldt.Layer.Macro();
    macro.setPipeline('elastic');
    macro.setURI('twitter-index');
    macro.setLOD(4);
    macro.setResolution(256);
    macro.setXField('pixel.x');
    macro.setYField('pixel.y');
    macro.setBounds(0, Math.pow(2, 32), 0, Math.pow(2, 32));
    macro.setRequestor(requestor);
    macro.setRenderer(new veldt.Renderer.WebGL.Macro({
        radius: 4,
        color: [ 0.4, 0.8, 0.2, 0.8 ]
    }));

    // Add layers to the map.
    map.add(carto);
    map.add(macro);
});

Building

Note: currently, veldt-js requires node 8.x to build. It will not build in 10.x.

npm run build