IValueSortSettings API in JavaScript (ES5) Pivotfieldlist API control

Allows to sort individual value field and its aggregated values either in row or column axis to ascending or descending order.

Properties

columnHeaderText

string

Defines the header text of the column field for which value-based sorting is applied (Relational). This should represent the exact column member path, separated using the specified headerDelimiter.

Note: Applicable only for relational data sources.

columnIndex

number

It allows to set the column index of the value cell.

columnSortOrder

Sorting

Sets the sorting order for the specified column header field (Relational). Available options:

• Ascending - Sorts field members in ascending order based on aggregated value.
• Descending - Sorts field members in descending order based on aggregated value.

Note: Applicable only for relational data sources.

headerDelimiter

string

It allows to set the delimiter, which is used a separator to split the given header text.

headerText

string

It allows to set the member name of a specific field for value sorting.

measure

string

It allows to set the measure name to achieve value sorting based on this.

It is applicable only for OLAP data source.

rowHeaderText

string

Defines the header text of the row field for which value-based sorting is applied (Relational). This should represent the exact row member path, separated using the specified headerDelimiter.

Note: Applicable only for relational data sources.

rowIndex

number

It allows to set the row index of the value cell.

rowSortOrder

Sorting

Sets the sorting order for the specified row header field (Relational). Available options:

• Ascending - Sorts field members in ascending order based on aggregated value.
• Descending - Sorts field members in descending order based on aggregated value.

Note: Applicable only for relational data sources.

sortOrder

Sorting

Allows to apply sorting to the specified field either by ascending or descending. The types are,

• Ascending: It allows to display the field members in ascending order.
• Descending: It allows to display the field members in descending order.