FilterByInstancePathsHierarchyRequestOptions<TIModel, TRulesetVariable> Interface

Request type of filtering hierarchies by given ECInstance paths.

Extends

Properties

Name Type Description
instancePaths InstanceKey[][] A list of paths from root ECInstance to target ECInstance.  
markedIndex undefined | number An optional index (0 <= markedIndex < instancePaths.length) to mark one of the instance paths.  

Inherited properties

Name Type Inherited from Description
imodel TIModel RequestOptionsWithRuleset<TIModel, TRulesetVariable> iModel to request data from
locale undefined | string RequestOptionsWithRuleset<TIModel, TRulesetVariable> Optional locale to use when formatting / localizing data
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 | UnitSystemKey RequestOptionsWithRuleset<TIModel, TRulesetVariable> Unit system to use when formatting property values with units.

Defined in

Last Updated: 30 November, 2023