angular-ui/ui-grid

gridSaveState

Open

#5,250 opened on Mar 23, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (5,395 stars) (2,496 forks)batch import
help wanted

Description

If there are filters applied to columns the result of gridApi.saveState.save() strips the condition out of the objects in the column.filters array. When attempting to reapply the filters, it doesn't work because of this missing property.

To reproduce:

  1. Generate a grid
  2. Apply a filter to a column (e.g. gridApi.grid.columns[2].filters = [{term: 'foo', condition: 8}]
  3. Execute gridApi.grid.refresh();
  4. Save the results of saveState.save() into var (e.g. var bar = gridApi.saveState.save())
  5. Examine bar.columns[2].filters === [{term: 'foo'}] i.e condition property is missing.

In Plnkr http://plnkr.co/edit/jHHMdZSez3Vxui4VWbP4?p=preview:

  1. Enter search term in input field
  2. Examine $scope.gridApi.grid.columns[4].filters after $scope.search has been executed
  3. Examine the filter for the colummn in $scope.state.column after $scope.saveState() has been executed
  4. Note that condition property is missing from the filter applied to the column in $scope.state

Contributor guide

Tech stack
javascriptangular
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
AngularJS basicsui grid usageJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the saveState.js file in the ui grid source, specifically the serialization of column filters. The issue shows that the 'condition' property is stripped when saving state. Examine the code that converts filter objects and ensure the condition property is included. Use the provided Plnkr reproduction to verify the bug and test the fix.