Permalink
Browse files

Updating README. Updating docs for tooltips and g prototype

  • Loading branch information...
1 parent 9310c89 commit 6f67cd4f217c52686a992e2904c05d87e53c6f99 @rzurad rzurad committed Nov 2, 2011
Showing with 87 additions and 50 deletions.
  1. +0 −19 README
  2. +21 −0 README.markdown
  3. +34 −22 docs/reference.html
  4. +5 −4 g.bar.js
  5. +27 −5 g.raphael.js
View
19 README
@@ -1,19 +0,0 @@
-g.Raphaël - Official charting plugin for Raphaël
-=========
-
-For more information, see: http://g.raphaeljs.com/
-
-Changelog
----------
-
-v0.5
- - Refactored codebase and API to work with Raphaël 2.0
- - The `g` property has been changed from a namespace to a prototype for all chart types. See documentation for all configurable options on the `g` prototype.
- - `g.markers` has been removed. The marker parameter strings now just try and resolve functions on the Paper prototype.
- - All primitive shapes have been removed. They are now part of Raphaël core in `plugins/`
- - The companion function `original` to the brightness functions `lighter` and `darker` has been renamed to `resetBrightness` to account for the `g` namespace removal
- - All tooltips can now be called on any Element or Set instance, as well as from the paper object.
- - All tooltip `update` functions have been removed. Tooltip functions now return their path element. It is up to the caller to manage both the Element or set that is used as the context and the path element that was drawn by the tooltip function.
- - all tooltip `dir` options have been changed from `0`, `1`, `2`, `3`, to `'down'`, `'left'`, `'up'`, `'right'` repectively.
- - `blob` and `drop` tooltips no longer accept `size` parameters. Instead, the bounding box of the Element/Set being used as content is used to automatically determine the size.
- - `popupit` and `labelit` have been removed. Their functionality is now the default behavior of all tooltips
View
@@ -0,0 +1,21 @@
+g.Raphaël - Official charting plugin for Raphaël
+=========
+
+For more information, see: http://g.raphaeljs.com/
+
+Changelog
+---------
+
+**v0.5**
+
+ * Refactored codebase and API to work with Raphaël 2.0
+ * `g` is no longer a namespace, but instead a prototype object that all charts inherit. See documentation for all configurable options on the `g` prototype.
+ * `g.markers` has been removed. The marker parameter strings now just try and resolve functions on the Paper prototype.
+ * All primitive shapes have been removed. They are now part of Raphaël core in `plugins/`
+ * The companion function `original` to the brightness functions `lighter` and `darker` has been renamed to `resetBrightness` to account for the `g` namespace removal
+ * Tooltips have been modified/enhanced in the following ways:
+ * All tooltips can now be called on any Element or Set instance, as well as from the paper object.
+ * All tooltip `update` functions have been removed. Tooltip functions now return their path element. It is up to the caller to manage both the Element or set that is used as the context and the path element that was drawn by the tooltip function.
+ * All tooltip `dir` options have been changed from `0`, `1`, `2`, `3`, to `'down'`, `'left'`, `'up'`, `'right'` repectively.
+ * `blob` and `drop` tooltips no longer accept `size` parameters. Instead, the bounding box of the Element/Set being used as content is used to automatically determine the size.
+ * `popupit` and `labelit` have been removed. Their functionality is now the default behavior of all tooltips
Oops, something went wrong.

0 comments on commit 6f67cd4

Please sign in to comment.