closed #9, fixed #10

Author: hjalmers

CHANGELOG.md

@@ -3,6 +3,13 @@ Release History
 
 ## [Unreleased]
 
+# [1.2.1] - 2016-07-14
+### Added
+- Support for passing array with object keys i.e. columns to export function
+
+### Fixed
+- export settings and column order wasn't re-added to field definition when table structure was updated
+
 # [1.2.0] - 2016-07-12
 ### Added
 - Support for table search

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "generic-table",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "main": [
     "dist/js/generic.table.min.js",
     "dist/css/generic-table.min.css"

directive/generic-table/generic-table.js

@@ -58,19 +58,22 @@ angular.module('generic.table').directive('genericTable', function() {
     $scope.gtNoDataTxt = typeof $scope.gtNoDataTxt === 'undefined' ? 'No table data to display':$scope.gtNoDataTxt;
     $scope.gtId = typeof $scope.gtId === 'undefined' ? $scope.$id:$scope.gtId;
 
-    // order columns
-    $filter('map')($scope.gtSettings,function(setting){
-        try{
-            var field = $filter('filter')($scope.gtFields,{objectKey:setting.objectKey},true)[0];
-            field.columnOrder = setting.columnOrder;
-            if(setting.export === false){
-                field.exportField = false;
+    // extend field definitions
+    var extendFieldDefinitions = function() {
+        $filter('map')($scope.gtSettings,function(setting){
+            try{
+                var field = $filter('filter')($scope.gtFields,{objectKey:setting.objectKey},true)[0];
+                field.columnOrder = setting.columnOrder; // add column order
+                if(setting.export === false) {
+                    field.exportField = false; // add export field
+                }
+            } catch(error) {
+                console.log('field definition object for property: "'+ setting.objectKey +'" not found.',error);
             }
-        } catch(error) {
-            console.log('field definition object for property: "'+ setting.objectKey +'" not found.',error);
-        }
 
-    });
+        });
+    };
+    extendFieldDefinitions();
 
     var initTable = function(initData){
         $scope.gtHasData = false;
@@ -186,6 +189,7 @@ angular.module('generic.table').directive('genericTable', function() {
     $scope.$on('gt-update-structure:'+$scope.gtId,function(event,arg){
         $scope.gtFields = arg.fields;
         $scope.gtSettings = arg.settings;
+        extendFieldDefinitions();
         searchColumns = $filter('map')($filter('removeWith')($scope.gtFields.slice(0),{search:false}),'objectKey');
 
         // if no sorting is applied or if sorting is forced...
@@ -379,19 +383,27 @@ angular.module('generic.table').directive('genericTable', function() {
             var row = exportData[i];
             for (var key in row) {
                 if (row.hasOwnProperty(key)) {
-                    var fieldSetting = $filter('filter')($scope.gtFields,{objectKey:key},true)[0];
-                    var tableSetting = $filter('filter')($scope.gtSettings,{objectKey:key},true)[0];
+                    var fieldSetting = $filter('filter')($scope.gtFields, {objectKey: key}, true)[0];
+                    var tableSetting = $filter('filter')($scope.gtSettings, {objectKey: key}, true)[0];
 
                     var exportMethod = fieldSetting.export;
 
                     // if export method is declared and is a function...
-                    if(exportMethod && angular.isFunction(exportMethod)){
+                    if (exportMethod && angular.isFunction(exportMethod)) {
                         // ...replace export data row value with value returned by function
                         row[key] = exportMethod(row, key);
                     }
+
+                    // if exportColumns are passed with options...
+                    if (typeof options.exportColumns !== 'undefined') {
+                        // ...set value to null i.e. don't export column if it's not in the exportColumns array
+                        if (options.exportColumns.indexOf(tableSetting.objectKey)===-1){
+                            row[key] = null;
+                        }
+                    }
                     // if export is set to false for field...
-                    if(typeof tableSetting.export !== 'undefined' && tableSetting.export === false) {
-                        // ...set value to null
+                    else if (typeof tableSetting.export !== 'undefined' && tableSetting.export === false) {
+                        // ...set value to null i.e. don't export column
                         row[key] = null;
                     }
                 }
@@ -401,7 +413,19 @@ angular.module('generic.table').directive('genericTable', function() {
         // declare export data
         var data = exportData;//JSON.parse(angular.toJson(sortedData.slice(0)));
 
-        var exportFields = $filter('orderBy')($filter('removeWith')($scope.gtFields,{exportField:false}),"columnOrder");
+        // if exportColumns are passed with options...
+        if (typeof options.exportColumns !== 'undefined') {
+            
+            // ...get field settings for all objectKeys in exportColumns array
+            var exportFields = $filter('map')(options.exportColumns, function(objectKey){
+                return $filter('filter')($scope.gtFields.slice(0), {objectKey:objectKey}, true)[0];
+            } );
+        }
+        // else export all columns except columns not marked for export i.e. has field setting export:false (added to gtField
+        else {
+            var exportFields = $filter('orderBy')($filter('removeWith')($scope.gtFields,{exportField:false}),"columnOrder");
+        }
+
         var headers = {
             fieldSep: typeof options.fieldSep === 'undefined' ? ";":options.fieldSep,
             header: $filter('map')(exportFields,"name"), // get headers by column order
@@ -411,6 +435,7 @@ angular.module('generic.table').directive('genericTable', function() {
             addByteOrderMarker:typeof options.addBom === 'undefined',
             charset:typeof options.charset === 'undefined' ? 'utf-8':options.charset
         };
+
         CSV.stringify(data, headers).then(function(result){
 
             var blob;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "generic-table",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "devDependencies": {
     "bower": "1.6.2",
     "bower-art-resolver": "^2.0.1",

partial/examples/examples.html

@@ -13,7 +13,7 @@ <h4>Settings</h4>
                     enabled:true, // should column be enabled (required for filters to work)
                     sort:'false', // should column be sortable
                     sortOrder:0, // sort order of column, 0 will be sorted first
-                    columnOrder:0 // column order, starting from the left with zero,
+                    columnOrder:0, // column order, starting from the left with zero
                     export:false // should column be exported to CSV (OPTIONAL)
                 }]
             </code>
@@ -32,7 +32,7 @@ <h4>Field definitions</h4>
                     value: function(row,column){ return row[column]/2;} // custom function for column value if no data exists for column in data array (OPTIONAL),
                     click: function(){ return console.log('column clicked);} // click function for column (OPTIONAL),
                     expand: "&lt;my-directive&gt;&lt;/my-directive&gt;" // expand (open/close) row when clicked and add this as content (could be a directive or plain html) (OPTIONAL),
-                    export: function(row,column){ return '&lt;span&gt;'+row[column]+'&lt;/span&gt;';} // custom function for export presentation (OPTIONAL),
+                    export: function(row,column){ return parseFloat(row[column]);} // custom function for export presentation (OPTIONAL),
                     search: false // should field be searchable, true or false, true by default (OPTIONAL)
 
                 }]

partial/examples/examples.js

@@ -278,6 +278,14 @@ angular.module('generic.table').controller('DocumentationController',function($s
             }
         ],
         data:[{
+            "name":"fileName",
+            "description":"file name (omit file extension)",
+            "default":"export.csv"
+        },{
+            "name":"exportColumns",
+            "description":"columns to export ex. ['objectKey1','objectKey2'] overrules field settings",
+            "default":"exports all column except columns with field setting export:false"
+        },{
             "name":"fieldSep",
             "description":"field separator",
             "default":";"