markvis-pie

0.0.7 • Public • Published

PieChart

Pie chart generator for markvis in browser and node.js.

NPM version NPM downloads Build Coverage donate

Install

npm install markvis-pie --save

or use yarn

yarn add markvis-pie --save

Usage

const markvisPie = require('markvis-pie');
const pie = markvisPie({ data, d3, d3node })

Check out the example for usage.

Output the visualization result to a image

npm run example

Output Preview (png):

chart

API

markvisPie({ data, d3, d3node[, selector, container, style] })

options

data

  • Type: Array

Data from file or web processed by d3 library.

d3
  • Type: Object

d3 library which used in browser environment.

d3node
  • Type: Object

d3-node constructor which used in node environment.

selector
  • Type: String
  • Default: '#chart'

DOM selector in container.

container
  • Type: String
  • Default: <div id="container"><h2>Pie Chart</h2><div id="chart"></div></div>

DOM contained the visualization result.

style
  • Type: String
  • Default:
.arc text {
   font: 10px sans-serif;
   text-anchor: middle;
}
.arc path {
   stroke: #fff;
 }

Pie chart style.

width
  • Type: Number
  • Default: 960

SVG width for pie chart.

radius
  • Type: Number
  • Default: width / 2 * 0.9

Radius for pie chart.

export
  • Type: boolean
  • Default: false

Whether to export to a PNG image.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

LICENSE

markvis-pie © geekplux, Released under the MIT License.
Authored and maintained by geekplux with help from contributors (list).

geekplux.com · GitHub @geekplux · Twitter @geekplux

Package Sidebar

Install

npm i markvis-pie

Weekly Downloads

2

Version

0.0.7

License

MIT

Unpacked Size

36.7 kB

Total Files

14

Last publish

Collaborators

  • geekplux