Skip to content

Fix #2049(columnDef): don't change user-provided column def #2056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 11, 2014
Merged

Fix #2049(columnDef): don't change user-provided column def #2056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions misc/tutorial/113_adding_and_removing_columns.ngdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,33 +12,40 @@ that default.
<file name="app.js">
var app = angular.module('app', ['ngAnimate', 'ui.grid']);

app.controller('MainCtrl', ['$scope', '$http', function ($scope, $http) {
app.controller('MainCtrl', ['$scope', '$http', 'uiGridConstants', function ($scope, $http, uiGridConstants) {
$scope.columns = [{ field: 'name' }, { field: 'gender' }];
$scope.gridOptions = {
enableSorting: true,
columnDefs: $scope.columns
columnDefs: $scope.columns,
onRegisterApi: function(gridApi) {
$scope.gridApi = gridApi;
}
};

$scope.remove = function() {
$scope.columns.splice($scope.columns.length-1, 1);
$scope.columns.splice($scope.columns.length-1, 1);
}

$scope.add = function() {
$scope.columns.push({ field: 'company', enableSorting: false });
$scope.columns.push({ field: 'company', enableSorting: false });
}

$scope.splice = function() {
$scope.columns.splice(1, 0, { field: 'company', enableSorting: false });
$scope.columns.splice(1, 0, { field: 'company', enableSorting: false });
}

$scope.unsplice = function() {
$scope.columns.splice(1, 1);
$scope.columns.splice(1, 1);
}

$scope.toggleVisible = function() {
$scope.columns[0].visible = !($scope.columns[0].visible || $scope.columns[0].visible === undefined);
$scope.gridApi.core.notifyDataChange($scope.gridApi.grid, uiGridConstants.dataChange.COLUMN);
}

$http.get('/data/100.json')
.success(function(data) {
$scope.gridOptions.data = data;
console.log(data)
});
}]);
</file>
Expand All @@ -53,6 +60,7 @@ that default.
<button id="button_remove" class="btn" ng-click="remove()">Remove Last</button>
<button id="button_splice" class="btn" ng-click="splice()">Splice</button>
<button id="button_unsplice" class="btn" ng-click="unsplice()">Remove Middle</button>
<button id="button_toggle_visible" class="btn" ng-click="toggleVisible()">Toggle Visible</button>
<div id="grid1" ui-grid="gridOptions" class="grid"></div>
</div>
</file>
Expand Down Expand Up @@ -89,7 +97,17 @@ that default.
element(by.id('button_unsplice')).click();
gridTestUtils.expectHeaderColumnCount( 'grid1', 2 );
gridTestUtils.expectHeaderCellValueMatch( 'grid1', 1, 'Gender' );
});
});

it('toggle column 0 visible should make column appear and disappear', function () {
element(by.id('button_toggle_visible')).click();
gridTestUtils.expectHeaderColumnCount( 'grid1', 1 );
gridTestUtils.expectHeaderCellValueMatch( 'grid1', 0, 'Gender' );

element(by.id('button_toggle_visible')).click();
gridTestUtils.expectHeaderColumnCount( 'grid1', 2 );
gridTestUtils.expectHeaderCellValueMatch( 'grid1', 0, 'Name' );
});
});
</file>
</example>
6 changes: 3 additions & 3 deletions src/features/importer/test/importer.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ describe('ui.grid.importer uiGridImporterService', function () {

grid.modifyRows($scope.data);
angular.forEach( grid.dataChangeCallbacks, function( callback, uid ) {
callback( grid );
callback.callback( grid );
});

expect( $scope.data.length ).toEqual(4, 'data should now have 4 rows');
Expand All @@ -194,7 +194,7 @@ describe('ui.grid.importer uiGridImporterService', function () {

grid.modifyRows($scope.data);
angular.forEach( grid.dataChangeCallbacks, function( callback, uid ) {
callback( grid );
callback.callback( grid );
});

expect( $scope.data.length ).toEqual(4, 'data should now have 4 rows');
Expand Down Expand Up @@ -263,7 +263,7 @@ describe('ui.grid.importer uiGridImporterService', function () {

grid.modifyRows($scope.data);
angular.forEach( grid.dataChangeCallbacks, function( callback, uid ) {
callback( grid );
callback.callback( grid );
});

expect( $scope.data.length ).toEqual(5, 'data should now have 5 rows');
Expand Down
2 changes: 0 additions & 2 deletions src/js/core/directives/ui-grid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@
self.grid.preCompileCellTemplates();

self.grid.callDataChangeCallbacks(uiGridConstants.dataChange.COLUMN);

self.grid.refresh();
});
}
}
Expand Down
17 changes: 16 additions & 1 deletion src/js/core/factories/Grid.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,8 @@ angular.module('ui.grid')
*
*/
self.api.registerMethod( 'core', 'notifyDataChange', this.notifyDataChange );

self.registerDataChangeCallback( self.columnRefreshCallback, [uiGridConstants.dataChange.COLUMN]);
};

/**
Expand Down Expand Up @@ -335,7 +337,7 @@ angular.module('ui.grid')
* @param {number} type the type of event that occurred - one of the
* uiGridConstants.dataChange values (ALL, ROW, EDIT, COLUMN)
*/
Grid.prototype.callDataChangeCallbacks = function callDataChangeCallbacks(type) {
Grid.prototype.callDataChangeCallbacks = function callDataChangeCallbacks(type, options) {
angular.forEach( this.dataChangeCallbacks, function( callback, uid ){
if ( callback.types.indexOf( uiGridConstants.dataChange.ALL ) !== -1 ||
callback.types.indexOf( type ) !== -1 ||
Expand Down Expand Up @@ -367,6 +369,19 @@ angular.module('ui.grid')
gridUtil.logError("Notified of a data change, but the type was not recognised, so no action taken, type was: " + type);
}
};


/**
* @ngdoc function
* @name columnRefreshCallback
* @methodOf ui.grid.class:Grid
* @description refreshes the grid when a column refresh
* is notified, which triggers handling of the visible flag
* @param {string} name column name
*/
Grid.prototype.columnRefreshCallback = function columnRefreshCallback( grid ){
grid.refresh();
};


/**
Expand Down
13 changes: 8 additions & 5 deletions src/js/core/services/gridClassFactory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,9 @@
*
*/
if (!colDef.headerCellTemplate) {
colDef.headerCellTemplate = 'ui-grid/uiGridHeaderCell';
col.headerCellTemplate = 'ui-grid/uiGridHeaderCell';
} else {
col.headerCellTemplate = colDef.headerCellTemplate;
}

/**
Expand All @@ -123,11 +125,12 @@
*
*/
if (!colDef.cellTemplate) {
colDef.cellTemplate = 'ui-grid/uiGridCell';
col.cellTemplatePromise = gridUtil.getTemplate(colDef.cellTemplate);
col.cellTemplate = 'ui-grid/uiGridCell';
} else {
col.cellTemplate = colDef.cellTemplate;
}

col.cellTemplatePromise = gridUtil.getTemplate(colDef.cellTemplate);
col.cellTemplatePromise = gridUtil.getTemplate(col.cellTemplate);
templateGetPromises.push(col.cellTemplatePromise
.then(
function (template) {
Expand All @@ -138,7 +141,7 @@
})
);

templateGetPromises.push(gridUtil.getTemplate(colDef.headerCellTemplate)
templateGetPromises.push(gridUtil.getTemplate(col.headerCellTemplate)
.then(
function (template) {
col.headerCellTemplate = template.replace(uiGridConstants.CUSTOM_FILTERS, col.headerCellFilter ? "|" + col.headerCellFilter : "");
Expand Down
2 changes: 1 addition & 1 deletion test/unit/core/factories/Grid.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ describe('Grid factory', function () {
expect( grid.dataChangeCallbacks[uid]).toEqual( { callback: jasmine.any(Function), types: [ uiGridConstants.dataChange.ALL ] } );

grid.deregisterDataChangeCallback( uid );
expect( grid.dataChangeCallbacks ).toEqual( {} );
expect( grid.dataChangeCallbacks[uid] ).toEqual( undefined );
});

describe( 'mix of callbacks being called', function() {
Expand Down
16 changes: 8 additions & 8 deletions test/unit/core/services/GridClassFactory.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ describe('gridClassFactory', function() {

gridClassFactory.defaultColumnBuilder( testSetup.colDef, testSetup.col, testSetup.gridOptions );

expect(testSetup.colDef.headerCellTemplate).toEqual('ui-grid/uiGridHeaderCell');
expect(testSetup.colDef.cellTemplate).toEqual('ui-grid/uiGridCell');
expect(testSetup.col.headerCellTemplate).toEqual('ui-grid/uiGridHeaderCell');
expect(testSetup.col.cellTemplate).toEqual('ui-grid/uiGridCell');

testSetup.$rootScope.$digest();

Expand All @@ -53,8 +53,8 @@ describe('gridClassFactory', function() {

gridClassFactory.defaultColumnBuilder( testSetup.colDef, testSetup.col, testSetup.gridOptions );

expect(testSetup.colDef.headerCellTemplate).toEqual('ui-grid/uiGridHeaderCell');
expect(testSetup.colDef.cellTemplate).toEqual('ui-grid/uiGridCell');
expect(testSetup.col.headerCellTemplate).toEqual('ui-grid/uiGridHeaderCell');
expect(testSetup.col.cellTemplate).toEqual('ui-grid/uiGridCell');

testSetup.$rootScope.$digest();

Expand All @@ -71,8 +71,8 @@ describe('gridClassFactory', function() {

gridClassFactory.defaultColumnBuilder( testSetup.colDef, testSetup.col, testSetup.gridOptions );

expect(testSetup.colDef.headerCellTemplate).toEqual('ui-grid/uiGridHeaderCell');
expect(testSetup.colDef.cellTemplate).toEqual('ui-grid/uiGridCell');
expect(testSetup.col.headerCellTemplate).toEqual('ui-grid/uiGridHeaderCell');
expect(testSetup.col.cellTemplate).toEqual('ui-grid/uiGridCell');

testSetup.$rootScope.$digest();

Expand All @@ -89,8 +89,8 @@ describe('gridClassFactory', function() {

gridClassFactory.defaultColumnBuilder( testSetup.colDef, testSetup.col, testSetup.gridOptions );

expect(testSetup.colDef.headerCellTemplate).toEqual('ui-grid/uiGridHeaderCell');
expect(testSetup.colDef.cellTemplate).toEqual('ui-grid/uiGridCell');
expect(testSetup.col.headerCellTemplate).toEqual('ui-grid/uiGridHeaderCell');
expect(testSetup.col.cellTemplate).toEqual('ui-grid/uiGridCell');

testSetup.$rootScope.$digest();

Expand Down