@sapui5/ts-types-esm 1.127.1 → 1.128.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +221 -22
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +1414 -225
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +13 -28
  11. package/types/sap.fe.ina.d.ts +1 -1
  12. package/types/sap.fe.macros.d.ts +7 -1
  13. package/types/sap.fe.navigation.d.ts +1 -1
  14. package/types/sap.fe.placeholder.d.ts +1 -1
  15. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  16. package/types/sap.fe.templates.d.ts +14 -3
  17. package/types/sap.fe.test.d.ts +3 -3
  18. package/types/sap.fe.tools.d.ts +1 -1
  19. package/types/sap.feedback.ui.d.ts +1 -1
  20. package/types/sap.gantt.d.ts +123 -64
  21. package/types/sap.insights.d.ts +24 -1
  22. package/types/sap.m.d.ts +327 -26
  23. package/types/sap.makit.d.ts +1 -1
  24. package/types/sap.me.d.ts +1 -1
  25. package/types/sap.ndc.d.ts +1 -1
  26. package/types/sap.ovp.d.ts +1 -1
  27. package/types/sap.rules.ui.d.ts +1 -1
  28. package/types/sap.sac.df.d.ts +110 -29
  29. package/types/sap.suite.ui.commons.d.ts +1 -1
  30. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  31. package/types/sap.suite.ui.microchart.d.ts +1 -1
  32. package/types/sap.tnt.d.ts +1 -1
  33. package/types/sap.ui.codeeditor.d.ts +10 -4
  34. package/types/sap.ui.commons.d.ts +1 -1
  35. package/types/sap.ui.comp.d.ts +997 -4
  36. package/types/sap.ui.core.d.ts +48 -28
  37. package/types/sap.ui.dt.d.ts +1 -1
  38. package/types/sap.ui.export.d.ts +1 -1
  39. package/types/sap.ui.fl.d.ts +10 -4
  40. package/types/sap.ui.generic.app.d.ts +1 -1
  41. package/types/sap.ui.generic.template.d.ts +1 -1
  42. package/types/sap.ui.integration.d.ts +55 -5
  43. package/types/sap.ui.layout.d.ts +5 -5
  44. package/types/sap.ui.mdc.d.ts +426 -212
  45. package/types/sap.ui.richtexteditor.d.ts +1 -1
  46. package/types/sap.ui.rta.d.ts +1 -1
  47. package/types/sap.ui.suite.d.ts +1 -1
  48. package/types/sap.ui.support.d.ts +1 -1
  49. package/types/sap.ui.table.d.ts +91 -23
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +624 -1
  52. package/types/sap.ui.ux3.d.ts +1 -1
  53. package/types/sap.ui.vbm.d.ts +1 -1
  54. package/types/sap.ui.vk.d.ts +48 -23
  55. package/types/sap.ui.vtm.d.ts +1 -1
  56. package/types/sap.ui.webc.common.d.ts +1 -1
  57. package/types/sap.ui.webc.fiori.d.ts +1 -1
  58. package/types/sap.ui.webc.main.d.ts +1 -1
  59. package/types/sap.uiext.inbox.d.ts +1 -1
  60. package/types/sap.ushell.d.ts +16 -8
  61. package/types/sap.ushell_abap.d.ts +1 -1
  62. package/types/sap.uxap.d.ts +44 -1
  63. package/types/sap.viz.d.ts +1 -1
  64. package/types/sap.webanalytics.core.d.ts +1 -1
  65. package/types/sap.zen.commons.d.ts +1 -1
  66. package/types/sap.zen.crosstab.d.ts +1 -1
  67. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/fe/base/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/fe/core/AppComponent" {
4
4
  import {
@@ -386,6 +386,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
386
386
 
387
387
  import ODataModel from "sap/ui/model/odata/v4/ODataModel";
388
388
 
389
+ import Binding from "sap/ui/model/Binding";
390
+
389
391
  /**
390
392
  * A controller extension offering hooks into the edit flow of the application
391
393
  *
@@ -518,13 +520,13 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
518
520
  *
519
521
  * @since 1.90.0
520
522
  *
521
- * @returns Promise resolves once the editable document is available with the editable context
523
+ * @returns Promise resolved once the editable document is available with the editable context
522
524
  */
523
525
  editDocument(
524
526
  /**
525
527
  * Context of the active document
526
528
  */
527
- oContext: Context
529
+ context: Context
528
530
  ): Promise<Context | void>;
529
531
  /**
530
532
  * Invokes an action (bound or unbound) and tracks the changes so that other pages can be refreshed and
@@ -591,7 +593,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
591
593
  */
592
594
  onAfterCreate(
593
595
  /**
594
- * Object containing the parameters passed to onBeforeCreate
596
+ * Object containing the parameters passed to onAfterCreate
595
597
  */
596
598
  _mParameters?: {
597
599
  /**
@@ -613,7 +615,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
613
615
  */
614
616
  onAfterDelete(
615
617
  /**
616
- * Object containing the parameters passed to onBeforeDelete
618
+ * Object containing the parameters passed to onAfterDelete
617
619
  */
618
620
  _mParameters?: {
619
621
  /**
@@ -635,7 +637,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
635
637
  */
636
638
  onAfterDiscard(
637
639
  /**
638
- * Object containing the parameters passed to onBeforeDiscard
640
+ * Object containing the parameters passed to onAfterDiscard
639
641
  */
640
642
  _mParameters?: {
641
643
  /**
@@ -657,7 +659,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
657
659
  */
658
660
  onAfterEdit(
659
661
  /**
660
- * Object containing the parameters passed to onBeforeEdit
662
+ * Object containing the parameters passed to onAfterEdit
661
663
  */
662
664
  _mParameters?: {
663
665
  /**
@@ -679,7 +681,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
679
681
  */
680
682
  onAfterSave(
681
683
  /**
682
- * Object containing the parameters passed to onBeforeSave
684
+ * Object containing the parameters passed to onAfterSave
683
685
  */
684
686
  _mParameters?: {
685
687
  /**
@@ -876,7 +878,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
876
878
  /**
877
879
  * Context of the updated field
878
880
  */
879
- updatedContext: object,
881
+ updatedContext: Binding | Context,
880
882
  /**
881
883
  * Promise to determine when the update operation is completed. The promise should be resolved when the
882
884
  * update operation is completed, so the draft status can be updated.
@@ -1352,24 +1354,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1352
1354
  /**
1353
1355
  * The current navigation parameter
1354
1356
  */
1355
- oNavParameter: {
1356
- /**
1357
- * The actual navigation type
1358
- */
1359
- navigationType: string;
1360
- /**
1361
- * Defines whether the standard variant must be used in variant management
1362
- */
1363
- requiresStandardVariant?: boolean | undefined;
1364
- /**
1365
- * The selectionVariant from the navigation
1366
- */
1367
- selectionVariant?: object | undefined;
1368
- /**
1369
- * The selectionVariant defaults from the navigation
1370
- */
1371
- selectionVariantDefaults?: object | undefined;
1372
- },
1357
+ oNavParameter: NavigationParameter,
1373
1358
  /**
1374
1359
  * Extensible array of promises to be resolved before continuing
1375
1360
  */
@@ -1461,7 +1446,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1461
1446
  retrieveViewState(): Promise<Record<string, any> | undefined>;
1462
1447
  }
1463
1448
  /**
1464
- * Definition of a custom action to be used inside the table toolbar
1449
+ * Definition of a navigation parameter
1465
1450
  */
1466
1451
  export type NavigationParameter = {
1467
1452
  /**
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/fe/macros/CollectionBindingInfo" {
4
4
  import Filter from "sap/ui/model/Filter";
@@ -2436,6 +2436,12 @@ declare module "sap/fe/macros/table/Column" {
2436
2436
  */
2437
2437
  placement?: string | PropertyBindingInfo;
2438
2438
 
2439
+ /**
2440
+ * Defines the properties displayed in the column
2441
+ * The properties allow to export, sort, group, copy, and paste in the column
2442
+ */
2443
+ properties?: string[] | PropertyBindingInfo | `{${string}}`;
2444
+
2439
2445
  /**
2440
2446
  * Defines the column's width.
2441
2447
  * Allowed values are `auto`, `value` and `inherit` according to {@link sap.ui.core.CSSSize }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/fe/navigation/library" {
4
4
  /**
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/fe/plugins/managecache/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/fe/templates/library" {}
4
4
 
@@ -264,11 +264,22 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
264
264
  vPath?: string | string[]
265
265
  ): Promise<void>;
266
266
  /**
267
- * This function will treat the control as a single content in an object page section.
267
+ * Defines a control to be the title owner of its section/subsection. As the title owners of standard subsections
268
+ * are determined automatically, it is recommended to use this function for custom section/subsection.
269
+ * The title owner can be either one of the standard building blocks (Form, Chart, Table), or reuse components,
270
+ * or sap.m.Title.
271
+ * The framework adapts the value of these properties to be aligned with the title that is shown in the
272
+ * anchor bar (or icon tab bar) for the section. Moreover, the title of the subsection (and if applicable
273
+ * also of the section) is hidden in order to prevent redundant titles, if the subsection possesses a title
274
+ * owner.
275
+ * Hint: If you choose to set sap.m.Title as the title owner, styling adjustments may be required in the
276
+ * custom view. For example, if sap.m.Title is set as title owner which belongs to sap.m.OverflowToolbar
277
+ * or to sap.m.Toolbar, then the ‘design’ property of the toolbar control is to be set to ‘Transparent’.
268
278
  */
269
279
  setAsSectionTitleOwner(
270
280
  /**
271
- * The single content control can be one of standard building blocks (Form, Chart, Table) or reuse components
281
+ * The single content control can be either one of the standard building blocks (Form, Chart, Table), or
282
+ * reuse components, or sap.m.Title.
272
283
  */
273
284
  control: ManagedObject
274
285
  ): void;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/fe/test/library" {}
4
4
 
@@ -3689,8 +3689,8 @@ declare module "sap/fe/test/ObjectPage" {
3689
3689
  */
3690
3690
  iGoToSection(
3691
3691
  /**
3692
- * The identifier of a section, or its label if passed as an object, the following pattern will be considered:
3693
- *
3692
+ * The identifier of a section, or its label if passed as an object, the following pattern will be considered
3693
+ * (please use to open sub-sections via drop-down):
3694
3694
  * ```javascript
3695
3695
  *
3696
3696
  * {
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/gantt/library" {
4
4
  import ChartScheme from "sap/gantt/config/ChartScheme";
@@ -1873,9 +1873,12 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
1873
1873
  /**
1874
1874
  * Gets content of aggregation {@link #getSkipTimePattern skipTimePattern}.
1875
1875
  *
1876
- * Specifies the skip time pattern that is to be removed from the gantt timeline. The functionality works
1877
- * only for `sap.gantt.axistime.StepwiseZoomStrategy`. We recommend that you set the type of this argument
1878
- * to `sap.gantt.skipTime.SkipPattern`. Otherwise, some properties you set may not function properly.
1876
+ * Specifies the skip time pattern that is to be removed from the gantt timeline. We recommend that you
1877
+ * set the type of this argument to `sap.gantt.skipTime.SkipPattern`. Otherwise, some properties you set
1878
+ * may not function properly.
1879
+ *
1880
+ * Supported in `sap.gantt.axistime.StepwiseZoomStrategy` from 1.126. Supported in `sap.gantt.axistime.ProportionZoomStrategy`
1881
+ * from 1.128. Supported in `sap.gantt.axistime.FullScreenStrategy` from 1.128.
1879
1882
  *
1880
1883
  * The default value for skipTimePattern is null.
1881
1884
  *
@@ -1916,6 +1919,10 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
1916
1919
  * - `"span": 1` - Span is 1.
1917
1920
  * - `"range": 90` - This granularity level is selected as the current level if 12 hours is the first
1918
1921
  * time span that consumes more than 90 pixels to be displayed in the chart area.
1922
+ * - `"selector": (requiredRange) => 90 ` - This granularity level is selected as the current level if
1923
+ * 12 hours is the first time span that consumes more than 90 pixels to be displayed in the chart area.
1924
+ * Selector takes precedence over the range for level selection and provides flexibility to adjust range
1925
+ * or column size in the timeline
1919
1926
  * - `largeInterval` - Time interval of the upper row in the timeline is 1 day. Formatted in the locale
1920
1927
  * language with the format string. This zoom level implements an interval larger than the interval in the
1921
1928
  * default zoom level.
@@ -2194,6 +2201,10 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
2194
2201
  * - `"span": 1` - Span is 1.
2195
2202
  * - `"range": 90` - This granularity level is selected as the current level if 12 hours is the first
2196
2203
  * time span that consumes more than 90 pixels to be displayed in the chart area.
2204
+ * - `"selector": (requiredRange) => 90 ` - This granularity level is selected as the current level if
2205
+ * 12 hours is the first time span that consumes more than 90 pixels to be displayed in the chart area.
2206
+ * Selector takes precedence over the range for level selection and provides flexibility to adjust range
2207
+ * or column size in the timeline
2197
2208
  * - `largeInterval` - Time interval of the upper row in the timeline is 1 day. Formatted in the locale
2198
2209
  * language with the format string. This zoom level implements an interval larger than the interval in the
2199
2210
  * default zoom level.
@@ -2409,6 +2420,10 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
2409
2420
  * - `"span": 1` - Span is 1.
2410
2421
  * - `"range": 90` - This granularity level is selected as the current level if 12 hours is the first
2411
2422
  * time span that consumes more than 90 pixels to be displayed in the chart area.
2423
+ * - `"selector": (requiredRange) => 90 ` - This granularity level is selected as the current level if
2424
+ * 12 hours is the first time span that consumes more than 90 pixels to be displayed in the chart area.
2425
+ * Selector takes precedence over the range for level selection and provides flexibility to adjust range
2426
+ * or column size in the timeline
2412
2427
  * - `largeInterval` - Time interval of the upper row in the timeline is 1 day. Formatted in the locale
2413
2428
  * language with the format string. This zoom level implements an interval larger than the interval in the
2414
2429
  * default zoom level.
@@ -2543,9 +2558,12 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
2543
2558
  visibleHorizon?: TimeHorizon;
2544
2559
 
2545
2560
  /**
2546
- * Specifies the skip time pattern that is to be removed from the gantt timeline. The functionality works
2547
- * only for `sap.gantt.axistime.StepwiseZoomStrategy`. We recommend that you set the type of this argument
2548
- * to `sap.gantt.skipTime.SkipPattern`. Otherwise, some properties you set may not function properly.
2561
+ * Specifies the skip time pattern that is to be removed from the gantt timeline. We recommend that you
2562
+ * set the type of this argument to `sap.gantt.skipTime.SkipPattern`. Otherwise, some properties you set
2563
+ * may not function properly.
2564
+ *
2565
+ * Supported in `sap.gantt.axistime.StepwiseZoomStrategy` from 1.126. Supported in `sap.gantt.axistime.ProportionZoomStrategy`
2566
+ * from 1.128. Supported in `sap.gantt.axistime.FullScreenStrategy` from 1.128.
2549
2567
  *
2550
2568
  * The default value for skipTimePattern is null.
2551
2569
  *
@@ -19683,7 +19701,11 @@ declare module "sap/gantt/misc/AxisTime" {
19683
19701
  /**
19684
19702
  * Given date within the timeRange.
19685
19703
  */
19686
- time: Date
19704
+ time: Date,
19705
+ /**
19706
+ * When set to true, the view offset is ignored in the calculation
19707
+ */
19708
+ bIgnoreOffset: boolean
19687
19709
  ): number;
19688
19710
  /**
19689
19711
  * Returns the date within the timeRange for the corresponding value within the viewRange.
@@ -47521,6 +47543,11 @@ declare module "sap/gantt/simple/GanttChartWithTable" {
47521
47543
  * Instance of the right-clicked shape.
47522
47544
  */
47523
47545
  shape?: BaseShape;
47546
+
47547
+ /**
47548
+ * Original JQuery event object.
47549
+ */
47550
+ originEvent?: object;
47524
47551
  }
47525
47552
 
47526
47553
  /**
@@ -47749,6 +47776,11 @@ declare module "sap/gantt/simple/GanttChartWithTable" {
47749
47776
  * The mouse position relative to the top edge of the document.
47750
47777
  */
47751
47778
  pageY?: int;
47779
+
47780
+ /**
47781
+ * Original JQuery event object.
47782
+ */
47783
+ originEvent?: object;
47752
47784
  }
47753
47785
 
47754
47786
  /**
@@ -47948,6 +47980,8 @@ declare module "sap/gantt/simple/GanttPrinting" {
47948
47980
  */
47949
47981
  getGanttChart(): ID | null;
47950
47982
  /**
47983
+ * Gets the print configuration class with the configuration data.
47984
+ *
47951
47985
  * @since 1.127
47952
47986
  *
47953
47987
  * @returns Print configuration class instance with print configuration data
@@ -51697,62 +51731,87 @@ declare module "sap/gantt/simple/PrintConfig" {
51697
51731
  */
51698
51732
  constructor(
51699
51733
  /**
51700
- * The print configurationobject can have keys as pageConfig, textConfig, marginConfig, durationConfig,
51701
- * exportConfig and with values as defined in below structure. pageConfig - The page configuration object
51702
- * with the following given keys. paperSize: : Possible values are "A0" | "A1" | "A2" | "A3" | "A4" | "A5"
51703
- * | "Letter" | "Legal" | "Tabloid" | "Custom". Select one of the provided values as the paper size of the
51704
- * print page. Default value is "A4". unit": Possible values are "mm" | "cm" | "in". Select one of the provided
51705
- * values as the unit for paper and margin measurements. Default value is "mm" for all paper size except
51706
- * "Letter", "Legal", "Tabloid" where default value is "in". paperHeight: It must be a number, and it must
51707
- * be the unit specified within the page configuration. It is considered only when paper size is "Custom".
51708
- * If paper size is not provided, then the default value is height of the "A4" paper size. paperWidth: It
51709
- * must be a number, and it must be the unit specified within the page configuration. It is considered only
51710
- * when the paper size is "Custom". If paper size is not provided, then "A4" is the default width. portrait:
51711
- * It must be a boolean value as it is the orientation of the page. Default value is true. showPageNumber:
51712
- * It must be a boolean value. It decides if the page number is to be displayed. Default value is false.
51713
- * Not applicable in single page API. textConfig - The text configuration with the following given keys.
51714
- * showHeaderText: It must be a boolean value. It is a flag to decide whether to show the header text or
51715
- * not in the print page. Default value is false. showFooterText: It must be a boolean value. It is a flag
51716
- * to decide whether to show the footer text or not in the print page. Default value is false. headerText:
51717
- * It must be a string value to display header text in the print page. Default value is empty string. footerText:
51718
- * It must be a string value to display footer text in the print page. Default value is empty string. marginConfig
51719
- * - The margin configuration object with the following given keys. marginType: Possible values are "custom"
51720
- * | "none" | "default". Select one of the provided values for the margin type of the print page. Default
51721
- * value is "default". marginLeft: It must be a number and it must be in the unit specified within the page
51722
- * configuration. It is considered only when margin type is set as "custom". When the margin type is "default",
51723
- * the default value is "5mm". If "none" is maintained, then the value is "0". marginBottom: It must be
51724
- * a number and it must be in the unit specified within the page configuration. It is considered only when
51725
- * margin type is set as "custom". When the margin type is "default", the default value is "5mm". If "none"
51726
- * is maintained, then the value is "0". marginRight: It must be a number and it must be in the unit specified
51727
- * within the page configuration. It is considered only when margin type is set as "custom". When the margin
51728
- * type is "default", the default value is "5mm". If "none" is maintained, then the value is "0". marginTop:
51729
- * It must be a number and it must be in the unit specified within the page configuration. It is considered
51730
- * only when margin type is set as "custom". When the margin type is "default", the default value is "5mm".
51731
- * If "none" is maintained, then the value is "0". marginLocked: It must be a boolean value. If set to true,
51732
- * it signifies all four margins get synced on the same value. If the value is provided by the application,
51733
- * the margin top is considered for all four margins. Default value is false and considered only when the
51734
- * margin type is "custom". durationConfig - The duration configuration object with following given keys.
51735
- * duration: Possible values are "all" | "week" | "month" | "custom". Select the date duration of the print
51736
- * page. Default value is "all". If the provided value is "all", then the total horizon is set as duration.
51737
- * Values provided in "startDate" and "endDate" are ignored. If the provided value is "week", then the next
51738
- * week is set as duration. Values provided in "startDate" and "endDate" are ignored. If the provided value
51739
- * is "month", then the next month is set as duration. Values provided in "startDate" and "endDate" are
51740
- * ignored. If the provided value is "custom", then the value provided in "startDate" and "endDate" is set
51741
- * as duration. startDate: This is a UI5 date object. It is the start date of a print page. It is considered
51742
- * only when the "duration" is set as "custom". endDate: This is a UI5 date object. It is the end date of
51743
- * a print page. It is considered only when the "duration" is set as "custom". exportConfig - The export
51744
- * configuration object with the following given keys. exportAsJPEG: It must be a boolean value. It is a
51745
- * flag to decide whether to export the pdf as a JPEG or not. Default value is true, which means that the
51746
- * exported PDF has content in a JPEG image format. This is not applicable for single page API. exportRange:
51747
- * It must be a string value such as, '0,1". It is the range of the export. This is not applicable for a
51748
- * single page API and when "exportAll" is set to true. exportAll: It must be a boolean value. It is a flag
51749
- * to decide whether to export all the pages or not. Default value is true. This is not applicable for a
51750
- * single page API. compressionQuality: It must be a number between the range of 1 to 100. The quality of
51751
- * the compression is applicable only when "exportAsJPEG" is set to true. Default value is 75. This is not
51752
- * applicable for a single page API. scale: It must be a number between the range of 50 to 100. This is
51753
- * to scale the export up or down. Default value is 100. This is not applicable for a single page API. multiplePage:
51754
- * It must be a boolean value. It is a flag to decide whether if the export is multiple page. This is not
51755
- * applicable for a single page API.
51734
+ * The print configuration object can have keys as pageConfig, textConfig, marginConfig, durationConfig,
51735
+ * exportConfig and with values as defined in below structure. pageConfig - The page configuration
51736
+ * object with the following given keys.
51737
+ * - paperSize: Possible values are "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "Letter" | "Legal" | "Tabloid"
51738
+ * | "Custom". Select one of the provided values as the paper size of the print page. Default value is "A4".
51739
+ *
51740
+ * - unit: Possible values are "mm" | "cm" | "in". Select one of the provided values as the unit for
51741
+ * paper and margin measurements. Default value is "mm" for all paper size except "Letter", "Legal", "Tabloid"
51742
+ * where default value is "in".
51743
+ * - paperHeight: It must be a number, and it must be the unit specified within the page configuration.
51744
+ * It is considered only when paper size is "Custom". If paper size is not provided, then the default value
51745
+ * is height of the "A4" paper size.
51746
+ * - paperWidth: It must be a number, and it must be the unit specified within the page configuration.
51747
+ * It is considered only when the paper size is "Custom". If paper size is not provided, then "A4" is the
51748
+ * default width.
51749
+ * - portrait: It must be a boolean value as it is the orientation of the page. Default value is true.
51750
+ *
51751
+ * - showPageNumber: It must be a boolean value. It decides if the page number is to be displayed. Default
51752
+ * value is false. Not applicable in single page API. textConfig - The text configuration with
51753
+ * the following given keys.
51754
+ * - showHeaderText: It must be a boolean value. It is a flag to decide whether to show the header text
51755
+ * or not in the print page. Default value is false.
51756
+ * - showFooterText: It must be a boolean value. It is a flag to decide whether to show the footer text
51757
+ * or not in the print page. Default value is false.
51758
+ * - headerText: It must be a string value to display header text in the print page. Default value is
51759
+ * empty string.
51760
+ * - footerText: It must be a string value to display footer text in the print page. Default value is
51761
+ * empty string. marginConfig - The margin configuration object with the following given keys.
51762
+ *
51763
+ * - marginType: Possible values are "custom" | "none" | "default". Select one of the provided values
51764
+ * for the margin type of the print page. Default value is "default".
51765
+ * - marginLeft: It must be a number and it must be in the unit specified within the page configuration.
51766
+ * It is considered only when margin type is set as "custom". When the margin type is "default", the default
51767
+ * value is "5mm". If "none" is maintained, then the value is "0".
51768
+ * - marginBottom: It must be a number and it must be in the unit specified within the page configuration.
51769
+ * It is considered only when margin type is set as "custom". When the margin type is "default", the default
51770
+ * value is "5mm". If "none" is maintained, then the value is "0".
51771
+ * - marginRight: It must be a number and it must be in the unit specified within the page configuration.
51772
+ * It is considered only when margin type is set as "custom". When the margin type is "default", the default
51773
+ * value is "5mm". If "none" is maintained, then the value is "0".
51774
+ * - marginTop: It must be a number and it must be in the unit specified within the page configuration.
51775
+ * It is considered only when margin type is set as "custom". When the margin type is "default", the default
51776
+ * value is "5mm". If "none" is maintained, then the value is "0".
51777
+ * - marginLocked: It must be a boolean value. If set to true, it signifies all four margins get synced
51778
+ * on the same value. If the value is provided by the application, the margin top is considered for all
51779
+ * four margins. Default value is false and considered only when the margin type is "custom".
51780
+ * durationConfig - The duration configuration object with following given keys.
51781
+ * - duration: Possible values are "all" | "week" | "month" | "custom". Select the date duration of the
51782
+ * print page. Default value is "all".
51783
+ * - If the provided value is "all", then the total horizon is set as duration. Values provided in "startDate"
51784
+ * and "endDate" are ignored.
51785
+ * - If the provided value is "week", then the next week is set as duration. Values provided in "startDate"
51786
+ * and "endDate" are ignored.
51787
+ * - If the provided value is "month", then the next month is set as duration. Values provided in "startDate"
51788
+ * and "endDate" are ignored.
51789
+ * - If the provided value is "custom", then the value provided in "startDate" and "endDate" is set as
51790
+ * duration.
51791
+ * - startDate: This is a UI5 date object. It is the start date of a print page. It is considered only
51792
+ * when the "duration" is set as "custom".
51793
+ * - endDate: This is a UI5 date object. It is the end date of a print page. It is considered only when
51794
+ * the "duration" is set as "custom". exportConfig - The export configuration object with the
51795
+ * following given keys.
51796
+ * - exportAsJPEG: It must be a boolean value. It is a flag to decide whether to export the pdf as a
51797
+ * JPEG or not. Default value is true, which means that the exported PDF has content in a JPEG image format.
51798
+ * This is not applicable for single page API.
51799
+ * - exportRange: It must be a string value such as, '0,1". It is the range of the export. This is not
51800
+ * applicable for a single page API and when "exportAll" is set to true.
51801
+ * - exportAll: It must be a boolean value. It is a flag to decide whether to export all the pages or
51802
+ * not. Default value is true. This is not applicable for a single page API.
51803
+ * - compressionQuality: It must be a number between the range of 1 to 100. The quality of the compression
51804
+ * is applicable only when "exportAsJPEG" is set to true. Default value is 75. This is not applicable for
51805
+ * a single page API.
51806
+ * - scale: It must be a number between the range of 50 to 100. This is to scale the export up or down.
51807
+ * Default value is 100. This is not applicable for a single page API.
51808
+ * - multiplePage: It must be a boolean value. It is a flag to decide whether if the export is multiple
51809
+ * page. This is not applicable for a single page API. If the configuration is incorrect, errors
51810
+ * with the following codes are shown.
51811
+ * - TYPE_ERROR - If the type of the property is not as expected.
51812
+ * - RANGE_ERROR - If the value of the property is not in the expected range or not in the list specified.
51813
+ *
51814
+ * - REQUIRED_ERROR - If the required property is missing.
51756
51815
  */
51757
51816
  printConfiguartionObject: object
51758
51817
  );
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/insights/library" {}
4
4
 
@@ -519,6 +519,10 @@ declare module "sap/insights/ManageCards" {
519
519
  export default class ManageCards extends Control {
520
520
  /**
521
521
  * Constructor for ManageCards.
522
+ *
523
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
524
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
525
+ * of the syntax of the settings object.
522
526
  */
523
527
  constructor();
524
528
 
@@ -553,6 +557,12 @@ declare module "sap/insights/ManageCards" {
553
557
  * @returns Metadata object describing this class
554
558
  */
555
559
  static getMetadata(): ElementMetadata;
560
+ /**
561
+ * Function to Clear Activities like navigation, filters
562
+ *
563
+ * @experimental (since 1.119)
564
+ */
565
+ clearPage(): void;
556
566
  /**
557
567
  * Gets current value of property {@link #getCardId cardId}.
558
568
  *
@@ -574,6 +584,19 @@ declare module "sap/insights/ManageCards" {
574
584
  * @returns Value of property `enableResetAllCards`
575
585
  */
576
586
  getEnableResetAllCards(): boolean;
587
+ /**
588
+ * Function to navigate to the specified page, if no sPageId provided navigate to CardList by default
589
+ */
590
+ navigateTo(
591
+ /**
592
+ * oEvent object
593
+ */
594
+ oEvent: Object,
595
+ /**
596
+ * page id to which to navigate to
597
+ */
598
+ sPageId: String
599
+ ): void;
577
600
  /**
578
601
  * Sets a new value for property {@link #getCardId cardId}.
579
602
  *