From 9396ceb4bc2a4b6fa0541aec8af98358c9cca1a3 Mon Sep 17 00:00:00 2001
From: "olau@iola.dk" <olau@iola.dk@1e0a6537-2640-0410-bfb7-f154510ff394>
Date: Wed, 21 Oct 2009 14:45:14 +0000
Subject: [PATCH] Added a hooks option to enable scripts to define hooks before
 doing a plot

git-svn-id: https://flot.googlecode.com/svn/trunk@209 1e0a6537-2640-0410-bfb7-f154510ff394
---
 API.txt        | 26 +++++++++++++++++---------
 jquery.flot.js |  7 ++++++-
 2 files changed, 23 insertions(+), 10 deletions(-)

diff --git a/API.txt b/API.txt
index 7af8c1e..a11dd86 100644
--- a/API.txt
+++ b/API.txt
@@ -919,16 +919,23 @@ Here's an overview of the phases Flot goes through:
 
   7. Responding to events, if any
 
-The hooks are simple arrays. They are available on the "hooks"
-object on the Plot object, e.g.
+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.
 
-  var plot = $.plot(...);
+  // define a simple draw hook
+  function hellohook(plot, canvascontext) { alert("hello!"); };
 
-  function f(plot, canvascontext) { alert("hello!")};
-  
-  plot.hooks.draw.push(f); // add f to the array of "draw" hooks
+  // pass it in, in an array since we might want to specify several
+  var plot = $.plot(placeholder, data, { hooks: { draw: [hellohook] } });
+
+  // we can now find it again in plot.hooks.draw[0] unless a plugin
+  // has added other hooks
 
-The hooks get the plot object as first parameter. Currently available hooks:
+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.
 
  - processOptions  [phase 1]
 
@@ -1053,7 +1060,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.
 
@@ -1066,4 +1073,5 @@ 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.
+See the PLUGINS.txt file for details on how to write a plugin. As the
+above description hints, it's actually pretty easy.
diff --git a/jquery.flot.js b/jquery.flot.js
index 915e93f..0c716b2 100644
--- a/jquery.flot.js
+++ b/jquery.flot.js
@@ -103,7 +103,8 @@
                 selection: {
                     mode: null, // one of null, "x", "y" or "xy"
                     color: "#e8cfac"
-                }
+                },
+                hooks: {}
             },
         canvas = null,      // the canvas for the plot itself
         overlay = null,     // canvas for interactive stuff on top of plot
@@ -205,6 +206,10 @@
             if (options.shadowSize)
                 options.series.shadowSize = options.shadowSize;
 
+            for (var n in hooks)
+                if (options.hooks[n] && options.hooks[n].length)
+                    hooks[n] = hooks[n].concat(options.hooks[n]);
+
             executeHooks(hooks.processOptions, [options]);
         }