Angular PivotGrid Summary Cell

The direction in which to search for the child cell. Can be "row" or "column".

fieldValue:

Number

The value of the child field whose summary cell should be returned.

Return Value:

The child cell.

Use this method for Total and Grand Total cells to get one of the cells, whose value is involved in the calculation of the total value. The image below demonstrates what cell will be returned by the following code.

JavaScript

var targetCell = sourceCell.child("row", 8); //August is the 8th month

This method is opposite to the parent(direction) method.

children(direction)

Gets all child cells in a specified direction.

Parameters:

direction:

The direction in which to search for child cells. Can be "row" or "column".

Return Value:

Array<Summary Cell>

The array of child cells.

This method is a general case of the child(direction, fieldValue) method. It returns all the cells whose values were involved in a calculation of the total value. Use it for Total and Grand Total cells.

field(area)

Gets a pivot grid field that corresponds to the summary cell.

Parameters:

area:

The area from which to get the field: "row", "column", or "data".

Return Value:

The pivot grid field.

If the header items are expanded and the cell belongs to multiple fields, the field of the deepest expanded header item is returned. The image below demonstrates what field will be returned by the following code.

JavaScript

var columnField = sourceCell.field("column");

grandTotal()

Gets the Grand Total of the entire pivot grid.

Return Value:

The Grand Total cell.

grandTotal(direction)

Gets a partial Grand Total cell of a row or column.

Parameters:

direction:

The direction in which to search for the grand total cell. Can be "row" or "column".

Return Value:

The partial Grand Total cell.

The image below demonstrates what cell will be returned by the following code.

JavaScript

var targetCell = sourceCell.grandTotal("row");

isPostProcessed(field)

Indicates whether the summaryDisplayMode or calculateSummaryValue post-processed the summary value.

Parameters:

field:

The index in the fields array, dataField, or caption of the field.

Return Value:

true if the summary value was post-processed; otherwise, false.

next(direction)

Gets the cell next to the current one in a specified direction.

Parameters:

direction:

The direction in which to search for the next cell. Can be "row" or "column".

Return Value:

The cell next to the current one.

This method is opposite of the prev(direction) method.

next(direction, allowCrossGroup)

Gets the cell next to current in a specified direction.

Parameters:

direction:

The direction in which to search for the next cell. Can be "row" or "column".

allowCrossGroup:

Specifies whether to allow this method to return cells from groups other than the current one.

Return Value:

The cell next to the current one.

This method is opposite of the prev(direction, allowCrossGroup) method.

parent(direction)

Gets the parent cell in a specified direction.

Parameters:

direction:

The direction in which to search for the parent cell. Can be "row" or "column".

Return Value:

The parent cell.

This method is opposite of the child(direction, fieldValue) method.

prev(direction)

Gets the cell prior to the current one in a specified direction.

Parameters:

direction:

The direction in which to search for the previous cell. Can be "row" or "column".

Return Value:

The cell before the current one.

This method is opposite of the next(direction) method.

prev(direction, allowCrossGroup)

Gets the cell previous to current in a specified direction.

Parameters:

direction:

The direction in which to search for the previous cell. Can be "row" or "column".

allowCrossGroup:

Specifies whether to allow this method to return cells from groups other than the current one.

Return Value:

The cell previous to the current one.

This method is opposite to the next(direction, allowCrossGroup) method.

slice(field, value)

Gets the cell located by the path of the source cell with one field value changed.

Parameters:

field:

The index in the fields array, dataField or caption of the field.

value:

Number

The field's value.

Return Value:

The target cell.

Use this method when you need to get a cell located by the similar path with one of its components changed. The image below demonstrates what cell will be returned by the following code.

JavaScript

var targetCell = sourceCell.slice("year", 1998);

value()

Gets the summary cell value.

Return Value: any

The summary cell value.

value(field)

Gets the value of any field associated with the summary cell.

Parameters:

field:

The index in the fields array, dataField, or caption of the field.

Return Value: any

The field value.

value(field, postProcessed)

Gets the value of any field associated with the summary cell.

Parameters:

field:

The index in the fields array, dataField, or caption of the field.

postProcessed:

Pass true to get a value post-processed by summaryDisplayMode or calculateSummaryValue; pass false to get the original summary value.

Return Value: any

The field value.

value(postProcessed)

Gets the summary cell value.

Parameters:

postProcessed: