PresentationInstanceFilterDialogProps - presentation-components

API Reference > presentation-components > InstancesFilter > PresentationInstanceFilterDialogProps

PresentationInstanceFilterDialogProps Interface

Beta

Props for PresentationInstanceFilterDialog component.

Extends

Omit<PresentationInstanceFilterBuilderProps, "onInstanceFilterChanged" | "descriptor">

Methods

Name	Description
filterResultCountRenderer(filter?: PresentationInstanceFilterInfo): ReactNode Optional	Renderer that renders count of results for currently built filter.
onApply(filter: PresentationInstanceFilterInfo): void	Callback that is invoked when 'Apply' button is clicked.
onClose(): void	Callback that is invoked when 'Close' button is clicked or dialog is closed.

Properties

Name	Type	Description
descriptor	Descriptor \| () => Promise<Descriptor>	Descriptor that will be used in PresentationInstanceFilterBuilder component rendered inside this dialog.
isOpen	boolean	Specifies whether dialog is open or not.
title	undefined \| ReactNode	Dialog title.

Inherited properties

Name	Type	Inherited from	Description
imodel	IModelConnection	Omit	iModel connection to pull data from.
initialFilter	undefined \| PresentationInstanceFilterInfo	Omit	Initial filter that will be show when component is mounted.
ruleGroupDepthLimit	undefined \| number	Omit	Specifies how deep rule groups can be nested.

Defined in

presentation/components/src/presentation-components/instance-filter-builder/PresentationInstanceFilterDialog.tsx Line 22

Last Updated: 20 June, 2023