API Reference > presentation-common > Core > HierarchyCompareOptions

HierarchyCompareOptions<TIModel, TNodeKey, TRulesetVariable> Interface

Data structure for comparing a hierarchy after ruleset or ruleset variable changes.

Extends

Properties

Name Type Description
continuationToken undefined | { currHierarchyNode: string, prevHierarchyNode: string }    
expandedNodeKeys undefined | TNodeKey[]    
prev { rulesetOrId?: string | Ruleset, rulesetVariables?: TRulesetVariable[] }    
resultSetSize undefined | number    

Inherited properties

Name Type Inherited from Description
diagnostics undefined | RequestOptionsWithRuleset<TIModel, TRulesetVariable>  
imodel TIModel RequestOptionsWithRuleset<TIModel, TRulesetVariable> iModel to request data from
locale undefined | string RequestOptionsWithRuleset<TIModel, TRulesetVariable> Optional locale to use when formatting / localizing data
priority undefined | number RequestOptionsWithRuleset<TIModel, TRulesetVariable> Optional request priority.
rulesetOrId string | Ruleset RequestOptionsWithRuleset<TIModel, TRulesetVariable> Ruleset or id of the ruleset to use when requesting data
rulesetVariables undefined | TRulesetVariable[] RequestOptionsWithRuleset<TIModel, TRulesetVariable> Ruleset variables to use when requesting data
unitSystem undefined | PresentationUnitSystem RequestOptionsWithRuleset<TIModel, TRulesetVariable> Unit system to use when formatting property values with units.

Defined in

Last Updated: 11 June, 2024