Added chart object to event handler callbacks

amcharts · May 26, 2015 · 3fc7a28 · 3fc7a28
1 parent ee7062c
commit 3fc7a28
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 16 deletions.
diff --git a/dataloader.js b/dataloader.js
@@ -2,7 +2,7 @@
 Plugin Name: amCharts Data Loader
 Description: This plugin adds external data loading capabilities to all amCharts libraries.
 Author: Martynas Majeris, amCharts
-Version: 1.0.4
+Version: 1.0.5
 Author URI: http://www.amcharts.com/
 
 Copyright 2015 amCharts
@@ -172,7 +172,7 @@ AmCharts.addInitHandler( function( chart ) {
 
       // error?
       if ( false === response ) {
-        callFunction( options.error, url, options );
+        callFunction( options.error, options, chart );
         raiseError( AmCharts.__( 'Error loading the file', chart.language ) + ': ' + url, false, options );
       } else {
 
@@ -193,13 +193,13 @@ AmCharts.addInitHandler( function( chart ) {
             holder[ providerKey ] = AmCharts.parseJSON( response );
 
             if ( false === holder[ providerKey ] ) {
-              callFunction( options.error, options );
+              callFunction( options.error, options, chart );
               raiseError( AmCharts.__( 'Error parsing JSON file', chart.language ) + ': ' + l.url, false, options );
               holder[ providerKey ] = [];
               return;
             } else {
               holder[ providerKey ] = postprocess( holder[ providerKey ], options );
-              callFunction( options.load, options );
+              callFunction( options.load, options, chart );
             }
 
             break;
@@ -209,19 +209,19 @@ AmCharts.addInitHandler( function( chart ) {
             holder[ providerKey ] = AmCharts.parseCSV( response, options );
 
             if ( false === holder[ providerKey ] ) {
-              callFunction( options.error, options );
+              callFunction( options.error, options, chart );
               raiseError( AmCharts.__( 'Error parsing CSV file', chart.language ) + ': ' + l.url, false, options );
               holder[ providerKey ] = [];
               return;
             } else {
               holder[ providerKey ] = postprocess( holder[ providerKey ], options );
-              callFunction( options.load, options );
+              callFunction( options.load, options, chart );
             }
 
             break;
 
           default:
-            callFunction( options.error, options );
+            callFunction( options.error, options, chart );
             raiseError( AmCharts.__( 'Unsupported data format', chart.language ) + ': ' + options.format, false, options.noStyles );
             return;
         }
@@ -233,7 +233,7 @@ AmCharts.addInitHandler( function( chart ) {
         if ( 0 === l.remaining ) {
 
           // callback
-          callFunction( options.complete );
+          callFunction( options.complete, chart );
 
           // take in the new data
           if ( options.async ) {
@@ -400,9 +400,9 @@ AmCharts.addInitHandler( function( chart ) {
   /**
    * Execute callback function
    */
-  function callFunction( func, param1, param2 ) {
+  function callFunction( func, param1, param2, param3 ) {
     if ( 'function' === typeof func )
-      func.call( l, param1, param2 );
+      func.call( l, param1, param2, param3 );
   }
 
 }, [ 'pie', 'serial', 'xy', 'funnel', 'radar', 'gauge', 'gantt', 'stock', 'map' ] );

diff --git a/dataloader.min.js b/dataloader.min.js
diff --git a/examples/serial2_json.html b/examples/serial2_json.html
@@ -27,13 +27,13 @@
         "dataLoader": {
           "url": "data/serial2.json",
           "showErrors": true,
-          "complete": function () {
+          "complete": function ( chart ) {
             console.log( "Loading complete" );
           },
-          "load": function ( options ) {
+          "load": function ( options, chart ) {
             console.log( "File loaded: ", options.url );
           },
-          "error": function ( options ) {
+          "error": function ( options, chart ) {
             console.log( "Error occured loading file: ", options.url );
           }
         },

diff --git a/readme.md b/readme.md
@@ -1,6 +1,6 @@
 # amCharts Data Loader
 
-Version: 1.0.4
+Version: 1.0.5
 
 
 ## Description
@@ -65,7 +65,7 @@ AmCharts.makeChart( "chartdiv", {
   "dataSets": [{
     ...,
     "dataLoader": {
-      "url": "data.csv"
+      "url": "data.csv",
       "format": "csv",
       "delimiter": ",",       // column separator
       "useColumnNames": true, // use first row for column names
@@ -162,6 +162,38 @@ Once chart is initialized, you can trigger the reload of all data manually by
 calling `chart.dataLoader.loadData()` function. (replace "chart" with the actual
 variable that holds reference to your chart object)
 
+## Using callback functions
+
+Data Loader can call your own function when certain event happens, like data
+loading is complete, error occurs, etc.
+
+To set custom event handlers, use these config options:
+
+* "complete"
+
+Example:
+
+```
+AmCharts.makeChart( "chartdiv", {
+  ...,
+  "dataSets": [{
+    ...,
+    "dataLoader": {
+      "url": "data.json",
+      "load": function ( options, chart ) {
+        console.log( 'Loaded file: ' + options.url );
+      },
+      "complete": function ( chart ) {
+        console.log( 'Woohoo! Finished loading' );
+      },
+      "error": function ( options, chart ) {
+        console.log( 'Ummm something went wrong loading this file: ' + options.url );
+      }
+    }
+  }]
+} );
+```
+
 
 ## Translating into other languages
 
@@ -238,6 +270,10 @@ http://www.apache.org/licenses/LICENSE-2.0
 
 ## Changelog
 
+### 1.0.5
+* Fixed JS error if periodSelector was not defined in chart config
+* Now all callback functions (complete, error, load) receive additional parameter: chart
+
 ### 1.0.4
 * Added chart.dataLoader.loadData() function which can be used to manually trigger all data reload