@sapui5/ts-types 1.126.2 → 1.127.1

package/types/sap.gantt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare namespace sap {
   /**
@@ -26413,7 +26413,7 @@ declare namespace sap {
 
         /**
          * Flag to show or hide the start time and end time of a shape when you drag it along the time line. The
-         * property takes effect if only one shape is selected.
+         * property takes effect if only one shape is selected or `enableMultipleGhosts` is set to false.
          */
         showShapeTimeOnDrag?:
           | boolean
@@ -26623,7 +26623,8 @@ declare namespace sap {
           | `{${string}}`;
 
         /**
-         * Option to show or hide shape labels on ghost while dragging.
+         * Option to show or hide shape labels on ghost while dragging. The property takes effect only when `enableMultipleGhosts`
+         * is set to true.
          *
          * @since 1.94
          */
@@ -26760,6 +26761,16 @@ declare namespace sap {
           | sap.ui.base.ManagedObject.PropertyBindingInfo
           | `{${string}}`;
 
+        /**
+         * Flag to enable displaying multiple ghosts when multiple shapes are selected and dragged.
+         *
+         * @experimental (since 1.127)
+         */
+        enableMultipleGhosts?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
         /**
          * Table of the Gantt Chart
          *
@@ -27390,6 +27401,18 @@ declare namespace sap {
           | `{${string}}`;
       }
 
+      /**
+       * Describes the settings that can be provided to the PrintDialogTemplate constructor.
+       */
+      interface $PrintDialogTemplateSettings
+        extends sap.ui.base.$ManagedObjectSettings {
+        footerButtons?:
+          | sap.m.Button[]
+          | sap.m.Button
+          | sap.ui.base.ManagedObject.AggregationBindingInfo
+          | `{${string}}`;
+      }
+
       /**
        * Describes the settings that can be provided to the Relationship constructor.
        */
@@ -39643,6 +39666,18 @@ declare namespace sap {
          * @returns Value of property `enableLassoInvert`
          */
         getEnableLassoInvert(): boolean;
+        /**
+         * Gets current value of property {@link #getEnableMultipleGhosts enableMultipleGhosts}.
+         *
+         * Flag to enable displaying multiple ghosts when multiple shapes are selected and dragged.
+         *
+         * Default value is `true`.
+         *
+         * @experimental (since 1.127)
+         *
+         * @returns Value of property `enableMultipleGhosts`
+         */
+        getEnableMultipleGhosts(): boolean;
         /**
          * Gets current value of property {@link #getEnableNonWorkingTime enableNonWorkingTime}.
          *
@@ -40139,7 +40174,7 @@ declare namespace sap {
          * Gets current value of property {@link #getShowShapeTimeOnDrag showShapeTimeOnDrag}.
          *
          * Flag to show or hide the start time and end time of a shape when you drag it along the time line. The
-         * property takes effect if only one shape is selected.
+         * property takes effect if only one shape is selected or `enableMultipleGhosts` is set to false.
          *
          * Default value is `false`.
          *
@@ -40150,7 +40185,8 @@ declare namespace sap {
         /**
          * Gets current value of property {@link #getShowTextOnGhost showTextOnGhost}.
          *
-         * Option to show or hide shape labels on ghost while dragging.
+         * Option to show or hide shape labels on ghost while dragging. The property takes effect only when `enableMultipleGhosts`
+         * is set to true.
          *
          * Default value is `true`.
          *
@@ -40994,6 +41030,25 @@ declare namespace sap {
            */
           bEnableLassoInvert?: boolean
         ): this;
+        /**
+         * Sets a new value for property {@link #getEnableMultipleGhosts enableMultipleGhosts}.
+         *
+         * Flag to enable displaying multiple ghosts when multiple shapes are selected and dragged.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `true`.
+         *
+         * @experimental (since 1.127)
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setEnableMultipleGhosts(
+          /**
+           * New value for property `enableMultipleGhosts`
+           */
+          bEnableMultipleGhosts?: boolean
+        ): this;
         /**
          * Sets a new value for property {@link #getEnableNonWorkingTime enableNonWorkingTime}.
          *
@@ -41612,7 +41667,7 @@ declare namespace sap {
          * Sets a new value for property {@link #getShowShapeTimeOnDrag showShapeTimeOnDrag}.
          *
          * Flag to show or hide the start time and end time of a shape when you drag it along the time line. The
-         * property takes effect if only one shape is selected.
+         * property takes effect if only one shape is selected or `enableMultipleGhosts` is set to false.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
@@ -41630,7 +41685,8 @@ declare namespace sap {
         /**
          * Sets a new value for property {@link #getShowTextOnGhost showTextOnGhost}.
          *
-         * Option to show or hide shape labels on ghost while dragging.
+         * Option to show or hide shape labels on ghost while dragging. The property takes effect only when `enableMultipleGhosts`
+         * is set to true.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
@@ -41908,6 +41964,12 @@ declare namespace sap {
          * `null`.
          */
         getGanttChart(): sap.ui.core.ID | null;
+        /**
+         * @since 1.127
+         *
+         * @returns Print configuration class instance with print configuration data
+         */
+        getPrintData(): sap.gantt.simple.PrintConfig;
         /**
          * Merges multiple canvases into one canvas.
          *
@@ -41931,7 +41993,11 @@ declare namespace sap {
            * Optional function which takes cloned gantt chart's table for modification. Applications can loop through
            * the table columns and update certain properties like maxLines to overcome html2canvas limitations.
            */
-          fnUpdateTable: Function
+          fnUpdateTable: Function,
+          /**
+           * which takes custom buttons to display on print Dialog
+           */
+          printDialogTemplate: sap.gantt.simple.PrintDialogTemplate
         ): Promise<any>;
         /**
          * Sets the Gantt chart to be exported as PDF.
@@ -41942,6 +42008,17 @@ declare namespace sap {
            */
           oGanttChart: undefined
         ): this;
+        /**
+         * Sets the print configuration data.
+         *
+         * @since 1.127
+         */
+        setPrintData(
+          /**
+           * configuration class instance with print configuration data.
+           */
+          objClass: sap.gantt.simple.PrintConfig
+        ): void;
       }
       /**
        * Enables users to define a shape aggregation name of their own.
@@ -45078,6 +45155,254 @@ declare namespace sap {
           vTask: int | string | sap.gantt.simple.BaseShape
         ): sap.gantt.simple.BaseShape | null;
       }
+      /**
+       * PrintConfig is a class that holds the configuration for the print page.
+       *
+       * @since 1.127
+       */
+      class PrintConfig extends sap.ui.base.Object {
+        /**
+         * Creates and initializes a print configuration class.
+         */
+        constructor(
+          /**
+           * The print configurationobject can have keys as pageConfig, textConfig, marginConfig, durationConfig,
+           * exportConfig and with values as defined in below structure. pageConfig - The page configuration object
+           * with the following given keys. paperSize: : Possible values are "A0" | "A1" | "A2" | "A3" | "A4" | "A5"
+           * | "Letter" | "Legal" | "Tabloid" | "Custom". Select one of the provided values as the paper size of the
+           * print page. Default value is "A4". unit": Possible values are "mm" | "cm" | "in". Select one of the provided
+           * values as the unit for paper and margin measurements. Default value is "mm" for all paper size except
+           * "Letter", "Legal", "Tabloid" where default value is "in". paperHeight: It must be a number, and it must
+           * be the unit specified within the page configuration. It is considered only when paper size is "Custom".
+           * If paper size is not provided, then the default value is height of the "A4" paper size. paperWidth: It
+           * must be a number, and it must be the unit specified within the page configuration. It is considered only
+           * when the paper size is "Custom". If paper size is not provided, then "A4" is the default width. portrait:
+           * It must be a boolean value as it is the orientation of the page. Default value is true. showPageNumber:
+           * It must be a boolean value. It decides if the page number is to be displayed. Default value is false.
+           * Not applicable in single page API. textConfig - The text configuration with the following given keys.
+           * showHeaderText: It must be a boolean value. It is a flag to decide whether to show the header text or
+           * not in the print page. Default value is false. showFooterText: It must be a boolean value. It is a flag
+           * to decide whether to show the footer text or not in the print page. Default value is false. headerText:
+           * It must be a string value to display header text in the print page. Default value is empty string. footerText:
+           * It must be a string value to display footer text in the print page. Default value is empty string. marginConfig
+           * - The margin configuration object with the following given keys. marginType: Possible values are "custom"
+           * | "none" | "default". Select one of the provided values for the margin type of the print page. Default
+           * value is "default". marginLeft: It must be a number and it must be in the unit specified within the page
+           * configuration. It is considered only when margin type is set as "custom". When the margin type is "default",
+           * the default value is "5mm". If "none" is maintained, then the value is "0". marginBottom: It must be
+           * a number and it must be in the unit specified within the page configuration. It is considered only when
+           * margin type is set as "custom". When the margin type is "default", the default value is "5mm". If "none"
+           * is maintained, then the value is "0". marginRight: It must be a number and it must be in the unit specified
+           * within the page configuration. It is considered only when margin type is set as "custom". When the margin
+           * type is "default", the default value is "5mm". If "none" is maintained, then the value is "0". marginTop:
+           * It must be a number and it must be in the unit specified within the page configuration. It is considered
+           * only when margin type is set as "custom". When the margin type is "default", the default value is "5mm".
+           * If "none" is maintained, then the value is "0". marginLocked: It must be a boolean value. If set to true,
+           * it signifies all four margins get synced on the same value. If the value is provided by the application,
+           * the margin top is considered for all four margins. Default value is false and considered only when the
+           * margin type is "custom". durationConfig - The duration configuration object with following given keys.
+           * duration: Possible values are "all" | "week" | "month" | "custom". Select the date duration of the print
+           * page. Default value is "all". If the provided value is "all", then the total horizon is set as duration.
+           * Values provided in "startDate" and "endDate" are ignored. If the provided value is "week", then the next
+           * week is set as duration. Values provided in "startDate" and "endDate" are ignored. If the provided value
+           * is "month", then the next month is set as duration. Values provided in "startDate" and "endDate" are
+           * ignored. If the provided value is "custom", then the value provided in "startDate" and "endDate" is set
+           * as duration. startDate: This is a UI5 date object. It is the start date of a print page. It is considered
+           * only when the "duration" is set as "custom". endDate: This is a UI5 date object. It is the end date of
+           * a print page. It is considered only when the "duration" is set as "custom". exportConfig - The export
+           * configuration object with the following given keys. exportAsJPEG: It must be a boolean value. It is a
+           * flag to decide whether to export the pdf as a JPEG or not. Default value is true, which means that the
+           * exported PDF has content in a JPEG image format. This is not applicable for single page API. exportRange:
+           * It must be a string value such as, '0,1". It is the range of the export. This is not applicable for a
+           * single page API and when "exportAll" is set to true. exportAll: It must be a boolean value. It is a flag
+           * to decide whether to export all the pages or not. Default value is true. This is not applicable for a
+           * single page API. compressionQuality: It must be a number between the range of 1 to 100. The quality of
+           * the compression is applicable only when "exportAsJPEG" is set to true. Default value is 75. This is not
+           * applicable for a single page API. scale: It must be a number between the range of 50 to 100. This is
+           * to scale the export up or down. Default value is 100. This is not applicable for a single page API. multiplePage:
+           * It must be a boolean value. It is a flag to decide whether if the export is multiple page. This is not
+           * applicable for a single page API.
+           */
+          printConfiguartionObject: object
+        );
+
+        /**
+         * Creates a new subclass of class sap.gantt.simple.PrintConfig 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.base.Object.extend}.
+         *
+         *
+         * @returns Created class / constructor function
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<T, sap.gantt.simple.PrintConfig>,
+          /**
+           * 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.gantt.simple.PrintConfig.
+         *
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.base.Metadata;
+      }
+      /**
+       * Enables the user to define print dialog footer buttons. Print dialog template offers an option to provide
+       * custom buttons for the print dialog footer.
+       *
+       * @since 1.127
+       */
+      class PrintDialogTemplate extends sap.ui.base.ManagedObject {
+        /**
+         * Creates and initializes a new print dialog template class.
+         *
+         * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+         * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+         * of the syntax of the settings object.
+         */
+        constructor(
+          /**
+           * Initial settings for the new control
+           */
+          mSettings?: sap.gantt.simple.$PrintDialogTemplateSettings
+        );
+        /**
+         * Creates and initializes a new print dialog template class.
+         *
+         * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+         * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+         * of the syntax of the settings object.
+         */
+        constructor(
+          /**
+           * ID of the new control, it is generated automatically if no ID is provided.
+           */
+          sId?: string,
+          /**
+           * Initial settings for the new control
+           */
+          mSettings?: sap.gantt.simple.$PrintDialogTemplateSettings
+        );
+
+        /**
+         * Creates a new subclass of class sap.gantt.simple.PrintDialogTemplate 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.base.ManagedObject.extend}.
+         *
+         *
+         * @returns Created class / constructor function
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<T, sap.gantt.simple.PrintDialogTemplate>,
+          /**
+           * 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.gantt.simple.PrintDialogTemplate.
+         *
+         *
+         * @returns Metadata object describing this class
+         */
+        static getMetadata(): sap.ui.base.ManagedObjectMetadata;
+        /**
+         * Adds some footerButton to the aggregation {@link #getFooterButtons footerButtons}.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        addFooterButton(
+          /**
+           * The footerButton to add; if empty, nothing is inserted
+           */
+          oFooterButton: sap.m.Button
+        ): this;
+        /**
+         * Destroys all the footerButtons in the aggregation {@link #getFooterButtons footerButtons}.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        destroyFooterButtons(): this;
+        /**
+         * Gets content of aggregation {@link #getFooterButtons footerButtons}.
+         */
+        getFooterButtons(): sap.m.Button[];
+        /**
+         * Checks for the provided `sap.m.Button` in the aggregation {@link #getFooterButtons footerButtons}. and
+         * returns its index if found or -1 otherwise.
+         *
+         *
+         * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+         */
+        indexOfFooterButton(
+          /**
+           * The footerButton whose index is looked for
+           */
+          oFooterButton: sap.m.Button
+        ): int;
+        /**
+         * Inserts a footerButton into the aggregation {@link #getFooterButtons footerButtons}.
+         *
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        insertFooterButton(
+          /**
+           * The footerButton to insert; if empty, nothing is inserted
+           */
+          oFooterButton: sap.m.Button,
+          /**
+           * The `0`-based index the footerButton should be inserted at; for a negative value of `iIndex`, the footerButton
+           * is inserted at position 0; for a value greater than the current size of the aggregation, the footerButton
+           * is inserted at the last position
+           */
+          iIndex: int
+        ): this;
+        /**
+         * Removes all the controls from the aggregation {@link #getFooterButtons footerButtons}.
+         *
+         * Additionally, it unregisters them from the hosting UIArea.
+         *
+         *
+         * @returns An array of the removed elements (might be empty)
+         */
+        removeAllFooterButtons(): sap.m.Button[];
+        /**
+         * Removes a footerButton from the aggregation {@link #getFooterButtons footerButtons}.
+         *
+         *
+         * @returns The removed footerButton or `null`
+         */
+        removeFooterButton(
+          /**
+           * The footerButton to remove or its index or id
+           */
+          vFooterButton: int | string | sap.m.Button
+        ): sap.m.Button | null;
+      }
       /**
        * Enables users to visualize the relationship between visiable objects.
        */
@@ -56114,6 +56439,10 @@ declare namespace sap {
 
     "sap/gantt/simple/MultiActivityRowSettings": undefined;
 
+    "sap/gantt/simple/PrintConfig": undefined;
+
+    "sap/gantt/simple/PrintDialogTemplate": undefined;
+
     "sap/gantt/simple/Relationship": undefined;
 
     "sap/gantt/simple/shapes/Shape": undefined;

package/types/sap.insights.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.126.0
+// For Library Version: 1.127.0
 
 declare namespace sap {
   /**
@@ -478,6 +478,27 @@ declare namespace sap {
          */
         providerId: string
       ): Promise<void>;
+      /**
+       * Request card creation to a given provider.
+       *
+       * @experimental
+       *
+       * @returns .
+       */
+      requestCardCreation(
+        /**
+         * .
+         */
+        consumerId: string,
+        /**
+         * .
+         */
+        card: sap.insights.CardsChannel.Card,
+        /**
+         * .
+         */
+        providerId: string
+      ): Promise<void>;
       /**
        * Unregister a previously registered consumer or provider.
        *