1 // This is a dummy file to help JSDoc document the d34raphael code better.
  2 //
  3 // It is not intented to be included or compiled.
  4 
  5 /**
  6  * @namespace
  7  */
  8 d3 = {};
  9 
 10 /**
 11  * @class Raphael aware selection, intended to be used like <code><a href="https://github.com/mbostock/d3/wiki/Selections">d3.selection</a></code>.
 12  *  caveats and differences documented below.  <br />
 13  *  <br />
 14  *  Unlike SVG, in Raphael, all elements are in a flat list, all peer to eachother, and all the direct child of the root Raphael element.
 15  *  This changes the behavior of some of the methods below (noted as appropriate).<br />
 16  *  <br />
 17  *  If you don't see a method documented, it probably doesn't exist yet.
 18  *
 19  * @constructor
 20  */
 21 D3RaphaelSelection = function() {};
 22 
 23 /**
 24  * @class Raphael aware update selection, intended to be used like <code><a href="https://github.com/mbostock/d3/wiki/Selections">d3.selection</a></code>.
 25  * @constructor
 26  * @extends D3RaphaelSelection
 27  */
 28 D3RaphaelUpdateSelection = function() {};
 29 
 30 /**
 31  * @class Raphael aware enter selection, intended to be used like <code><a href="https://github.com/mbostock/d3/wiki/Selections">d3.selection</a></code>.
 32  *
 33  * @constructor
 34  */
 35 D3RaphaelEnterSelection = function() {};
 36 
 37 /**
 38  * @class A Raphael axis renderer function, intended to be used like <code><a href="https://github.com/mbostock/d3/wiki/SVG-Axes">d3.svg.axis</a></code>.
 39  *   caveates and differences documented below.  <br />
 40  *   <br />
 41  *   If you don't see a method documented, it probably doesn't exist yet.<br />
 42  *   <br />
 43  *   NOTE: The object is actually a function with signature <code>function(selection)</code>, to be called with a selection to which it renders it's axis,
 44  *
 45  * @constructor
 46  */
 47 D3RaphaelAxis = function() {}