@sapui5/ts-types-esm 1.139.0 → 1.141.0

package/types/sap.esh.search.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.139.0
+// For Library Version: 1.141.1
 
 declare module "sap/esh/search/ui/SearchCompositeControl" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
@@ -296,6 +296,61 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       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: 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: Event) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.esh.search.ui.SearchCompositeControl`
+       * itself
+       */
+      oListener?: object
+    ): this;
     /**
      * Detaches event handler `fnFunction` from the {@link #event:resultViewTypeChanged resultViewTypeChanged }
      * event of this `sap.esh.search.ui.SearchCompositeControl`.
@@ -376,6 +431,26 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       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: Event) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
     /**
      * Fires event {@link #event:resultViewTypeChanged resultViewTypeChanged} to attached listeners.
      *
@@ -432,6 +507,20 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       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}.
      *
@@ -515,6 +604,19 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * @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}.
      *
@@ -524,6 +626,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * Default value is `false`.
      *
      * @since 1.96.0
+     * @deprecated As of version 1.141.0. use 'resultviewSelectionMode' instead.
      *
      * @returns Value of property `enableMultiSelectionResultItems`
      */
@@ -602,6 +705,22 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * @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
+     * @experimental As of version 1.140.0. this feature is experimental and the API may change.
+     *
+     * @returns Value of property `facetToggleButtonLocation`
+     */
+    getFacetToggleButtonLocation(): string;
     /**
      * Gets current value of property {@link #getFacetVisibility facetVisibility}.
      *
@@ -826,6 +945,35 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * @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}.
      *
@@ -886,6 +1034,20 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * @returns Value of property `resultViewTypes`
      */
     getResultViewTypes(): string[];
+    /**
+     * 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
+     * @experimental As of version 1.140.0. this feature is experimental and the API may change.
+     *
+     * @returns Value of property `searchInputLocation`
+     */
+    getSearchInputLocation(): string;
     /**
      * Gets current value of property {@link #getSearchOnStart searchOnStart}.
      *
@@ -933,6 +1095,20 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * @returns Value of property `selectionChange`
      */
     getSelectionChange(): Function;
+    /**
+     * 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}.
      *
@@ -1149,6 +1325,26 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       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}.
      *
@@ -1160,6 +1356,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * 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
      */
@@ -1285,6 +1482,29 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       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
+     * @experimental As of version 1.140.0. this feature is experimental and the API may change.
+     *
+     * @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}.
      *
@@ -1623,6 +1843,49 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       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}.
      *
@@ -1704,6 +1967,27 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       sResultViewTypes?: 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
+     * @experimental As of version 1.140.0. this feature is experimental and the API may change.
+     *
+     * @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}.
      *
@@ -1779,6 +2063,27 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       fnSelectionChange: Function
     ): 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}.
      *
@@ -1947,6 +2252,14 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      */
     resultViewSettings?: string | 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 | 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
@@ -2038,6 +2351,15 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
       | 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
+     * @experimental As of version 1.140.0. this feature is experimental and the API may change.
+     */
+    searchInputLocation?: string | 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.
@@ -2086,6 +2408,25 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      */
     facetVisibility?: boolean | 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
+     * @experimental As of version 1.140.0. this feature is experimental and the API may change.
+     */
+    facetToggleButtonLocation?: string | PropertyBindingInfo;
+
+    /**
+     * 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 | PropertyBindingInfo | `{${string}}`;
+
     /**
      * A boolean for enabling (business) object suggestions.
      *
@@ -2165,12 +2506,33 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * the value is set to 'true'.
      *
      * @since 1.96.0
+     * @deprecated As of version 1.141.0. use 'resultviewSelectionMode' instead.
      */
     enableMultiSelectionResultItems?:
       | boolean
       | 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 | 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 | 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.
@@ -2239,6 +2601,14 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * @since 1.124
      */
     resultViewTypeChanged?: (oEvent: 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: Event) => void;
   }
 
   /**
@@ -2292,6 +2662,19 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
     SearchCompositeControl$SelectionChangedEventParameters,
     SearchCompositeControl
   >;
+
+  /**
+   * Parameters of the SearchCompositeControl#showResultDetail event.
+   */
+  export interface SearchCompositeControl$ShowResultDetailEventParameters {}
+
+  /**
+   * Event object of the SearchCompositeControl#showResultDetail event.
+   */
+  export type SearchCompositeControl$ShowResultDetailEvent = Event<
+    SearchCompositeControl$ShowResultDetailEventParameters,
+    SearchCompositeControl
+  >;
 }
 
 declare module "sap/esh/search/ui/library" {}