PivotFieldSortSetting

PivotFieldSortSetting class

Represents the setting of sorting pivot fields.

class PivotFieldSortSetting;

Properties

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

Methods

Method	Description
getSortType()	@deprecated. Please use the ‘sortType’ property instead. Represents the SortOrder.
isSortByLabels()	@deprecated. Please use the ‘isSortByLabels’ property instead. Indicates whether sorting the field by itself or data field.
getFieldIndex()	@deprecated. Please use the ‘fieldIndex’ property instead. Represents the index of the field sorted by. -1 means sorting the PivotField by the labels,others means sorting by the data field.
getLineTypeSortedBy()	@deprecated. Please use the ’lineTypeSortedBy’ property instead. The pivot line type sorted by.
isSimpleSort()	@deprecated. Please use the ‘isSimpleSort’ property instead. Indicates whether a simple data sort operation will be applied.
getCell()	@deprecated. Please use the ‘cell’ property instead. Sorts by the values in which row or column.
isNull()	Checks whether the implementation object is null.

sortType

Readonly. Represents the SortOrder.

sortType : SortOrder;

isSortByLabels

Readonly. Indicates whether sorting the field by itself or data field.

isSortByLabels : boolean;

fieldIndex

Readonly. 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;

lineTypeSortedBy

Readonly. The pivot line type sorted by.

lineTypeSortedBy : PivotLineType;

Remarks

Only works when not sorting this field by labels.

isSimpleSort

Readonly. 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;

getSortType()

@deprecated. Please use the ‘sortType’ property instead. Represents the SortOrder.

getSortType() : SortOrder;

Returns

SortOrder

isSortByLabels()

@deprecated. Please use the ‘isSortByLabels’ property instead. Indicates whether sorting the field by itself or data field.

isSortByLabels() : boolean;

getFieldIndex()

@deprecated. Please use the ‘fieldIndex’ property instead. Represents the index of the field sorted by. -1 means sorting the PivotField by the labels,others means sorting by the data field.

getFieldIndex() : number;

getLineTypeSortedBy()

@deprecated. Please use the ’lineTypeSortedBy’ property instead. The pivot line type sorted by.

getLineTypeSortedBy() : PivotLineType;

Returns

PivotLineType

Remarks

Only works when not sorting this field by labels.

isSimpleSort()

@deprecated. Please use the ‘isSimpleSort’ property instead. Indicates whether a simple data sort operation will be applied.

isSimpleSort() : boolean;

Remarks

The default value is true.

getCell()

@deprecated. Please use the ‘cell’ property instead. Sorts by the values in which row or column.

getCell() : string;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;