com.aspose.gridweb

Class GridPivotField

java.lang.Object

com.aspose.gridweb.GridPivotField

public class GridPivotField
extends java.lang.Object

Represents a field in a PivotTable report.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDisplayName() Represents the PivotField display name.
int	getFunction() Represents the function used to summarize the PivotTable data field.
int	getPosition() Represents the PivotField index in the PivotFields.
void	hideItem(int index, boolean isHidden) Sets whether the specific PivotItem in a data field is hidden.
void	hideItemByName(java.lang.String name, boolean isHidden) Sets whether the specific PivotItem in a data field is hidden.
void	hideItemByValue(java.lang.String value, boolean isHidden) Sets whether the specific PivotItem in a data field is hidden.
boolean	isAscendSort() Indicates whether the specified PivotTable field is autosorted ascending.
boolean	isAutoSort() Indicates whether the specified PivotTable field is automatically sorted.
void	setAscendSort(boolean value) Indicates whether the specified PivotTable field is autosorted ascending.
void	setAutoSort(boolean value) Indicates whether the specified PivotTable field is automatically sorted.
void	setDisplayName(java.lang.String value) Represents the PivotField display name.
void	setFunction(int value) Represents the function used to summarize the PivotTable data field.
void	setPosition(int value) Represents the PivotField index in the PivotFields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFunction

public int getFunction()

Represents the function used to summarize the PivotTable data field.

See GridPivotFieldFunction.

setFunction

public void setFunction(int value)

Represents the function used to summarize the PivotTable data field.

See GridPivotFieldFunction.

isAutoSort

public boolean isAutoSort()

Indicates whether the specified PivotTable field is automatically sorted.

setAutoSort

public void setAutoSort(boolean value)

Indicates whether the specified PivotTable field is automatically sorted.

isAscendSort

public boolean isAscendSort()

Indicates whether the specified PivotTable field is autosorted ascending.

setAscendSort

public void setAscendSort(boolean value)

Indicates whether the specified PivotTable field is autosorted ascending.

hideItem

public void hideItem(int index,
            boolean isHidden)

Sets whether the specific PivotItem in a data field is hidden.

Parameters:

index - the index of the pivotItem in the pivotField.

isHidden - whether the specific PivotItem is hidden

hideItemByValue

public void hideItemByValue(java.lang.String value,
                   boolean isHidden)

Sets whether the specific PivotItem in a data field is hidden.

Parameters:

value - the value of the pivotItem in the pivotField.

isHidden - whether the specific PivotItem is hidden

hideItemByName

public void hideItemByName(java.lang.String name,
                  boolean isHidden)

Sets whether the specific PivotItem in a data field is hidden.

Parameters:

name - the name of the pivotItem in the pivotField.

isHidden - whether the specific PivotItem is hidden

getDisplayName

public java.lang.String getDisplayName()

Represents the PivotField display name.

setDisplayName

public void setDisplayName(java.lang.String value)

Represents the PivotField display name.

getPosition

public int getPosition()

Represents the PivotField index in the PivotFields.

setPosition

public void setPosition(int value)

Represents the PivotField index in the PivotFields.