1.1.2 • Published 4 years ago

cubism-es v1.1.2

Weekly downloads
31
License
MIT
Repository
github
Last release
4 years ago

cubism-es

cubism-es is an ES6 module of cubism, based on D3V5.

IMPORTANT Version 1.1.0 contains api breaks. Please see below for details

Usage:

  1. Install
npm install cubism-es --save
  1. ES6 Usage
import { context } from 'cubism-es';

API Breaks (v1.1.0)

functioncubismcubism-es
Context.axisd3.select(...).call(context.axis)context.axis().render(d3.select(...))
Context.ruled3.select(...).call(context.rule)context.rule().render(d3.select(...))
Context.horizond3.select(...).call(context.horizon)context.horizon().render(d3.select(...))

API Breaks (v1.0.0 and previous)

functioncubismcubism-es
Contextd3.select(...).call(cubism.context)const context = cubism.context(d3.select(...)).height(30)
Context.axisd3.select(...).call(context.axis)context.axis(d3.select(...))
Context.ruled3.select(...).call(context.rule)context.rule(d3.select(...))
Context.horizond3.select(...).call(context.horizon)context.horizon(d3.select(...))

Demo

the following samples work, you can try them by downloading this project and running npm install and npm run dev:

Development

  1. Clone repository
  2. Run commands
npm install         // install dependencies
npm run dev         // view demos in web browser at localhost:3004
npm run build       // build
npm run test        // run tests only
npm run test:cover  // run tests and view coverage report

Documentation

For more information, please visit square/cubism's home page and wiki

Limitation

Graphite, Cube and GangliaWeb have not been verified yet.

Credits

Contributors of the original cubism.

License

This project is licensed under the MIT License - see the LICENSE file for details