API reference
API reference
Select your platform
No SDKs available
No versions available

SortCriterion

SortCriterion

abstract class SortCriterion(val attrId: Int, var propCode: Int = 0, var sortOption: Int = 0)
Sort criterion for sorting a list of entities.
A sort criterion defines how entities should be ordered based on a specific attribute. Each criterion includes:
  • An attribute ID (attrId) identifying which attribute to sort by
  • An optional property code (propCode) for vector/pose attributes to specify which component (X, Y or Z) to use
  • A sort option (sortOption) determining the direction and case sensitivity

Constructors

NameSummary
SortCriterion
constructor(attrId: Int, propCode: Int = 0, sortOption: Int = 0)

Properties

NameSummary
attrId
val attrId: Int
propCode
var propCode: Int
sortOption
var sortOption: Int

Functions

NameSummary
asc
fun asc(): SortCriterion

function to set the sorting order to ascending
desc
fun desc(): SortCriterion

function to set the sorting order to descending
Did you find this page helpful?
Thumbs up icon
Thumbs down icon