What the difference between loadComplete and gridComplete events?

by

I think that this question is asked by many users of jqGrid. So it’s interesting to know the answer.

I personally prefer to use loadComplete. If you examine code from all my examples which I posted, you will find gridComplete only when the Original Poster posted it in the question and I would have modified a little code. I prefer to use loadComplete because of some advantages of loadComplete and disadvantages of gridComplete.

Here are advantages of loadComplete:

  • It’s the last callback which will be called if the whole grid body will be reloaded. For example after loading the page on the grid from the server. It’s important to understand, that if the user changes sorting of some column or sets filter or chooses another page of the grid; the grid body will be reloaded.
  • loadComplete has parameter data which represent full page of local data or full data loaded from the server.

On the other side gridComplete will be called (in the current version of jqGrid 4.4.4) from internal updatepager (see here), which will be called from delRowData (see here), addRowData (see here) and clearGridData (see here) methods; in addition to addXmlData (see here) and addJSONData (see here). It’s not what one mostly want.

Another disadvantage of gridComplete one can see if one examines the code of addXmlData (see here) and addJSONData (see here) from where updatepager is called and so gridComplete will be called. If one uses loadonce: true and the internal parameters data and _index will be filled with full data returned from the server. One can see when using loadonce: true; the callback gridComplete will be called after the first page of data are loaded from the sever. At this moment data and _index contains only the data for the page. On the other side loadComplete will be called later after all data returned from the server are processed and saved locally in data and _index.

If you load the data from the server and if you don’t use loadonce: true option, clearGridData, addRowData and delRowData then you could use gridComplete instead of loadComplete.

More Related Contents:

  1. jqgrid server side error message/validation handling
  2. jqgrid incorrect select drop down option values in edit box
  3. jqGrid does not render correctly in Chrome/Chrome Frame
  4. How to replace remapColums with remapColumnsByName in free jqgrid
  5. jqGrid add new column
  6. jQGrid, how to make a column editable in the add dialog but not during (inline) edits
  7. How to pass data to url from jqgrid row if hyperlink is clicked
  8. JQGRID – maintain check box selection state – page refresh / redirect / reload
  9. JavaScript data grid for millions of rows [closed]
  10. jqGrid: change background color of row based on row cell value by column name
  11. How do I implement custom sort to a specific column after jqgrid has been generated?
  12. Resize jqGrid when browser is resized?
  13. jqGrid GridUnload/ GridDestroy
  14. jQuery jqGrid Show message when an edit row is complete
  15. jQGrid Column Chooser Modal Overlay
  16. jqGrid access cell data while it is being edited
  17. JQGrid Custom Sorting
  18. How can I preserve the search filters in jqGrid on page reload?
  19. Is there a full working example for a jqGrid ColumnChooser? [closed]
  20. How to disable editing for some cells in row editing of JQGrid?
  21. Is JQGrid free?
  22. Customizing the Add/Edit Dialog in jqGrid
  23. Enabling Save button on JQ Grid with InlineEditing and CellEdit
  24. Using jqgrid with popover from angular ui bootstrap
  25. Sorting of jqGrid (v4.1.2) treegrid not working with Ajacency Model
  26. jqGrid multiselect “check all” in header: how to hide it?
  27. Possible to make jqGrid Search Box Stay on Page?
  28. How to show all rows in the jqGrid?
  29. Is variable rowheight a possibility in SlickGrid?
  30. JQGrid: Resize Grid Width After Column Resized

Leave a Comment