savetheclocktower / krang

Branches (1)
- master ✓
Tags (0)

A charting library built on Prototype (http://prototypejs.org) and Raphaël (http://raphaeljs.com) — Read more

This URL has Read+Write access

Update README.

savetheclocktower (author)

Mon Nov 23 14:03:00 -0800 2009

commit ae08525628072c00f2c3acc67ec0dc88cffe527e
tree 7b4fe0b0929822f7637493464a238e388f9a641a
parent 41a0d4d2b30fb5c162677ac98f927ff383dd6d62

krang /

name	age	history message
.gitignore	Thu Apr 23 09:57:50 -0700 2009	Ignore distributable files. [savetheclocktower]
.gitmodules	Thu Apr 23 04:32:40 -0700 2009	Initial checkin. [savetheclocktower]
MIT-LICENSE	Thu Apr 23 04:32:40 -0700 2009	Initial checkin. [savetheclocktower]
README.markdown	Mon Nov 23 14:03:00 -0800 2009	Update README. [savetheclocktower]
Rakefile	Wed Sep 02 17:23:28 -0700 2009	Create "dist" directory if it doesn't exist alr... [savetheclocktower]
TODO	Wed Jun 03 07:38:44 -0700 2009	Add TODO file. [savetheclocktower]
lib/	Tue Sep 15 22:24:10 -0700 2009	Update Raphael to 1.0 RC1.3. [savetheclocktower]
src/	Tue Sep 15 22:25:28 -0700 2009	Various changes for Raphael 1.0 compatibility. [savetheclocktower]
test/	Tue Sep 15 21:19:26 -0700 2009	A sloppy first pass at animating between datasets. [savetheclocktower]
vendor/	Thu Apr 23 04:32:40 -0700 2009	Initial checkin. [savetheclocktower]

README.markdown

Krang

(A charting library built on Prototype and Raphaël)

About

Krang wraps around the excellent Raphaël library (a JavaScript vector drawing library using SVG/VML) and handles the ugly details of drawing charts. Supply a dataset, pick a chart type, and you're good to go.

Krang differs from other drawing libraries in a few important ways:

Unlike canvas solutions, Krang draws vectors. The individual regions of an SVG/VML graph can respond to events in ways that canvas cannot. Your charts can be interactive.
Unlike Flash solutions, Krang draws charts that can be viewed on the iPhone.
Unlike g.raphaël and ico, Krang is built upon Prototype, and therefore is architected in a way that will be familiar to users of the library.

Status

Krang is in late-alpha, early-beta stage. It has been used on a couple different public-facing web sites without issue. I don't yet consider it feature-complete, so if there's something you want it to do, please let me know.

Documentation

The beginnings of PDoc documentation exist in the source files, and I've tried my best to add comments where the code itself is not self-explanatory. Also, look in test/functional for demonstrations of different chart types.

License

Just like its dependencies — Prototype and Raphaël — Krang carries the MIT License.