Dimensional charting built to work natively with crossfilter rendered using d3.js
JavaScript CSS HTML Other
Switch branches/tags
Clone or download
biovisualize update crossfilter fd08fe1, mapd-data-layer-2 0.0.6 (#244)
* update crossfilter fd08fe1, mapd-data-layer-2 0.0.6

* back to old knuth on unit test
Latest commit d58a07d Jul 20, 2018

README.md

MapD Charting

Dimensional charting built to work natively with crossfilter rendered using d3.js.

Screenshots

Flights Dataset: Brushing on timeline with Bubble Chart and Row Chart

example1

Tweets Dataset: Brushing on timeline and hovering on Pointmap datapoint which displays row information

example2

Tweets Dataset: Using MapD-Draw tool on pointmap to select specific areas on a map

example5

Examples

Visit our examples page for ideas of what can be created MapD Charting

Quick Start

Step 1: Install Dependencies
yarn install #downloads all dependencies and devDependencies
yarn install mapbox-gl@https://github.com/mapd/mapbox-gl-js/tarball/9c04de6949fe498c8c79f5c0627dfd6d6321f307 #downloads mapbox peer dependency
Step 2: Run Start Script
yarn run start
or
yarn run watch

Synopsis

MapD-Charting is a superfast charting library that works natively with crossfilter that is based off dc.js. It is designed to work with MapD-Connector and MapD-Crossfilter to create charts instantly with our MapD-Core SQL Database. Please see examples for further understanding to quickly create interactive charts.

Our Tweetmap Demo was made only using MapD-Charting.

Documentation

Visit our API Docs for additional information on MapD Charting

Testing

New components in MapD-Charting should be unit-tested and linted. All tests will be in the same folder as the new component.

+-- src
|   +-- /mixins/new-mixin-component.js
|   +-- /mixins/new-mixin-component.unit.spec.js

The linter and all tests run on

yarn run test

To check only unit-tests run:

yarn run test:unit

Linting

Please lint all your code in mapd-charting/. The lint config file can be found in .eslintrc.json. For new components, please fix all lint warnings and errors.

Scripts

Command Description
yarn run start Copies files for examples and then serves the example
yarn run build Runs webpack and builds js and css in /dist
yarn run docs Creates and opens docs
yarn run test Runs both linting and unit tests
yarn run clean Removes node modules, dist, docs, and example files

Documentation

The charting library uses documentation.js for API documentation. Docs can be built and viewed locally with the npm run docs command.

Contributing

Interested in contributing? We'd love for you to help! Check out Contributing.MD