Git Product home page Git Product logo

tilelive-decorator's Introduction

tilelive-decorator

Circle CI

Load vector tiles from a tilelive source and decorate them with properties from redis. So if you use tilelive-s3 it can load tiles from s3, and add properties to features from redis.

usage

with tilelive

Tilelive decorator registers several tilelive protocols:

  • decorator+s3: for reading tiles from S3
  • decorator+mbtiles: for reading tiles from an mbtiles
var tilelive = require('tilelive');
var TileliveDecorator = require('tilelive-decorator');
var TileliveS3 = require('tilelive-s3');

TileliveDecorator.registerProtocols(tilelive);
TileliveS3.registerProtocols(tilelive);

tilelive.load('decorator+s3://test/{z}/{x}/{y}?key=id&sourceProps={"keep":["id","name"]}&redis=redis://localhost:6379', function(err, source) {
  // source.getTile(z, x, y, callback);
});

manually

var TileliveDecorator = require('tilelive-decorator');

var uri = 'decorator+s3://test/{z}/{x}/{y}?key=id&sourceProps={"keep":["id","name"]}&redis=redis://localhost:6379'
new TileliveDecorator(uri, function (err, source) {
  // source.getTile(z, x, y, callback);
});

options

key (required) - specifies what property in the source tiles will be matched to keys in redis.

sourceProps - a json object, specifying properties to keep from the source tile, and properties that are required to exist on features in the source tile. example: {"keep": ["id", "class"], "required": ["rating"]}. If all required properties don't exist on a feature, that feature is filtered out.

redisProps - a json object, specifying properties to keep from redis records, and properties that are required to exist on redis records. example: {"keep": ["congestion"], "required": ["speed"]}. If all required properties don't exist on a record, that record is filtered out and no new properties will be applied to features that match the record key.

outputProps - a json object, specifying properties to keep in the output tile after decoration, and properties that are required to exist on features in the output tile. example: {"keep": ["class", "congestion"], "required": ["congestion"]}. If all required properties don't exist on a feature, that feature is filtered out.

redis - a redis connection string, e.g. redis://localhost:6379.

hashes - If hashes=true is included, redis keys are treated as hash types as opposed to stringified JSON data in string type keys. In this case hget is used instead of the default get commands.

development

setup

Tests and benchmarks require a local redis server

brew install redis
git clone https://github.com/mapbox/tilelive-decorator
cd tilelive-decorator
npm install
redis-server --save "" &

benchmarks

redis-cli flushall && node benchmark.js

tests

redis-cli flushall && npm test

tilelive-decorator's People

Contributors

tcql avatar mourner avatar defvol avatar willwhite avatar tmcw avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.