// For Library Version: 1.149.1 declare namespace sap { namespace esh { namespace search { /** * UI5 library: sap.esh.search.ui. */ namespace ui { namespace controls { namespace basket { /** * Describes the settings that can be provided to the CustomBasket constructor. */ interface $CustomBasketSettings extends sap.ui.layout.$VerticalLayoutSettings {} /** * Describes the settings that can be provided to the SearchBasketAddButton constructor. */ interface $SearchBasketAddButtonSettings extends sap.m.$OverflowToolbarButtonSettings {} /** * This is the SAPUI5 sample basket class, making use of the sap.ui.table.Table extension SearchBasketSapUiTable. * In addition, adds a custom header, footer (sap.ui.table.Table is used for the basket items). Use in combination * with control SearchCompositeControl by the Enterprise Search Team. * * @since 1.144.0 */ class CustomBasket extends sap.ui.layout.VerticalLayout { /** * Constructs a new `CustomBasket` to be used as a search basket (extend this class). * See: * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html * SAP HANA Search Developer Guide * https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html * Enterprise Search in SAP S/4HANA */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string ); } /** * This is the SAPUI5 search basket button control to display a button to add result items to the search * basket. Use in combination with control SearchCompositeControl by the Enterprise Search Team. * * @since 1.143.0 */ class SearchBasketAddButton extends sap.m.OverflowToolbarButton { /** * Constructs a new `SearchBasketAddButton` to display a button to add result items to the search basket. * See: * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html * SAP HANA Search Developer Guide * https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html * Enterprise Search in SAP S/4HANA */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string ); } } namespace resultview { /** * Describes the settings that can be provided to the SearchShowDetailButton constructor. */ interface $SearchShowDetailButtonSettings extends sap.m.$ButtonSettings {} /** * Describes the settings that can be provided to the SearchText constructor. */ interface $SearchTextSettings extends sap.m.$TextSettings {} /** * This is the SAPUI5 search show detail button control to navigate to the detail of a result item. Use * in combination with control SearchCompositeControl by the Enterprise Search Team. The master detail mode * of the result view must be activated (see config property 'resultviewMasterDetailMode'). Place this button * on custom result grid view tiles (see config property 'customGridView'). The press event of this button * will fire the event 'showResultDetail' (see sap.esh.search.ui.controls.SearchCompositeControl). * * @since 1.141.0 */ class SearchShowDetailButton extends sap.m.Button { /** * Constructs a new `SearchShowDetailButton` to display a button to navigate to the detail of a result item. * See: * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html * SAP HANA Search Developer Guide * https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html * Enterprise Search in SAP S/4HANA */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string ); } /** * This is the SAPUI5 search text control to display attributes of search results. For attribute with navigation * use control sap.esh.search.ui.SearchLink. Use in combination with control SearchCompositeControl by the * Enterprise Search Team. * * @since 1.93.0 */ class SearchText extends sap.m.Text { /** * Constructs a new `SearchText` to display an attribute (text only, no navigation) on custom grid control * tiles. * See: * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html * SAP HANA Search Developer Guide * https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html * Enterprise Search in SAP S/4HANA */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Text to be displayed */ text?: object, /** * Maximum number of text lines to be displayed */ maxlines?: object, /** * Text can wrap automatically within the given width */ wrapping?: object ); } } /** * Describes the settings that can be provided to the SearchLink constructor. */ interface $SearchLinkSettings extends sap.m.$LinkSettings { /** * An object containing all data needed to define navigation of a attribute (result item) * * @since 1.93.0 */ navigationTarget?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the * function 'performNavigation' of item's navigationTarget do the job * * @since 1.143.0 */ forceNavigationAnchorElementNotProcessed?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Visualisation style of search navigation * * @since 1.144.0 */ visualisation?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; } /** * This is the SAPUI5 search link control to display attributes of search results. For attribute without * navigation use control sap.esh.search.ui.controls.resultview.SearchText. Use in combination with control * SearchCompositeControl by the Enterprise Search Team. * * @since 1.93.0 */ class SearchLink extends sap.m.Link { /** * Constructs a new `SearchText` to display an attribute (with navigation) on custom grid control tiles. * See: * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html * SAP HANA Search Developer Guide * https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html * Enterprise Search in SAP S/4HANA */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Object instance of NavigationTarget which contains all relevant information for navigation */ navigationTarget?: object ); /** * Creates a new subclass of class sap.esh.search.ui.controls.SearchLink with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Link.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.esh.search.ui.controls.SearchLink >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.esh.search.ui.controls.SearchLink. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}. * * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the * function 'performNavigation' of item's navigationTarget do the job * * Default value is `false`. * * @since 1.143.0 * * @returns Value of property `forceNavigationAnchorElementNotProcessed` */ getForceNavigationAnchorElementNotProcessed(): boolean; /** * Gets current value of property {@link #getNavigationTarget navigationTarget}. * * An object containing all data needed to define navigation of a attribute (result item) * * @since 1.93.0 * * @returns Value of property `navigationTarget` */ getNavigationTarget(): object; /** * Gets current value of property {@link #getVisualisation visualisation}. * * Visualisation style of search navigation * * Default value is `"hyperLink"`. * * @since 1.144.0 * * @returns Value of property `visualisation` */ getVisualisation(): string; /** * Sets a new value for property {@link #getForceNavigationAnchorElementNotProcessed forceNavigationAnchorElementNotProcessed}. * * When SearchLink is used on sap.m.GenericTile, the a-element does not call its href, we need to let the * function 'performNavigation' of item's navigationTarget do the job * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.143.0 * * @returns Reference to `this` in order to allow method chaining */ setForceNavigationAnchorElementNotProcessed( /** * New value for property `forceNavigationAnchorElementNotProcessed` */ bForceNavigationAnchorElementNotProcessed?: boolean ): this; /** * Sets a new value for property {@link #getNavigationTarget navigationTarget}. * * An object containing all data needed to define navigation of a attribute (result item) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.93.0 * * @returns Reference to `this` in order to allow method chaining */ setNavigationTarget( /** * New value for property `navigationTarget` */ oNavigationTarget: object ): this; /** * Sets a new value for property {@link #getVisualisation visualisation}. * * Visualisation style of search navigation * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"hyperLink"`. * * @since 1.144.0 * * @returns Reference to `this` in order to allow method chaining */ setVisualisation( /** * New value for property `visualisation` */ sVisualisation?: string ): this; } } /** * Describes the settings that can be provided to the SearchCompositeControl constructor. */ interface $SearchCompositeControlSettings extends sap.ui.layout.$VerticalLayoutSettings { /** * An additional CSS class to add to this control * * @since 1.93.0 */ cssClass?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the initial search term for the search input. * * @since 1.93.0 */ searchTerm?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines if the search composite control will send a search request directly after loading, using given * search term, data source and filter root condition settings. * * @since 1.93.0 */ searchOnStart?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the filter root condition of a filter tree which shall be applied to the search request. This * control only allows filter trees which have a the following structure: complex condition (root level) * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions * which do not follow this structure won't be accepted and an error will be thrown. Please see the below * for a more in-depth example. * * @since 1.98.0 */ filterRootCondition?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Configuration for the Enterprise Search Client API. * * @since 1.93.0 */ sinaConfiguration?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The id of the data source in which it will search right after initialization. * * @since 1.98.0 */ dataSource?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet * panel) - data source name/link on result list (header section of item) * * @since 1.121.0 */ exclusiveDataSource?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines selectable search result view types. The value can be set/get in attach event "searchFinished". * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is * not switchable. Case 2: Search in All or other Category: result is switchable between different view * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3, * Search in Business Object: result is switchable between different view types. Possible values for the * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value * of `resultViewTypes` and `resultViewType` must be compatible to each other. * * After the result view type has been changed, the event 'resultViewTypeChanged' is fired. * * @since 1.98.0 */ resultViewTypes?: | string[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines active search result view type. The value can be set/get in attach event "searchFinished", and * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true): * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`. * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`. * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other. * * After the result view type has been changed, the event 'resultViewTypeChanged' is fired. * * @since 1.98.0 */ resultViewType?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes` * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType: * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes` * and `resultViewType` must be compatible to each other. * * After the result view type has been changed, the event 'resultViewTypeChanged' is fired. * * @since 1.100.0 */ resultViewSettings?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The result views are displayed in a master-detail mode. The event showResultDetail is fired whenever * the detail button/indicator is clicked. * * @since 1.140.0 */ resultviewMasterDetailMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Set default number of visible columns of search result table. This is important when adding custom columns * by means of formatters. * * @since 1.142.0 */ searchResultTableMaxNumberOfInitiallyVisibleColumns?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed * in the tabstrips. * * @since 1.103.0 */ tabStripsFormatter?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy. * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute) * are set. * * In folder mode and in case a folder filter is set the result view only shows direct children of a folder. * In contrast the counts in the facets are calculated by counting direct and not direct children. In case * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct * children of a folder. * * @since 1.106.0 */ folderMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode * is enabled. * * @since 1.114.0 */ folderModeForInitialSearch?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * In case folder mode is active: Automatically switch result view type to list in search mode and to table * in folder mode. * * @since 1.106.0 */ autoAdjustResultViewTypeInFolderMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables the query language for the hana_odata provider. With query language it is possible for the end * user to enter complex search queries with logical operators. * * @since 1.107.0 */ enableQueryLanguage?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents. * * @since 1.108.0 */ applicationComponent?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria. * * @since 1.108.0 */ facetPanelResizable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable" * is true, the width of the facet panel can be changed by the user. * * @since 1.108.0 */ facetPanelWidthInPercent?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A boolean which indicates whether the basket panel with selected items is initially opened or closed. * This affects only the initial state of the basket panel. * * @since 1.146.0 */ basketPanelVisibility?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Display a splitter bar to resize the right hand panel, containing the basket with selected items. * * @since 1.142.0 */ basketPanelResizable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable" * is true, the width of the basket panel can be changed by the user. * * @since 1.142.0 */ basketPanelWidthInPercent?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control * to be more specific and add some hints, links, buttons or other content. * * @since 1.94.0 */ getCustomNoResultScreen?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile'). * * @since 1.93.0 */ customGridView?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Define a custom toolbar. * * @since 1.93.0 */ getCustomToolbar?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A callback which returns customized "label" for placeholder text of search box in case there is no search * term. The placeholder text (en) will be "Search In: ". */ getSearchInputPlaceholderLabel?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl) * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar". * * @since 1.140.0 */ searchInputLocation?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Shall the window title be overwritten by this control? If true, the control will set the current search * condition as window title. If false, it will not set or update the window title. * * @since 1.93.0 */ overwriteBrowserTitle?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource * will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource' * to 'true', do not set this parameter (will be ignored). * * @since 1.93.0 */ defaultDataSource?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The layout is optimized for object selection / value help (narrow view w/o facet panel). * * @since 1.111.0 */ optimizeForValueHelp?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets * a list of datsources and returns the filtered list of datasources. * * @since 1.112.0 */ filterDataSources?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Show a text/title at the start(left) of the search bar. * * @since 1.143.0 */ searchBarTitle?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Controls whether the facet functionality is available or not. * * @since 1.133.0 */ facets?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A boolean which indicates whether the facet panel is initially opened or closed. This affects only the * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user, * depending on the user's personalization settings. * * @since 1.113.0 */ facetVisibility?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Location of the button to show/hide facet panel. The button (filter icon) can be placed on the left (begin) * or on the right (end) of the search bar. By default the button's location is at the beginning (left), * values are "Begin" and "End". The property is not evaluated if facet panel is disabled, see property * 'facets'. * * @since 1.140.0 */ facetToggleButtonLocation?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Location of the buttons to show/hide basket and add items to the basket. The buttons can be placed on * the left (begin) or on the right (end) of the search bar. By default the location is at the end (right), * values are "Begin", "Middle" and "End". * * @since 1.143.0 */ basketButtonsLocation?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Items of the basket are automatically added/removed when selecting/deselecting items on result views. * Moreover all items of the basket are automatically selected on result views, if they are visible on the * current result view page. The basket show/hide button is rendered as a toggle button. The left button * shows available items (label: "Available"), the right button shows selected items (label: "Selected"). * You either see the result view (table, list or grid) or the basket. With release 1.148.0 the label, icon * and tooltip of the right button are controlled by the properties 'basketShowHideButtonText', 'basketShowHideButtonIcon' * and 'basketShowHideButtonTooltip'. * * @since 1.143.0 */ basketLinkByResultViewItemSelection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4". * * @since 1.143.0 */ basketAddButtonIcon?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Custom text of button 'add items to basket'. By default the text is empty and the button will show the * icon, only. * * @since 1.143.0 */ basketAddButtonText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Custom tooltip of button 'add items to basket'. By default there tooltip is 'Add to Basket'. * * @since 1.143.0 */ basketAddButtonTooltip?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Custom icon of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection } * is true. In that case, the icon is applied to the right button part ("Selected") of the segmented toggle * button. * * @since 1.148.0 */ basketShowHideButtonIcon?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Custom text of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection } * is true. In that case, the text is applied to the right button part ("Selected") of the segmented toggle * button. * * @since 1.148.0 */ basketShowHideButtonText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Custom tooltip of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection } * is true. In that case, the tooltip is applied to the right button part ("Selected") of the segmented * toggle button. * * @since 1.148.0 */ basketShowHideButtonTooltip?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * When basket gets initialized, this callback is called with the columns of the (future) basket table. * You can add more columns or adjust the sequence of columns. * * @since 1.144.0 */ basketInit?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Before new item is added to basket, this callback is called with the public item (search result) and * the new basket item You can adjust the model data of the basket item. * * @since 1.144.0 */ basketBeforeAddItem?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Location of the basket. When creating your own basket (see function 'createAndRegisterBasket'), set this * property to "CustomBasketLocation". By default the basket is a panel at the right of the result view. * * Values: - "SidePanelRight" (default): basket is a panel at the right of the result view - "CustomBasketLocation": * basket is created by function 'createAndRegisterBasket' and can be placed anywhere in the UI * * @since 1.145.0 */ basketLocation?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Define your own view for the basket. The basket is displayed on a panel at the right/end of result views * (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket * (see config properties 'basketVisibilityButton' and 'basketAddButton'). For the basket items collection, * we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl. * 'add to basket') of result views with table/list is managed by SearchCompositeControl. * * @since 1.144.0 */ customBasket?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A boolean for enabling chart visualizations (pie chart / bar chart facets). If set to true, facets can * be viewed as a pie or bar chart (this cannot be deactivated at runtime). * * @since 1.140.0 */ enableCharts?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A boolean for enabling (business) object suggestions. * * @since 1.113.0 */ boSuggestions?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * When set to true the facet panel is displayed also in case there are no search results. * * @since 1.113.0 * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled * by the end user. */ displayFacetPanelInCaseOfNoResults?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A boolean indicating that the search state is written to the URL. * * @since 1.113.0 */ updateUrl?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns * the URL string. Typically you need to register this callback in case of 'updateUrl = true'. * * @since 1.113.0 */ renderSearchUrl?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns * 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case * of 'updateUrl = true'. * * @since 1.113.0 */ isSearchUrl?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL * parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback * is not needed. * * @since 1.113.0 */ parseSearchUrlParameters?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A list of data sources to be displayed in the facet panel in the section "Collection". * * @since 1.113.0 */ quickSelectDataSources?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * An asynchronues callback which is called after the initialization of the search composite control. * * @since 1.113.0 */ initAsync?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables the multiselection mode of search result items. A checkbox is provided for each result item if * the value is set to 'true'. * * @since 1.96.0 * @deprecated As of version 1.141.0. use 'resultviewSelectionMode' instead. */ enableMultiSelectionResultItems?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * To select result view items, enable multi-selection or single-selection mode. Shows checkboxes ('MultipleItems') * or enables item press ('OneItem'). Values of configuration parameter `resultviewSelectionMode` are 'None', * 'OneItem' and 'MultipleItems'. To show a button for switching selection mode on/off, see 'showSelectionToggleButton'. * A checkbox is provided for each result item if the value is true. The setting is related to `resultviewMasterDetailMode` * (master-detail mode). The event `showResultDetail` is fired whenever the detail button is clicked. * * @since 1.141.0 */ resultviewSelectionMode?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Enables the selection toggle button in the search result list. The button is displayed on the top of * search result view and allows to toggle the selection of all result items. The button is only displayed * if the property 'resultviewSelectionMode' is not set to 'None'. * * @since 1.140.0 */ showSelectionToggleButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables a button in the search result list to control basket panel visibility. Depending on the configuration, * this is either a show/hide button or an 'Available'/'Selected' toggle button (when basketLinkByResultViewItemSelection=true). * The button is only rendered when the basket feature is active (i.e. createAndRegisterBasket was called). * * @since 1.143.0 */ basketVisibilityButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables the basket add button in the search result list. The button is displayed on the top of search * result view and allows to add result view items to the basket. Has no effect when basketLinkByResultViewItemSelection=true * — in that case items are added automatically via result view item selection and a manual add button is * redundant (a console warning is logged). * * @since 1.143.0 */ basketAddButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The maximum count of search result items displayed on a page after a search. By clicking 'Show More' * button, another page of result items of the same count (if available) will be displayed. * * @since 1.96.0 */ pageSize?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel). * * @since 1.120 */ formatFilterBarText?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Callback for checking whether the filter bar is visible. * * @since 1.120 */ isFilterBarVisible?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Adds a callback function which is called whenever there is a user or a technical event. A user event * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event * is an event which is triggered by the internal events or events which can also be triggered by API. * * @since 1.120 */ eventConsumers?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Limit for length of searchterm. */ searchTermLengthLimit?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Prevents too many ajax requests in a short time. */ limitAjaxRequests?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Event is fired when search is started. * * @since 1.121 */ searchStarted?: (oEvent: sap.ui.base.Event) => void; /** * Event is fired when search is finished. * * @since 1.121 */ searchFinished?: (oEvent: sap.ui.base.Event) => void; /** * Event is fired when selection on result view (list, table or grid) has changed. * * @since 1.143 */ resultViewSelectionChanged?: (oEvent: sap.ui.base.Event) => void; /** * Event is fired when selection on result view (list, table or grid) has changed. * * @since 1.121 */ selectionChanged?: (oEvent: sap.ui.base.Event) => void; /** * Event is fired after result view type got changed (list, table or grid). Parameters of the event (since * 1.143): - newValue: current result view type - oldValue: previous result view type * * @since 1.124 */ resultViewTypeChanged?: (oEvent: sap.ui.base.Event) => void; /** * Event is fired after result view detail button is pressed (list, table or grid). To use this event, set * the property 'resultviewMasterDetailMode' to 'true'. * * @since 1.140.0 */ showResultDetail?: (oEvent: sap.ui.base.Event) => void; /** * After items are added/removed from basket, this callback is called Parameters of the event: - count: * current number of items in basket * * @since 1.144.0 */ basketChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Parameters of the SearchCompositeControl#basketChanged event. */ interface SearchCompositeControl$BasketChangedEventParameters {} /** * Parameters of the SearchCompositeControl#resultViewSelectionChanged event. */ interface SearchCompositeControl$ResultViewSelectionChangedEventParameters {} /** * Parameters of the SearchCompositeControl#resultViewTypeChanged event. */ interface SearchCompositeControl$ResultViewTypeChangedEventParameters {} /** * Parameters of the SearchCompositeControl#searchFinished event. */ interface SearchCompositeControl$SearchFinishedEventParameters {} /** * Parameters of the SearchCompositeControl#searchStarted event. */ interface SearchCompositeControl$SearchStartedEventParameters {} /** * Parameters of the SearchCompositeControl#selectionChanged event. */ interface SearchCompositeControl$SelectionChangedEventParameters {} /** * Parameters of the SearchCompositeControl#showResultDetail event. */ interface SearchCompositeControl$ShowResultDetailEventParameters {} /** * This is the SAPUI5 composite control by the Enterprise Search Team which helps to make full use of the * Enterprise Search Engine features built into ABAP and HANA (including natural language processing). It * includes a search input box with a suggestion dropdown, a result view which can have different visualisation, * including tiles, list and table, filtering facets and more. This control is ready to use with enterprise * search backend services but also allows deep extension to match requirements of adopting applications. * * @since 1.93.0 */ class SearchCompositeControl extends sap.ui.layout.VerticalLayout { /** * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services. * See: * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html * SAP HANA Search Developer Guide * https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html * Enterprise Search in SAP S/4HANA */ constructor( /** * Initial settings for the new control */ mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings ); /** * Constructs a new `SearchCompositeControl` to interact with SAP Enterprise Search Services. * See: * https://help.sap.com/viewer/691cb949c1034198800afde3e5be6570/2.0.08/en-US/ce86ef2fd97610149eaaaa0244ca4d36.html * SAP HANA Search Developer Guide * https://help.sap.com/docs/SAP_S4HANA_ON-PREMISE/90b263323d0a4976bcda415e6bd20ea4/d93d53ef27074bbf9a4849c4a4c3e360.html * Enterprise Search in SAP S/4HANA */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings ); /** * Creates a new subclass of class sap.esh.search.ui.SearchCompositeControl with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.VerticalLayout.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.esh.search.ui.SearchCompositeControl >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.esh.search.ui.SearchCompositeControl. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds a callback function which is called whenever there is a user triggered event. * * @since 1.120.0 */ addEventConsumer( /** * This function will be called when the user triggered an UI event. As arguments this function will receive * the UI event along with details of the event. */ eventConsumer: object ): void; /** * Attaches event handler `fnFunction` to the {@link #event:basketChanged basketChanged} event of this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * After items are added/removed from basket, this callback is called Parameters of the event: - count: * current number of items in basket * * @since 1.144.0 * * @returns Reference to `this` in order to allow method chaining */ attachBasketChanged( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:basketChanged basketChanged} event of this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * After items are added/removed from basket, this callback is called Parameters of the event: - count: * current number of items in basket * * @since 1.144.0 * * @returns Reference to `this` in order to allow method chaining */ attachBasketChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resultViewSelectionChanged resultViewSelectionChanged } * event of this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired when selection on result view (list, table or grid) has changed. * * @since 1.143 * * @returns Reference to `this` in order to allow method chaining */ attachResultViewSelectionChanged( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resultViewSelectionChanged resultViewSelectionChanged } * event of this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired when selection on result view (list, table or grid) has changed. * * @since 1.143 * * @returns Reference to `this` in order to allow method chaining */ attachResultViewSelectionChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged } * event of this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired after result view type got changed (list, table or grid). Parameters of the event (since * 1.143): - newValue: current result view type - oldValue: previous result view type * * @since 1.124 * * @returns Reference to `this` in order to allow method chaining */ attachResultViewTypeChanged( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resultViewTypeChanged resultViewTypeChanged } * event of this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired after result view type got changed (list, table or grid). Parameters of the event (since * 1.143): - newValue: current result view type - oldValue: previous result view type * * @since 1.124 * * @returns Reference to `this` in order to allow method chaining */ attachResultViewTypeChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this * `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired when search is finished. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ attachSearchFinished( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:searchFinished searchFinished} event of this * `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired when search is finished. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ attachSearchFinished( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired when search is started. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ attachSearchStarted( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:searchStarted searchStarted} event of this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired when search is started. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ attachSearchStarted( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired when selection on result view (list, table or grid) has changed. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired when selection on result view (list, table or grid) has changed. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:showResultDetail showResultDetail} event of * this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired after result view detail button is pressed (list, table or grid). To use this event, set * the property 'resultviewMasterDetailMode' to 'true'. * * @since 1.140.0 * * @returns Reference to `this` in order to allow method chaining */ attachShowResultDetail( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:showResultDetail showResultDetail} event of * this `sap.esh.search.ui.SearchCompositeControl`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.esh.search.ui.SearchCompositeControl` itself. * * Event is fired after result view detail button is pressed (list, table or grid). To use this event, set * the property 'resultviewMasterDetailMode' to 'true'. * * @since 1.140.0 * * @returns Reference to `this` in order to allow method chaining */ attachShowResultDetail( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl` * itself */ oListener?: object ): this; /** * Clears the object selection in the search results list,table or grid. It is useful when you want to clear * any user selections and start fresh. * * @since 1.133.0 * * @returns void */ clearObjectSelection(): undefined; /** * Create an instance of a basket and register it for interaction with the result view (items/selection * indicator). See property 'basketLocation' in search model configuration to define where the basket panel * is located. * * @since 1.145.0 * * @returns A basket control of type sap.m.Table or sap.m.List containing items of the search basket ('selected * items') */ createAndRegisterBasket( /** * The ID postfix for the basket instance */ idPostfix: string, /** * The UI type table/list ("sapMList" | "sapMTable" | "sapUiTable") */ type: "sapMList" | "sapMTable" | "sapUiTable" ): object; /** * Create a NavigationTarget instance for filtering/search. * * Use this method for the creation a NavigationTarget instance with filter and label. * * @since 1.114.0 * * @returns The NavigationTarget instance. If the configuration parameter updateUrl is true, it contains * targetUrl, otherwise it contains targetFunction. */ createSearchNavigationTarget( /** * A sina filter object storing the searchterm, datasource and the filter conditions. */ filter: object, /** * The label of the navigation target. */ label: string ): object; /** * Create a NavigationTarget instance for hierarchy. * * Use this method for the creation a NavigationTarget instance by hierarchical node id value and its label. * * @since 1.114.0 * * @returns The NavigationTarget instance. If the configuration parameter updateUrl is true, it contains * targetUrl, otherwise it contains targetFunction. */ createStaticHierarchySearchNavigationTarget( /** * The hiearchical node id value of the giving datasource or its helper hierarchical datasource. */ hierarchyNodeId: object, /** * The label of the hiearchical node id. */ hierarchyNodeLabel: string, /** * The datasource instance. */ dataSource: object, /** * The label of the NavigatonTarget instance. */ navigationTargetLabel: string ): object; /** * Detaches event handler `fnFunction` from the {@link #event:basketChanged basketChanged} event of this * `sap.esh.search.ui.SearchCompositeControl`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.144.0 * * @returns Reference to `this` in order to allow method chaining */ detachBasketChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:resultViewSelectionChanged resultViewSelectionChanged } * event of this `sap.esh.search.ui.SearchCompositeControl`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.143 * * @returns Reference to `this` in order to allow method chaining */ detachResultViewSelectionChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:resultViewTypeChanged resultViewTypeChanged } * event of this `sap.esh.search.ui.SearchCompositeControl`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.124 * * @returns Reference to `this` in order to allow method chaining */ detachResultViewTypeChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:searchFinished searchFinished} event of this * `sap.esh.search.ui.SearchCompositeControl`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ detachSearchFinished( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:searchStarted searchStarted} event of this * `sap.esh.search.ui.SearchCompositeControl`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ detachSearchStarted( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChanged selectionChanged} event of * this `sap.esh.search.ui.SearchCompositeControl`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:showResultDetail showResultDetail} event of * this `sap.esh.search.ui.SearchCompositeControl`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.140.0 * * @returns Reference to `this` in order to allow method chaining */ detachShowResultDetail( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:basketChanged basketChanged} to attached listeners. * * @since 1.144.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireBasketChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:resultViewSelectionChanged resultViewSelectionChanged} to attached listeners. * * @since 1.143 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireResultViewSelectionChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:resultViewTypeChanged resultViewTypeChanged} to attached listeners. * * @since 1.124 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireResultViewTypeChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:searchFinished searchFinished} to attached listeners. * * @since 1.121 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSearchFinished( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:searchStarted searchStarted} to attached listeners. * * @since 1.121 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSearchStarted( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:selectionChanged selectionChanged} to attached listeners. * * @since 1.121 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelectionChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:showResultDetail showResultDetail} to attached listeners. * * @since 1.140.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireShowResultDetail( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getApplicationComponent applicationComponent}. * * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents. * * Default value is `"HAN-AS-INA-UI"`. * * @since 1.108.0 * * @returns Value of property `applicationComponent` */ getApplicationComponent(): string; /** * Gets current value of property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}. * * In case folder mode is active: Automatically switch result view type to list in search mode and to table * in folder mode. * * Default value is `false`. * * @since 1.106.0 * * @returns Value of property `autoAdjustResultViewTypeInFolderMode` */ getAutoAdjustResultViewTypeInFolderMode(): boolean; /** * Get the active/current search basket (see interfaceSearchBasketApi) * * @since 1.145.0 * * @returns A control containing other controls. At least one of the controls is the basket-list/table, * containg the 'selected items'. */ getBasket(): object; /** * Gets current value of property {@link #getBasketAddButton basketAddButton}. * * Enables the basket add button in the search result list. The button is displayed on the top of search * result view and allows to add result view items to the basket. Has no effect when basketLinkByResultViewItemSelection=true * — in that case items are added automatically via result view item selection and a manual add button is * redundant (a console warning is logged). * * Default value is `false`. * * @since 1.143.0 * * @returns Value of property `basketAddButton` */ getBasketAddButton(): boolean; /** * Gets current value of property {@link #getBasketAddButtonIcon basketAddButtonIcon}. * * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4". * * @since 1.143.0 * * @returns Value of property `basketAddButtonIcon` */ getBasketAddButtonIcon(): string; /** * Gets current value of property {@link #getBasketAddButtonText basketAddButtonText}. * * Custom text of button 'add items to basket'. By default the text is empty and the button will show the * icon, only. * * @since 1.143.0 * * @returns Value of property `basketAddButtonText` */ getBasketAddButtonText(): string; /** * Gets current value of property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}. * * Custom tooltip of button 'add items to basket'. By default there tooltip is 'Add to Basket'. * * @since 1.143.0 * * @returns Value of property `basketAddButtonTooltip` */ getBasketAddButtonTooltip(): string; /** * Gets current value of property {@link #getBasketBeforeAddItem basketBeforeAddItem}. * * Before new item is added to basket, this callback is called with the public item (search result) and * the new basket item You can adjust the model data of the basket item. * * @since 1.144.0 * * @returns Value of property `basketBeforeAddItem` */ getBasketBeforeAddItem(): Function; /** * Gets current value of property {@link #getBasketButtonsLocation basketButtonsLocation}. * * Location of the buttons to show/hide basket and add items to the basket. The buttons can be placed on * the left (begin) or on the right (end) of the search bar. By default the location is at the end (right), * values are "Begin", "Middle" and "End". * * Default value is `"End"`. * * @since 1.143.0 * * @returns Value of property `basketButtonsLocation` */ getBasketButtonsLocation(): string; /** * Gets current value of property {@link #getBasketInit basketInit}. * * When basket gets initialized, this callback is called with the columns of the (future) basket table. * You can add more columns or adjust the sequence of columns. * * @since 1.144.0 * * @returns Value of property `basketInit` */ getBasketInit(): Function; /** * Get items of the latest search basket ('selected items', JSON model) The model is read-only. * * @since 1.143.0 * * @returns A JSON model containing items of the search basket ('selected items') */ getBasketItems(): object; /** * Gets current value of property {@link #getBasketLinkByResultViewItemSelection basketLinkByResultViewItemSelection}. * * Items of the basket are automatically added/removed when selecting/deselecting items on result views. * Moreover all items of the basket are automatically selected on result views, if they are visible on the * current result view page. The basket show/hide button is rendered as a toggle button. The left button * shows available items (label: "Available"), the right button shows selected items (label: "Selected"). * You either see the result view (table, list or grid) or the basket. With release 1.148.0 the label, icon * and tooltip of the right button are controlled by the properties 'basketShowHideButtonText', 'basketShowHideButtonIcon' * and 'basketShowHideButtonTooltip'. * * Default value is `false`. * * @since 1.143.0 * * @returns Value of property `basketLinkByResultViewItemSelection` */ getBasketLinkByResultViewItemSelection(): boolean; /** * Gets current value of property {@link #getBasketLocation basketLocation}. * * Location of the basket. When creating your own basket (see function 'createAndRegisterBasket'), set this * property to "CustomBasketLocation". By default the basket is a panel at the right of the result view. * * Values: - "SidePanelRight" (default): basket is a panel at the right of the result view - "CustomBasketLocation": * basket is created by function 'createAndRegisterBasket' and can be placed anywhere in the UI * * Default value is `"SidePanelRight"`. * * @since 1.145.0 * * @returns Value of property `basketLocation` */ getBasketLocation(): string; /** * Gets current value of property {@link #getBasketPanelResizable basketPanelResizable}. * * Display a splitter bar to resize the right hand panel, containing the basket with selected items. * * Default value is `true`. * * @since 1.142.0 * * @returns Value of property `basketPanelResizable` */ getBasketPanelResizable(): boolean; /** * Get visibility status of basket panel * * @since 1.146.0 * * @returns boolean The visibility status of basket panel */ getBasketPanelVisibility(): undefined; /** * Gets current value of property {@link #getBasketPanelWidthInPercent basketPanelWidthInPercent}. * * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable" * is true, the width of the basket panel can be changed by the user. * * Default value is `100`. * * @since 1.142.0 * * @returns Value of property `basketPanelWidthInPercent` */ getBasketPanelWidthInPercent(): float; /** * Gets current value of property {@link #getBasketShowHideButtonIcon basketShowHideButtonIcon}. * * Custom icon of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection } * is true. In that case, the icon is applied to the right button part ("Selected") of the segmented toggle * button. * * @since 1.148.0 * * @returns Value of property `basketShowHideButtonIcon` */ getBasketShowHideButtonIcon(): string; /** * Gets current value of property {@link #getBasketShowHideButtonText basketShowHideButtonText}. * * Custom text of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection } * is true. In that case, the text is applied to the right button part ("Selected") of the segmented toggle * button. * * @since 1.148.0 * * @returns Value of property `basketShowHideButtonText` */ getBasketShowHideButtonText(): string; /** * Gets current value of property {@link #getBasketShowHideButtonTooltip basketShowHideButtonTooltip}. * * Custom tooltip of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection } * is true. In that case, the tooltip is applied to the right button part ("Selected") of the segmented * toggle button. * * @since 1.148.0 * * @returns Value of property `basketShowHideButtonTooltip` */ getBasketShowHideButtonTooltip(): string; /** * Gets current value of property {@link #getBasketVisibilityButton basketVisibilityButton}. * * Enables a button in the search result list to control basket panel visibility. Depending on the configuration, * this is either a show/hide button or an 'Available'/'Selected' toggle button (when basketLinkByResultViewItemSelection=true). * The button is only rendered when the basket feature is active (i.e. createAndRegisterBasket was called). * * Default value is `true`. * * @since 1.143.0 * * @returns Value of property `basketVisibilityButton` */ getBasketVisibilityButton(): boolean; /** * Gets current value of property {@link #getBoSuggestions boSuggestions}. * * A boolean for enabling (business) object suggestions. * * Default value is `false`. * * @since 1.113.0 * * @returns Value of property `boSuggestions` */ getBoSuggestions(): boolean; /** * Gets the settings. * * @since 1.125.0 * * @returns The settings (search configuration) */ getConfig(): object; /** * Gets current value of property {@link #getCssClass cssClass}. * * An additional CSS class to add to this control * * @since 1.93.0 * * @returns Value of property `cssClass` */ getCssClass(): string; /** * Gets current value of property {@link #getCustomBasket customBasket}. * * Define your own view for the basket. The basket is displayed on a panel at the right/end of result views * (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket * (see config properties 'basketVisibilityButton' and 'basketAddButton'). For the basket items collection, * we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl. * 'add to basket') of result views with table/list is managed by SearchCompositeControl. * * @since 1.144.0 * * @returns Value of property `customBasket` */ getCustomBasket(): Function; /** * Gets current value of property {@link #getCustomGridView customGridView}. * * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile'). * * @since 1.93.0 * * @returns Value of property `customGridView` */ getCustomGridView(): Function; /** * Gets current value of property {@link #getDataSource dataSource}. * * The id of the data source in which it will search right after initialization. * * @since 1.98.0 * * @returns Value of property `dataSource` */ getDataSource(): string; /** * Gets current value of property {@link #getDefaultDataSource defaultDataSource}. * * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource * will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource' * to 'true', do not set this parameter (will be ignored). * * @since 1.93.0 * * @returns Value of property `defaultDataSource` */ getDefaultDataSource(): string; /** * Gets current value of property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}. * * When set to true the facet panel is displayed also in case there are no search results. * * Default value is `false`. * * @since 1.113.0 * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled * by the end user. * * @returns Value of property `displayFacetPanelInCaseOfNoResults` */ getDisplayFacetPanelInCaseOfNoResults(): boolean; /** * Gets current value of property {@link #getEnableCharts enableCharts}. * * A boolean for enabling chart visualizations (pie chart / bar chart facets). If set to true, facets can * be viewed as a pie or bar chart (this cannot be deactivated at runtime). * * Default value is `false`. * * @since 1.140.0 * * @returns Value of property `enableCharts` */ getEnableCharts(): boolean; /** * Gets current value of property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}. * * Enables the multiselection mode of search result items. A checkbox is provided for each result item if * the value is set to 'true'. * * Default value is `false`. * * @since 1.96.0 * @deprecated As of version 1.141.0. use 'resultviewSelectionMode' instead. * * @returns Value of property `enableMultiSelectionResultItems` */ getEnableMultiSelectionResultItems(): boolean; /** * Gets current value of property {@link #getEnableQueryLanguage enableQueryLanguage}. * * Enables the query language for the hana_odata provider. With query language it is possible for the end * user to enter complex search queries with logical operators. * * Default value is `false`. * * @since 1.107.0 * * @returns Value of property `enableQueryLanguage` */ getEnableQueryLanguage(): boolean; /** * Returns all event consumers. * * @since 1.120.0 * * @returns List containing all event consumers. */ getEventConsumers(): object[]; /** * Gets current value of property {@link #getExclusiveDataSource exclusiveDataSource}. * * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet * panel) - data source name/link on result list (header section of item) * * @since 1.121.0 * * @returns Value of property `exclusiveDataSource` */ getExclusiveDataSource(): string; /** * Gets current value of property {@link #getFacetPanelResizable facetPanelResizable}. * * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria. * * Default value is `true`. * * @since 1.108.0 * * @returns Value of property `facetPanelResizable` */ getFacetPanelResizable(): boolean; /** * Gets current value of property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}. * * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable" * is true, the width of the facet panel can be changed by the user. * * Default value is `25`. * * @since 1.108.0 * * @returns Value of property `facetPanelWidthInPercent` */ getFacetPanelWidthInPercent(): float; /** * Gets current value of property {@link #getFacets facets}. * * Controls whether the facet functionality is available or not. * * Default value is `true`. * * @since 1.133.0 * * @returns Value of property `facets` */ getFacets(): boolean; /** * Gets current value of property {@link #getFacetToggleButtonLocation facetToggleButtonLocation}. * * Location of the button to show/hide facet panel. The button (filter icon) can be placed on the left (begin) * or on the right (end) of the search bar. By default the button's location is at the beginning (left), * values are "Begin" and "End". The property is not evaluated if facet panel is disabled, see property * 'facets'. * * Default value is `"Begin"`. * * @since 1.140.0 * * @returns Value of property `facetToggleButtonLocation` */ getFacetToggleButtonLocation(): string; /** * Gets current value of property {@link #getFacetVisibility facetVisibility}. * * A boolean which indicates whether the facet panel is initially opened or closed. This affects only the * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user, * depending on the user's personalization settings. * * Default value is `false`. * * @since 1.113.0 * * @returns Value of property `facetVisibility` */ getFacetVisibility(): boolean; /** * Gets the filter containing all attribute filters currently set and functions to manipulate the filter. * * @since 1.124.0 * * @returns The filter */ getFilter(): object; /** * Gets current value of property {@link #getFilterDataSources filterDataSources}. * * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets * a list of datsources and returns the filtered list of datasources. * * @since 1.112.0 * * @returns Value of property `filterDataSources` */ getFilterDataSources(): Function; /** * Gets current value of property {@link #getFilterRootCondition filterRootCondition}. * * Defines the filter root condition of a filter tree which shall be applied to the search request. This * control only allows filter trees which have a the following structure: complex condition (root level) * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions * which do not follow this structure won't be accepted and an error will be thrown. Please see the below * for a more in-depth example. * * @since 1.98.0 * * @returns Value of property `filterRootCondition` */ getFilterRootCondition(): object; /** * Gets current value of property {@link #getFolderMode folderMode}. * * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy. * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute) * are set. * * In folder mode and in case a folder filter is set the result view only shows direct children of a folder. * In contrast the counts in the facets are calculated by counting direct and not direct children. In case * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct * children of a folder. * * Default value is `false`. * * @since 1.106.0 * * @returns Value of property `folderMode` */ getFolderMode(): boolean; /** * Gets current value of property {@link #getFolderModeForInitialSearch folderModeForInitialSearch}. * * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode * is enabled. * * Default value is `false`. * * @since 1.114.0 * * @returns Value of property `folderModeForInitialSearch` */ getFolderModeForInitialSearch(): boolean; /** * Gets current value of property {@link #getFormatFilterBarText formatFilterBarText}. * * Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel). * * @since 1.120 * * @returns Value of property `formatFilterBarText` */ getFormatFilterBarText(): Function; /** * Gets current value of property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}. * * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control * to be more specific and add some hints, links, buttons or other content. * * @since 1.94.0 * * @returns Value of property `getCustomNoResultScreen` */ getGetCustomNoResultScreen(): Function; /** * Gets current value of property {@link #getGetCustomToolbar getCustomToolbar}. * * Define a custom toolbar. * * @since 1.93.0 * * @returns Value of property `getCustomToolbar` */ getGetCustomToolbar(): Function; /** * Gets current value of property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}. * * A callback which returns customized "label" for placeholder text of search box in case there is no search * term. The placeholder text (en) will be "Search In: ". * * * @returns Value of property `getSearchInputPlaceholderLabel` */ getGetSearchInputPlaceholderLabel(): Function; /** * Gets current value of property {@link #getInitAsync initAsync}. * * An asynchronues callback which is called after the initialization of the search composite control. * * @since 1.113.0 * * @returns Value of property `initAsync` */ getInitAsync(): Function; /** * Get the status of initialization. In unsuccessful case, the corresponding error instance is returned * either. * * @since 1.132.0 * * @returns Promise<{success: boolean;error?: Error;}> If success is true, the initialization was successful. * If success is false, the error property contains the error instance for further handling. */ getInitializationStatus(): object; /** * Gets current value of property {@link #getIsFilterBarVisible isFilterBarVisible}. * * Callback for checking whether the filter bar is visible. * * @since 1.120 * * @returns Value of property `isFilterBarVisible` */ getIsFilterBarVisible(): Function; /** * Gets current value of property {@link #getIsSearchUrl isSearchUrl}. * * A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns * 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case * of 'updateUrl = true'. * * @since 1.113.0 * * @returns Value of property `isSearchUrl` */ getIsSearchUrl(): Function; /** * Gets current value of property {@link #getLimitAjaxRequests limitAjaxRequests}. * * Prevents too many ajax requests in a short time. * * Default value is `true`. * * * @returns Value of property `limitAjaxRequests` */ getLimitAjaxRequests(): boolean; /** * Gets current value of property {@link #getOptimizeForValueHelp optimizeForValueHelp}. * * The layout is optimized for object selection / value help (narrow view w/o facet panel). * * @since 1.111.0 * * @returns Value of property `optimizeForValueHelp` */ getOptimizeForValueHelp(): boolean; /** * Gets current value of property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}. * * Shall the window title be overwritten by this control? If true, the control will set the current search * condition as window title. If false, it will not set or update the window title. * * @since 1.93.0 * * @returns Value of property `overwriteBrowserTitle` */ getOverwriteBrowserTitle(): boolean; /** * Gets current value of property {@link #getPageSize pageSize}. * * The maximum count of search result items displayed on a page after a search. By clicking 'Show More' * button, another page of result items of the same count (if available) will be displayed. * * Default value is `10`. * * @since 1.96.0 * * @returns Value of property `pageSize` */ getPageSize(): int; /** * Gets current value of property {@link #getParseSearchUrlParameters parseSearchUrlParameters}. * * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL * parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback * is not needed. * * @since 1.113.0 * * @returns Value of property `parseSearchUrlParameters` */ getParseSearchUrlParameters(): Function; /** * Gets current value of property {@link #getQuickSelectDataSources quickSelectDataSources}. * * A list of data sources to be displayed in the facet panel in the section "Collection". * * @since 1.113.0 * * @returns Value of property `quickSelectDataSources` */ getQuickSelectDataSources(): object; /** * Gets current value of property {@link #getRenderSearchUrl renderSearchUrl}. * * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns * the URL string. Typically you need to register this callback in case of 'updateUrl = true'. * * @since 1.113.0 * * @returns Value of property `renderSearchUrl` */ getRenderSearchUrl(): Function; /** * Gets current value of property {@link #getResultviewMasterDetailMode resultviewMasterDetailMode}. * * The result views are displayed in a master-detail mode. The event showResultDetail is fired whenever * the detail button/indicator is clicked. * * Default value is `false`. * * @since 1.140.0 * * @returns Value of property `resultviewMasterDetailMode` */ getResultviewMasterDetailMode(): boolean; /** * Gets current value of property {@link #getResultviewSelectionMode resultviewSelectionMode}. * * To select result view items, enable multi-selection or single-selection mode. Shows checkboxes ('MultipleItems') * or enables item press ('OneItem'). Values of configuration parameter `resultviewSelectionMode` are 'None', * 'OneItem' and 'MultipleItems'. To show a button for switching selection mode on/off, see 'showSelectionToggleButton'. * A checkbox is provided for each result item if the value is true. The setting is related to `resultviewMasterDetailMode` * (master-detail mode). The event `showResultDetail` is fired whenever the detail button is clicked. * * Default value is `"None"`. * * @since 1.141.0 * * @returns Value of property `resultviewSelectionMode` */ getResultviewSelectionMode(): string; /** * Gets current value of property {@link #getResultViewSettings resultViewSettings}. * * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes` * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType: * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes` * and `resultViewType` must be compatible to each other. * * After the result view type has been changed, the event 'resultViewTypeChanged' is fired. * * Default value is `...see text or source`. * * @since 1.100.0 * * @returns Value of property `resultViewSettings` */ getResultViewSettings(): string; /** * Gets current value of property {@link #getResultViewType resultViewType}. * * Defines active search result view type. The value can be set/get in attach event "searchFinished", and * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true): * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`. * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`. * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other. * * After the result view type has been changed, the event 'resultViewTypeChanged' is fired. * * Default value is `"searchResultList"`. * * @since 1.98.0 * * @returns Value of property `resultViewType` */ getResultViewType(): string; /** * Gets current value of property {@link #getResultViewTypes resultViewTypes}. * * Defines selectable search result view types. The value can be set/get in attach event "searchFinished". * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is * not switchable. Case 2: Search in All or other Category: result is switchable between different view * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3, * Search in Business Object: result is switchable between different view types. Possible values for the * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value * of `resultViewTypes` and `resultViewType` must be compatible to each other. * * After the result view type has been changed, the event 'resultViewTypeChanged' is fired. * * Default value is `["searchResultList", "searchResultTable"]`. * * @since 1.98.0 * * @returns Value of property `resultViewTypes` */ getResultViewTypes(): string[]; /** * Gets current value of property {@link #getSearchBarTitle searchBarTitle}. * * Show a text/title at the start(left) of the search bar. * * @since 1.143.0 * * @returns Value of property `searchBarTitle` */ getSearchBarTitle(): string; /** * Get the basket model ('selected items', 'count' : JSON model) The model is managed by SearchCompositeControl, * do not change it manually. * * @since 1.145.0 * * @returns A JSON model containing items of the search basket ('selected items', 'count') */ getSearchBasketModel(): object; /** * Gets current value of property {@link #getSearchInputLocation searchInputLocation}. * * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl) * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar". * * Default value is `"Top"`. * * @since 1.140.0 * * @returns Value of property `searchInputLocation` */ getSearchInputLocation(): string; /** * Gets current value of property {@link #getSearchOnStart searchOnStart}. * * Defines if the search composite control will send a search request directly after loading, using given * search term, data source and filter root condition settings. * * Default value is `true`. * * @since 1.93.0 * * @returns Value of property `searchOnStart` */ getSearchOnStart(): boolean; /** * Gets current value of property {@link #getSearchResultTableMaxNumberOfInitiallyVisibleColumns searchResultTableMaxNumberOfInitiallyVisibleColumns}. * * Set default number of visible columns of search result table. This is important when adding custom columns * by means of formatters. * * Default value is `6`. * * @since 1.142.0 * * @returns Value of property `searchResultTableMaxNumberOfInitiallyVisibleColumns` */ getSearchResultTableMaxNumberOfInitiallyVisibleColumns(): float; /** * Gets current value of property {@link #getSearchTerm searchTerm}. * * Defines the initial search term for the search input. * * Default value is `empty string`. * * @since 1.93.0 * * @returns Value of property `searchTerm` */ getSearchTerm(): string; /** * Gets current value of property {@link #getSearchTermLengthLimit searchTermLengthLimit}. * * Limit for length of searchterm. * * Default value is `1000`. * * * @returns Value of property `searchTermLengthLimit` */ getSearchTermLengthLimit(): int; /** * Gets current value of property {@link #getShowSelectionToggleButton showSelectionToggleButton}. * * Enables the selection toggle button in the search result list. The button is displayed on the top of * search result view and allows to toggle the selection of all result items. The button is only displayed * if the property 'resultviewSelectionMode' is not set to 'None'. * * Default value is `false`. * * @since 1.140.0 * * @returns Value of property `showSelectionToggleButton` */ getShowSelectionToggleButton(): boolean; /** * Gets current value of property {@link #getSinaConfiguration sinaConfiguration}. * * Configuration for the Enterprise Search Client API. * * @since 1.93.0 * * @returns Value of property `sinaConfiguration` */ getSinaConfiguration(): object; /** * Retrieves a list of filter conditions from the root filter that do not belong to the standard filter-by * conditions. These conditions often represent additional static or hierarchy-based filters that are not * meant to be displayed in the typical “filter-by” UI. * * This method is a convenience wrapper calling an internal engine-level function (`getStaticHierarchyFilterConditions`) * on the underlying `SearchModel`. * * @since 1.133.0 * * @returns An array of filter conditions which are considered "static hierarchy facet filter" conditions. */ getStaticHierarachyFilters(): object[]; /** * Gets current value of property {@link #getTabStripsFormatter tabStripsFormatter}. * * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed * in the tabstrips. * * @since 1.103.0 * * @returns Value of property `tabStripsFormatter` */ getTabStripsFormatter(): Function; /** * Gets current value of property {@link #getUpdateUrl updateUrl}. * * A boolean indicating that the search state is written to the URL. * * Default value is `true`. * * @since 1.113.0 * * @returns Value of property `updateUrl` */ getUpdateUrl(): boolean; /** * This method checks if the filter contains only static hierarchy facet filter conditions. * * @since 1.136.0 * * @returns true if the filter contains only static hierarchy facet filter conditions, false otherwise. */ hasStaticHierarchyFacetFilterConditionOnly(): boolean; /** * Invalidate the search cache. To trigger a search in addition, use function 'retriggerSearch' instead. * * @since 1.124.0 */ invalidateSearchResultCache(): Promise; /** * Resets the active data source which is selected in the data source drop down list to its default (see * 'defaultDataSource'/'exclusiveDataSource'). * * @since 1.124.0 */ resetDataSource( /** * If true, fires a search query right away. Set to 'false' for batch updates. */ fireQuery?: boolean ): this; /** * Resets the UI / search results (reset search query and fire a new search). * * @since 1.125.0 */ resetSearch(): Promise; /** * Fire a new search (includes invalidation of search cache). To invalidate the search cache w/o triggering * a new search, use function 'invalidateSearchResultCache' instead. * * @since 1.124.0 */ retriggerSearch(): Promise; /** * Invalidate the search cache and optionally fire a new search. Also see functions 'retriggerSearch' and * 'invalidateSearchResultCache'. * * @since 1.124.0 * * @returns Returns 'true' if the search query was fired, otherwise 'void'. */ search( /** * Indicates wether the search query should be resetted. Set to 'true' to reset the query. */ invalidateQuery?: boolean, /** * Indicates wether the search query should be sent to the search service or not. Set to 'false', to prevent * auto-update of search results. */ fireQuery?: boolean ): Promise; /** * Sets a new value for property {@link #getApplicationComponent applicationComponent}. * * Relevant for SAP partners and SAP, the "Application Component" you expect customers to create incidents. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"HAN-AS-INA-UI"`. * * @since 1.108.0 * * @returns Reference to `this` in order to allow method chaining */ setApplicationComponent( /** * New value for property `applicationComponent` */ sApplicationComponent?: string ): this; /** * Sets a new value for property {@link #getAutoAdjustResultViewTypeInFolderMode autoAdjustResultViewTypeInFolderMode}. * * In case folder mode is active: Automatically switch result view type to list in search mode and to table * in folder mode. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.106.0 * * @returns Reference to `this` in order to allow method chaining */ setAutoAdjustResultViewTypeInFolderMode( /** * New value for property `autoAdjustResultViewTypeInFolderMode` */ bAutoAdjustResultViewTypeInFolderMode?: boolean ): this; /** * Sets a new value for property {@link #getBasketAddButton basketAddButton}. * * Enables the basket add button in the search result list. The button is displayed on the top of search * result view and allows to add result view items to the basket. Has no effect when basketLinkByResultViewItemSelection=true * — in that case items are added automatically via result view item selection and a manual add button is * redundant (a console warning is logged). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.143.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketAddButton( /** * New value for property `basketAddButton` */ bBasketAddButton?: boolean ): this; /** * Sets a new value for property {@link #getBasketAddButtonIcon basketAddButtonIcon}. * * Custom icon of button 'add items to basket'. By default the icon is "sap-icon://cart-4". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.143.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketAddButtonIcon( /** * New value for property `basketAddButtonIcon` */ sBasketAddButtonIcon: string ): this; /** * Sets a new value for property {@link #getBasketAddButtonText basketAddButtonText}. * * Custom text of button 'add items to basket'. By default the text is empty and the button will show the * icon, only. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.143.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketAddButtonText( /** * New value for property `basketAddButtonText` */ sBasketAddButtonText: string ): this; /** * Sets a new value for property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}. * * Custom tooltip of button 'add items to basket'. By default there tooltip is 'Add to Basket'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.143.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketAddButtonTooltip( /** * New value for property `basketAddButtonTooltip` */ sBasketAddButtonTooltip: string ): this; /** * Sets a new value for property {@link #getBasketBeforeAddItem basketBeforeAddItem}. * * Before new item is added to basket, this callback is called with the public item (search result) and * the new basket item You can adjust the model data of the basket item. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.144.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketBeforeAddItem( /** * New value for property `basketBeforeAddItem` */ fnBasketBeforeAddItem: Function ): this; /** * Sets a new value for property {@link #getBasketButtonsLocation basketButtonsLocation}. * * Location of the buttons to show/hide basket and add items to the basket. The buttons can be placed on * the left (begin) or on the right (end) of the search bar. By default the location is at the end (right), * values are "Begin", "Middle" and "End". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"End"`. * * @since 1.143.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketButtonsLocation( /** * New value for property `basketButtonsLocation` */ sBasketButtonsLocation?: string ): this; /** * Sets a new value for property {@link #getBasketInit basketInit}. * * When basket gets initialized, this callback is called with the columns of the (future) basket table. * You can add more columns or adjust the sequence of columns. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.144.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketInit( /** * New value for property `basketInit` */ fnBasketInit: Function ): this; /** * Sets a new value for property {@link #getBasketLinkByResultViewItemSelection basketLinkByResultViewItemSelection}. * * Items of the basket are automatically added/removed when selecting/deselecting items on result views. * Moreover all items of the basket are automatically selected on result views, if they are visible on the * current result view page. The basket show/hide button is rendered as a toggle button. The left button * shows available items (label: "Available"), the right button shows selected items (label: "Selected"). * You either see the result view (table, list or grid) or the basket. With release 1.148.0 the label, icon * and tooltip of the right button are controlled by the properties 'basketShowHideButtonText', 'basketShowHideButtonIcon' * and 'basketShowHideButtonTooltip'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.143.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketLinkByResultViewItemSelection( /** * New value for property `basketLinkByResultViewItemSelection` */ bBasketLinkByResultViewItemSelection?: boolean ): this; /** * Sets a new value for property {@link #getBasketLocation basketLocation}. * * Location of the basket. When creating your own basket (see function 'createAndRegisterBasket'), set this * property to "CustomBasketLocation". By default the basket is a panel at the right of the result view. * * Values: - "SidePanelRight" (default): basket is a panel at the right of the result view - "CustomBasketLocation": * basket is created by function 'createAndRegisterBasket' and can be placed anywhere in the UI * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"SidePanelRight"`. * * @since 1.145.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketLocation( /** * New value for property `basketLocation` */ sBasketLocation?: string ): this; /** * Sets a new value for property {@link #getBasketPanelResizable basketPanelResizable}. * * Display a splitter bar to resize the right hand panel, containing the basket with selected items. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.142.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketPanelResizable( /** * New value for property `basketPanelResizable` */ bBasketPanelResizable?: boolean ): this; /** * Set visibility status of basket panel * * @since 1.146.0 * * @returns boolean The visibility status of basket panel */ setBasketPanelVisibility(): undefined; /** * Sets a new value for property {@link #getBasketPanelWidthInPercent basketPanelWidthInPercent}. * * Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable" * is true, the width of the basket panel can be changed by the user. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `100`. * * @since 1.142.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketPanelWidthInPercent( /** * New value for property `basketPanelWidthInPercent` */ fBasketPanelWidthInPercent?: float ): this; /** * Sets a new value for property {@link #getBasketShowHideButtonIcon basketShowHideButtonIcon}. * * Custom icon of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection } * is true. In that case, the icon is applied to the right button part ("Selected") of the segmented toggle * button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.148.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketShowHideButtonIcon( /** * New value for property `basketShowHideButtonIcon` */ sBasketShowHideButtonIcon: string ): this; /** * Sets a new value for property {@link #getBasketShowHideButtonText basketShowHideButtonText}. * * Custom text of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection } * is true. In that case, the text is applied to the right button part ("Selected") of the segmented toggle * button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.148.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketShowHideButtonText( /** * New value for property `basketShowHideButtonText` */ sBasketShowHideButtonText: string ): this; /** * Sets a new value for property {@link #getBasketShowHideButtonTooltip basketShowHideButtonTooltip}. * * Custom tooltip of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection } * is true. In that case, the tooltip is applied to the right button part ("Selected") of the segmented * toggle button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.148.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketShowHideButtonTooltip( /** * New value for property `basketShowHideButtonTooltip` */ sBasketShowHideButtonTooltip: string ): this; /** * Sets a new value for property {@link #getBasketVisibilityButton basketVisibilityButton}. * * Enables a button in the search result list to control basket panel visibility. Depending on the configuration, * this is either a show/hide button or an 'Available'/'Selected' toggle button (when basketLinkByResultViewItemSelection=true). * The button is only rendered when the basket feature is active (i.e. createAndRegisterBasket was called). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.143.0 * * @returns Reference to `this` in order to allow method chaining */ setBasketVisibilityButton( /** * New value for property `basketVisibilityButton` */ bBasketVisibilityButton?: boolean ): this; /** * Sets a new value for property {@link #getBoSuggestions boSuggestions}. * * A boolean for enabling (business) object suggestions. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.113.0 * * @returns Reference to `this` in order to allow method chaining */ setBoSuggestions( /** * New value for property `boSuggestions` */ bBoSuggestions?: boolean ): this; /** * Sets a new value for property {@link #getCssClass cssClass}. * * An additional CSS class to add to this control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.93.0 * * @returns Reference to `this` in order to allow method chaining */ setCssClass( /** * New value for property `cssClass` */ sCssClass: string ): this; /** * Sets a new value for property {@link #getCustomBasket customBasket}. * * Define your own view for the basket. The basket is displayed on a panel at the right/end of result views * (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket * (see config properties 'basketVisibilityButton' and 'basketAddButton'). For the basket items collection, * we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl. * 'add to basket') of result views with table/list is managed by SearchCompositeControl. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.144.0 * * @returns Reference to `this` in order to allow method chaining */ setCustomBasket( /** * New value for property `customBasket` */ fnCustomBasket: Function ): this; /** * Sets a new value for property {@link #getCustomGridView customGridView}. * * Define your own rendering of result items (we recommend to use 'sap.m.GridContainer' and 'sap.m.GenericTile'). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.93.0 * * @returns Reference to `this` in order to allow method chaining */ setCustomGridView( /** * New value for property `customGridView` */ fnCustomGridView: Function ): this; /** * Sets a new value for property {@link #getDataSource dataSource}. * * The id of the data source in which it will search right after initialization. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.98.0 * * @returns Reference to `this` in order to allow method chaining */ setDataSource( /** * New value for property `dataSource` */ sDataSource: string ): this; /** * Sets a new value for property {@link #getDefaultDataSource defaultDataSource}. * * Data source id which is set when the UI is loaded or filter is reset. If dataSource is also set, dataSource * will be used during UI load and this parameter will used only after filter is reset. When setting 'exclusiveDataSource' * to 'true', do not set this parameter (will be ignored). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.93.0 * * @returns Reference to `this` in order to allow method chaining */ setDefaultDataSource( /** * New value for property `defaultDataSource` */ sDefaultDataSource: string ): this; /** * Sets a new value for property {@link #getDisplayFacetPanelInCaseOfNoResults displayFacetPanelInCaseOfNoResults}. * * When set to true the facet panel is displayed also in case there are no search results. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.113.0 * @deprecated As of version 1.134.0. this setting is ignored and the visibility of the facet panel is controlled * by the end user. * * @returns Reference to `this` in order to allow method chaining */ setDisplayFacetPanelInCaseOfNoResults( /** * New value for property `displayFacetPanelInCaseOfNoResults` */ bDisplayFacetPanelInCaseOfNoResults?: boolean ): this; /** * Sets a new value for property {@link #getEnableCharts enableCharts}. * * A boolean for enabling chart visualizations (pie chart / bar chart facets). If set to true, facets can * be viewed as a pie or bar chart (this cannot be deactivated at runtime). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.140.0 * * @returns Reference to `this` in order to allow method chaining */ setEnableCharts( /** * New value for property `enableCharts` */ bEnableCharts?: boolean ): this; /** * Sets a new value for property {@link #getEnableMultiSelectionResultItems enableMultiSelectionResultItems}. * * Enables the multiselection mode of search result items. A checkbox is provided for each result item if * the value is set to 'true'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.96.0 * @deprecated As of version 1.141.0. use 'resultviewSelectionMode' instead. * * @returns Reference to `this` in order to allow method chaining */ setEnableMultiSelectionResultItems( /** * New value for property `enableMultiSelectionResultItems` */ bEnableMultiSelectionResultItems?: boolean ): this; /** * Sets a new value for property {@link #getEnableQueryLanguage enableQueryLanguage}. * * Enables the query language for the hana_odata provider. With query language it is possible for the end * user to enter complex search queries with logical operators. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.107.0 * * @returns Reference to `this` in order to allow method chaining */ setEnableQueryLanguage( /** * New value for property `enableQueryLanguage` */ bEnableQueryLanguage?: boolean ): this; /** * Sets a list of event consumers. * * @since 1.120.0 */ setEventConsumers( /** * List containing all event consumers. */ eventConsumers: object[] ): SearchCompositeControl; /** * Sets a new value for property {@link #getExclusiveDataSource exclusiveDataSource}. * * Data source id which is set when the UI is loaded and cannot be changed at run time. The following UI * parts will be hidden: - data source select (dropdown) - data source tab bar - data source facet (facet * panel) - data source name/link on result list (header section of item) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.121.0 * * @returns Reference to `this` in order to allow method chaining */ setExclusiveDataSource( /** * New value for property `exclusiveDataSource` */ sExclusiveDataSource: string ): this; /** * Sets a new value for property {@link #getFacetPanelResizable facetPanelResizable}. * * Display a splitter bar to resize the left hand panel, containing all facets and filter criteria. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.108.0 * * @returns Reference to `this` in order to allow method chaining */ setFacetPanelResizable( /** * New value for property `facetPanelResizable` */ bFacetPanelResizable?: boolean ): this; /** * Sets a new value for property {@link #getFacetPanelWidthInPercent facetPanelWidthInPercent}. * * Default size (percent) of the left hand panel, containing all facets and filter criteria. If "facetPanelResizable" * is true, the width of the facet panel can be changed by the user. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `25`. * * @since 1.108.0 * * @returns Reference to `this` in order to allow method chaining */ setFacetPanelWidthInPercent( /** * New value for property `facetPanelWidthInPercent` */ fFacetPanelWidthInPercent?: float ): this; /** * Sets a new value for property {@link #getFacets facets}. * * Controls whether the facet functionality is available or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.133.0 * * @returns Reference to `this` in order to allow method chaining */ setFacets( /** * New value for property `facets` */ bFacets?: boolean ): this; /** * Sets a new value for property {@link #getFacetToggleButtonLocation facetToggleButtonLocation}. * * Location of the button to show/hide facet panel. The button (filter icon) can be placed on the left (begin) * or on the right (end) of the search bar. By default the button's location is at the beginning (left), * values are "Begin" and "End". The property is not evaluated if facet panel is disabled, see property * 'facets'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"Begin"`. * * @since 1.140.0 * * @returns Reference to `this` in order to allow method chaining */ setFacetToggleButtonLocation( /** * New value for property `facetToggleButtonLocation` */ sFacetToggleButtonLocation?: string ): this; /** * Sets a new value for property {@link #getFacetVisibility facetVisibility}. * * A boolean which indicates whether the facet panel is initially opened or closed. This affects only the * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user, * depending on the user's personalization settings. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.113.0 * * @returns Reference to `this` in order to allow method chaining */ setFacetVisibility( /** * New value for property `facetVisibility` */ bFacetVisibility?: boolean ): this; /** * Sets a new value for property {@link #getFilterDataSources filterDataSources}. * * Callback for filtering the datasources displayed in the datasource dropdown listbox. The callback gets * a list of datsources and returns the filtered list of datasources. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.112.0 * * @returns Reference to `this` in order to allow method chaining */ setFilterDataSources( /** * New value for property `filterDataSources` */ fnFilterDataSources: Function ): this; /** * Sets a new value for property {@link #getFilterRootCondition filterRootCondition}. * * Defines the filter root condition of a filter tree which shall be applied to the search request. This * control only allows filter trees which have a the following structure: complex condition (root level) * \ complex condition (attribute level) \ simple condition (attribute value level) Filter root conditions * which do not follow this structure won't be accepted and an error will be thrown. Please see the below * for a more in-depth example. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.98.0 * * @returns Reference to `this` in order to allow method chaining */ setFilterRootCondition( /** * New value for property `filterRootCondition` */ oFilterRootCondition: object ): this; /** * Sets a new value for property {@link #getFolderMode folderMode}. * * Activates the folder mode. Precondition for folder mode is 1) Search model: In the search model for the * current datasource a hierarchy attribute (representing the folders) is defined 1.1) the hierarchy attribute * is annotated with displayType=TREE and for the hierarchy there is a helper connector representing the * hierarchy or 1.2) the current datasource is the helper datasource representing the folder hierarchy. * The hierarchy attribute is annotated with displayType=FLAT 2) Search query: The folder mode is only active * in case the search query has an empty search term and no filter conditions (except the hierarchy attribute) * are set. * * In folder mode and in case a folder filter is set the result view only shows direct children of a folder. * In contrast the counts in the facets are calculated by counting direct and not direct children. In case * the folder mode is not active the UI uses the search mode: The result list shows direct and not direct * children of a folder. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.106.0 * * @returns Reference to `this` in order to allow method chaining */ setFolderMode( /** * New value for property `folderMode` */ bFolderMode?: boolean ): this; /** * Sets a new value for property {@link #getFolderModeForInitialSearch folderModeForInitialSearch}. * * In case folderMode is set to true this boolean indicates whether for the initial search the folder mode * is enabled. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.114.0 * * @returns Reference to `this` in order to allow method chaining */ setFolderModeForInitialSearch( /** * New value for property `folderModeForInitialSearch` */ bFolderModeForInitialSearch?: boolean ): this; /** * Sets a new value for property {@link #getFormatFilterBarText formatFilterBarText}. * * Callback for formatting the filter string to be displayed on the filter bar (for closed facet panel). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.120 * * @returns Reference to `this` in order to allow method chaining */ setFormatFilterBarText( /** * New value for property `formatFilterBarText` */ fnFormatFilterBarText: Function ): this; /** * Sets a new value for property {@link #getGetCustomNoResultScreen getCustomNoResultScreen}. * * Whenever a search has no results, a 'No Results Screen' is displayed. You can provide a custom control * to be more specific and add some hints, links, buttons or other content. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.94.0 * * @returns Reference to `this` in order to allow method chaining */ setGetCustomNoResultScreen( /** * New value for property `getCustomNoResultScreen` */ fnGetCustomNoResultScreen: Function ): this; /** * Sets a new value for property {@link #getGetCustomToolbar getCustomToolbar}. * * Define a custom toolbar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.93.0 * * @returns Reference to `this` in order to allow method chaining */ setGetCustomToolbar( /** * New value for property `getCustomToolbar` */ fnGetCustomToolbar: Function ): this; /** * Sets a new value for property {@link #getGetSearchInputPlaceholderLabel getSearchInputPlaceholderLabel}. * * A callback which returns customized "label" for placeholder text of search box in case there is no search * term. The placeholder text (en) will be "Search In: ". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setGetSearchInputPlaceholderLabel( /** * New value for property `getSearchInputPlaceholderLabel` */ fnGetSearchInputPlaceholderLabel: Function ): this; /** * Sets a new value for property {@link #getInitAsync initAsync}. * * An asynchronues callback which is called after the initialization of the search composite control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.113.0 * * @returns Reference to `this` in order to allow method chaining */ setInitAsync( /** * New value for property `initAsync` */ fnInitAsync: Function ): this; /** * Sets a new value for property {@link #getIsFilterBarVisible isFilterBarVisible}. * * Callback for checking whether the filter bar is visible. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.120 * * @returns Reference to `this` in order to allow method chaining */ setIsFilterBarVisible( /** * New value for property `isFilterBarVisible` */ fnIsFilterBarVisible: Function ): this; /** * Sets a new value for property {@link #getIsSearchUrl isSearchUrl}. * * A callback for checking whether a URL is a search-relevant URL. The callback receives a URL and returns * 'true' in case the URL is a search-relevant URL. Typically you need to register this callback in case * of 'updateUrl = true'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.113.0 * * @returns Reference to `this` in order to allow method chaining */ setIsSearchUrl( /** * New value for property `isSearchUrl` */ fnIsSearchUrl: Function ): this; /** * Sets a new value for property {@link #getLimitAjaxRequests limitAjaxRequests}. * * Prevents too many ajax requests in a short time. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setLimitAjaxRequests( /** * New value for property `limitAjaxRequests` */ bLimitAjaxRequests?: boolean ): this; /** * Sets a new value for property {@link #getOptimizeForValueHelp optimizeForValueHelp}. * * The layout is optimized for object selection / value help (narrow view w/o facet panel). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.111.0 * * @returns Reference to `this` in order to allow method chaining */ setOptimizeForValueHelp( /** * New value for property `optimizeForValueHelp` */ bOptimizeForValueHelp: boolean ): this; /** * Sets a new value for property {@link #getOverwriteBrowserTitle overwriteBrowserTitle}. * * Shall the window title be overwritten by this control? If true, the control will set the current search * condition as window title. If false, it will not set or update the window title. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.93.0 * * @returns Reference to `this` in order to allow method chaining */ setOverwriteBrowserTitle( /** * New value for property `overwriteBrowserTitle` */ bOverwriteBrowserTitle: boolean ): this; /** * Sets a new value for property {@link #getPageSize pageSize}. * * The maximum count of search result items displayed on a page after a search. By clicking 'Show More' * button, another page of result items of the same count (if available) will be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `10`. * * @since 1.96.0 * * @returns Reference to `this` in order to allow method chaining */ setPageSize( /** * New value for property `pageSize` */ iPageSize?: int ): this; /** * Sets a new value for property {@link #getParseSearchUrlParameters parseSearchUrlParameters}. * * A callback for parsing URL parameters. The callback receices URL parameters and returns modified URL * parameters. This is an optional callback. In case you set 'updateUrl = true' typcically this callback * is not needed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.113.0 * * @returns Reference to `this` in order to allow method chaining */ setParseSearchUrlParameters( /** * New value for property `parseSearchUrlParameters` */ fnParseSearchUrlParameters: Function ): this; /** * Sets a new value for property {@link #getQuickSelectDataSources quickSelectDataSources}. * * A list of data sources to be displayed in the facet panel in the section "Collection". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.113.0 * * @returns Reference to `this` in order to allow method chaining */ setQuickSelectDataSources( /** * New value for property `quickSelectDataSources` */ oQuickSelectDataSources: object ): this; /** * Sets a new value for property {@link #getRenderSearchUrl renderSearchUrl}. * * A callback for rendering the search URL. The callback gets a list of url encoded parameters and returns * the URL string. Typically you need to register this callback in case of 'updateUrl = true'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.113.0 * * @returns Reference to `this` in order to allow method chaining */ setRenderSearchUrl( /** * New value for property `renderSearchUrl` */ fnRenderSearchUrl: Function ): this; /** * Sets a new value for property {@link #getResultviewMasterDetailMode resultviewMasterDetailMode}. * * The result views are displayed in a master-detail mode. The event showResultDetail is fired whenever * the detail button/indicator is clicked. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.140.0 * * @returns Reference to `this` in order to allow method chaining */ setResultviewMasterDetailMode( /** * New value for property `resultviewMasterDetailMode` */ bResultviewMasterDetailMode?: boolean ): this; /** * Sets a new value for property {@link #getResultviewSelectionMode resultviewSelectionMode}. * * To select result view items, enable multi-selection or single-selection mode. Shows checkboxes ('MultipleItems') * or enables item press ('OneItem'). Values of configuration parameter `resultviewSelectionMode` are 'None', * 'OneItem' and 'MultipleItems'. To show a button for switching selection mode on/off, see 'showSelectionToggleButton'. * A checkbox is provided for each result item if the value is true. The setting is related to `resultviewMasterDetailMode` * (master-detail mode). The event `showResultDetail` is fired whenever the detail button is clicked. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"None"`. * * @since 1.141.0 * * @returns Reference to `this` in order to allow method chaining */ setResultviewSelectionMode( /** * New value for property `resultviewSelectionMode` */ sResultviewSelectionMode?: string ): this; /** * Sets a new value for property {@link #getResultViewSettings resultViewSettings}. * * Defines a pair of search result view settings. The value is an object of properties `resultViewTypes` * and `resultViewType`. An example: `{resultViewTypes: ["searchResultList", "searchResultTable"], resultViewType: * "searchResultList"}` Find more detail in the definition of each child property. The value can be set/get * in attached event "searchFinished". Function `setResultViewSettings` prevents incompatibility of sequential * execution of functions `setResultViewTypes` and `setResultViewType`. Note: The value of `resultViewTypes` * and `resultViewType` must be compatible to each other. * * After the result view type has been changed, the event 'resultViewTypeChanged' is fired. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `...see text or source`. * * @since 1.100.0 * * @returns Reference to `this` in order to allow method chaining */ setResultViewSettings( /** * New value for property `resultViewSettings` */ sResultViewSettings?: string ): this; /** * Sets a new value for property {@link #getResultViewType resultViewType}. * * Defines active search result view type. The value can be set/get in attach event "searchFinished", and * it must be contained in resultViewTypes. Case 1, Search in Apps: result is displayed in a mandatory view * type `"appSearchResult"`. Case 2.1, Search in All or other Category (configuration.isUshell !== true): * result is switchable between different view types. Possible value is `"searchResultList"`, or `"searchResultGrid"`. * Case 2.2, Search in All or other Category (configuration.isUshell === true): result is displayed in a * mandatory view type `"searchResultList"`. Case 3, Search in Business Object: result is switchable between * different view types. Possible value is `"searchResultList"`, `"searchResultTable"` or `"searchResultGrid"`. * Note: The value of `resultViewTypes` and `resultViewType` must be compatible to each other. * * After the result view type has been changed, the event 'resultViewTypeChanged' is fired. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"searchResultList"`. * * @since 1.98.0 * * @returns Reference to `this` in order to allow method chaining */ setResultViewType( /** * New value for property `resultViewType` */ sResultViewType?: string ): this; /** * Sets a new value for property {@link #getResultViewTypes resultViewTypes}. * * Defines selectable search result view types. The value can be set/get in attach event "searchFinished". * Case 1: Search in Apps: result is displayed in a mandatory view type `["appSearchResult"]`, and it is * not switchable. Case 2: Search in All or other Category: result is switchable between different view * types. Possible values for the array items are `"searchResultList"` and `"searchResultGrid"`. Case 3, * Search in Business Object: result is switchable between different view types. Possible values for the * array items are `"searchResultList"`, `"searchResultTable"` and `"searchResultGrid"`. Note: The value * of `resultViewTypes` and `resultViewType` must be compatible to each other. * * After the result view type has been changed, the event 'resultViewTypeChanged' is fired. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `["searchResultList", "searchResultTable"]`. * * @since 1.98.0 * * @returns Reference to `this` in order to allow method chaining */ setResultViewTypes( /** * New value for property `resultViewTypes` */ sResultViewTypes?: string[] ): this; /** * Sets a new value for property {@link #getSearchBarTitle searchBarTitle}. * * Show a text/title at the start(left) of the search bar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.143.0 * * @returns Reference to `this` in order to allow method chaining */ setSearchBarTitle( /** * New value for property `searchBarTitle` */ sSearchBarTitle: string ): this; /** * Sets a new value for property {@link #getSearchInputLocation searchInputLocation}. * * Location of the search input box. The search input can be placed on the top of the control (SearchCompositeControl) * or as part of the search bar. By default the location is at the top, values are "Top" and "Searchbar". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"Top"`. * * @since 1.140.0 * * @returns Reference to `this` in order to allow method chaining */ setSearchInputLocation( /** * New value for property `searchInputLocation` */ sSearchInputLocation?: string ): this; /** * Sets a new value for property {@link #getSearchOnStart searchOnStart}. * * Defines if the search composite control will send a search request directly after loading, using given * search term, data source and filter root condition settings. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.93.0 * * @returns Reference to `this` in order to allow method chaining */ setSearchOnStart( /** * New value for property `searchOnStart` */ bSearchOnStart?: boolean ): this; /** * Sets a new value for property {@link #getSearchResultTableMaxNumberOfInitiallyVisibleColumns searchResultTableMaxNumberOfInitiallyVisibleColumns}. * * Set default number of visible columns of search result table. This is important when adding custom columns * by means of formatters. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `6`. * * @since 1.142.0 * * @returns Reference to `this` in order to allow method chaining */ setSearchResultTableMaxNumberOfInitiallyVisibleColumns( /** * New value for property `searchResultTableMaxNumberOfInitiallyVisibleColumns` */ fSearchResultTableMaxNumberOfInitiallyVisibleColumns?: float ): this; /** * Sets a new value for property {@link #getSearchTerm searchTerm}. * * Defines the initial search term for the search input. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * @since 1.93.0 * * @returns Reference to `this` in order to allow method chaining */ setSearchTerm( /** * New value for property `searchTerm` */ sSearchTerm?: string ): this; /** * Sets a new value for property {@link #getSearchTermLengthLimit searchTermLengthLimit}. * * Limit for length of searchterm. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1000`. * * * @returns Reference to `this` in order to allow method chaining */ setSearchTermLengthLimit( /** * New value for property `searchTermLengthLimit` */ iSearchTermLengthLimit?: int ): this; /** * Sets a new value for property {@link #getShowSelectionToggleButton showSelectionToggleButton}. * * Enables the selection toggle button in the search result list. The button is displayed on the top of * search result view and allows to toggle the selection of all result items. The button is only displayed * if the property 'resultviewSelectionMode' is not set to 'None'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.140.0 * * @returns Reference to `this` in order to allow method chaining */ setShowSelectionToggleButton( /** * New value for property `showSelectionToggleButton` */ bShowSelectionToggleButton?: boolean ): this; /** * Sets a new value for property {@link #getSinaConfiguration sinaConfiguration}. * * Configuration for the Enterprise Search Client API. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.93.0 * * @returns Reference to `this` in order to allow method chaining */ setSinaConfiguration( /** * New value for property `sinaConfiguration` */ oSinaConfiguration: object ): this; /** * Sets a new value for property {@link #getTabStripsFormatter tabStripsFormatter}. * * Function callback for formatting the datasource tabstrips in the top toolbar. To the callback function * a list of datasources is passed. The callback functions return a modified list of datasources to be displayed * in the tabstrips. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.103.0 * * @returns Reference to `this` in order to allow method chaining */ setTabStripsFormatter( /** * New value for property `tabStripsFormatter` */ fnTabStripsFormatter: Function ): this; /** * Sets a new value for property {@link #getUpdateUrl updateUrl}. * * A boolean indicating that the search state is written to the URL. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.113.0 * * @returns Reference to `this` in order to allow method chaining */ setUpdateUrl( /** * New value for property `updateUrl` */ bUpdateUrl?: boolean ): this; /** * Update hierarchy facet Updates the one and only (static) hierarchy facet (tree control on facet panel). * If no hierarchy facet exists, nothing will happen. * * @since 1.126.0 */ updateStaticHierarchyFacet(): Promise; } /** * Event object of the SearchCompositeControl#basketChanged event. */ type SearchCompositeControl$BasketChangedEvent = sap.ui.base.Event< SearchCompositeControl$BasketChangedEventParameters, SearchCompositeControl >; /** * Event object of the SearchCompositeControl#resultViewSelectionChanged event. */ type SearchCompositeControl$ResultViewSelectionChangedEvent = sap.ui.base.Event< SearchCompositeControl$ResultViewSelectionChangedEventParameters, SearchCompositeControl >; /** * Event object of the SearchCompositeControl#resultViewTypeChanged event. */ type SearchCompositeControl$ResultViewTypeChangedEvent = sap.ui.base.Event< SearchCompositeControl$ResultViewTypeChangedEventParameters, SearchCompositeControl >; /** * Event object of the SearchCompositeControl#searchFinished event. */ type SearchCompositeControl$SearchFinishedEvent = sap.ui.base.Event< SearchCompositeControl$SearchFinishedEventParameters, SearchCompositeControl >; /** * Event object of the SearchCompositeControl#searchStarted event. */ type SearchCompositeControl$SearchStartedEvent = sap.ui.base.Event< SearchCompositeControl$SearchStartedEventParameters, SearchCompositeControl >; /** * Event object of the SearchCompositeControl#selectionChanged event. */ type SearchCompositeControl$SelectionChangedEvent = sap.ui.base.Event< SearchCompositeControl$SelectionChangedEventParameters, SearchCompositeControl >; /** * Event object of the SearchCompositeControl#showResultDetail event. */ type SearchCompositeControl$ShowResultDetailEvent = sap.ui.base.Event< SearchCompositeControl$ShowResultDetailEventParameters, SearchCompositeControl >; } } } interface IUI5DefineDependencyNames { "sap/esh/search/ui/controls/basket/CustomBasket": undefined; "sap/esh/search/ui/controls/basket/SearchBasketAddButton": undefined; "sap/esh/search/ui/controls/resultview/SearchShowDetailButton": undefined; "sap/esh/search/ui/controls/resultview/SearchText": undefined; "sap/esh/search/ui/controls/SearchLink": undefined; "sap/esh/search/ui/library": undefined; "sap/esh/search/ui/SearchCompositeControl": undefined; } }