nagyistge / tangram.cartodb Goto Github PK

View Code? Open in Web Editor NEW

A library to render in webgl vector tiles in cartodb.js

License: BSD 3-Clause "New" or "Revised" License

CSS 10.96% JavaScript 76.38% HTML 12.66%

tangram.cartodb's Introduction

Tangram.cartodb

Installation & usage

me$ npm i tangram-cartocss
// or
me$ yarn add tangram-cartocss

import TC from 'tangram.cartodb';

API

TC constructor

`new TC`

/**
 * Cartodb api to handle tangram maps.
 * @param  {LeafletMap} map   object with a leaflet map instance
 * @return {TangramScene}     return a Tangram wrapper with a complete api for cartodb.js
 */

var tangramScene = new TC(map);

`.addLayer`

/**
 * Add a layer to Tangram instance.
 * @param  {Object} layer   layer object model
 */
tangramScene.addLayer(layer);

`.addDataSource`

/**
 * Add a dataSource to Tangram instance.
 * @param  {String} url   tile url generated by cartodb.js
 */
tangramScene.addDataSource('http://flo.localhost.lan:8181/api/v1/map/flo@4d30aeba@77e23386655d49f11e3cc4e729105014:1478776666976/{sourceLayers}/{z}/{x}/{y}.png');

Contributing

me$ git clone $repo_url
cd into_folder
yarn
yarn start

It will print the dev url to try the demos.

[0001] info  Server running at http://192.168.0.12:8000/ (connect)
[0001] info  LiveReload running on 35729
[0003] 43ms       1115B GET    200 /
[0003] 7ms         886B GET    200 /demos/css/main.css
[0004] 220ms       12KB GET    200 /demos/main.js

We use ES6 and Node > 6.X, I'm using 7.0 right now.

Recommend Projects