ViewSettingsDialog SAP SE Helps the user to sort, filter, or group data within a (master) {@link sap.m.List} or a {@link sap.m.Table}. The dialog is triggered by icon buttons in the table toolbar. Each button shows a dropdown list icon. <h3>Overview</h3> The <code>ViewSettingsDialog</code> is a composite control, consisting of a modal {@link sap.m.Popover} and several internal lists. There are three different tabs (Sort, Group, Filter) in the dialog that can be activated by filling the respective associations. If only one association is filled, the other tabs are automatically hidden. The selected options can be used to create sorters and filters for the table. <b>Note:</b> If the app does not offer all three sorting, filtering, and grouping operations, but only one of these (such as sort), we recommend placing the icon button directly in the toolbar. Do not place sort, filter, or group buttons in the footer toolbar if they refer to a table. Place group, sort, and filter buttons in the footer toolbar if they refer to a master list. <b>Note:</b> Reset button, when used in <code>ViewSettingsDialog</code> without custom tabs, is enabled when there are some Filters or presetFilters selected as well as there are changes in Sort by, Sort order, Group By or Group order values compared to initial state of the dialog, and disabled, if there are no changes or filters set. If the <code>ViewSettingsDialog</code> have one or more custom tabs, the Reset button is always enabled, because there is no way to determine the initial state of the custom tabs content and compare to their current state in order to determine enable/disable state of the Reset button. <h3>Usage</h3> <i>When to use?</i> <ul><li>If you need to allow the user to sort line items in a manageable list or table (up to 20 columns)</li> <li>If you need to offer custom filter settings in a manageable list or table (up to 20 columns)</li> <li>If you need to allow the user to group line items in a manageable list or table (up to 20 columns)</li></ul> <i>When not to use?</i> <ul><li>If you have complex tables (more than 20 columns)</li> <li>If you need to rearrange columns within your table (use the {@link sap.m.TablePersoDialog} instead)</li> <li>If you need very specific sort, filter, or column sorting options within complex tables (use the {@link sap.m.P13nDialog} instead)</li></ul> <h3>Responsive behavior</h3> The popover dialog appears as a modal window on desktop and tablet screen sizes, but full screen on smartphones. 1.16 sap.ui.core/Control Defines the title of the dialog. If not set and there is only one active tab, the dialog uses the default "View" or "Sort", "Group", "Filter" respectively. Determines whether the sort order is descending or ascending (default). Determines whether the group order is descending or ascending (default). Provides a string filter operator which is used when the user searches items in filter details page. Possible operators are: <code>AnyWordStartsWith</code>, <code>Contains</code>, <code>StartsWith</code>, <code>Equals</code>. This property will be ignored if a custom callback is provided through <code>setFilterSearchCallback</code> method. Specifies the Title alignment (theme specific). If set to <code>TitleAlignment.Auto</code>, the Title will be aligned as it is set in the theme (if not set, the default value is <code>center</code>); Other possible values are <code>TitleAlignment.Start</code> (left or right depending on LTR/RTL), and <code>TitleAlignment.Center</code> (centered) Indicates that the user has pressed the OK button and the selected sort, group, and filter settings should be applied to the data on this page. </br></br><b>Note:</b> Custom tabs are not converted to event parameters automatically. For custom tabs, you have to read the state of your controls inside the callback of this event. The selected sort item. The selected sort order (true = descending, false = ascending). The selected group item. The selected group order (true = descending, false = ascending). The selected preset filter item. The selected filters in an array of ViewSettingsItem. The selected filter items in an object notation format: { key: boolean }. If a custom control filter was displayed (for example, the user clicked on the filter item), the value for its key is set to true to indicate that there has been an interaction with the control. replaced by <code>filterCompoundKeys</code> event The selected filter items in an object notation format: { parentKey: { key: boolean, key2: boolean, ... }, ...}. If a custom control filter was displayed (for example, the user clicked on the filter item), the value for its key is set to true to indicate that there has been an interaction with the control. The selected filter items in a string format to display in the control's header bar in format "Filtered by: key (subkey1, subkey2, subkey3)". Called when the Cancel button is pressed. It can be used to set the state of custom filter controls. Called when the filters are being reset. Called when the Reset button is pressed. It can be used to set the state of custom tabs. Fired when the filter detail page is opened. The filter item for which the details are opened. The list of items with key and value that can be sorted over (for example, a list of columns for a table). The list of items with key and value that can be grouped on (for example, a list of columns for a table). The list of items with key and value that can be filtered on (for example, a list of columns for a table). A filterItem is associated with one or more detail filters. <b>Note:</b> It is recommended to use the <code>sap.m.ViewSettingsFilterItem</code> as it fits best at the filter page. The list of preset filter items with key and value that allows the selection of more complex or custom filters. These entries are displayed at the top of the filter tab. The list of all the custom tabs. The sort item that is selected. It can be set by either passing a key or the item itself to the function setSelectedSortItem. The group item that is selected. It can be set by either passing a key or the item itself to the function setSelectedGroupItem. By default 'None' is selected. You can restore back to 'None' by setting this association to empty value. The preset filter item that is selected. It can be set by either passing a key or the item itself to the function setSelectedPresetFilterItem. Note that either a preset filter OR multiple detail filters can be active at the same time. Opens the ViewSettingsDialog relative to the parent control. The ID of the initial page to be opened in the dialog. Returns the selected filters as an array of ViewSettingsItems. It can be used to create matching sorters and filters to apply the selected settings to the data. Gets the filter string in format: "filter name (subfilter1 name, subfilter2 name, ...), ...". For custom and preset filters it will only add the filter name to the resulting string. Gets the selected filter object in format {key: boolean}. It can be used to create matching sorters and filters to apply the selected settings to the data. replaced by <code>getSelectedFilterCompoundKeys</code> method Gets the selected filter object in format { parent_key: { key: boolean, key2: boolean, ...}, ... }. Sets the selected filter object in format {key: boolean}. <b>Note:</b> Do not use duplicated item keys with this method. replaced by <code>setSelectedFilterCompoundKeys</code> method A configuration object with filter item and sub item keys in the format: { key: boolean }. Sets the selected filter object in format { parent_key: { key: boolean, key2: boolean, ...}, ... }. A configuration object with filter item and sub item keys in the format: { parent_key: { key: boolean, key2: boolean, ...}, ... }.