Introduction | Demo | API Reference

A tile grid map component built on top of d3Kit

Note: If you are upgrading from v0.x.x to v1.x.x, this library now return the constructor d3KitGridmap instead of d3Kit. Please see the change logs for more detail.

npm install d3kit-gridmap --save

or

bower install d3kit-gridmap --save

For example, to draw a grid map of the US, create a grid map component and pass gridmap-layout-usa as the layout. View source of this demo for example.

var chart = new d3KitGridmap('#usa', {
  col: function(d){return d.x;},
  row: function(d){return d.y;},
  fill: function(d){return color(d.name.length);}
})
  .data(gridmapLayoutUsa)
  .resizeToFitMap();

For more detailed usage please refer to the API Reference.

d3Kit-gridmap does not come with layout, which is an Array of tiles and their positions, which make it can be reused for a map of any region or country.

The layout has to be passed to the chart by calling chart.data(layout) for this component to show something on the screen.

In the simplest way, you can just pass a custom Array as your own layout.

chart.data([
  {key: 'region1', col: 1, row 2},
  {key: 'region2', col: 1, row 3},
  ...
]);

Or use these available layouts:

• gridmap-layout-usa
• gridmap-layout-thailand

Adding this library via <script> tag is the simplest way. By doing this, d3KitGridmap is available in the global scope.

<script src="bower_components/d3/d3.min.js"></script>
<script src="bower_components/d3kit/dist/d3kit.min.js"></script>
<script src="bower_components/d3kit-gridmap/dist/d3kit-gridmap.min.js"></script>

If you use requirejs, this library support AMD out of the box.

require.config({
  paths: {
    d3:    'path/to/d3',
    d3kit: 'path/to/d3kit',
    'd3kit-gridmap': 'path/to/d3kit-gridmap'
  }
});
require(['d3kit-gridmap'], function(d3KitGridmap) {
  // do something with d3KitGridmap
});

This module will be available as d3Kit.Gridmap.

This library also supports usage in commonjs style.

var d3KitGridmap = require('d3kit-gridmap');
// do something with d3KitGridmap

Krist Wongsuphasawat / @kristw

Copyright 2016 Krist Wongsuphasawat. Licensed under the Apache License Version 2.0