usePresentationInstanceFilteringProps Function

Beta  

Custom hook that extracts properties and classes from Descriptor and creates props that can be used by InstanceFilterBuilder component.

This hook also makes sure that when classes are selected available properties list is updated to contain only properties found on selected classes and vice versa - when property is selected in one of the rules selected classes list is updated to contain only classes that has access to that property.

usePresentationInstanceFilteringProps(descriptor: Descriptor, imodel: IModelConnection, initialClasses?: ClassInfo[]): Required<Pick<, "properties" | "classes" | "selectedClasses" | "onClassSelected" | "onClassDeselected" | "onClearClasses" | "propertyRenderer" | "onRulePropertySelected" | "isDisabled">>

Parameter Type Description
descriptor Descriptor  
imodel IModelConnection  
initialClasses ClassInfo[]  

Returns - Required<Pick<, "properties" | "classes" | "selectedClasses" | "onClassSelected" | "onClassDeselected" | "onClearClasses" | "propertyRenderer" | "onRulePropertySelected" | "isDisabled">>

Defined in

Last Updated: 30 November, 2023