Skip to content

Latest commit

 

History

History
69 lines (55 loc) · 3.07 KB

README.md

File metadata and controls

69 lines (55 loc) · 3.07 KB

Yako

npm version Stories in Ready Dependencies Build Status Coverage Status bitHound Score

A tiny DOM-less graph library, build for fast front end and server side rendering in CommonJs pattern. This library is intend to generate light weight and simple SVG graphs, and is more performable compare to highcharts / flot / c3 / d3 when front end matters.

This library also works great with webpack & react w/ prepared react graph components

Documentation https://github.com/alfredkam/yakojs/blob/master/doc.md

Demo http://github.alfredkam.com/yakojs or gulp dev and visit http://localhost:5000

Supports Chrome, Firefox, Safari, and IE 9+;

###Note on upgrading 0.4.X to 0.5.X

  • Deprecate the old bubble usage and with a new interface
  • Simplify <graph>.timeseries require usage - It is now no longer needed to include .timeseries to use those graphs
  • Simplify chart configuration by flattern out <graph>.attr({})

Install

npm install yako<br Alternatively
bower install yako

Building the package

gulp build
This will build the lib directory, by converting src directory from es6 to es5.

API Ready

  • Simple Graphs
    • Spark
      • Scattered
      • Line
      • Area Graphs
    • Pie Charts
    • Donut Charts
    • Bubble Point (Bubble Line) Chart for Time Flow Representation (Represents actions across a period of time)
    • Bubble Graph (Represents a cohort / segment activty)
    • Bar Graphs (stack & non stack)
  • MixIn / Inheritance
  • Multi axis for spark graphs
  • Labels
    • Bar graph
    • Line Graph
    • Bubble Graph
  • Programmatic point of access (Only Avaliable for React)
  • Events & Emitters (Only Avaliable for React)

Road Map

  • Complex Graphs
    • eg. time series w/ auto fill
  • Expose math functions
  • Bring svg to live
  • Real time graphs

How to run unit test

npm test

Latest Release

Please refer to the release branch - https://github.com/alfredkam/yakojs/tree/release

Analytics wercker status