SortingRuleBase Interface

Base class for all SortingRule implementations. Not meant to be used directly, see SortingRule.

Extends

Properties

Name Type Description
class undefined | SingleSchemaClassSpecification Specification of ECClass whose ECInstances should be sorted by this rule.  
condition undefined | string Defines a condition for the rule, which needs to be met in order to execute it.  
isPolymorphic undefined | boolean Should SortingRuleBase.class defined in this rule be handled polymorphically.  

Inherited properties

Name Type Inherited from Description
onlyIfNotHandled undefined | boolean RuleBase Should this rule should be ignored if there is already an existing
priority undefined | number RuleBase Defines the order in which presentation rules will be evaluated and executed.
requiredSchemas undefined | RequiredSchemaSpecification[] RuleBase Schema requirements for this rule.
ruleType RuleTypes RuleBase Used for serializing to JSON.

Defined in

Last Updated: 12 June, 2024