MapD3 charts library optimized for fast interactivity
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dev
dist
doc
examples
src
test
.babelrc
.editorconfig
.eslintrc-babel.json
.eslintrc.json
.gitignore
.npmignore
.sass-lint.yml
LICENSE.md
README.md
package.json
postcss.config.js
webpack.config-spec.js
webpack.config.js
yarn.lock

README.md

MapD3

MapD3 is a D3v4 charts library developed for MapD Immerse. It is in active development, currently at 0.16. We will accept PRs and bug reports once we reach 1.0.0.

The main component is mapd3.chart, which is a wrapper for a suite of sub-components, like axis, tooltip, marks, labels, etc. The chart type is nothing more than a configuration option (currently line, area, bar and variants of those).

Documentation

The documentation is generated with documentationjs.

The chart API is very simple: instantiate a chart, set configuration, set data, which automatically triggers a render, otherwise explicitely call render.

mapd3.Chart(document.querySelector('.chart'))
    .setConfig({
        width: 800,
        height: 400,
        keyType: "time",
        chartType: "line"
    })
    .setData(data)

A complete example, including the use of a data generator, is available in this ObservaleHQ Notebook: https://beta.observablehq.com/@biovisualize/mapd3-test-sheet.

Development

Look in /package.json for the build scripts. It is available as an npm package.