how_are_we_doing 0.0.4 → 0.0.5

data/lib/generators/how_are_we_doing/install/templates/public/javascripts/flot/API.txt

@@ -166,6 +166,8 @@ If you want the legend to appear somewhere else in the DOM, you can
 specify "container" as a jQuery object/expression to put the legend
 table into. The "position" and "margin" etc. options will then be
 ignored. Note that Flot will overwrite the contents of the container.
+Most of the above settings do not apply
+
 
 
 Customizing the axes
@@ -176,13 +178,9 @@ Customizing the axes
     min: null or number
     max: null or number
     autoscaleMargin: null or number
-    
     labelWidth: null or number
     labelHeight: null or number
 
-    transform: null or fn: number -> number
-    inverseTransform: null or fn: number -> number
-    
     ticks: null or number or ticks array or (fn: range -> ticks array)
     tickSize: number or array
     minTickSize: number or array
@@ -210,29 +208,6 @@ nearest whole tick. The default value is "null" for the x axis and
 labels in pixels. They're useful in case you need to align several
 plots.
 
-"transform" and "inverseTransform" are callbacks you can put in to
-change the way the data is drawn. You can design a function to
-compress or expand certain parts of the axis non-linearly, e.g.
-suppress weekends or compress far away points with a logarithm or some
-other means. When Flot draws the plot, each value is first put through
-the transform function. Here's an example, the x axis can be turned
-into a natural logarithm axis with the following code:
-
-  xaxis: {
-    transform: function (v) { return Math.log(v); },
-    inverseTransform: function (v) { return Math.exp(v); }
-  }
-
-Note that for finding extrema, Flot assumes that the transform
-function does not reorder values (monotonicity is assumed).
-
-The inverseTransform is simply the inverse of the transform function
-(so v == inverseTransform(transform(v)) for all relevant v). It is
-required for converting from canvas coordinates to data coordinates,
-e.g. for a mouse interaction where a certain pixel is clicked. If you
-don't use any interactive features of Flot, you may not need it.
-
-
 The rest of the options deal with the ticks.
 
 If you don't specify any ticks, a tick generator algorithm will make
@@ -309,6 +284,7 @@ an example of a custom formatter:
       return val.toFixed(axis.tickDecimals) + " B";
   }
 
+
 Time series data
 ================
 
@@ -379,7 +355,6 @@ through the following axis options:
   minTickSize: array
   timeformat: null or format string
   monthNames: null or array of size 12 of strings
-  twelveHourClock: boolean
 
 Here "timeformat" is a format string to use. You might use it like
 this:
@@ -392,25 +367,20 @@ this:
 This will result in tick labels like "2000/12/24". The following
 specifiers are supported
 
-  %h: hours
-  %H: hours (left-padded with a zero)
-  %M: minutes (left-padded with a zero)
-  %S: seconds (left-padded with a zero)
-  %d: day of month (1-31)
-  %m: month (1-12)
-  %y: year (four digits)
-  %b: month name (customizable)
-  %p: am/pm, additionally switches %h/%H to 12 hour instead of 24
-  %P: AM/PM (uppercase version of %p)
+  %h': hours
+  %H': hours (left-padded with a zero)
+  %M': minutes (left-padded with a zero)
+  %S': seconds (left-padded with a zero)
+  %d': day of month (1-31)
+  %m': month (1-12)
+  %y': year (four digits)
+  %b': month name (customizable)
 
 You can customize the month names with the "monthNames" option. For
 instance, for Danish you might specify:
 
   monthNames: ["jan", "feb", "mar", "apr", "maj", "jun", "jul", "aug", "sep", "okt", "nov", "dec"]
 
-If you set "twelveHourClock" to true, the autogenerated timestamps
-will use 12 hour AM/PM timestamps instead of 24 hour.
-  
 The format string and month names are used by a very simple built-in
 format function that takes a date object, a format string (and
 optionally an array of month names) and returns the formatted string.
@@ -665,6 +635,39 @@ can set "hoverable" and "clickable" to false in the options for that
 series, like this { data: [...], label: "Foo", clickable: false }.
 
 
+Customizing the selection
+=========================
+
+  selection: {
+    mode: null or "x" or "y" or "xy",
+    color: color
+  }
+
+You enable selection support by setting the mode to one of "x", "y" or
+"xy". In "x" mode, the user will only be able to specify the x range,
+similarly for "y" mode. For "xy", the selection becomes a rectangle
+where both ranges can be specified. "color" is color of the selection.
+
+When selection support is enabled, a "plotselected" event will be emitted
+on the DOM element you passed into the plot function. The event
+handler gets one extra parameter with the ranges selected on the axes,
+like this:
+
+  placeholder.bind("plotselected", function(event, ranges) {
+    alert("You selected " + ranges.xaxis.from + " to " + ranges.xaxis.to)
+    // similar for yaxis, secondary axes are in x2axis
+    // and y2axis if present
+  });
+
+The "plotselected" event is only fired when the user has finished
+making the selection. A "plotselecting" event is fired during the
+process with the same parameters as the "plotselected" event, in case
+you want to know what's happening while it's happening,
+
+A "plotunselected" event with no arguments is emitted when the user
+clicks the mouse to remove the selection.
+
+
 Specifying gradients
 ====================
 
@@ -683,18 +686,10 @@ For the series you can specify the gradient as an object that
 specifies the scaling of the brightness and the opacity of the series
 color, e.g.
 
-  { colors: [{ opacity: 0.8 }, { brightness: 0.6, opacity: 0.8 } ] }
+  { colors: [{ opacity: 0.8 }, { brightness: 0.6, opacity: 0.8 } ]
 
 where the first color simply has its alpha scaled, whereas the second
-is also darkened. For instance, for bars the following makes the bars
-gradually disappear, without outline:
-
-  bars: {
-      show: true,
-      lineWidth: 0,
-      fill: true,
-      fillColor: { colors: [ { opacity: 0.8 }, { opacity: 0.1 } ] }
-  }
+is also darkened.
   
 Flot currently only supports vertical gradients drawn from top to
 bottom because that's what works with IE.
@@ -706,6 +701,34 @@ Plot Methods
 The Plot object returned from the plot function has some methods you
 can call:
 
+  - setSelection(ranges, preventEvent)
+
+    Set the selection rectangle. The passed in ranges is on the same
+    form as returned in the "plotselected" event. If the selection
+    mode is "x", you should put in either an xaxis (or x2axis) object,
+    if the mode is "y" you need to put in an yaxis (or y2axis) object
+    and both xaxis/x2axis and yaxis/y2axis if the selection mode is
+    "xy", like this:
+
+      setSelection({ xaxis: { from: 0, to: 10 }, yaxis: { from: 40, to: 60 } });
+
+    setSelection will trigger the "plotselected" event when called. If
+    you don't want that to happen, e.g. if you're inside a
+    "plotselected" handler, pass true as the second parameter.
+
+    
+  - clearSelection(preventEvent)
+
+    Clear the selection rectangle. Pass in true to avoid getting a
+    "plotunselected" event.
+
+  - getSelection()
+
+    Returns the current selection in the same format as the
+    "plotselected" event. If there's currently no selection, it
+    returns null.
+    
+
   - highlight(series, datapoint)
 
     Highlight a specific datapoint in the data series. You can either
@@ -754,7 +777,7 @@ can call:
   - triggerRedrawOverlay()
 
     Schedules an update of an overlay canvas used for drawing
-    interactive things like a selection and point highlights. This
+    interactive things like the selection and point highlights. This
     is mostly useful for writing plugins. The redraw doesn't happen
     immediately, instead a timer is set to catch multiple successive
     redraws (e.g. from a mousemove).
@@ -866,23 +889,18 @@ Here's an overview of the phases Flot goes through:
 
   7. Responding to events, if any
 
-Each hook is simply a function which is put in the appropriate array.
-You can add them through the "hooks" option, and they are also available
-after the plot is constructed as the "hooks" attribute on the returned
-plot object, e.g.
+The hooks are simple arrays. They are available on the "hooks"
+sub-object on the Plot object with the names mentioned below, e.g.
 
-  // define a simple draw hook
-  function hellohook(plot, canvascontext) { alert("hello!"); };
+  var plot = $.plot(...);
 
-  // pass it in, in an array since we might want to specify several
-  var plot = $.plot(placeholder, data, { hooks: { draw: [hellohook] } });
+  function f(plot, series, datapoints) { alert("hello!")};
+  
+  plot.hooks.processDatapoints.push(f);
 
-  // we can now find it again in plot.hooks.draw[0] unless a plugin
-  // has added other hooks
+All hooks get the plot object as first parameter.
 
-The available hooks are described below. All hook callbacks get the
-plot object as first parameter. You can find some examples of defined
-hooks in the plugins bundled with Flot.
+Currently available hooks (when in doubt, check the Flot source):
 
  - processOptions  [phase 1]
 
@@ -1007,7 +1025,7 @@ Plugins extend the functionality of Flot. To use a plugin, simply
 include its Javascript file after Flot in the HTML page.
 
 If you're worried about download size/latency, you can concatenate all
-the plugins you use, and Flot itself for that matter, into one big file
+the plugins you use and Flot itself for that matter into one big file
 (make sure you get the order right), then optionally run it through a
 Javascript minifier such as YUI Compressor.
 
@@ -1020,5 +1038,4 @@ from its "option" attribute. The init function gets a reference to the
 plot object created and uses this to register hooks and add new public
 methods if needed.
 
-See the PLUGINS.txt file for details on how to write a plugin. As the
-above description hints, it's actually pretty easy.
+See the PLUGINS.txt file for details on how to write a plugin.

data/lib/generators/how_are_we_doing/install/templates/public/javascripts/flot/NEWS.txt

@@ -1,32 +1,26 @@
-Flot 0.6
+Flot 0.x
 --------
 
 API changes:
 
-1. Selection support has been moved to a plugin. Thus if you're
-passing selection: { mode: something }, you MUST include the file
-jquery.flot.selection.js after jquery.flot.js. This reduces the size
-of base Flot and makes it easier to customize the selection as well as
-improving code clarity. The change is based on patch from andershol.
-
-2. In the global options specified in the $.plot command,
+1. In the global options specified in the $.plot command,
 "lines", "points", "bars" and "shadowSize" have been moved to a
 sub-object called "series", i.e.
 
   $.plot(placeholder, data, { lines: { show: true }})
 
-should be changed to
+becomes
 
   $.plot(placeholder, data, { series: { lines: { show: true }}})
 
 All future series-specific options will go into this sub-object to
-simplify plugin writing. Backward-compatibility code is in place, so
-old code should not break.
+simplify plugin writing. Backward-compatibility hooks are in place,
+so old code should not break.
 
-3. "plothover" no longer provides the original data point, but instead
+2. "plothover" no longer provides the original data point, but instead
 a normalized one, since there may be no corresponding original point.
 
-4. Due to a bug in previous versions of jQuery, you now need at least
+3. Due to a bug in previous versions of jQuery, you now need at least
 jQuery 1.2.6. But if you can, try jQuery 1.3.2 as it got some
 improvements in event handling speed.
 
@@ -91,9 +85,9 @@ Changes:
   offset within the placeholder.
   
 - Plugin system: register an init method in the $.flot.plugins array
-  to get started, see PLUGINS.txt for details on how to write plugins
-  (it's easy). There are also some extra methods to enable access to
-  internal state.
+  to get started, see PLUGINS.txt for details on how to write plugins.
+  There are also some extra methods to enable access to internal
+  state.
 
 - Hooks: you can register functions that are called while Flot is
   crunching the data and doing the plot. This can be used to modify
@@ -117,16 +111,7 @@ Changes:
 
 - More configurable grid.
 
-- Axis transformation support, useful for non-linear plots, e.g. log
-  axes and compressed time axes (like omitting weekends).
-
-- Support for twelve-hour date formatting (patch by Forrest Aldridge).
-
-- The color parsing code in Flot has been cleaned up and split out so
-  it's now available as a separate jQuery plugin. It's included inline
-  in the Flot source to make dependency managing easier. This also
-  makes it really easy to use the color helpers in Flot plugins.
-
+  
 Bug fixes:
 
 - Fixed two corner-case bugs when drawing filled curves (report and
@@ -141,7 +126,7 @@ Bug fixes:
   problem reported by Sergio Nunes).
 - Updated mousemove position expression to the latest from jQuery (bug
   reported by meyuchas).
-- Use CSS borders instead of background in legend (fix printing issue 25
+- Use borders instead of background in legend (fix printing issue 25
   and 45).
 - Explicitly convert axis min/max to numbers.
 - Fixed a bug with drawing marking lines with different colors
@@ -167,11 +152,6 @@ Bug fixes:
   smarter.
 - Fix for uneven axis margins (report and patch by Paul Kienzle) and
   snapping to ticks (concurrent report and patch by lifthrasiir).
-- Fixed bug with slicing in findNearbyItems (patch by zollman).
-- Make heuristic for x axis label widths more dynamic (patch by
-  rickinhethuis).
-- Make sure points on top take precedence when finding nearby points
-  when hovering (reported by didroe, issue 224).
 
 Flot 0.5
 --------

data/lib/generators/how_are_we_doing/install/templates/public/javascripts/flot/README.txt

@@ -64,7 +64,7 @@ in the file "API.txt". Here's a quick example that'll draw a line from
 
   $.plot($("#placeholder"), [ [[0, 0], [1, 1]] ], { yaxis: { max: 1 } });
 
-The plot function immediately draws the chart and then returns a plot
+The plot function immediately draws the chart and then returns a Plot
 object with a couple of methods.
 
 
@@ -73,9 +73,9 @@ What's with the name?
 
 First: it's pronounced with a short o, like "plot". Not like "flawed".
 
-So "Flot" rhymes with "plot".
+So "Flot" is like "Plot".
 
 And if you look up "flot" in a Danish-to-English dictionary, some up
 the words that come up are "good-looking", "attractive", "stylish",
 "smart", "impressive", "extravagant". One of the main goals with Flot
-is pretty looks.
+is pretty looks. Flot is supposed to be "flot".