API Reference › presentation-components› InstancesFilter

InstancesFilter

Utilities for creating filters for filtering presentation data.

Global Functions

Name Description  
convertToInstanceFilterDefinition Converts PresentationInstanceFilter into InstanceFilterDefinition that can be passed Deprecated
createInstanceFilterDefinition Creates InstanceFilterDefinition from PresentationInstanceFilterInfo.  
isPresentationInstanceFilterConditionGroup Function that checks if supplied PresentationInstanceFilter is PresentationInstanceFilterConditionGroup. Deprecated
PresentationFilterBuilderValueRenderer Custom renderer of the filter rule value input.  
PresentationInstanceFilterBuilder Component for building complex instance filters for filtering content and nodes produced  
PresentationInstanceFilterDialog Dialog component that renders InstanceFilterBuilder inside.  
useInstanceFilterPropertyInfos Custom hook that collects properties from descriptor for filter building.  

Interfaces

Name Description  
FilteringDialogToolbarHandlers Set of action handlers that are passed to toolbarButtonsRenderer for rendering custom buttons.  
PresentationFilterBuilderValueRendererProps Props for PresentationFilterBuilderValueRenderer.  
PresentationInstanceFilterBuilderProps Props for PresentationInstanceFilterBuilder component.  
PresentationInstanceFilterCondition Data structure that describes single filter condition.  
PresentationInstanceFilterConditionGroup Data structure that describes group of filter condition joined by logical operator.  
PresentationInstanceFilterDialogProps Props for PresentationInstanceFilterDialog component.  
PresentationInstanceFilterInfo Data structure that stores information about filter built by PresentationInstanceFilterDialog.  
PresentationInstanceFilterPropertiesSource Data structure that describes source to gather properties from.  
PresentationInstanceFilterPropertyInfo Data structure that contains information about property used for building filter.  
UseInstanceFilterPropertyInfosProps Props for useInstanceFilterPropertyInfos hook.  

Namespaces

Name Description  
PresentationInstanceFilter  

Type Aliases

Name Description  
PresentationInstanceFilter Type that describes instance filter based on Descriptor fields.  

Last Updated: 30 October, 2024