This is an old revision of the document!


Methods

jqPivot

jqPivotGrid has the following calling convention

jQuery("#grid").jqGrid('jqPivot', data, pivotoptions, gridoptions, ajaxoptions);

Where

#grid is the id of the table element as used in the jqGrid.

data

- can be a string or array of data to be passed to the pivot. In case the parameter is a string a ajax request is made. The data that should be returned should have a name value pair like this:

{"rows":[
{"CategoryName":"Beverages","ProductName":"Steeleye Stout","Country":"UK","Price":"1008.0000","Quantity":"65"},
{"CategoryName":"Beverages","ProductName":"Laughing Lumberjack Lager","Country":"USA","Price":"140.0000","Quantity":"10"},
{"CategoryName":"Beverages","ProductName":"Lakkalik","Country":"USA","Price":"2160.0000","Quantity":"120"},
...
]}

The “rows” property name can be configured from the ajaxoptions - see below.

In case a array of data is passed the rows property should be omitted and the data should look like this

[
...
{"CategoryName":"Beverages","ProductName":"Steeleye Stout","Country":"UK","Price":"1008.0000","Quantity":"65"},
{"CategoryName":"Beverages","ProductName":"Laughing Lumberjack Lager","Country":"USA","Price":"140.0000","Quantity":"10"},
{"CategoryName":"Beverages","ProductName":"Lakkalik","Country":"USA","Price":"2160.0000","Quantity":"120"},
...
]

The method expect all the needed data to be passed to the pivot. This means that no other special handling on server
should be done. All other next transformations are done at client side and the jqPivotGrid build its new data to be displayed.

pivotoptions

This is a object with following properties:

PropertyTypeDescriptionDefault
aggregatesarray of objectsDefines the aggregates records and builds the pivot. The array should have at minimum one set of object and should always be defined. If no aggregates is set, the pivot will not be build. All properties of colModel can be set. For all available properties see belowNon empty
colTotalsbooleanIf set to true additional footer row is build. All pivot fields are summarized. Note that only summary function is aplied.false
frozenStaticColsbooleanIf set to true all fields defined in xDimension (see below) are set as frozen so that when scroll horizontally theses fields are always visible.false
groupSummarybooleanWith this option we summarizes the groups and subgroups if they are available. If set to false no summations are vailable.true
groupSummaryPosstring Defines where the summary row should appear - at top of the group or at bottom. Available options are 'header' (top row) or 'footer' (bottom row)header
rowTotalsbooleanIf set to true additional column is build ed which summarizes all column values of the row.false
rowTotalsTextstringSet the column label of the column if rowTotals is set to trueTotal
xDimension array of objects
You could leave a comment if you were logged in.

QR Code
QR Code wiki:pivotsettings (generated for current page)