README.md

cartodb.js

This library allows to embed you visualizations created with CartoDB in your map or website in a simple way.

quick start

1. add cartodb.js and css to your site (and google maps if you are using it):

```html

    <link rel="stylesheet" href="http://libs.cartocdn.com/cartodb.js/v3/themes/css/cartodb.css" />

    <script src="http://maps.googleapis.com/maps/api/js?sensor=false"></script>
    <script src="http://libs.cartocdn.com/cartodb.js/v3/cartodb.js"></script>

    <!-- use these cartodb.css links if you are using https -->
    <!--link rel="stylesheet" href="https://cartodb-libs.global.ssl.fastly.net/cartodb.js/v3/themes/css/cartodb.css" /-->

    <!-- use this cartodb.js link if you are using https -->
    <!-- script src="https://cartodb-libs.global.ssl.fastly.net/cartodb.js/v3/cartodb.js"></script -->
```

2. create the map and add the layer

**gmaps**

```javascript

    // create google map
    var map;
    var mapOptions = {
      zoom: 7,
      center: new google.maps.LatLng(43, -68),
      mapTypeId: google.maps.MapTypeId.ROADMAP
    };
    map = new google.maps.Map(document.getElementById('map'),  mapOptions);

    // add the cartodb layer
    // you can find this url in CartoDB interface:
    // - go to map
    // - click on share
    // - API tab
    var layerUrl = 'http://examples.cartodb.com/api/v1/viz/15589/viz.json';
    cartodb.createLayer(map, layerUrl).addTo(map)

```

**leaflet**

```javascript
  var map = L.map('map').setView([0, 0], 3);

  // set a base layer 
  L.tileLayer('http://a.tile.stamen.com/toner/{z}/{x}/{y}.png', {
    attribution: 'stamen http://maps.stamen.com/'
  }).addTo(map);
  
  // add the cartodb layer
  var layerUrl = 'http://examples.cartodb.com/api/v1/viz/15589/viz.json';
  cartodb.createLayer(map, layerUrl).addTo(map);
```

examples

• Load a layer with Google Maps
• Load a layer with Leaflet
• Show a complete visualization
• A visualization with a layer selector
• How to create a custom infowindow
• The Hobbit filming location paths a full example with some widgets
• Load a vector layer with Google Maps
• Load a vector layer with Leaflet
• Load a vector layer to Leaflet with hover effect
• Add cursor interaction without a visualization

next steps

• see our examples
• read the API reference
• read our mailing list

how to build

```
open test/SpecRunner.html
make release
```