cellDrillThrough callback & customDrillThrough control add

Author: nikitaeverywhere

example/index.html

@@ -97,6 +97,7 @@
                 // drillDown: function ({Object { level: {number}, mdx: {string} }}) {}
                 //, drillThrough: function ({Object { level: {number}, mdx: {string} }}) {}
                 //, back: function ({Object { level: {number} }}) {}
+                //, cellDrillThrough: function ({Object { event: {event}, filters: {string[]} }}) {}
             }
             //, hideButtons: true // hides "back" and "drillThrough" buttons
             //, triggerEvent: "touchstart" // all "click" events will be replaced by this event

readme.md

@@ -46,6 +46,8 @@ var setup = { // Object that contain settings. Any setting may be missed.
              drillDown: function ({Object { level: {number}, mdx: {string} }}) {}
             , drillThrough: function ({Object { level: {number}, mdx: {string} }}) {}
             , back: function ({Object { level: {number} }}) {}
+            // if cellDrillThrough callback returns boolean false, DrillThrough won't be performed.
+            , cellDrillThrough: function ({Object { event: {event}, filters: {string[]} }}) {}
         } ]
         [ , hideButtons: true // hides "back" and "drillThrough" buttons ]
         [ , triggerEvent: "touchstart" // all "click" events will be replaced by this event ]
@@ -56,6 +58,11 @@ var setup = { // Object that contain settings. Any setting may be missed.
     lp = new LightPivotTable(setup);
 
 console.log(lp.CONTROLS); // object with functions that can be triggered to control pivot table
+/* Available controls:
+ * lp.CONTROLS.drillThrough() - Perform drillThrough for current location.
+ * lp.CONTROLS.customDrillThrough(["filterSpec1", ...]) - Perform drillThrough with filters.
+ * lp.CONTROLS.back() - Back to the parent level.
+ */
 
 lp.setFilter("[DateOfSale].[Actual].[YearSold].&[2009]");
 lp.refresh();

source/js/LightPivotTable.js

@@ -246,6 +246,14 @@ LightPivotTable.prototype.init = function () {
         _.pivotView._drillThroughClickHandler.call(_.pivotView);
     };
 
+    this.CONTROLS.customDrillThrough = function (filters) {
+        if (!(filters instanceof Array)) {
+            console.error("Parameter \"filters\" must be array of strings.");
+            return;
+        }
+        _.tryDrillThrough.call(_, filters);
+    };
+
     this.CONTROLS.back = function () {
         _.pivotView._backClickHandler.call(_.pivotView);
     };

source/js/PivotView.js

@@ -171,10 +171,15 @@ PivotView.prototype._drillThroughClickHandler = function (event) {
 
 };
 
-PivotView.prototype._cellClickHandler = function (x, y) {
+/**
+ * @param {number} x
+ * @param {number} y
+ * @param {event} event
+ */
+PivotView.prototype._cellClickHandler = function (x, y, event) {
 
     var data = this.controller.dataController.getData(),
-        f = [], f1, f2;
+        f = [], f1, f2, callbackRes;
 
     try {
         f1 = data.rawData[y][data.info.leftHeaderColumnsNumber - 1].source.path;
@@ -191,7 +196,15 @@ PivotView.prototype._cellClickHandler = function (x, y) {
         + encodeURIComponent(this.controller.CONFIG["drillDownTarget"]) + "&SETTINGS=FILTER:"
         + encodeURIComponent(f.join("~")) + ";";
     } else {
-        this.controller.tryDrillThrough(f);
+        if (typeof this.controller.CONFIG.triggers["cellDrillThrough"] === "function") {
+            callbackRes = this.controller.CONFIG.triggers["cellDrillThrough"]({
+                event: event,
+                filters: f
+            });
+            if (callbackRes !== false) this.controller.tryDrillThrough(f);
+        } else {
+            this.controller.tryDrillThrough(f);
+        }
     }
 
 };
@@ -535,8 +548,8 @@ PivotView.prototype.renderRawData = function (data) {
                         span.textContent = data[y][x].value;
                     }
 
-                    (function (x, y) {addTrigger(td, clickEvent, function () {
-                        _._cellClickHandler.call(_, x, y);
+                    (function (x, y) {addTrigger(td, clickEvent, function (event) {
+                        _._cellClickHandler.call(_, x, y, event);
                     })})(x, y);
                 } else {
                     span.textContent = data[y][x].value;