@sapui5/types 1.121.2 → 1.122.1

package/types/sap.sac.df.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.121.2
+// For Library Version: 1.122.0
 
 declare module "sap/sac/df/library" {}
 
@@ -81,10 +81,6 @@ declare module "sap/sac/df/FilterBar" {
     $FilterBarSettings as $FilterBarSettings1,
   } from "sap/ui/mdc/FilterBar";
 
-  import Event from "sap/ui/base/Event";
-
-  import FieldDisplay from "sap/ui/mdc/enums/FieldDisplay";
-
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
@@ -136,304 +132,245 @@ declare module "sap/sac/df/FilterBar" {
      */
     static getMetadata(): ElementMetadata;
     /**
-     * Attaches event handler `fnFunction` to the {@link #event:beforeFilterChange beforeFilterChange} event
-     * of this `sap.sac.df.FilterBar`.
-     *
-     * 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.sac.df.FilterBar` itself.
+     * Gets current value of property {@link #getMetaPath metaPath}.
      *
-     * Fires before update variable of multidimension model after input value or open value help of variable.
+     * Defines the relative path of the property in the metamodel, based on the current contextPath.
      *
      *
-     * @returns Reference to `this` in order to allow method chaining
+     * @returns Value of property `metaPath`
      */
-    attachBeforeFilterChange(
-      /**
-       * 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: FilterBar$BeforeFilterChangeEvent) => void,
-      /**
-       * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
-       */
-      oListener?: object
-    ): this;
+    getMetaPath(): string;
     /**
-     * Attaches event handler `fnFunction` to the {@link #event:beforeFilterChange beforeFilterChange} event
-     * of this `sap.sac.df.FilterBar`.
+     * Gets current value of property {@link #getMode mode}.
      *
-     * 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.sac.df.FilterBar` itself.
+     * Mode
      *
-     * Fires before update variable of multidimension model after input value or open value help of variable.
+     * Default value is `"VariablesOfDataProvider"`.
      *
+     * @deprecated - please use the property `metaPath` instead
      *
-     * @returns Reference to `this` in order to allow method chaining
+     * @returns Value of property `mode`
      */
-    attachBeforeFilterChange(
-      /**
-       * The function to be called when the event occurs
-       */
-      fnFunction: (p1: FilterBar$BeforeFilterChangeEvent) => void,
-      /**
-       * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
-       */
-      oListener?: object
-    ): this;
+    getMode(): string;
     /**
-     * Attaches event handler `fnFunction` to the {@link #event:cancelFilterChange cancelFilterChange} event
-     * of this `sap.sac.df.FilterBar`.
+     * Sets a new value for property {@link #getMetaPath metaPath}.
      *
-     * 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.sac.df.FilterBar` itself.
+     * Defines the relative path of the property in the metamodel, based on the current contextPath.
      *
-     * Fires when cancel change in the value help dialog.
+     * 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
      */
-    attachCancelFilterChange(
-      /**
-       * An application-specific payload object that will be passed to the event handler along with the event
-       * object when firing the event
-       */
-      oData: object,
+    setMetaPath(
       /**
-       * 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.sac.df.FilterBar` itself
+       * New value for property `metaPath`
        */
-      oListener?: object
+      sMetaPath: string
     ): this;
     /**
-     * Attaches event handler `fnFunction` to the {@link #event:cancelFilterChange cancelFilterChange} event
-     * of this `sap.sac.df.FilterBar`.
+     * Sets a new value for property {@link #getMode mode}.
      *
-     * 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.sac.df.FilterBar` itself.
+     * Mode
      *
-     * Fires when cancel change in the value help dialog.
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"VariablesOfDataProvider"`.
      *
+     * @deprecated - please use the property `metaPath` instead
      *
      * @returns Reference to `this` in order to allow method chaining
      */
-    attachCancelFilterChange(
-      /**
-       * The function to be called when the event occurs
-       */
-      fnFunction: (p1: Event) => void,
+    setMode(
       /**
-       * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
+       * New value for property `mode`
        */
-      oListener?: object
+      sMode?: string
     ): this;
+  }
+
+  export interface $FilterBarSettings extends $FilterBarSettings1 {
     /**
-     * Detaches event handler `fnFunction` from the {@link #event:beforeFilterChange beforeFilterChange} event
-     * of this `sap.sac.df.FilterBar`.
-     *
-     * The passed function and listener object must match the ones used for event registration.
-     *
+     * Defines the relative path of the property in the metamodel, based on the current contextPath.
+     */
+    metaPath?: string | PropertyBindingInfo;
+
+    /**
+     * Mode
      *
-     * @returns Reference to `this` in order to allow method chaining
+     * @deprecated - please use the property `metaPath` instead
      */
-    detachBeforeFilterChange(
-      /**
-       * The function to be called, when the event occurs
-       */
-      fnFunction: (p1: FilterBar$BeforeFilterChangeEvent) => void,
+    mode?: string | PropertyBindingInfo;
+  }
+}
+
+declare module "sap/sac/df/FilterField" {
+  import {
+    default as FieldBase,
+    $FieldBaseSettings,
+  } from "sap/ui/mdc/field/FieldBase";
+
+  import { IFormContent, ISemanticFormContent } from "sap/ui/core/library";
+
+  import { IOverflowToolbarContent } from "sap/m/library";
+
+  import ElementMetadata from "sap/ui/core/ElementMetadata";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  /**
+   * The `FilterField` control is used to filter data based on the conditions. The conditions are managed
+   * in the corresponding {@link sap.ui.mdc.condition.ConditionModel ConditionModel}. That is why the `conditions`
+   * property must be bound to the related conditions in the {@link sap.ui.mdc.condition.ConditionModel ConditionModel}.
+   * The type of this data must be defined in the `dataType` property.
+   *
+   * Based on the data type settings, a default control is rendered by the `FilterField` as follows:
+   *
+   *
+   * 	 - In display mode, usually a {@link sap.m.Text Text} control is rendered.
+   * 	 - If `multipleLines` is set, an {@link sap.m.ExpandableText ExpandableText} control is rendered.
+   * 	 - If multiple values are allowed, a {@link sap.m.Tokenizer Tokenizer} control is rendered.
+   * 	 - In edit mode, usually an {@link sap.m.Input Input} control is rendered.
+   * 	 - If multiple values are allowed, a {@link sap.m.MultiInput MultiInput} control is rendered.
+   * 	 - If `multipleLines` is set, a {@link sap.m.TextArea TextArea} control is rendered.
+   * 	 - If a date type or a date/time type is used, a {@link sap.m.DateRangeSelection DateRangeSelection }
+   *     control is rendered.
+   * 	 - If a date type is used and only single values are allowed, a {@link sap.m.DatePicker DatePicker }
+   *     control is rendered.
+   * 	 - If a date type is used and only single ranges are allowed, a {@link sap.m.DateRangeSelection DateRangeSelection }
+   *     control is rendered.
+   * 	 - If a date/time type is used and only single values are allowed, a {@link sap.m.DateTimePicker DateTimePicker }
+   *     control is rendered.
+   * 	 - If a time type is used and only single values are allowed, a {@link sap.m.TimePicker TimePicker }
+   *     control is rendered.
+   * 	 - If used for search, a {@link sap.m.SearchField SearchField} control is rendered.
+   *
+   * @since 1.48.0
+   * @experimental (since 1.48.0)
+   */
+  export default class FilterField
+    extends FieldBase
+    implements IFormContent, ISemanticFormContent, IOverflowToolbarContent {
+    __implements__sap_ui_core_IFormContent: boolean;
+    __implements__sap_ui_core_ISemanticFormContent: boolean;
+    __implements__sap_m_IOverflowToolbarContent: boolean;
+    /**
+     * Constructor for a new `FilterField`.
+     */
+    constructor(
       /**
-       * Context object on which the given function had to be called
+       * Initial settings for the new control
        */
-      oListener?: object
-    ): this;
+      mSettings?: $FilterFieldSettings
+    );
     /**
-     * Detaches event handler `fnFunction` from the {@link #event:cancelFilterChange cancelFilterChange} event
-     * of this `sap.sac.df.FilterBar`.
-     *
-     * The passed function and listener object must match the ones used for event registration.
-     *
-     *
-     * @returns Reference to `this` in order to allow method chaining
+     * Constructor for a new `FilterField`.
      */
-    detachCancelFilterChange(
+    constructor(
       /**
-       * The function to be called, when the event occurs
+       * ID for the new control, generated automatically if no ID is given
        */
-      fnFunction: (p1: Event) => void,
+      sId?: string,
       /**
-       * Context object on which the given function had to be called
+       * Initial settings for the new control
        */
-      oListener?: object
-    ): this;
+      mSettings?: $FilterFieldSettings
+    );
+
     /**
-     * Fires event {@link #event:beforeFilterChange beforeFilterChange} to attached listeners.
+     * Creates a new subclass of class sap.sac.df.FilterField with name `sClassName` and enriches it with the
+     * information contained in `oClassInfo`.
      *
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.FilterField.extend}.
      *
-     * @returns Reference to `this` in order to allow method chaining
+     *
+     * @returns Created class / constructor function
      */
-    fireBeforeFilterChange(
+    static extend<T extends Record<string, unknown>>(
       /**
-       * Parameters to pass along with the event
+       * Name of the class being created
        */
-      mParameters?: FilterBar$BeforeFilterChangeEventParameters
-    ): this;
-    /**
-     * Fires event {@link #event:cancelFilterChange cancelFilterChange} to attached listeners.
-     *
-     * @ui5-protected Do not call from applications (only from related classes in the framework)
-     *
-     * @returns Reference to `this` in order to allow method chaining
-     */
-    fireCancelFilterChange(
+      sClassName: string,
       /**
-       * Parameters to pass along with the event
+       * Object literal with information about the class
        */
-      mParameters?: object
-    ): this;
-    /**
-     * Gets current value of property {@link #getDisplay display}.
-     *
-     * Defines whether the value and/or description of the field is shown and in which order.
-     *
-     * Default value is `ValueDescription`.
-     *
-     *
-     * @returns Value of property `display`
-     */
-    getDisplay(): FieldDisplay | keyof typeof FieldDisplay;
+      oClassInfo?: sap.ClassInfo<T, FilterField>,
+      /**
+       * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+       * used by this class
+       */
+      FNMetaImpl?: Function
+    ): Function;
     /**
-     * Gets current value of property {@link #getMode mode}.
-     *
-     * Mode
-     *
-     * Default value is `"VariablesOfDataProvider"`.
+     * Returns a metadata object for class sap.sac.df.FilterField.
      *
      *
-     * @returns Value of property `mode`
+     * @returns Metadata object describing this class
      */
-    getMode(): string;
+    static getMetadata(): ElementMetadata;
     /**
-     * Gets current value of property {@link #getMultiDimModelId multiDimModelId}.
+     * Gets current value of property {@link #getMetaPath metaPath}.
      *
-     * ID of multiDimModel
-     *
-     * Default value is `"om"`.
+     * Defines the relative path of the property in the metamodel, based on the current contextPath.
      *
      *
-     * @returns Value of property `multiDimModelId`
+     * @returns Value of property `metaPath`
      */
-    getMultiDimModelId(): string;
+    getMetaPath(): string;
     /**
-     * Sets a new value for property {@link #getDisplay display}.
-     *
-     * Defines whether the value and/or description of the field is shown and in which order.
-     *
-     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     * Gets current value of property {@link #getSearchAttributes searchAttributes}.
      *
-     * Default value is `ValueDescription`.
+     * Search attributes for the token validation. Available options are Key and Text
      *
      *
-     * @returns Reference to `this` in order to allow method chaining
+     * @returns Value of property `searchAttributes`
      */
-    setDisplay(
-      /**
-       * New value for property `display`
-       */
-      sDisplay?: FieldDisplay | keyof typeof FieldDisplay
-    ): this;
+    getSearchAttributes(): string[];
     /**
-     * Sets a new value for property {@link #getMode mode}.
+     * Sets a new value for property {@link #getMetaPath metaPath}.
      *
-     * Mode
+     * Defines the relative path of the property in the metamodel, based on the current contextPath.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
-     * Default value is `"VariablesOfDataProvider"`.
-     *
      *
      * @returns Reference to `this` in order to allow method chaining
      */
-    setMode(
+    setMetaPath(
       /**
-       * New value for property `mode`
+       * New value for property `metaPath`
        */
-      sMode?: string
+      sMetaPath: string
     ): this;
     /**
-     * Sets a new value for property {@link #getMultiDimModelId multiDimModelId}.
+     * Sets a new value for property {@link #getSearchAttributes searchAttributes}.
      *
-     * ID of multiDimModel
+     * Search attributes for the token validation. Available options are Key and Text
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
-     * Default value is `"om"`.
-     *
      *
      * @returns Reference to `this` in order to allow method chaining
      */
-    setMultiDimModelId(
+    setSearchAttributes(
       /**
-       * New value for property `multiDimModelId`
+       * New value for property `searchAttributes`
        */
-      sMultiDimModelId?: string
+      sSearchAttributes: string[]
     ): this;
   }
 
-  export interface $FilterBarSettings extends $FilterBarSettings1 {
+  export interface $FilterFieldSettings extends $FieldBaseSettings {
     /**
-     * ID of multiDimModel
+     * Defines the relative path of the property in the metamodel, based on the current contextPath.
      */
-    multiDimModelId?: string | PropertyBindingInfo;
+    metaPath?: string | PropertyBindingInfo;
 
     /**
-     * Mode
-     */
-    mode?: string | PropertyBindingInfo;
-
-    /**
-     * Defines whether the value and/or description of the field is shown and in which order.
-     */
-    display?:
-      | (FieldDisplay | keyof typeof FieldDisplay)
-      | PropertyBindingInfo
-      | `{${string}}`;
-
-    /**
-     * Fires before update variable of multidimension model after input value or open value help of variable.
+     * Search attributes for the token validation. Available options are Key and Text
      */
-    beforeFilterChange?: (oEvent: FilterBar$BeforeFilterChangeEvent) => void;
-
-    /**
-     * Fires when cancel change in the value help dialog.
-     */
-    cancelFilterChange?: (oEvent: Event) => void;
+    searchAttributes?: string[] | PropertyBindingInfo | `{${string}}`;
   }
-
-  export interface FilterBar$BeforeFilterChangeEventParameters {
-    /**
-     * Indicates whether value help dialog is going to open.
-     */
-    beforeValueHelpOpen?: boolean;
-  }
-
-  export type FilterBar$BeforeFilterChangeEvent = Event<
-    FilterBar$BeforeFilterChangeEventParameters,
-    FilterBar
-  >;
-
-  export interface FilterBar$CancelFilterChangeEventParameters {}
-
-  export type FilterBar$CancelFilterChangeEvent = Event<
-    FilterBar$CancelFilterChangeEventParameters,
-    FilterBar
-  >;
 }
 
 declare module "sap/sac/df/FlexAnalysis" {
@@ -452,6 +389,8 @@ declare module "sap/sac/df/FlexAnalysis" {
 
   import SystemType from "sap/sac/df/types/SystemType";
 
+  import Event from "sap/ui/base/Event";
+
   /**
    * Enables users to view, navigate and change multidimensional data exposed via InA.
    *
@@ -520,6 +459,53 @@ declare module "sap/sac/df/FlexAnalysis" {
        */
       oCustomPanel: FlexAnalysisPanel
     ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.FlexAnalysis`.
+     *
+     * 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.sac.df.FlexAnalysis` itself.
+     *
+     * Fires on cell click event
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachOnCellClick(
+      /**
+       * 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: FlexAnalysis$OnCellClickEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.sac.df.FlexAnalysis` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.FlexAnalysis`.
+     *
+     * 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.sac.df.FlexAnalysis` itself.
+     *
+     * Fires on cell click event
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachOnCellClick(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: FlexAnalysis$OnCellClickEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.sac.df.FlexAnalysis` itself
+       */
+      oListener?: object
+    ): this;
     /**
      * Binds property {@link #getDataProvider dataProvider} to model data.
      *
@@ -542,6 +528,37 @@ declare module "sap/sac/df/FlexAnalysis" {
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyCustomPanels(): this;
+    /**
+     * Detaches event handler `fnFunction` from the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.FlexAnalysis`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachOnCellClick(
+      /**
+       * The function to be called, when the event occurs
+       */
+      fnFunction: (p1: FlexAnalysis$OnCellClickEvent) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Fires event {@link #event:onCellClick onCellClick} to attached listeners.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    fireOnCellClick(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: FlexAnalysis$OnCellClickEventParameters
+    ): this;
     /**
      * Gets current value of property {@link #getAutoUpdate autoUpdate}.
      *
@@ -1479,7 +1496,24 @@ declare module "sap/sac/df/FlexAnalysis" {
       | FlexAnalysisPanel
       | AggregationBindingInfo
       | `{${string}}`;
+
+    /**
+     * Fires on cell click event
+     */
+    onCellClick?: (oEvent: FlexAnalysis$OnCellClickEvent) => void;
   }
+
+  export interface FlexAnalysis$OnCellClickEventParameters {
+    /**
+     * Cell context
+     */
+    cellContext?: object;
+  }
+
+  export type FlexAnalysis$OnCellClickEvent = Event<
+    FlexAnalysis$OnCellClickEventParameters,
+    FlexAnalysis
+  >;
 }
 
 declare module "sap/sac/df/FlexAnalysisPanel" {
@@ -2930,6 +2964,30 @@ declare module "sap/sac/df/model/MultiDimModel" {
        */
       oProperties: Object
     ): Promise<VariableGroup>;
+    /**
+     * Creates a new variable group and attaches it to the model.
+     *
+     * A variable group defines which variables of the underlying data providers should behave as the same variable.
+     * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
+     *
+     *
+     * @returns created variable group
+     */
+    createVariableGroup(
+      /**
+       * Variable group name
+       */
+      sVariableGroupName: string,
+      /**
+       * Rule is a function which accept the variable definition and decides if the variable has to be part of
+       * te group.
+       */
+      fnRule: Function,
+      /**
+       * Additional properties
+       */
+      oProperties: Object
+    ): VariableGroup;
     /**
      * Updates the model from the given the model state including all aggregated data providers
      *
@@ -2982,6 +3040,18 @@ declare module "sap/sac/df/model/MultiDimModel" {
        */
       oParameters?: object
     ): this;
+    /**
+     * Fires event {@link #event:variableGroupsAdded variableGroupsAdded} to attached listeners.
+     *
+     *
+     * @returns Reference to this in order to allow method chaining
+     */
+    fireVariableGroupsAdded(
+      /**
+       * Parameters to pass along with the event
+       */
+      oParameters?: object
+    ): this;
     /**
      * Get a data provider
      *
@@ -3086,6 +3156,21 @@ declare module "sap/sac/df/model/MultiDimModel" {
        */
       mMessages: Record<string, Message[]>
     ): void;
+    /**
+     * Set variable groups.
+     *
+     * A variable group defines which variables of the underlying data providers should behave as the same variable.
+     * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
+     *
+     *
+     * @returns Promise which resolves the created variable group
+     */
+    setVariableGroups(
+      /**
+       * array of variable groups
+       */
+      aVariableGroups: VariableGroup[]
+    ): Promise<VariableGroup[]>;
   }
 
   export interface MultiDimModel$DataProviderAddedEventParameters {}
@@ -3641,6 +3726,8 @@ declare namespace sap {
 
     "sap/sac/df/FilterBar": undefined;
 
+    "sap/sac/df/FilterField": undefined;
+
     "sap/sac/df/FlexAnalysis": undefined;
 
     "sap/sac/df/FlexAnalysisPanel": undefined;