Added comments to the x-gap plugin.

oughton · oughton · commit 73ef2ff6afa3 · 2011-11-11T15:37:21.000+13:00
diff --git a/src/flot/jquery.flot.xgap.js b/src/flot/jquery.flot.xgap.js
@@ -1,6 +1,25 @@
 /**
  * Flot plugin for adding gaps to the line in a line graph when a certain x threashold has been reached.
  *
+ * Usage:
+ *
+ * To configure this plugin, values must be added to two areas.
+ * 
+ * The first is in the global x-axis options:
+ * xaxis: {
+ *   insertGaps: true,  // enable or disable this plugin
+ *   gapColor: rgba(100,100,100,0.2) // the color to use for gaps - undefined is no indication
+ * }
+ *
+ * The second is in the series object for a set of data.
+ * var series1 = {
+ *   data: [ ... ],
+ *   label: 'Series 1',
+ *   xGapThresh: 300 // A value of 300 here indicates that a x-gap > 300 will insert a gap
+ * }
+ *
+ * Enjoy!
+ *
  * @author Joel Oughton
  */
 (function($){
