PivotFieldSortSetting

• Open Markdown

• ---

• Open in ChatGPT
• Open in Claude
• Open in Perplexity

PivotFieldSortSetting class

Represents the setting for sorting pivot fields.

class PivotFieldSortSetting;

Properties

Property	Type	Description
sortType	SortOrder	Represents the SortOrder.
isSortByLabels	boolean	Readonly. Indicates whether to sort the field by itself or data field.
fieldIndex	number	Represents the index of the field sorted by. -1 means sorting the PivotField by the labels,others means sorting by the data field.
sortBy	number	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.
lineTypeSortedBy	PivotLineType	Readonly. The pivot line type sorted by.
isSimpleSort	boolean	Indicates whether a simple data sort operation will be applied.
cell	string	Readonly. Sorts by the values in which row or column.

sortType

Represents the SortOrder.

sortType : SortOrder;

isSortByLabels

Readonly. Indicates whether to sort the field by itself or data field.

isSortByLabels : boolean;

fieldIndex

Represents the index of the field sorted by. -1 means sorting the PivotField by the labels,others means sorting by the data field.

fieldIndex : number;

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.

sortBy

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.

sortBy : number;

lineTypeSortedBy

Readonly. The pivot line type sorted by.

lineTypeSortedBy : PivotLineType;

Remarks

Only works when not sorting this field by labels.

isSimpleSort

Indicates whether a simple data sort operation will be applied.

isSimpleSort : boolean;

Remarks

The default value is true.

cell

Readonly. Sorts by the values in which row or column.

cell : string;