Skip to content

Commit

Permalink
refactor(NgTableParams): renamed data field on settings to dataset
Browse files Browse the repository at this point in the history
Rename necessary to reduce confusion between the data field on an the `NgTableParams` instance
and the data field on the `NgTableParams.settings()` object. The former being the current page
worth of data being presented to the user and the later being the data array from which pages
are selected from.

BREAKING CHANGE:

* `NgTableParams.settings().data` renamed to `NgTableParams.settings().dataset`

Previously:

```js
var tp = new NgTableParams({}, {data: yourArray });
```

Now:

```js
var tp = new NgTableParams({}, {dataset: yourArray });
```
  • Loading branch information
ccrowhurstram committed Sep 13, 2015
1 parent e7ab764 commit 380ba21
Show file tree
Hide file tree
Showing 13 changed files with 97 additions and 100 deletions.
2 changes: 1 addition & 1 deletion examples/demo12-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h1>Table with grouping</h1>
groupOptions: {
isExpanded: false
},
data: data
dataset: data
});
})
</script>
Expand Down
2 changes: 1 addition & 1 deletion examples/demo12.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ <h1>Table with grouping</h1>
groupOptions: {
isExpanded: false
},
data: data
dataset: data
});
})
</script>
Expand Down
2 changes: 1 addition & 1 deletion examples/demo13.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ <h1>Table with grouping with callback</h1>
name: 'asc'
}
}, {
data: data
dataset: data
});
})
</script>
Expand Down
6 changes: 3 additions & 3 deletions examples/demo14.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,15 @@ <h2>Dataset: <select ng-model="dataset" ng-options="ds for ds in datasets"></sel
var self = this;
self.data1 = [{"name":"Lee","surname":"Gilmore","age":38},{"name":"Murphy","surname":"Cabrera","age":71},{"name":"Montana","surname":"Austin","age":68},{"name":"Phoebe","surname":"Wells","age":8},{"name":"Abra","surname":"Gay","age":32},{"name":"Brynne","surname":"Conley","age":69},{"name":"Baxter","surname":"Murphy","age":77},{"name":"Hilda","surname":"Nelson","age":39},{"name":"Leila","surname":"Perkins","age":96},{"name":"Micah","surname":"Herring","age":4},{"name":"Jeremy","surname":"Sosa","age":97},{"name":"Orson","surname":"Moore","age":99}];

self.data2 = {"name":"Vance","surname":"Santana","age":93},{"name":"Jenna","surname":"Castaneda","age":82},{"name":"Tanisha","surname":"Alexander","age":97},{"name":"Guy","surname":"Salazar","age":3},{"name":"Karina","surname":"Buchanan","age":62},{"name":"Josephine","surname":"Clayton","age":53},{"name":"Armand","surname":"Lucas","age":69},{"name":"Seth","surname":"Herring","age":5},{"name":"Clarke","surname":"Horton","age":11},{"name":"Mallory","surname":"Armstrong","age":60},{"name":"Ryan","surname":"Gay","age":12},{"name":"Pamela","surname":"Greer","age":41},{"name":"Christen","surname":"White","age":88},{"name":"Malik","surname":"Ray","age":79},{"name":"Steel","surname":"Foley","age":14},{"name":"Louis","surname":"Diaz","age":12};
self.data2 = [{"name":"Vance","surname":"Santana","age":93},{"name":"Jenna","surname":"Castaneda","age":82},{"name":"Tanisha","surname":"Alexander","age":97},{"name":"Guy","surname":"Salazar","age":3},{"name":"Karina","surname":"Buchanan","age":62},{"name":"Josephine","surname":"Clayton","age":53},{"name":"Armand","surname":"Lucas","age":69},{"name":"Seth","surname":"Herring","age":5},{"name":"Clarke","surname":"Horton","age":11},{"name":"Mallory","surname":"Armstrong","age":60},{"name":"Ryan","surname":"Gay","age":12},{"name":"Pamela","surname":"Greer","age":41},{"name":"Christen","surname":"White","age":88},{"name":"Malik","surname":"Ray","age":79},{"name":"Steel","surname":"Foley","age":14},{"name":"Louis","surname":"Diaz","age":12}];

$scope.nameFilter = {
name: { id: 'text', placeholder: 'First Name' },
surname: { id: 'text', placeholder: 'Surname' }
};

$scope.$watch("dataset", function () {
$scope.tableParams.settings({ data: self["data" + $scope.dataset]});
$scope.tableParams.settings({ dataset: self["data" + $scope.dataset]});
});

$scope.tableParams = new NgTableParams({
Expand All @@ -67,7 +67,7 @@ <h2>Dataset: <select ng-model="dataset" ng-options="ds for ds in datasets"></sel
name: 'asc' // initial sorting,
}
}, {
data: self["data" + $scope.dataset],
dataset: self["data" + $scope.dataset],
filterOptions: { filterLayout: 'horizontal' }
});
})
Expand Down
2 changes: 1 addition & 1 deletion examples/demo27.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ <h1>Table with data passed at init</h1>
count: 10 // count per page
}, {
showFilter: true,
data: data
dataset: data
});
})
</script>
Expand Down
2 changes: 1 addition & 1 deletion examples/demo28.html
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ <h1>Custom external pagination element</h1>
page: 1, // show first page
count: 3 // count per page
}, {
data: data
dataset: data
});
})
</script>
Expand Down
2 changes: 1 addition & 1 deletion examples/demo4.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ <h1>Table with filters</h1>
name: 'M' // initial filter
}
}, {
data: data
dataset: data
});
})
</script>
Expand Down
10 changes: 5 additions & 5 deletions examples/js/angular.min.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions examples/js/jquery-1.9.1.min.js

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions src/scripts/ngTableParams.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
defaultFilterOptions = {
filterComparator: undefined, // look for a substring match in case insensitive way
filterDelay: 500,
filterDelayThreshold: 10000, // size of data array that will trigger the filterDelay being applied
filterDelayThreshold: 10000, // size of dataset array that will trigger the filterDelay being applied
filterFilterName: undefined, // when defined overrides ngTableDefaultGetDataProvider.filterFilterName
filterFn: undefined, // when defined overrides the filter function that ngTableDefaultGetData uses
filterLayout: 'stack' // alternative: 'horizontal'
Expand Down Expand Up @@ -138,9 +138,9 @@
newSettings.groupOptions = angular.extend({}, settings.groupOptions, newSettings.groupOptions);
}

if (angular.isArray(newSettings.data)) {
//auto-set the total from passed in data
newSettings.total = newSettings.data.length;
if (angular.isArray(newSettings.dataset)) {
//auto-set the total from passed in dataset
newSettings.total = newSettings.dataset.length;
}

// todo: remove the backwards compatibility shim and the following two if blocks
Expand All @@ -153,21 +153,21 @@
newSettings.getGroupsFnAdaptor = ngTableGetDataBcShim;
}

var originalDataset = settings.data;
var originalDataset = settings.dataset;
settings = angular.extend(settings, newSettings);

if (angular.isArray(newSettings.data)) {
if (angular.isArray(newSettings.dataset)) {
optimizeFilterDelay();
}

// note: using != as want null and undefined to be treated the same
var hasDatasetChanged = newSettings.hasOwnProperty('data') && (newSettings.data != originalDataset);
var hasDatasetChanged = newSettings.hasOwnProperty('dataset') && (newSettings.dataset != originalDataset);
if (hasDatasetChanged) {
if (isCommittedDataset){
this.page(1); // reset page as a new dataset has been supplied
}
isCommittedDataset = false;
ngTableEventsChannel.publishDatasetChanged(this, newSettings.data, originalDataset);
ngTableEventsChannel.publishDatasetChanged(this, newSettings.dataset, originalDataset);
}
log('ngTable: set settings', settings);
return this;
Expand Down Expand Up @@ -655,7 +655,7 @@
* @param {Object} params the `NgTableParams` requesting data
*/
function getData(params) {
return ngTableDefaultGetData(params.settings().data, params);
return ngTableDefaultGetData(params.settings().dataset, params);
}

/**
Expand Down Expand Up @@ -740,7 +740,7 @@
// todo: remove $scope after acceptable depreciation period as no longer required
$scope: null, // set by ngTable controller
$loading: false,
data: null, //allows data to be set when table is initialized
dataset: null, //allows data to be set when table is initialized
total: 0,
defaultSort: 'desc',
filterOptions: angular.copy(defaultFilterOptions),
Expand Down
11 changes: 4 additions & 7 deletions test/tableDynamicSpec.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
describe('ng-table-dynamic', function() {
var data = [
var dataset = [
{ id: 1, name: "Moroni", age: 50, money: -10 },
{ id: 2, name: "Tiancum", age: 43, money: 120 },
{ id: 3, name: "Jacob", age: 27, money: 5.5 },
Expand Down Expand Up @@ -148,8 +148,7 @@ describe('ng-table-dynamic', function() {
page: 1, // show first page
count: 10 // count per page
}, {
total: data.length,
data: data
dataset: dataset
});
scope.$digest();

Expand All @@ -173,8 +172,7 @@ describe('ng-table-dynamic', function() {
page: 1, // show first page
count: 10 // count per page
}, {
total: data.length,
data: data
dataset: dataset
});
scope.$digest();

Expand Down Expand Up @@ -306,8 +304,7 @@ describe('ng-table-dynamic', function() {
page: 1, // show first page
count: 10 // count per page
}, {
total: data.length,
data: data
dataset: dataset
});

$compile(elm)(scope);
Expand Down

0 comments on commit 380ba21

Please sign in to comment.