Merge pull request #36 from RallyTechServices/listener

Listener

Author: tyrjo

README.md

@@ -5,6 +5,8 @@
 Note that as with other custom lists, the filter is only applied at the root level.
 
 Additionally, items can be filtered by an ancestor portfolio item. (e.g. filter Features that are ultimately children of the higher level Theme).
+If placed on a page that also has a [pi-ancestor-filter-broadcaster](https://github.com/RallyTechServices/pi-ancestor-filter-broadcaster),
+and filter by ancestor portfolio item is enabled, it will listen to the broadcaster for the selected ancestor.
 
 Several export options are provided and change depending on the root record type
 chosen in Edit App Settings...

config.json

@@ -5,6 +5,7 @@
     "apiKey": "_PUT_APIKEY_HERE_",
     "javascript": [
         "node_modules/@agile-central-technical-services/utils-shared-views/index.js",
+        "node_modules/@agile-central-technical-services/utils-ancestor-pi-app-filter/index.js",
         "node_modules/@agile-central-technical-services/utils-ancestor-pi-inline-filter/index.js",
         "src/javascript/utils/*.js",
         "src/javascript/*.js"

deploy/Ugly.txt

@@ -1,6 +1,6 @@
 {
   "name": "custom-grid-with-deep-export",
-  "version": "1.2.11",
+  "version": "1.3.0",
   "scripts": {
     "debug": "grunt debug",
     "debug:watch": "nodemon --exec grunt debug",
@@ -9,6 +9,7 @@
     "deploy-debugsdk:watch": "nodemon --exec grunt deploy-debugsdk"
   },
   "dependencies": {
+    "@agile-central-technical-services/utils-ancestor-pi-app-filter": "^2.1.0",
     "@agile-central-technical-services/utils-ancestor-pi-inline-filter": "^1.0.12",
     "@agile-central-technical-services/utils-shared-views": "^1.0.2"
   },

package.json

@@ -7,6 +7,14 @@ Ext.define("custom-grid-with-deep-export", {
         align: 'stretch'
     },
     items: [{
+        id: Utils.AncestorPiAppFilter.RENDER_AREA_ID,
+        xtype: 'container',
+        layout: {
+            type: 'hbox',
+            align: 'middle',
+            defaultMargins: '0 10 10 0',
+        }
+    }, {
         id: 'grid-area',
         xtype: 'container',
         flex: 1,
@@ -40,22 +48,37 @@ Ext.define("custom-grid-with-deep-export", {
         this._buildStore();
     },
     launch: function() {
-        Rally.data.util.PortfolioItemHelper.getPortfolioItemTypes()
-            .then({
-                success: function(portfolioItemTypes) {
-                    this.portfolioItemTypes = _.sortBy(portfolioItemTypes, function(type) {
-                        return type.get('Ordinal');
-                    });
-                    this._buildStore();
-                },
-                failure: function(msg) {
-                    this._showError(msg);
+        this.ancestorFilterPlugin = Ext.create('Utils.AncestorPiAppFilter', {
+            ptype: 'UtilsAncestorPiAppFilter',
+            pluginId: 'ancestorFilterPlugin',
+            settingsConfig: {
+                //labelWidth: 150,
+                //margin: 10
+            },
+            listeners: {
+                scope: this,
+                ready: function(plugin) {
+                    Rally.data.util.PortfolioItemHelper.getPortfolioItemTypes().then({
+                        scope: this,
+                        success: function(portfolioItemTypes) {
+                            this.portfolioItemTypes = _.sortBy(portfolioItemTypes, function(type) {
+                                return type.get('Ordinal');
+                            });
+
+                            plugin.addListener({
+                                scope: this,
+                                select: this.viewChange
+                            });
+                            this.viewChange();
+                        },
+                        failure: function(msg) {
+                            this._showError(msg);
+                        },
+                    })
                 },
-                scope: this
-            });
-        var listenerConfig = {
-            scope: this
-        }
+            }
+        });
+        this.addPlugin(this.ancestorFilterPlugin);
     },
 
     // Usual monkey business to size gridboards
@@ -93,11 +116,17 @@ Ext.define("custom-grid-with-deep-export", {
         var gridArea = this.down('#grid-area')
         gridArea.removeAll();
 
+        var currentModelName = this.modelNames[0];
+
         var filters = this.getSetting('query') ? [Rally.data.wsapi.Filter.fromQueryString(this.getSetting('query'))] : [];
         var timeboxScope = this.getContext().getTimeboxScope();
         if (timeboxScope && timeboxScope.isApplicable(store.model)) {
             filters.push(timeboxScope.getQueryFilter());
         }
+        var ancestorFilter = this.ancestorFilterPlugin.getFilterForType(currentModelName);
+        if (ancestorFilter) {
+            filters.push(ancestorFilter);
+        }
         this.logger.log('_addGridboard', store);
 
         var context = this.getContext();
@@ -106,7 +135,6 @@ Ext.define("custom-grid-with-deep-export", {
             dataContext.project = null;
         }
         var summaryRowFeature = Ext.create('Rally.ui.grid.feature.SummaryRow');
-        var currentModelName = this.modelNames[0];
         this.gridboard = gridArea.add({
             xtype: 'rallygridboard',
             context: context,

src/javascript/app.js

@@ -2,6 +2,10 @@
 # yarn lockfile v1
 
 
+"@agile-central-technical-services/utils-ancestor-pi-app-filter@^2.1.0":
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/@agile-central-technical-services/utils-ancestor-pi-app-filter/-/utils-ancestor-pi-app-filter-2.1.0.tgz#a2417a0aa43cce28f6c0cc34a7f3d6a898f6e2bf"
+
 "@agile-central-technical-services/utils-ancestor-pi-inline-filter@^1.0.12":
   version "1.0.12"
   resolved "https://registry.yarnpkg.com/@agile-central-technical-services/utils-ancestor-pi-inline-filter/-/utils-ancestor-pi-inline-filter-1.0.12.tgz#eb82287496305bec975beea03ff7a510588e05ee"