API Reference › presentation-common› PresentationRules › SortingRuleBase

SortingRuleBase Interface

Sorting rules provide a way to either disable sorting or sort instances by specific properties.

@see Sorting rule reference documentation page

Extends

Properties

Name Type Description
class SingleSchemaClassSpecification | undefined Specifies ECClass whose ECInstances should be sorted.  
condition string | undefined Defines a condition which needs to be met in order for the rule to be used.  
isPolymorphic boolean | undefined Specifies that class attribute defined in this rule should be handled polymorphically.  

Inherited properties

Name Type Inherited from Description
onlyIfNotHandled Inherited boolean | undefined RuleBase Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule
priority Inherited number | undefined RuleBase Defines the order in which rules are handled, higher number means the rule is handled first.
requiredSchemas Inherited RequiredSchemaSpecification[] | undefined RuleBase A list of ECSchema requirements that need to be met for the rule to be used.
ruleType Inherited "RootNodes" | "ChildNodes" | "Content" | "ContentModifier" | "DefaultPropertyCategoryOverride" | "Grouping" | "PropertySorting" | "DisabledSorting" | "NodeArtifacts" | "InstanceLabelOverride" | "LabelOverride" | "CheckBox" | "ImageIdOverride" | "StyleOverride" | "ExtendedData" RuleBase Used for serializing to JSON.

Defined in

Last Updated: 14 November, 2024