PivotFieldSortSetting
Inheritance: java.lang.Object
public class PivotFieldSortSetting
Represents the setting for sorting pivot fields.
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getCell() | Sorts by the values in which row or column. |
| getClass() | |
| getFieldIndex() | Represents the index of the field sorted by |
| getLineTypeSortedBy() | The pivot line type sorted by. |
| getSortBy() | Represents the index of the field sorted by. |
| getSortType() | Represents the SortOrder. |
| hashCode() | |
| isSimpleSort() | Indicates whether a simple data sort operation will be applied. |
| isSortByLabels() | Indicates whether to sort the field by itself or data field. |
| notify() | |
| notifyAll() | |
| setFieldIndex(int value) | Represents the index of the field sorted by |
| setSimpleSort(boolean value) | Indicates whether a simple data sort operation will be applied. |
| setSortBy(int value) | Represents the index of the field sorted by. |
| setSortType(int value) | Represents the SortOrder. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getCell()
public String getCell()
Sorts by the values in which row or column.
Returns: java.lang.String
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getFieldIndex()
public int getFieldIndex()
Represents the index of the field sorted by. -1 means sorting the PivotField by the labels,others means sorting by the data field.
Remarks
NOTE: This property is now obsolete. Instead, please use PivotFieldSortSetting.SortBy property instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.
Returns: int
getLineTypeSortedBy()
public int getLineTypeSortedBy()
The pivot line type sorted by.
See PivotLineType.
Remarks
Only works when not sorting this field by labels.
Returns: int
getSortBy()
public int getSortBy()
Represents the index of the field sorted by. A value of -1 indicates sorting by the pivot item’s own values. When greater than or equal to zero, it represents the index of data field in the data region.
Returns: int
getSortType()
public int getSortType()
Represents the SortOrder.
See SortOrder.
Returns: int
hashCode()
public native int hashCode()
Returns: int
isSimpleSort()
public boolean isSimpleSort()
Indicates whether a simple data sort operation will be applied.
Remarks
The default value is true.
Returns: boolean
isSortByLabels()
public boolean isSortByLabels()
Indicates whether to sort the field by itself or data field.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setFieldIndex(int value)
public void setFieldIndex(int value)
Represents the index of the field sorted by. -1 means sorting the PivotField by the labels,others means sorting by the data field.
Remarks
NOTE: This property is now obsolete. Instead, please use PivotFieldSortSetting.SortBy property instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setSimpleSort(boolean value)
public void setSimpleSort(boolean value)
Indicates whether a simple data sort operation will be applied.
Remarks
The default value is true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSortBy(int value)
public void setSortBy(int value)
Represents the index of the field sorted by. A value of -1 indicates sorting by the pivot item’s own values. When greater than or equal to zero, it represents the index of data field in the data region.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setSortType(int value)
public void setSortType(int value)
Represents the SortOrder.
See SortOrder.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |
