Aspose::Cells::Pivot::PivotFieldSortSetting class

PivotFieldSortSetting class

Represents the setting for sorting pivot fields.

class PivotFieldSortSetting

Methods

MethodDescription
GetCell()Sorts by the values in which row or column.
GetFieldIndex()(Deprecated) Represents the index of the field sorted by. -1 means sorting the PivotField by the labels,others means sorting by the data field.
GetLineTypeSortedBy()The pivot line type sorted by.
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.
GetSortType()Represents the SortOrder.
IsNull() constChecks whether the implementation object is nullptr.
IsSimpleSort()Indicates whether a simple data sort operation will be applied.
IsSortByLabels()Indicates whether to sort the field by itself or data field.
explicit operator bool() constoperator bool()
operator=(const PivotFieldSortSetting& src)operator=
PivotFieldSortSetting(PivotFieldSortSetting_Impl* impl)Constructs from an implementation object.
PivotFieldSortSetting(const PivotFieldSortSetting& src)Copy constructor.
SetFieldIndex(int32_t value)(Deprecated) Represents the index of the field sorted by. -1 means sorting the PivotField by the labels,others means sorting by the data field.
SetIsSimpleSort(bool value)Indicates whether a simple data sort operation will be applied.
SetSortBy(int32_t 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.
SetSortType(SortOrder value)Represents the SortOrder.
~PivotFieldSortSetting()Destructor.

Fields

FieldDescription
_implThe implementation object.

See Also