API Reference > presentation-common > PresentationRules > PropertySortingRule

PropertySortingRule Interface

Rule to configure sorting for certain ECInstances in the hierarchy and/or content. It is possible to configure different sorting for different types of ECInstances.

Multiple sorting rules may be applied for the same instances - in this case the instances are first sorted by the highest priority rule and then the lower priority ones.

Note: This rule is not meant to be used to sort grouping nodes, custom nodes or other non ECInstance type of nodes.

Extends

Properties

Name Type Description
propertyName string Name of the property which should be used for sorting  
ruleType PropertySorting Used for serializing to JSON.  
sortAscending undefined | boolean Will sort in ascending order if set to true, otherwise descending.  

Inherited properties

Name Type Inherited from Description
class undefined | SingleSchemaClassSpecification SortingRuleBase Specification of ECClass whose ECInstances should be sorted by this rule.
condition undefined | string SortingRuleBase Defines a condition for the rule, which needs to be met in order to execute it.
isPolymorphic undefined | boolean SortingRuleBase Should SortingRuleBase.class defined in this rule be handled polymorphically.
onlyIfNotHandled undefined | boolean SortingRuleBase Should this rule should be ignored if there is already an existing
priority undefined | number SortingRuleBase Defines the order in which presentation rules will be evaluated and executed.
requiredSchemas undefined | RequiredSchemaSpecification[] SortingRuleBase Schema requirements for this rule.

Defined in

Last Updated: 12 June, 2024