¿Cómo se lee userData en jqgrid?

Question

Necesito pasar userData a jqgrid, pero no puedo encontrar ningún ejemplo de cómo hacerlo. Aquí está mi intento:

enviado desde el servidor:

{ total: 25, 
    page: currentpage, 
    userData: {foo: 'bar'}, 
    rows: myRows } 

y en jqGrid:

var data = jQuery("#grid").getGridParam('userData'); 

¿Cómo puedo enviar userData y leerlo desde jqGrid?

EDITAR: Sé que se está enviando userData, porque puedo verlo en Fiddler. Creo que estoy atascado en cómo leerlo en el lado del cliente.

Answer 1

En general, el uso de userData es bastante simple. jqGrid le brinda soporte para enviar desde el servidor datos adicionales de que se guardarán junto con los datos de jqGrid. Entonces, si jqGrid analiza los datos devueltos por el servidor, simplemente busca userdata (no para userData !!!) y se guarda en el parámetro interno userData.

{ "total":25, 
    "page":1 
    "records":107, 
    "userdata": {"foo": "bar"}, 
    "rows": [...] } 

CUIDADO: la propiedad predeterminada en los datos de entrada debe ser userdata y NOuserData como que tiene actualmente. Puede sobrescribir el nombre predeterminado de la propiedad de entrada jsonReader: {userdata: "userData"} o jsonReader: {userdata: "myData"} si usa userData o myData como nombre de propiedad con su additional data.

Uno del uso estándar de userData es para displaying of the footer en el jqGrid. Puede usar los datos para cualquier otra propuesta. En another answer se muestra cómo usar userData para seleccionar algunas filas/filas directamente después de cargar los datos del servidor.

Si utiliza loadonce:true parámetro, el uso de userData será un poco más complicado, porque después de la primera carga se eliminarán los datos del parámetro userData, así que hay que guardar allí en el objeto externo.

De causa que puede acceder al userData con respecto a jQuery("#grid").getGridParam('userData') solo después de cargar los datos. Por lo tanto, debe hacer esto dentro del identificador de evento loadComplete o posterior. Por cierto, dentro del identificador de evento loadComplete puede acceder a todos los datos que se le envían desde el servidor a través del parámetro data del evento loadComplete. Para que pueda leer cualquier otro dato adicional y guardarlo en alguna parte.

Answer 2

jqGrid acepta de manera predeterminada JSON en este formato.

{"rows": 
    [{"foo":"bar"}] 
} 

y configurar las opciones jqGrid que haría algo como esto:

$("#cashflow-sheet").jqGrid({ 
    url:'bbc-json.html', 
    datatype: "json", 
     ...