filterbar/FilterBar SAP The control displays filters in a user-friendly manner to populate values for a query. The FilterBar consists of a row containing the {@link sap.ui.comp.variants.VariantManagement VariantManagement} control, the related buttons, and an area underneath displaying the filters. The filters are arranged in a logical row that is divided depending on the space available and the width of the filters. The area containing the filters can be hidden or shown using the Hide FilterBar / Show FilterBar button. The Go button triggers the search event, and the Filters button shows the filter dialog.<br> In this dialog, the consumer has full control over the FilterBar. The filters in this dialog are displayed in one column and organized in groups. The filter items of the <code>filterItems</code> aggregation are grouped in the Basic group . Each filter can be marked as visible in the FilterBar by selecting Add to FilterBar. In addition, the items in the <code>filterGroupItems</code> aggregation can be marked as part of the current variant. The FilterBar also supports a different UI layout when used inside a value help dialog. In this case the FilterBar consists of two logical areas, one containing the general search button and one the Advanced Search area. The Advanced Search is a collapsible area displaying the advanced filters in two columns. sap.ui.layout/Grid Key used to access personalization data. Only if the persistencyKey is provided, will the <code>VariantManagement</code> control be used. The advanced mode is only relevant for the value help scenario. UI representation is different from the standard FilterBar. Collapses/expands the advanced area. Replaced by property <code>filterBarExpanded</code> This property is mapped to the filterBarExpanded property. Enables/disables the Search button. Shows the filters area. When property <code>useToolbar</code> is set to <code>false</code>, <code>filterBarExpanded</code> is set to <code>true</code> automatically. If this property is set, then the label for filters will be prefixed with the group title. Handles visibility of the Clear button on the Filters dialog. Handles visibility of the "Restore" button on the "Filters" dialog. <b>Note:</b> Restore works only automatically when a property <code>persistencyKey</code> is set and therefore Variant Management is used. In all other cases the "restore" behavior needs to be implemented by the app, based on the event <code>reset</code>. Handles visibility of the Go button on the FilterBar. Handles visibility of the Restore button on the FilterBar. Handles visibility of the Clear button on the FilterBar. Handles visibility of the Go button on the FilterBar. Replaced by property <code>showGoOnFB</code> Stores the delta as compared to the standard variant. Sets the width of the filters container. Determines what design should be used. Default is the design with toolbar. The design with toolbar is always used on phones. When property <code>useToolbar</code> is set to <code>false</code>, <code>filterBarExpanded</code> is set to <code>true</code> automatically. Specifies header text that is shown in the toolbar on the first position. This property is ignored, when <code>useToolbar</code> is set to <code>false</code>. Handles visibility of the Filters button on the FilterBar. Determines the behavior when <code>reset</code> is executed. <br> <b>Note:</b> This property is only relevant if no variant management is used, and the filter bar is not used in the advanced mode. A snapshot shows the current state of the filter bar, just before the Filters dialog is opened. <ul> <li><code>undefined</code> (default) defines the standard behavior: snapshot will be applied after <code>reset</code> was triggered</li> <li><code>false</code> defines that the snapshot will not be applied</li> <li><code>true</code>is not considered at all</li> </ul> This event is fired when the Cancel button on the Filters dialog is pressed and the variant is marked as dirty. This event is fired when the Restore button is pressed. Visible controls This event is fired when the Go button is pressed. Visible controls This event is fired before a variant is saved. The event can be used to adapt the data of the custom filters, which will be saved as variant later. Replaced by the event <code>beforeVariantFetch</code> Context of the event. Can also be <code>null</code> or <code>undefined</code> This event is fired before a variant is fetched. This event is fired after a variant has been loaded and applied to the FilterBar. The event can be used to adapt custom filters with data from the variant. Context of the event. Can also be <code>null</code> or <code>undefined</code> executeOnSelect indicates if the variant will trigger search This event is fired when a filter or multiple filters has changed. This event is fired when the Clear button is pressed. The consumer has to clear all filters. Visible controls This event is fired when the FilterBar is initialized to indicate that metadata are available. This event is fired after the <code>FilterBar</code> has been initialized, the user's default variant has been applied, and a stable filter state has been achieved. With this event all relevant filter information, for example, for navigation-related actions, is available via {@link sap.ui.comp.filterbar.FilterBar#getUiState}. This event is fired after a variant has been saved. This event is fired after the filters dialog is closed. Context of the event. Can also be <code>null</code> or <code>undefined</code> This event is fired after the filters dialog is opened. This event is fired when the Cancel button on the filters dialog is pressed. This event is fired when the Go button on the filters dialog is pressed. This event is fired when search field of the filter dialog is changed. Contains the entered search filed value This event is fired when the filters information has changed. It indicates specifically that the count of assigned filters may be changed. One of the intended reaction to this event would be to call <code>retrieveFiltersWithValuesAsText</code> method. Filters belonging to the basic group. Use aggregation <code>filterGroupItems</code> instead. Contains all FilterBar filters. <br> <code>Note:</code>In case a filter has to be added to the basic group <ul> <li>the property <code>groupName</code> has to be set to the constant <code>sap.ui.comp.filterbar.FilterBar.INTERNAL_GROUP</code></li> <li>the property <code>groupLabel</code> will be handled internally and will be ignored, if set</li> <li>the property <code>partOfCurrentVariant</code> has to be set to <code>true</code></li> <li>if the property <code>visibleInFilterBar</code> is set to <code>true</code>, the property <code>partOfCurrentVariant</code> will be set internally also to <code>true</code></li> </ul> Special handling for analytic parameters. Populates the basic search area on the FilterBar and the Filters dialog.