PresentationInstanceFilterDialogProps Interface
Props for PresentationInstanceFilterDialog component.
Properties
| Name | Type | Description | |
|---|---|---|---|
| filterResultsCountRenderer | (filter: PresentationInstanceFilterInfo) => React.ReactNode | undefined | Renders filter results count. | |
| imodel | IModelConnection | iModel connection to pull data from. | |
| initialFilter | PresentationInstanceFilterInfo | (descriptor: Descriptor) => PresentationInstanceFilterInfo | Initial filter that will be show when component is mounted. | |
| isOpen | boolean | Specifies whether dialog is open or not. | |
| onApply | (filter?: PresentationInstanceFilterInfo) => void | Callback that is invoked when 'Apply' button is clicked. | |
| onClose | () => void | undefined | Callback that is invoked when 'Close' button is clicked or dialog is closed. | |
| onReset | () => void | undefined | Callback that is invoked when 'Reset' button is clicked. | |
| propertiesSource | undefined | PresentationInstanceFilterPropertiesSource | () => Promise<PresentationInstanceFilterPropertiesSource> | PresentationInstanceFilterPropertiesSource that will be used in InstanceFilterBuilder component to populate properties. | |
| ruleGroupDepthLimit | number | undefined | Specifies how deep rule groups can be nested. | Deprecated |
| title | React.ReactNode | undefined | Dialog title. | |
| toolbarButtonsRenderer | (toolbarHandlers: FilteringDialogToolbarHandlers) => React.ReactNode | undefined | Renderer that will be used to render a custom toolbar instead of the default one. |
Defined in
Last Updated: 13 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.