Canada Map Widget for Dashing

README.md

##Preview

Description

Dashing widget to display geo points in Canada. This widget is designed as a general purpose map for any api that returns latitude and longitude data.

##Dependencies

Move topojson.v1.min.js to /assets/javascripts and ca.topojson to the /public directory so D3 can load the map data.

##Usage

To use this widget, copy camap.html, camap.coffee, and camap.scss into the /widgets/camap directory.

You will have to create a custom job to populate the geo point data. The JSON data follows this format

{
  "points": [
    {
      "id": 12345,
      "lat": 35,
      "lon": -70,
      "type": "red"
    },
    {
      "id": 678910,
      "lat": 35,
      "lon": -70,
      "type": "green"
    }
  ]
}

Each point must have a unique id, so it can be properly added and removed by d3. The type field is optional and will be appended as a class to the svg circle. By default all points are blue and there are CSS classes for red and green.

To include the widget in a dashboard, add the following snippet to the dashboard layout file:

<li data-row="1" data-col="1" data-sizex="3" data-sizey="2">
  <div data-id="camap" data-view="Camap" data-title="Flickr Activity"></div>
</li>

Visit this page for a demo of the map connected to the Flickr api.

ca.topojson

camap.coffee

class Dashing.Camap extends Dashing.Widget



  ready: ->
    container = $(@node).parent()

    width = (Dashing.widget_base_dimensions[0] * container.data("sizex")) + Dashing.widget_margins[0] * 2 * (container.data("sizex") - 1)
    height = (Dashing.widget_base_dimensions[1] * container.data("sizey"))

    # projection = d3.geo.albers()
    #   .scale(200)
    #   .translate([width / 2, height / 2 - 10])

    projection = d3.geo.azimuthalEqualArea()
      .rotate([100, -45])
      .center([5, 19])
      .scale(Math.min(width*1.1, height*1.2))
      .translate([width/2, height/2])

    path = d3.geo.path()
      .projection(projection)

    #create base svg object
    svg = d3.select(@node).append("svg")
      .attr("width", width)
      .attr("height", height)

    #add background
    svg.append("rect")
      .attr("class", "background")
      .attr("width", width)
      .attr("height", height)

    g = svg.append("g")

    #load map json
    d3.json("/ca.topojson", (error, ca) ->
      #add province outlines
      g.append("g")
          .attr("id", "provinces")
        .selectAll("path")
          .data(topojson.feature(ca, ca.objects.provinces).features)
        .enter().append("path")
          .attr("d", path)

      #add province borders
      g.append("path")
          .datum(topojson.mesh(ca, ca.objects.provinces, (a, b) -> a != b ))
          .attr("id", "province-borders")
          .attr("d", path)
    )



  onData: (data) ->
    if (Dashing.widget_base_dimensions)
      container = $(@node).parent()

      width = (Dashing.widget_base_dimensions[0] * container.data("sizex")) + Dashing.widget_margins[0] * 2 * (container.data("sizex") - 1)
      height = (Dashing.widget_base_dimensions[1] * container.data("sizey"))

      projection = d3.geo.azimuthalEqualArea()
        .rotate([100, -45])
        .center([5, 19])
        .scale(Math.min(width*1.1, height*1.2))
        .translate([width/2, height/2])


      #on each update grab the existing svg node
      svg = d3.select(@node).select('svg')

      #select all the points on the map and merge with current data
      circle = svg.selectAll("circle")
        .data(data.points, (d) -> d.id )

      #for each new point, add a svg circle
      #I've left commented code to animate and base the circle radius on an optional size parameter
      circle.enter().append("circle")
        # .attr("r", (d) -> if d.size then 5 + parseInt(d.size,10)/(100*1024*1024) else 5)
        .attr('r', Math.min(.008*width, 5))
        .attr("class", (d) -> "point" + if d.type then ' '+d.type else '')
        .attr("transform", (d) -> "translate(" + projection([d.lon,d.lat]) + ")" )
        # .transition()
        #   .duration(1000)
        #   .attr('r', 5)
        # .transition()
        #   .delay(1000)
        #   .duration(30000)
        #   .style('opacity', .4)

      #remove points no longer in data set
      circle.exit().remove()

      #reorder points based on id
      #if new points will always have higher ids than existing points, this may not be necessary
      circle.order()

camap.html

<p class="title" data-bind="title"></p>

<p class="updated-at" data-bind="updatedAtMessage"></p>

camap.scss

// ----------------------------------------------------------------------------
// Sass declarations
// ----------------------------------------------------------------------------
$background-color:  #fff;

// ----------------------------------------------------------------------------
// Widget-camap styles
// ----------------------------------------------------------------------------
.widget-camap {

  background-color: $background-color;

  .title {
    color: #000;
    position: absolute;
    width: 100%;
    text-align: center;
    left: 0;
    top: 10px;
  }

  svg {
    position: absolute;
    left: 0;
    top: 0;
  }

  .updated-at {
    color: #000
  }
  .background {
    fill: none;
    pointer-events: all;
  }

  #provinces {
    fill: #ddd;
  }

  #province-borders {
    fill: none;
    stroke: #fff;
    stroke-width: 1.5px;
    stroke-linejoin: round;
    stroke-linecap: round;
    pointer-events: none;
  }

  .point {
    fill: #1221ec;
    stroke: #ffffff;
    // opacity: 0.40;
  }

  .red {
    fill: #c90d0d;
  }

  .green {
    fill: #0dc92c;
  }

}

LICENSE.md

The MIT License (MIT)

Copyright (c) 2014 Josh Runge, Aquto

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sample.png

topojson.v1.min.js

topojson=function(){function e(e,n){function t(n){var t=e.arcs[n],r=t[0],o=[0,0];return t.forEach(function(e){o[0]+=e[0],o[1]+=e[1]}),[r,o]}var r={},o={};n.forEach(function(e){var n,a,i=t(e),u=i[0],c=i[1];if(n=o[u])if(delete o[n.end],n.push(e),n.end=c,a=r[c]){delete r[a.start];var s=a===n?n:n.concat(a);r[s.start=n.start]=o[s.end=a.end]=s}else if(a=o[c]){delete r[a.start],delete o[a.end];var s=n.concat(a.map(function(e){return~e}).reverse());r[s.start=n.start]=o[s.end=a.start]=s}else r[n.start]=o[n.end]=n;else if(n=r[c])if(delete r[n.start],n.unshift(e),n.start=u,a=o[u]){delete o[a.end];var f=a===n?n:a.concat(n);r[f.start=a.start]=o[f.end=n.end]=f}else if(a=r[u]){delete r[a.start],delete o[a.end];var f=a.map(function(e){return~e}).reverse().concat(n);r[f.start=a.end]=o[f.end=n.end]=f}else r[n.start]=o[n.end]=n;else if(n=r[u])if(delete r[n.start],n.unshift(~e),n.start=c,a=o[c]){delete o[a.end];var f=a===n?n:a.concat(n);r[f.start=a.start]=o[f.end=n.end]=f}else if(a=r[c]){delete r[a.start],delete o[a.end];var f=a.map(function(e){return~e}).reverse().concat(n);r[f.start=a.end]=o[f.end=n.end]=f}else r[n.start]=o[n.end]=n;else if(n=o[c])if(delete o[n.end],n.push(~e),n.end=u,a=o[u]){delete r[a.start];var s=a===n?n:n.concat(a);r[s.start=n.start]=o[s.end=a.end]=s}else if(a=r[u]){delete r[a.start],delete o[a.end];var s=n.concat(a.map(function(e){return~e}).reverse());r[s.start=n.start]=o[s.end=a.start]=s}else r[n.start]=o[n.end]=n;else n=[e],r[n.start=u]=o[n.end=c]=n});var a=[];for(var i in o)a.push(o[i]);return a}function n(n,t,r){function a(e){0>e&&(e=~e),(l[e]||(l[e]=[])).push(f)}function i(e){e.forEach(a)}function u(e){e.forEach(i)}function c(e){"GeometryCollection"===e.type?e.geometries.forEach(c):e.type in d&&(f=e,d[e.type](e.arcs))}var s=[];if(arguments.length>1){var f,l=[],d={LineString:i,MultiLineString:u,Polygon:u,MultiPolygon:function(e){e.forEach(u)}};c(t),l.forEach(arguments.length<3?function(e,n){s.push(n)}:function(e,n){r(e[0],e[e.length-1])&&s.push(n)})}else for(var p=0,v=n.arcs.length;v>p;++p)s.push(p);return o(n,{type:"MultiLineString",arcs:e(n,s)})}function t(e,n){return"GeometryCollection"===n.type?{type:"FeatureCollection",features:n.geometries.map(function(n){return r(e,n)})}:r(e,n)}function r(e,n){var t={type:"Feature",id:n.id,properties:n.properties||{},geometry:o(e,n)};return null==n.id&&delete t.id,t}function o(e,n){function t(e,n){n.length&&n.pop();for(var t,r=f[0>e?~e:e],o=0,i=r.length;i>o;++o)n.push(t=r[o].slice()),s(t,o);0>e&&a(n,i)}function r(e){return e=e.slice(),s(e,0),e}function o(e){for(var n=[],r=0,o=e.length;o>r;++r)t(e[r],n);return n.length<2&&n.push(n[0].slice()),n}function i(e){for(var n=o(e);n.length<4;)n.push(n[0].slice());return n}function u(e){return e.map(i)}function c(e){var n=e.type;return"GeometryCollection"===n?{type:n,geometries:e.geometries.map(c)}:n in l?{type:n,coordinates:l[n](e)}:null}var s=d(e.transform),f=e.arcs,l={Point:function(e){return r(e.coordinates)},MultiPoint:function(e){return e.coordinates.map(r)},LineString:function(e){return o(e.arcs)},MultiLineString:function(e){return e.arcs.map(o)},Polygon:function(e){return u(e.arcs)},MultiPolygon:function(e){return e.arcs.map(u)}};return c(n)}function a(e,n){for(var t,r=e.length,o=r-n;o<--r;)t=e[o],e[o++]=e[r],e[r]=t}function i(e,n){for(var t=0,r=e.length;r>t;){var o=t+r>>>1;e[o]<n?t=o+1:r=o}return t}function u(e){function n(e,n){e.forEach(function(e){0>e&&(e=~e);var t=o[e];t?t.push(n):o[e]=[n]})}function t(e,t){e.forEach(function(e){n(e,t)})}function r(e,n){"GeometryCollection"===e.type?e.geometries.forEach(function(e){r(e,n)}):e.type in u&&u[e.type](e.arcs,n)}var o={},a=e.map(function(){return[]}),u={LineString:n,MultiLineString:t,Polygon:t,MultiPolygon:function(e,n){e.forEach(function(e){t(e,n)})}};e.forEach(r);for(var c in o)for(var s=o[c],f=s.length,l=0;f>l;++l)for(var d=l+1;f>d;++d){var p,v=s[l],h=s[d];(p=a[v])[c=i(p,h)]!==h&&p.splice(c,0,h),(p=a[h])[c=i(p,v)]!==v&&p.splice(c,0,v)}return a}function c(e,n){function t(e){i.remove(e),e[1][2]=n(e),i.push(e)}var r,o=d(e.transform),a=p(e.transform),i=l(f),u=0;for(n||(n=s),e.arcs.forEach(function(e){var t=[];e.forEach(o);for(var a=1,u=e.length-1;u>a;++a)r=e.slice(a-1,a+2),r[1][2]=n(r),t.push(r),i.push(r);e[0][2]=e[u][2]=1/0;for(var a=0,u=t.length;u>a;++a)r=t[a],r.previous=t[a-1],r.next=t[a+1]});r=i.pop();){var c=r.previous,v=r.next;r[1][2]<u?r[1][2]=u:u=r[1][2],c&&(c.next=v,c[2]=r[2],t(c)),v&&(v.previous=c,v[0]=r[0],t(v))}return e.arcs.forEach(function(e){e.forEach(a)}),e}function s(e){return Math.abs((e[0][0]-e[2][0])*(e[1][1]-e[0][1])-(e[0][0]-e[1][0])*(e[2][1]-e[0][1]))}function f(e,n){return e[1][2]-n[1][2]}function l(e){function n(n){for(var t=o[n];n>0;){var r=(n+1>>1)-1,a=o[r];if(e(t,a)>=0)break;o[a.index=n]=a,o[t.index=n=r]=t}}function t(n){for(var t=o[n];;){var r=n+1<<1,a=r-1,i=n,u=o[i];if(a<o.length&&e(o[a],u)<0&&(u=o[i=a]),r<o.length&&e(o[r],u)<0&&(u=o[i=r]),i===n)break;o[u.index=n]=u,o[t.index=n=i]=t}}var r={},o=[];return r.push=function(){for(var e=0,t=arguments.length;t>e;++e){var r=arguments[e];n(r.index=o.push(r)-1)}return o.length},r.pop=function(){var e=o[0],n=o.pop();return o.length&&(o[n.index=0]=n,t(0)),e},r.remove=function(r){var a=r.index,i=o.pop();return a!==o.length&&(o[i.index=a]=i,(e(i,r)<0?n:t)(a)),a},r}function d(e){if(!e)return v;var n,t,r=e.scale[0],o=e.scale[1],a=e.translate[0],i=e.translate[1];return function(e,u){u||(n=t=0),e[0]=(n+=e[0])*r+a,e[1]=(t+=e[1])*o+i}}function p(e){if(!e)return v;var n,t,r=e.scale[0],o=e.scale[1],a=e.translate[0],i=e.translate[1];return function(e,u){u||(n=t=0);var c=0|(e[0]-a)/r,s=0|(e[1]-i)/o;e[0]=c-n,e[1]=s-t,n=c,t=s}}function v(){}return{version:"1.4.0",mesh:n,feature:t,neighbors:u,presimplify:c}}();

Hi,

I really like how your widget looks and would like to use it for my own small project, but I can't get it running. I just end up with a white box without anything except the title. This holds for this camap and for the usmap.

I followed your instructions, but in the javascript console the following error shows up: "Uncaught ReferenceError: topojson is not defined"

Any idea what is missing? How do I install the topojson module? There is no gem and google only finds node.js stuff.

Thanks for your help,
Christian

Yep, I missed that. You're missing the topojson library. I've had the library installed for a long time and forgot about the dependency.

I've updated the readme, but essentially you need to copy the new topojson.v1.min.js file to the /assets/javascripts directory in your dashing project.

Cool. Thanks for the fast response!

Is the flicker code something you could share as well?

Here is the flickr api code I'm using, though it may not be as helpful as you want since it's in javascript. (I'm using a nodejs port of dashing)

var Flickr = require("flickrapi");
var flickrOptions = require("../flickr-creds.json");

flickrOptions.silent = true;


setTimeout(function(){
  getUSPics();
  getPTPics();
  getCAPics();
}, 100);


setInterval(function() {
  getUSPics();
  getPTPics();
  getCAPics();
}, 10 * 1000);


var getUSPics = function () {
  Flickr.tokenOnly(flickrOptions, function(error, flickr) {
    // we can now use "flickr" as our API object,
    // but we can only call public methods and access public data

    flickr.photos.search({
      page: 1,
      per_page: 250,
      extras: 'geo,license',
      "woe_id": 23424977
      // bbox: '-124.7625, 24.5210, -66.9326, 49.3845'
    }, function(err, result) {
      if (err) {
        console.log(err);
      }
      else {
        var data = {
          points: []
        };
        var photoArray = result.photos.photo;
        for (var i = photoArray.length - 1; i >= 0; i--) {
          if (photoArray[i].latitude) {
            data.points.push({
              id: photoArray[i].id,
              lat: photoArray[i].latitude,
              lon: photoArray[i].longitude,
              type: photoArray[i].license === '0' ? '': 'green'
            })
          }
        };
        send_event('usmap', data);
      }

    });
  });

};

var getPTPics = function () {
  Flickr.tokenOnly(flickrOptions, function(error, flickr) {
    // we can now use "flickr" as our API object,
    // but we can only call public methods and access public data

    flickr.photos.search({
      page: 1,
      per_page: 250,
      extras: 'geo,license',
      "woe_id": 23424925
      // bbox: '-31.2660, 30.0281, -6.1893, 42.1541'
    }, function(err, result) {
      if (err) {
        console.log(err);
      }
      else {
        var data = {
          points: []
        };
        var photoArray = result.photos.photo;
        for (var i = photoArray.length - 1; i >= 0; i--) {
          if (photoArray[i].latitude) {
            data.points.push({
              id: photoArray[i].id,
              lat: photoArray[i].latitude,
              lon: photoArray[i].longitude,
              type: photoArray[i].license === '0' ? '': 'green'
            })
          }
        };
        send_event('ptmap', data);
      }

    });
  });

};

var getCAPics = function () {
  Flickr.tokenOnly(flickrOptions, function(error, flickr) {
    // we can now use "flickr" as our API object,
    // but we can only call public methods and access public data

    flickr.photos.search({
      page: 1,
      per_page: 250,
      extras: 'geo,license',
      "woe_id": 23424775
      // bbox: '-31.2660, 30.0281, -6.1893, 42.1541'
    }, function(err, result) {
      if (err) {
        console.log(err);
      }
      else {
        var data = {
          points: []
        };
        var photoArray = result.photos.photo;
        for (var i = photoArray.length - 1; i >= 0; i--) {
          if (photoArray[i].latitude) {
            data.points.push({
              id: photoArray[i].id,
              lat: photoArray[i].latitude,
              lon: photoArray[i].longitude,
              type: photoArray[i].license === '0' ? '': 'green'
            })
          }
        };
        send_event('camap', data);
      }

    });
  });

};

Thats for the example. What is the data type (label) which needs to be passed with the points JSON data to have the map properly present the map points?

I have the data, formated properly but I cannot deduce what the proper ruby send_event() data label should be. Suggestions?

Great job!! Would it be possible to adapt the widget to use any other d3 type maps? I got one from Europe and I changed the file however it does not work. Is there any way to use another map, in your example I have seen different ones, thanks in advance.

Hi, I'm deploying the Dashing to IIS and I've done the following:

1. Added "topojson.v1.min.js" to Assets/javascripts
2. Added "ca.topojson" to root directory of the website.
3. Added "camap" widget to Widgets directory
4. Added <li....<div...for camap into view web page.
5. Created a job in c# as follows with columns id, lat, lon, type with correct data in it.
   var GeoData = DataProcessor.GetCPShipmetGeo("DAILY");
   string JSONString=string.Empty;
   JSONString = JsonConvert.SerializeObject(GeoData);
   Dashing.SendMessage(new { id = "camap", items = JSONString });

When I deploy and run it it shows only white and empty flickr Activity !!!
Your kind help will be appreciated.

Thanks!

This is my sample Points Json Data sent to camap:
{"points":[{"id":266314,"lat":45.645207,"lon":-72.892878,"type":"blue"},{"id":329875,"lat":45.510694,"lon":-75.580939,"type":"blue"},{"id":341968,"lat":44.998046,"lon":-74.99671,"type":"blue"},{"id":509475,"lat":43.777541,"lon":-79.136476,"type":"blue"},{"id":487740,"lat":43.199771,"lon":-79.803978,"type":"blue"},{"id":540645,"lat":43.644521,"lon":-79.384713,"type":"blue"},{"id":594886,"lat":44.145267,"lon":-81.016845,"type":"blue"},{"id":596651,"lat":43.115053,"lon":-80.74624,"type":"blue"},{"id":578995,"lat":43.506771,"lon":-80.511806,"type":"blue"},{"id":766398,"lat":53.527925,"lon":-113.519318,"type":"blue"},{"id":888613,"lat":49.252126,"lon":-123.106036,"type":"blue"},{"id":253089,"lat":45.382646,"lon":-71.927445,"type":"blue"},{"id":332369,"lat":45.436075,"lon":-75.712091,"type":"blue"},{"id":344347,"lat":45.45182,"lon":-75.53339,"type":"blue"},{"id":390701,"lat":43.332545,"lon":-79.902803,"type":"blue"}]}