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

SortCriterion Class

Modifiers: abstract
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

Signature

abstract class SortCriterion(val attrId: Int, var propCode: Int = 0, var sortOption: Int = 0)

Constructors

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

Properties

attrId : Int
[Get]
Signature
val attrId: Int
propCode : Int
[Get][Set]
Signature
var propCode: Int
sortOption : Int
[Get][Set]
Signature
var sortOption: Int

Functions

asc () : SortCriterion
function to set the sorting order to ascending
Signature
fun asc(): SortCriterion
desc () : SortCriterion
function to set the sorting order to descending
Signature
fun desc(): SortCriterion
Did you find this page helpful?
Thumbs up icon
Thumbs down icon