Typically, using the userData feature in jqGrid is straightforward. It allows you to include additional data that will be stored along with the jqGrid data. When jqGrid processes data from the server, it specifically searches for the property userdata (not userData) and stores it in the internal parameter userData.
{ "total":25,
"page":1
"records":107,
"userdata": {"foo": "bar"},
"rows": [...] }
It's important to note that the default input property should be named userdata, not userData as currently shown. You have the option to change the name by specifying
jsonReader: {userdata: "userData"}
or
jsonReader: {userdata: "myData"} if you prefer
userData or
myData for your
additional data.
One common use of userData is for displaying a footer in the jqGrid. This data can also be utilized for various other purposes. In another scenario, the use of userData is illustrated for programmatically selecting rows immediately after loading data from the server.
If you set the parameter loadonce:true, handling userData becomes slightly more complex because the data from the userData parameter will be cleared after the initial load, necessitating storage in an external object.
You can access the userData by using
jQuery("#grid").getGridParam('userData')
only once the data has been loaded. It's recommended to do this within the
loadComplete event handler or later. Additionally, inside the
loadComplete event handler, you have access to
all data sent from the server via the
data parameter, allowing you to read any additional data and save it elsewhere.