Skip to content
/ mapd3 Public

MapD3 charts library optimized for fast interactivity

License

Notifications You must be signed in to change notification settings

heavyai/mapd3

Repository files navigation

D3 Combo Chart

D3 Combo Chart is a D3v4 charts library developed for HeavyImmerse. 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 d3ComboChart.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.

d3ComboChart.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.

If, for some reason, you get errors about d3/build/d3.js missing, try running npm run clean and npm install.