• Pivot Grid
  • Pivot Designer
  • Pivot Cell
  • Pivot Cell Formatting
  • Pivot Cells
  • Pivot Columns
  • Pivot Field
  • Pivot Filter Field
  • Pivot Item
  • Pivot Rows
  • Pivot Settings
  • Pivot Value Field
  • Pivot Point

Properties

source Object null

Gets or sets pivot source adapter used to supply data to the pivot grid.

Code example:

var column1Values =
[
   'a', 'b', 'c', 'd'
];
var column2Values =
[
   'e', 'f', 'g', 'h'
];
var column3Values =
[
   'i', 'j', 'k', 'l'
];
var column4Values =
[
   '2.25', '1.5', '3.0', '3.3', '4.5'
];
var myData = [];
for (var i = 0; i < 500; i++) {
   var row = {};
   row.column1 = column1Values[Math.floor(Math.random() * column1Values.length)];
   row.column2 = column2Values[Math.floor(Math.random() * column2Values.length)];
   row.column3 = column3Values[Math.floor(Math.random() * column3Values.length)];
   row.column4 = parseFloat(column4Values[Math.floor(Math.random() * column4Values.length)]);
   myData.push(row);
}
var source = {
   localdata: myData,
   datatype: 'array',
   datafields:
   [
      { name: 'column1', type: 'string' },
      { name: 'column2', type: 'string' },
      { name: 'column3', type: 'string' },
      { name: 'column4', type: 'number' }
   ]
};
var dataAdapter = new jqx.dataAdapter(source);
dataAdapter.dataBind();
// create a pivotDataSource from the dataAdapter
var pivotDataSource = new jqx.pivot(
   dataAdapter,
   {
      pivotValuesOnRows: false,
      rows: [{ dataField: 'column1' }, { dataField: 'column2'}],
      columns: [{ dataField: 'column3'}],
      values: [
         { dataField: 'column4', text: 'Sum of column4', 'function': 'sum'},
         { dataField: 'column4', text: 'Count of column4', 'function': 'count'}
      ]
   });
// create a pivot grid
$('#divPivotGrid').jqxPivotGrid({
   source: pivotDataSource
});
localization Object null

Gets or sets the localization object used to localize the text elements of the pivot grid.

Code example:

var customLocalizationObj = {
 sortascendingstring: 'Sortiere aufsteigend',
 sortdescendingstring: 'Sortiere absteigend',
 sortremovestring: 'Entferne Sortierung'
};
scrollBarsEnabled Boolean true

Gets or sets whether the scrollbars of the pivot grid are enabled or disabled.

Code example:

<jqx-pivot-grid style="height: 600px; width:850px;" scroll-bars-enabled="false" source="dataSource" tree-style-rows="true" auto-resize="false" multiple-selection-enabled="true"></jqx-pivot-grid>
selectionEnabled Boolean true

Gets or sets whether selection in the pivot grid is enabled or disabled.

Code example:

<jqx-pivot-grid style="height: 600px; width:850px;" source="dataSource" selection-enabled="true" tree-style-rows="true" auto-resize="false" multiple-selection-enabled="true"></jqx-pivot-grid>
multipleSelectionEnabled Boolean true

Gets or sets whether the multiple selection in the pivot grid is enabled or disabled.

Code example:

<jqx-pivot-grid style="height: 600px; width:850px;" source="dataSource" tree-style-rows="true" auto-resize="false" multiple-selection-enabled="true"></jqx-pivot-grid>
treeStyleRows Boolean true

Gets or sets the rows of the pivot grid are displayed as a tree structure or using classic OLAP style.

Code example:

<jqx-pivot-grid style="height: 600px; width:850px;" source="dataSource" tree-style-rows="true" auto-resize="false" multiple-selection-enabled="true"></jqx-pivot-grid>
autoResize Boolean false

Gets or sets if the size of pivot grid adjusts automatically to display the entire content.

Code example:

<jqx-pivot-grid style="height: 600px; width:850px;" source="dataSource" tree-style-rows="true" auto-resize="false" multiple-selection-enabled="true"></jqx-pivot-grid>

Events

pivotitemexpanding Event

This event is triggered when a pivot item is expanding. You may use the event's cancel flag to stop further processing.
pivotitemexpanded Event

This event is triggered after a pivot item is expanded.
pivotitemcollapsing Event

This event is triggered when a pivot item is collapsing. You may use the event's cancel flag to stop further processing.
pivotitemcollapsed Event

This event is triggered after a pivot item is collapsed.
sortchanging Event

This event is triggered the sorting is about to change. You may use the event's cancel flag to stop further processing.
sortchanged Event

This event is triggered after the sorting order has changed.
sortremoving Event

This event is triggered the sorting is about to be removed. You may use the event's cancel flag to stop further processing.
sortremoved Event

This event is triggered after the sorting has been sortremoved.
pivotitemselectionchanged Event

This event is triggered after the selection of a pivot item has changed.
pivotcellmousedown Event

This event is triggered on mousedown over a pivot grid cell. You may use the event's cancel flag to stop further processing.
pivotcellmouseup Event

This event is triggered on mouseup over a pivot grid cell. You may use the event's cancel flag to stop further processing.
pivotcellclick Event

This event is triggered on click over a pivot grid cell. You may use the event's cancel flag to stop further processing.
pivotcelldblclick Event

This event is triggered on double click over a pivot grid cell. You may use the event's cancel flag to stop further processing.
pivotitemmousedown Event

This event is triggered on mousedown over a pivot grid item. You may use the event's cancel flag to stop further processing.
pivotitemmouseup Event

This event is triggered on mouseup over a pivot grid item. You may use the event's cancel flag to stop further processing.
pivotitemclick Event

This event is triggered on click over a pivot grid item. You may use the event's cancel flag to stop further processing.
pivotitemdblclick Event

This event is triggered on double click over a pivot grid item. You may use the event's cancel flag to stop further processing.

Methods

getInstance Method

Returns the instance of the pivot grid component

Parameters
None

Return Value
Object
refresh Method

Refreshes the content of the pivot grid component

Parameters
None

Return Value
None
destroy Method

Destroys the pivot grid component instance

Parameters
None

Return Value
None
getPivotRows Method

Return the pivot rows of the pivot grid

Parameters
None

Return Value
Object
getPivotColumns Method

Return the pivot columns of the pivot grid

Parameters
None

Return Value
Object
getPivotCells Method

Return the pivot cells of the pivot grid

Parameters
None

Return Value
Object

Properties

type undefined pivotGrid

Gets or sets the type of the pivot designer - pivotGrid or pivotChart.
target Object

Gets or sets the instance of the widget component controlled by the pivot designer component.

Events

Methods

refresh Method
Parameters
None

Return Value
None

destroy Method
Parameters
None

Return Value
None

Properties

pivotRow Object

The row of the pivot cell.
pivotColumn Object

The column of the pivot cell.

Properties

prefix String

Optional text that appears at the start of the formatted string
sufix String

Optional text that appears at the end of the formatted string
decimalSeparator String .

Separator for the decimal point in the cell's value
thousandsSeparator String ,

Separator for the thousands in the cell's value
decimalPlaces Number 2

Number of decimal places for the cell's value
negativeWithBrackets Boolean false

Determines if negative numbers will be displayed in brackets or with a negative sign.

Properties

Methods

hitTest Method

Returns the pivot cell at the corresponding position if exists

Parameters
Name Type Description
point Object The coordinate of the hit test point.

Return Value
Object

clear Method

Clears all pivot cells

Parameters
None

Return Value
None

setCellValue Method

Sets the value of a pivot cell

Parameters
Name Type Description
pivotRow Object The row of the pivot cell.
pivotColumn Object The column of the pivot cell.
value Object The value of the pivot cell.

Return Value
None

getCellValue Method

Gets the value of a pivot cell

Parameters
Name Type Description
pivotRow Object The row of the pivot cell.
pivotColumn Object The column of the pivot cell.

Return Value
Object

drillThroughCell Method

Drills through a pivot cells and returns the respective source data records

Parameters
Name Type Description
pivotRow Object The row of the pivot cell.
pivotColumn Object The column of the pivot cell.

Return Value
Array

selectCell Method

Selects a pivot cell

Parameters
Name Type Description
pivotRow Object The row of the pivot cell.
pivotColumn Object The column of the pivot cell.

Return Value
None

unselectCell Method

Unselects a pivot cell

Parameters
Name Type Description
pivotRow Object The row of the pivot cell.
pivotColumn Object The column of the pivot cell.

Return Value
None

clearSelection Method

Clears the selection of all selected pivot cells

Parameters
None

Return Value
None

isCellSelected Method

Checks if a pivot cell is selected

Parameters
Name Type Description
pivotRow Object The row of the pivot cell.
pivotColumn Object The column of the pivot cell.

Return Value
Boolean

getSelectedCellsCount Method

Returns the number of selected cells

Parameters
None

Return Value
Number

getSelectedCells Method

Returns an array of all selected cells

Parameters
None

Return Value
Array

getNextCell Method

Returns the cell left, right, above or below a specific pivot cell

Parameters
Name Type Description
pivotCell Object The pivot cell
position String Position relative to the cell: 'left', 'right', 'top', 'bottom'

Return Value
Object

Properties

resizable Boolean true

Gets or sets if the collection of pivot items is resizable.
sortable Boolean true

Gets or sets if the collection of pivot items is sortable.
showExpandCollapseButtons Boolean true

Gets or sets if expand/collapse buttons are visible.
parentPivotGrid Object null

Returns a reference to the parent pivot grid instance.
items Array []

Returns an array of all child pivot items.
valueItems Array []

Returns an array of all child pivot value items.
isHidden Boolean false

Returns true if the pivot items collection is hidden.

Methods

show Method

Makes the pivot items collection visible

Parameters
None

Return Value
None

hide Method

Hides the pivot items collection

Parameters
None

Return Value
None

refresh Method

Refreshes the content of the pivot items collection

Parameters
None

Return Value
None

getHierarchyDepth Method

Returns the depth of the collection

Parameters
None

Return Value
Number

autoResize Method

Auto resizes the pivot items collection

Parameters
Name Type Description
autoResizeMode String

Return Value
None

getSortItem Method

Returns the sort item of the collection

Parameters
None

Return Value
Object

getSortOrder Method

Returns the sort order of the collection

Parameters
None

Return Value
Object

sortBy Method

Sorts the items collection

Parameters
Name Type Description
pivotItem Object
sortOrder String Sort order of the collection - 'asc' or 'desc'

Return Value
None

removeSort Method

Removes the sort order of the collection

Parameters
None

Return Value
None

selectItem Method

Selects a pivot item

Parameters
Name Type Description
pivotItem Object

Return Value
None

unselectItem Method

Clears the selection of a pivot item

Parameters
Name Type Description
pivotItem Object

Return Value
None

clearSelection Method

Clears the selection of all items in the collection

Parameters
None

Return Value
None

getSelectedItems Method

Returns all selected items in an array

Parameters
None

Return Value
Array

Properties

dataField String

The dataField in the data source used for this pivot field.
text String

The text which will appear in the pivot designer when using this field.
align String

Text alignment when the value of this field is displayed on the pivot rows or pivot columns.
className String

Name of style to use when displaying this field on the pivot rows or columns.
classNameSelected String

Name of style to use when displaying this field on the pivot rows or columns and column or row is selected.

Properties

dataField String

The dataField in the data source used for this pivot filter field.
text String

The text which will appear in the pivot designer when using this field.
filterFunction function

Implementation of the filtering function used to skip/filter records from the data source. The function should return true if the record should be filtered, otherwise false.

Properties

isExpanded Boolean false

Returns true if the pivot item is expanded.
isHidden Boolean false

Returns true if the pivot item is hidden.
isSelected Boolean false

Returns true if the pivot item is hidden.
parentItem Object null

Returns a reference to the parent item.
hierarchy Object null

Returns a reference to the parent rows or columns hierarchy.
parentPivotGrid Object null

Returns a reference to the parent pivot grid instance.
items Array []

Returns an array of all child pivot items.
valueItems Array []

Returns an array of all child pivot value items.

Methods

getWidth Method

Gets the width of the pivot item

Parameters
None

Return Value
Number

getDisplayWidth Method

Gets the displayed width of the pivot item

Parameters
None

Return Value
Number

autoResize Method

Auto resizes the pivot item

Parameters
None

Return Value
None

getHeight Method

Gets the height of the pivot item

Parameters
None

Return Value
Number

getDisplayHeight Method

Gets the displayed height of the pivot item

Parameters
None

Return Value
Number

setHeight Method

Sets the height of the pivot item

Parameters
Name Type Description
height Number

Return Value
None

expand Method

Expands the pivot item so all sub-items will be visible

Parameters
None

Return Value
None

collapse Method

Collapses the pivot item so all sub-items will be invisible

Parameters
None

Return Value
None

Properties

resizable Boolean true

Gets or sets if the collection of pivot items is resizable.
sortable Boolean true

Gets or sets if the collection of pivot items is sortable.
showExpandCollapseButtons Boolean true

Gets or sets if expand/collapse buttons are visible.
parentPivotGrid Object null

Returns a reference to the parent pivot grid instance.
items Array []

Returns an array of all child pivot items.
valueItems Array []

Returns an array of all child pivot value items.
isHidden Boolean false

Returns true if the pivot items collection is hidden.

Methods

show Method

Makes the pivot items collection visible

Parameters
None

Return Value
None

hide Method

Hides the pivot items collection

Parameters
None

Return Value
None

refresh Method

Refreshes the content of the pivot items collection

Parameters
None

Return Value
None

getHierarchyDepth Method

Returns the depth of the collection

Parameters
None

Return Value
None

autoResize Method

Auto resizes the pivot items collection

Parameters
Name Type Description
autoResizeMode String

Return Value
None

getSortItem Method

Returns the sort item of the collection

Parameters
None

Return Value
Object

getSortOrder Method

Returns the sort order of the collection

Parameters
None

Return Value
Object

sortBy Method

Sorts the items collection

Parameters
Name Type Description
pivotItem Object
sortOrder String Sort order of the collection - 'asc' or 'desc'

Return Value
None

removeSort Method

Removes the sort order of the collection

Parameters
None

Return Value
None

selectItem Method

Selects a pivot item

Parameters
Name Type Description
pivotItem Object

Return Value
None

unselectItem Method

Clears the selection of a pivot item

Parameters
Name Type Description
pivotItem Object

Return Value
None

clearSelection Method

Clears the selection of all items in the collection

Parameters
None

Return Value
None

getSelectedItems Method

Returns all selected items in an array

Parameters
None

Return Value
Array

Properties

pivotValuesOnRows Boolean false

Determines whether the pivot values will be displayed on rows or columns.
rows Boolean []

A list of data fields which will be used to build the pivot rows.
columns Boolean []

A list of data fields which will be used to build the pivot columns.
values Boolean []

A list of data fields which will be used to build the pivot values.
filters Boolean []

A list of filters to apply on the source records while building the pivot table.

Properties

dataField String

The dataField in the data source used for this pivot field.
function String|function

The data aggregation function to use when calculating the cells values. You can either use the name of one of the built in functions like 'sum', 'count', 'min', 'max', 'product', 'average' or provide the implementation of your own function.
text String

The text which will appear in the pivot designer when using this field.
align String

Text alignment when the value of this field is displayed on the pivot rows or pivot columns.
className String

Name of style to use when displaying this field on the pivot rows or columns.
classNameSelected String

Name of style to use when displaying this field on the pivot rows or columns and column or row is selected.
cellsClassName String

Name of style to use when displaying the cells of this pivot value field.
cellsClassNameSelected String

Name of style to use when displaying this cells this pivot value field when the cells are selected.
formatSettings Object {}

Properties

x Number

X coordinate
y Number

Y coordinate