@sapui5/ts-types-esm 1.135.0 → 1.136.0

package/types/sap.fe.macros.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.135.0
+// For Library Version: 1.136.0
 
 declare module "sap/fe/macros/Chart" {
   import {
@@ -651,6 +651,189 @@ declare module "sap/fe/macros/MacroAPI" {
   }
 }
 
+declare module "sap/fe/macros/MessageButton" {
+  import {
+    default as BuildingBlock,
+    $BuildingBlockSettings,
+  } from "sap/fe/core/buildingBlocks/BuildingBlock";
+
+  import Event from "sap/ui/base/Event";
+
+  /**
+   * Building block used to show bound messages.
+   * The Message Button Building Block gets the bound messages from the MessageModel.
+   * Usage example:
+   *
+   * ```javascript
+   *
+   * <macros:MessageButton visibilityChange=".handler.onMessageButtonVisibilityChange" />
+   * ```
+   *
+   *
+   *
+   * @experimental
+   */
+  export default class MessageButton extends BuildingBlock {}
+  /**
+   * Describes the settings that can be provided to the MessageButton constructor.
+   *
+   * @experimental
+   */
+  export interface $MessageButtonSettings extends $BuildingBlockSettings {}
+
+  /**
+   * Parameters of the MessageButton#visibilityChange event.
+   */
+  export interface MessageButton$VisibilityChangeEventParameters {}
+
+  /**
+   * Event object of the MessageButton#visibilityChange event.
+   */
+  export type MessageButton$VisibilityChangeEvent = Event<
+    MessageButton$VisibilityChangeEventParameters,
+    MessageButton
+  >;
+}
+
+declare module "sap/fe/macros/MicroChart" {
+  import {
+    default as BuildingBlock,
+    $BuildingBlockSettings,
+  } from "sap/fe/core/buildingBlocks/BuildingBlock";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  /**
+   * Building block used to create a MicroChart based on the metadata provided by OData V4.
+   * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/microchart/ Overview of Micro Chart Building Block}
+   *
+   *
+   * Usually, a contextPath and metaPath is expected.
+   *
+   * Usage example:
+   *
+   * ```javascript
+   *
+   * <macros:MicroChart id="MyMicroChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
+   * ```
+   *
+   *
+   * ```javascript
+   *
+   * sap.ui.require(["sap/fe/macros/MicroChart"], function(MicroChart) {
+   * 	 ...
+   * 	 new MicroChart("myMicroChart", {metaPath:"@com.sap.vocabularies.UI.v1.Chart"})
+   * })
+   * ```
+   *
+   *
+   *
+   * @since 1.93.0
+   */
+  export default class MicroChart extends BuildingBlock {
+    /**
+     * Gets current value of property contextPath.
+     *
+     *
+     * @returns Value of property `contextPath`
+     */
+    getContextPath(): string;
+    /**
+     * Gets current value of property hideOnNoData.
+     *
+     *
+     * @returns Value of property `hideOnNoData`
+     */
+    getHideOnNoData(): boolean;
+    /**
+     * Gets current value of property metaPath.
+     *
+     *
+     * @returns Value of property `metaPath`
+     */
+    getMetaPath(): string;
+    /**
+     * Gets current value of property showOnlyChart.
+     *
+     *
+     * @returns Value of property `showOnlyChart`
+     */
+    getShowOnlyChart(): boolean;
+    /**
+     * Gets current value of property size.
+     *
+     *
+     * @returns Value of property `size`
+     */
+    getSize(): string;
+    /**
+     * Gets current value of property contextPath.
+     *
+     *
+     * @returns Value of property `contextPath`
+     */
+    setContextPath(): string;
+    /**
+     * Gets current value of property hideOnNoData.
+     *
+     *
+     * @returns Value of property `hideOnNoData`
+     */
+    setHideOnNoData(): boolean;
+    /**
+     * Gets current value of property metaPath.
+     *
+     *
+     * @returns Value of property `metaPath`
+     */
+    setMetaPath(): string;
+    /**
+     * Gets current value of property showOnlyChart.
+     *
+     *
+     * @returns Value of property `showOnlyChart`
+     */
+    setShowOnlyChart(): boolean;
+    /**
+     * Gets current value of property size.
+     *
+     *
+     * @returns Value of property `size`
+     */
+    setSize(): string;
+  }
+  /**
+   * Describes the settings that can be provided to the MicroChart constructor.
+   */
+  export interface $MicroChartSettings extends $BuildingBlockSettings {
+    /**
+     * context path to the MicroChart.
+     */
+    contextPath?: string | PropertyBindingInfo;
+
+    /**
+     * Show blank space in case there is no data in the chart
+     */
+    hideOnNoData?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Metadata path to the  MicroChart.
+     */
+    metaPath?: string | PropertyBindingInfo;
+
+    /**
+     * To control the rendering of Title, Subtitle and Currency Labels. When the size is xs then we do
+     * not see the inner labels of the MicroChart as well.
+     */
+    showOnlyChart?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Size of the MicroChart
+     */
+    size?: string | PropertyBindingInfo;
+  }
+}
+
 declare module "sap/fe/macros/MultiValueField" {
   import {
     default as BuildingBlock,
@@ -712,6 +895,52 @@ declare module "sap/fe/macros/MultiValueField" {
   }
 }
 
+declare module "sap/fe/macros/Page" {
+  import {
+    default as BuildingBlock,
+    $BuildingBlockSettings,
+  } from "sap/fe/core/buildingBlocks/BuildingBlock";
+
+  import {
+    PropertyBindingInfo,
+    AggregationBindingInfo,
+  } from "sap/ui/base/ManagedObject";
+
+  import Control from "sap/ui/core/Control";
+
+  /**
+   * Provides a Page building block that can be used to create a page with a title and content
+   * By default, the page comes with an ObjectTitle
+   */
+  export default class Page extends BuildingBlock {}
+  /**
+   * Describes the settings that can be provided to the Page constructor.
+   */
+  export interface $PageSettings extends $BuildingBlockSettings {
+    /**
+     * Avatar source of the page. It is considered only if the title property is specified.
+     */
+    avatarSrc?: string | PropertyBindingInfo;
+
+    /**
+     * Description of the page. It is considered only if the title property is specified.
+     */
+    description?: string | PropertyBindingInfo;
+
+    /**
+     * Title of the page
+     * If title is not given, then we will add a title, avatar and description based on the unqualified HeaderInfo
+     * associated to the entity
+     */
+    title?: string | PropertyBindingInfo;
+
+    /**
+     * Content(s) of the page
+     */
+    items?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
+  }
+}
+
 declare module "sap/fe/macros/Paginator" {
   import {
     default as BuildingBlock,
@@ -2431,50 +2660,19 @@ declare module "sap/fe/macros/form/FormElement.block" {
   >;
 }
 
-declare module "sap/fe/macros/microchart/MicroChart.block" {
-  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
-
-  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
-
-  /**
-   * Building block used to create a MicroChart based on the metadata provided by OData V4.
-   * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/microchart/microChartDefault Overview of Building Blocks}
-   *
-   * @since 1.93.0
-   */
-  export default class MicroChart extends Control {}
-  /**
-   * Describes the settings that can be provided to the MicroChart constructor.
-   */
-  export interface $MicroChartSettings extends $ControlSettings {
-    /**
-     * Show blank space in case there is no data in the chart
-     */
-    hideOnNoData?: string | PropertyBindingInfo;
-
-    /**
-     * To control the rendering of Title, Subtitle and Currency Labels. When the size is xs then we do
-     * not see the inner labels of the MicroChart as well.
-     */
-    showOnlyChart?: string | PropertyBindingInfo;
-
-    /**
-     * Size of the MicroChart
-     */
-    size?: string | PropertyBindingInfo;
-  }
-}
-
 declare module "sap/fe/macros/microchart/MicroChart" {
   import {
-    default as BuildingBlockWithTemplating,
-    $BuildingBlockWithTemplatingSettings,
-  } from "sap/fe/macros/controls/BuildingBlockWithTemplating";
+    default as MicroChart1,
+    $MicroChartSettings as $MicroChartSettings1,
+  } from "sap/fe/macros/MicroChart";
 
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
 
   /**
    * Building block used to create a MicroChart based on the metadata provided by OData V4.
+   *
+   *
+   * Usually, a contextPath and metaPath is expected.
    * Usage example:
    *
    * ```javascript
@@ -2491,26 +2689,108 @@ declare module "sap/fe/macros/microchart/MicroChart" {
    * usage.
    *
    *
+   * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart } instead
    * @experimental
    */
-  export default class MicroChart extends BuildingBlockWithTemplating {}
+  export default class MicroChart extends MicroChart1 {
+    /**
+     * Gets current value of property contextPath.
+     *
+     *
+     * @returns Value of property `contextPath`
+     */
+    getContextPath(): string;
+    /**
+     * Gets current value of property hideOnNoData.
+     *
+     *
+     * @returns Value of property `hideOnNoData`
+     */
+    getHideOnNoData(): boolean;
+    /**
+     * Gets current value of property metaPath.
+     *
+     *
+     * @returns Value of property `metaPath`
+     */
+    getMetaPath(): string;
+    /**
+     * Gets current value of property showOnlyChart.
+     *
+     *
+     * @returns Value of property `showOnlyChart`
+     */
+    getShowOnlyChart(): boolean;
+    /**
+     * Gets current value of property size.
+     *
+     *
+     * @returns Value of property `size`
+     */
+    getSize(): string;
+    /**
+     * Gets current value of property contextPath.
+     *
+     *
+     * @returns Value of property `contextPath`
+     */
+    setContextPath(): string;
+    /**
+     * Gets current value of property hideOnNoData.
+     *
+     *
+     * @returns Value of property `hideOnNoData`
+     */
+    setHideOnNoData(): boolean;
+    /**
+     * Gets current value of property metaPath.
+     *
+     *
+     * @returns Value of property `metaPath`
+     */
+    setMetaPath(): string;
+    /**
+     * Gets current value of property showOnlyChart.
+     *
+     *
+     * @returns Value of property `showOnlyChart`
+     */
+    setShowOnlyChart(): boolean;
+    /**
+     * Gets current value of property size.
+     *
+     *
+     * @returns Value of property `size`
+     */
+    setSize(): string;
+  }
   /**
    * Describes the settings that can be provided to the MicroChart constructor.
    *
+   * @deprecated As of version 1.130. Use {@link sap.fe.macros.MicroChart } instead
    * @experimental
    */
-  export interface $MicroChartSettings
-    extends $BuildingBlockWithTemplatingSettings {
+  export interface $MicroChartSettings extends $MicroChartSettings1 {
+    /**
+     * context path to the MicroChart.
+     */
+    contextPath?: string | PropertyBindingInfo;
+
     /**
      * Show blank space in case there is no data in the chart
      */
-    hideOnNoData?: string | PropertyBindingInfo;
+    hideOnNoData?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Metadata path to the  MicroChart.
+     */
+    metaPath?: string | PropertyBindingInfo;
 
     /**
      * To control the rendering of Title, Subtitle and Currency Labels. When the size is xs then we do
      * not see the inner labels of the MicroChart as well.
      */
-    showOnlyChart?: string | PropertyBindingInfo;
+    showOnlyChart?: boolean | PropertyBindingInfo | `{${string}}`;
 
     /**
      * Size of the MicroChart
@@ -2610,6 +2890,8 @@ declare module "sap/fe/macros/table/Action" {
 
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
 
+  import Event from "sap/ui/base/Event";
+
   /**
    * Definition of a custom action to be used inside the table toolbar
    */
@@ -2651,11 +2933,6 @@ declare module "sap/fe/macros/table/Action" {
      */
     placement?: string | PropertyBindingInfo;
 
-    /**
-     * Event handler to be called when the user chooses the action
-     */
-    press?: string | PropertyBindingInfo;
-
     /**
      * Defines if the action requires a selection.
      */
@@ -2671,6 +2948,16 @@ declare module "sap/fe/macros/table/Action" {
      */
     visible?: boolean | PropertyBindingInfo | `{${string}}`;
   }
+
+  /**
+   * Parameters of the Action#press event.
+   */
+  export interface Action$PressEventParameters {}
+
+  /**
+   * Event object of the Action#press event.
+   */
+  export type Action$PressEvent = Event<Action$PressEventParameters, Action>;
 }
 
 declare module "sap/fe/macros/table/ActionGroup" {
@@ -2860,6 +3147,30 @@ declare module "sap/fe/macros/table/ActionOverride" {
   }
 }
 
+declare module "sap/fe/macros/table/AnalyticalConfiguration" {
+  import {
+    default as BuildingBlockObjectProperty,
+    $BuildingBlockObjectPropertySettings,
+  } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  /**
+   * A set of options that can be configured to control the aggregation behavior
+   */
+  export default class AnalyticalConfiguration extends BuildingBlockObjectProperty {}
+  /**
+   * Describes the settings that can be provided to the AnalyticalConfiguration constructor.
+   */
+  export interface $AnalyticalConfigurationSettings
+    extends $BuildingBlockObjectPropertySettings {
+    /**
+     * True if leaf level rows shall display aggregated data
+     */
+    aggregationOnLeafLevel?: boolean | PropertyBindingInfo | `{${string}}`;
+  }
+}
+
 declare module "sap/fe/macros/table/Column" {
   import {
     default as BuildingBlockObjectProperty,
@@ -3077,21 +3388,21 @@ declare module "sap/fe/macros/table/MassEdit" {
 
 declare module "sap/fe/macros/table/QuickVariantSelection" {
   import {
-    default as BuildingBlock,
-    $BuildingBlockSettings,
-  } from "sap/fe/core/buildingBlocks/BuildingBlock";
+    default as BuildingBlockObjectProperty,
+    $BuildingBlockObjectPropertySettings,
+  } from "sap/fe/macros/controls/BuildingBlockObjectProperty";
 
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
 
   /**
    * Definition of the quickVariantSelection to be used inside the table.
    */
-  export default class QuickVariantSelection extends BuildingBlock {}
+  export default class QuickVariantSelection extends BuildingBlockObjectProperty {}
   /**
    * Describes the settings that can be provided to the QuickVariantSelection constructor.
    */
   export interface $QuickVariantSelectionSettings
-    extends $BuildingBlockSettings {
+    extends $BuildingBlockObjectPropertySettings {
     /**
      * Defines the list of paths pointing to the selection variants that should be used as quick filters
      */
@@ -3127,6 +3438,8 @@ declare module "sap/fe/macros/table/Table.block" {
 
   import Action from "sap/fe/macros/table/Action";
 
+  import AnalyticalConfiguration from "sap/fe/macros/table/AnalyticalConfiguration";
+
   import ColumnOverride from "sap/fe/macros/table/ColumnOverride";
 
   import Column from "sap/fe/macros/table/Column";
@@ -3462,6 +3775,12 @@ declare module "sap/fe/macros/table/Table.block" {
      * - Column
      *
      * - Filter
+     *
+     * - Group
+     *
+     *
+     *
+     * The Group option is only applicable to analytical tables and responsive tables.
      */
     personalization?: string | PropertyBindingInfo;
 
@@ -3546,6 +3865,11 @@ declare module "sap/fe/macros/table/Table.block" {
       | AggregationBindingInfo
       | `{${string}}`;
 
+    /**
+     * A set of options that can be configured to control the aggregation behavior
+     */
+    analyticalConfiguration?: AnalyticalConfiguration;
+
     /**
      * Aggregate columns of the table.
      */
@@ -3634,6 +3958,8 @@ declare module "sap/fe/macros/table/Table" {
 
   import ActionGroup from "sap/fe/macros/table/ActionGroup";
 
+  import AnalyticalConfiguration from "sap/fe/macros/table/AnalyticalConfiguration";
+
   import ColumnOverride from "sap/fe/macros/table/ColumnOverride";
 
   import MassEdit from "sap/fe/macros/table/MassEdit";
@@ -4058,6 +4384,12 @@ declare module "sap/fe/macros/table/Table" {
      * - Column
      *
      * - Filter
+     *
+     * - Group
+     *
+     *
+     *
+     * The Group option is only applicable to analytical tables and responsive tables.
      */
     personalization?: string | PropertyBindingInfo;
 
@@ -4142,6 +4474,11 @@ declare module "sap/fe/macros/table/Table" {
       | AggregationBindingInfo
       | `{${string}}`;
 
+    /**
+     * A set of options that can be configured to control the aggregation behavior
+     */
+    analyticalConfiguration?: AnalyticalConfiguration;
+
     /**
      * Aggregate columns of the table.
      */
@@ -4302,6 +4639,8 @@ declare module "sap/fe/macros/table/TreeTable.block" {
 
   import Action from "sap/fe/macros/table/Action";
 
+  import AnalyticalConfiguration from "sap/fe/macros/table/AnalyticalConfiguration";
+
   import ColumnOverride from "sap/fe/macros/table/ColumnOverride";
 
   import Column from "sap/fe/macros/table/Column";
@@ -4592,10 +4931,20 @@ declare module "sap/fe/macros/table/TreeTable.block" {
     ignoredFields?: string | PropertyBindingInfo;
 
     /**
-     * Defines the extension point to control if a source node can be dropped on a specific parent node.
+     * Defines the extension point to control whether a source node can be copied to a specific parent node.
+     */
+    isCopyToPositionAllowed?: string | PropertyBindingInfo;
+
+    /**
+     * Defines the extension point to control whether a source node can be dropped on a specific parent node.
      */
     isMoveToPositionAllowed?: string | PropertyBindingInfo;
 
+    /**
+     * efines the extension point to control whether a node can be copied.
+     */
+    isNodeCopyable?: string | PropertyBindingInfo;
+
     /**
      * Defines the extension point to control if a node can be dragged.
      */
@@ -4637,6 +4986,12 @@ declare module "sap/fe/macros/table/TreeTable.block" {
      * - Column
      *
      * - Filter
+     *
+     * - Group
+     *
+     *
+     *
+     * The Group option is only applicable to analytical tables and responsive tables.
      */
     personalization?: string | PropertyBindingInfo;
 
@@ -4722,6 +5077,11 @@ declare module "sap/fe/macros/table/TreeTable.block" {
       | AggregationBindingInfo
       | `{${string}}`;
 
+    /**
+     * A set of options that can be configured to control the aggregation behavior
+     */
+    analyticalConfiguration?: AnalyticalConfiguration;
+
     /**
      * Aggregate columns of the table.
      */
@@ -4813,6 +5173,8 @@ declare module "sap/fe/macros/table/TreeTable" {
 
   import ActionGroup from "sap/fe/macros/table/ActionGroup";
 
+  import AnalyticalConfiguration from "sap/fe/macros/table/AnalyticalConfiguration";
+
   import ColumnOverride from "sap/fe/macros/table/ColumnOverride";
 
   import MassEdit from "sap/fe/macros/table/MassEdit";
@@ -5211,10 +5573,20 @@ declare module "sap/fe/macros/table/TreeTable" {
     ignoredFields?: string | PropertyBindingInfo;
 
     /**
-     * Defines the extension point to control if a source node can be dropped on a specific parent node.
+     * Defines the extension point to control whether a source node can be copied to a specific parent node.
+     */
+    isCopyToPositionAllowed?: string | PropertyBindingInfo;
+
+    /**
+     * Defines the extension point to control whether a source node can be dropped on a specific parent node.
      */
     isMoveToPositionAllowed?: string | PropertyBindingInfo;
 
+    /**
+     * efines the extension point to control whether a node can be copied.
+     */
+    isNodeCopyable?: string | PropertyBindingInfo;
+
     /**
      * Defines the extension point to control if a node can be dragged.
      */
@@ -5256,6 +5628,12 @@ declare module "sap/fe/macros/table/TreeTable" {
      * - Column
      *
      * - Filter
+     *
+     * - Group
+     *
+     *
+     *
+     * The Group option is only applicable to analytical tables and responsive tables.
      */
     personalization?: string | PropertyBindingInfo;
 
@@ -5341,6 +5719,11 @@ declare module "sap/fe/macros/table/TreeTable" {
       | AggregationBindingInfo
       | `{${string}}`;
 
+    /**
+     * A set of options that can be configured to control the aggregation behavior
+     */
+    analyticalConfiguration?: AnalyticalConfiguration;
+
     /**
      * Aggregate columns of the table.
      */
@@ -5621,12 +6004,16 @@ declare namespace sap {
 
     "sap/fe/macros/MacroAPI": undefined;
 
-    "sap/fe/macros/microchart/MicroChart": undefined;
+    "sap/fe/macros/MessageButton": undefined;
+
+    "sap/fe/macros/MicroChart": undefined;
 
-    "sap/fe/macros/microchart/MicroChart.block": undefined;
+    "sap/fe/macros/microchart/MicroChart": undefined;
 
     "sap/fe/macros/MultiValueField": undefined;
 
+    "sap/fe/macros/Page": undefined;
+
     "sap/fe/macros/Paginator": undefined;
 
     "sap/fe/macros/RichTextEditor": undefined;
@@ -5649,6 +6036,8 @@ declare namespace sap {
 
     "sap/fe/macros/table/ActionOverride": undefined;
 
+    "sap/fe/macros/table/AnalyticalConfiguration": undefined;
+
     "sap/fe/macros/table/Column": undefined;
 
     "sap/fe/macros/table/ColumnExportSettings": undefined;