@sapui5/types 1.125.1 → 1.126.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/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +75 -89
  7. package/types/sap.cux.home.d.ts +336 -0
  8. package/types/sap.esh.search.ui.d.ts +65 -144
  9. package/types/sap.f.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +13 -3
  12. package/types/sap.fe.macros.d.ts +156 -126
  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 +1 -1
  17. package/types/sap.fe.test.d.ts +1 -1
  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 +885 -21
  21. package/types/sap.insights.d.ts +1 -1
  22. package/types/sap.m.d.ts +510 -720
  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 +25 -8
  27. package/types/sap.rules.ui.d.ts +1 -1
  28. package/types/sap.sac.df.d.ts +89 -250
  29. package/types/sap.suite.ui.commons.d.ts +6 -5
  30. package/types/sap.suite.ui.generic.template.d.ts +4 -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 +1 -1
  34. package/types/sap.ui.commons.d.ts +1 -1
  35. package/types/sap.ui.comp.d.ts +1699 -1226
  36. package/types/sap.ui.core.d.ts +356 -287
  37. package/types/sap.ui.dt.d.ts +1 -1
  38. package/types/sap.ui.export.d.ts +2 -2
  39. package/types/sap.ui.fl.d.ts +7 -1
  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 +26 -117
  43. package/types/sap.ui.layout.d.ts +43 -32
  44. package/types/sap.ui.mdc.d.ts +830 -2992
  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 +14 -3
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +1 -153
  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 +16 -271
  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 +1 -1
  61. package/types/sap.ushell_abap.d.ts +1 -1
  62. package/types/sap.uxap.d.ts +3 -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.125.0
1
+ // For Library Version: 1.126.0
2
2
 
3
3
  declare module "sap/gantt/library" {
4
4
  import ChartScheme from "sap/gantt/config/ChartScheme";
@@ -1594,6 +1594,8 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
1594
1594
 
1595
1595
  import { MouseWheelZoomType } from "sap/gantt/library";
1596
1596
 
1597
+ import SkipPattern from "sap/gantt/skipTime/SkipPattern";
1598
+
1597
1599
  import TimeHorizon from "sap/gantt/config/TimeHorizon";
1598
1600
 
1599
1601
  import CalendarWeekNumbering from "sap/ui/core/date/CalendarWeekNumbering";
@@ -1768,6 +1770,14 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
1768
1770
  */
1769
1771
  oLocale: Locale
1770
1772
  ): void;
1773
+ /**
1774
+ * Destroys the skipTimePattern in the aggregation {@link #getSkipTimePattern skipTimePattern}.
1775
+ *
1776
+ * @experimental (since 1.126)
1777
+ *
1778
+ * @returns Reference to `this` in order to allow method chaining
1779
+ */
1780
+ destroySkipTimePattern(): this;
1771
1781
  /**
1772
1782
  * Destroys the totalHorizon in the aggregation {@link #getTotalHorizon totalHorizon}.
1773
1783
  *
@@ -1860,6 +1870,18 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
1860
1870
  getMouseWheelZoomType():
1861
1871
  | MouseWheelZoomType
1862
1872
  | keyof typeof MouseWheelZoomType;
1873
+ /**
1874
+ * Gets content of aggregation {@link #getSkipTimePattern skipTimePattern}.
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.
1879
+ *
1880
+ * The default value for skipTimePattern is null.
1881
+ *
1882
+ * @experimental (since 1.126)
1883
+ */
1884
+ getSkipTimePattern(): SkipPattern;
1863
1885
  /**
1864
1886
  * Gets current value of property {@link #getTimeLineOption timeLineOption}.
1865
1887
  *
@@ -1876,12 +1898,13 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
1876
1898
  * - granularity level: time span between two neighboring vertical lines. Examples: 12 hours.
1877
1899
  * - labelling format: time formats for the upper row and lower row in the time line. These two rows do
1878
1900
  * not have to share the same format.
1879
- * - range: defines a certain length in pixel. Gantt Chart loops the granularity levels from the beginning
1880
- * and chooses the first granularity level with the time span that consumes more than the defined length.
1881
- * For example, if the current range is 90, Gantt Chart loops the granularity levels from the default initial
1882
- * granularity level 5min. If the 6hour granularity level consumes 50 pixels, 12hour consumes 100 pixels,
1883
- * and 1Day consumes 200 pixels, the 12hour granularity level is selected as the current granularity level
1884
- * as it's the first level with the time span that consumes more than 90 pixels.
1901
+ * - range: defines a certain length in pixel. This can be a value, or a function that returns the value.
1902
+ * Gantt Chart loops the granularity levels from the beginning and chooses the first granularity level with
1903
+ * the time span that consumes more than the defined length. For example, if the current range is 90, Gantt
1904
+ * Chart loops the granularity levels from the default initial granularity level 5min. If the 6hour granularity
1905
+ * level consumes 50 pixels, 12hour consumes 100 pixels, and 1Day consumes 200 pixels, the 12hour granularity
1906
+ * level is selected as the current granularity level as it's the first level with the time span that consumes
1907
+ * more than 90 pixels.
1885
1908
  *
1886
1909
  * The granularity level is a JSON object with the granularity as the key and some internal information
1887
1910
  * such as formatting.
@@ -2117,6 +2140,19 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
2117
2140
  */
2118
2141
  sMouseWheelZoomType?: MouseWheelZoomType | keyof typeof MouseWheelZoomType
2119
2142
  ): this;
2143
+ /**
2144
+ * Sets the skip time pattern for gantt chart
2145
+ */
2146
+ setSkipTimePattern(
2147
+ /**
2148
+ * Skip time pattern to be set
2149
+ */
2150
+ oSkipTimePattern: SkipPattern,
2151
+ /**
2152
+ * Flag to suppress re-rendering of the control
2153
+ */
2154
+ bSuppressInvalidate: Boolean
2155
+ ): void;
2120
2156
  /**
2121
2157
  * Sets a new value for property {@link #getTimeLineOption timeLineOption}.
2122
2158
  *
@@ -2140,12 +2176,13 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
2140
2176
  * - granularity level: time span between two neighboring vertical lines. Examples: 12 hours.
2141
2177
  * - labelling format: time formats for the upper row and lower row in the time line. These two rows do
2142
2178
  * not have to share the same format.
2143
- * - range: defines a certain length in pixel. Gantt Chart loops the granularity levels from the beginning
2144
- * and chooses the first granularity level with the time span that consumes more than the defined length.
2145
- * For example, if the current range is 90, Gantt Chart loops the granularity levels from the default initial
2146
- * granularity level 5min. If the 6hour granularity level consumes 50 pixels, 12hour consumes 100 pixels,
2147
- * and 1Day consumes 200 pixels, the 12hour granularity level is selected as the current granularity level
2148
- * as it's the first level with the time span that consumes more than 90 pixels.
2179
+ * - range: defines a certain length in pixel. This can be a value, or a function that returns the value.
2180
+ * Gantt Chart loops the granularity levels from the beginning and chooses the first granularity level with
2181
+ * the time span that consumes more than the defined length. For example, if the current range is 90, Gantt
2182
+ * Chart loops the granularity levels from the default initial granularity level 5min. If the 6hour granularity
2183
+ * level consumes 50 pixels, 12hour consumes 100 pixels, and 1Day consumes 200 pixels, the 12hour granularity
2184
+ * level is selected as the current granularity level as it's the first level with the time span that consumes
2185
+ * more than 90 pixels.
2149
2186
  *
2150
2187
  * The granularity level is a JSON object with the granularity as the key and some internal information
2151
2188
  * such as formatting.
@@ -2354,12 +2391,13 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
2354
2391
  * - granularity level: time span between two neighboring vertical lines. Examples: 12 hours.
2355
2392
  * - labelling format: time formats for the upper row and lower row in the time line. These two rows do
2356
2393
  * not have to share the same format.
2357
- * - range: defines a certain length in pixel. Gantt Chart loops the granularity levels from the beginning
2358
- * and chooses the first granularity level with the time span that consumes more than the defined length.
2359
- * For example, if the current range is 90, Gantt Chart loops the granularity levels from the default initial
2360
- * granularity level 5min. If the 6hour granularity level consumes 50 pixels, 12hour consumes 100 pixels,
2361
- * and 1Day consumes 200 pixels, the 12hour granularity level is selected as the current granularity level
2362
- * as it's the first level with the time span that consumes more than 90 pixels.
2394
+ * - range: defines a certain length in pixel. This can be a value, or a function that returns the value.
2395
+ * Gantt Chart loops the granularity levels from the beginning and chooses the first granularity level with
2396
+ * the time span that consumes more than the defined length. For example, if the current range is 90, Gantt
2397
+ * Chart loops the granularity levels from the default initial granularity level 5min. If the 6hour granularity
2398
+ * level consumes 50 pixels, 12hour consumes 100 pixels, and 1Day consumes 200 pixels, the 12hour granularity
2399
+ * level is selected as the current granularity level as it's the first level with the time span that consumes
2400
+ * more than 90 pixels.
2363
2401
  *
2364
2402
  * The granularity level is a JSON object with the granularity as the key and some internal information
2365
2403
  * such as formatting.
@@ -2503,6 +2541,17 @@ declare module "sap/gantt/axistime/AxisTimeStrategyBase" {
2503
2541
  * Default visible horizon value is `sap.gantt.config.DEFAULT_VISIBLE_HORIZON`
2504
2542
  */
2505
2543
  visibleHorizon?: TimeHorizon;
2544
+
2545
+ /**
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.
2549
+ *
2550
+ * The default value for skipTimePattern is null.
2551
+ *
2552
+ * @experimental (since 1.126)
2553
+ */
2554
+ skipTimePattern?: SkipPattern;
2506
2555
  }
2507
2556
  }
2508
2557
 
@@ -23163,7 +23212,7 @@ declare module "sap/gantt/shape/ext/rls/SelectedRelationship" {
23163
23212
  * Provides an implementation of shape for drawing relationships with red and wider lines when they
23164
23213
  * are selected.
23165
23214
  *
23166
- * @deprecated (since 1.64)
23215
+ * @deprecated (since 1.64) - the concept has been discarded.
23167
23216
  */
23168
23217
  export default class SelectedRelationship extends Relationship {
23169
23218
  /**
@@ -23334,7 +23383,7 @@ declare module "sap/gantt/shape/ext/rls/SelectedRelationship" {
23334
23383
  /**
23335
23384
  * Describes the settings that can be provided to the SelectedRelationship constructor.
23336
23385
  *
23337
- * @deprecated (since 1.64)
23386
+ * @deprecated (since 1.64) - the concept has been discarded.
23338
23387
  */
23339
23388
  export interface $SelectedRelationshipSettings extends $RelationshipSettings {
23340
23389
  /**
@@ -41305,6 +41354,18 @@ declare module "sap/gantt/simple/GanttChartContainer" {
41305
41354
  * @returns Value of property `enableAdhocLine`
41306
41355
  */
41307
41356
  getEnableAdhocLine(): boolean;
41357
+ /**
41358
+ * Gets current value of property {@link #getEnableAutoFocusOnZoom enableAutoFocusOnZoom}.
41359
+ *
41360
+ * This property enables auto focus while zooming in on a selected shape.
41361
+ *
41362
+ * Default value is `false`.
41363
+ *
41364
+ * @since 1.126
41365
+ *
41366
+ * @returns Value of property `enableAutoFocusOnZoom`
41367
+ */
41368
+ getEnableAutoFocusOnZoom(): boolean;
41308
41369
  /**
41309
41370
  * Gets current value of property {@link #getEnableAutoSelectOnFind enableAutoSelectOnFind}.
41310
41371
  *
@@ -41679,6 +41740,25 @@ declare module "sap/gantt/simple/GanttChartContainer" {
41679
41740
  */
41680
41741
  bEnableAdhocLine?: boolean
41681
41742
  ): this;
41743
+ /**
41744
+ * Sets a new value for property {@link #getEnableAutoFocusOnZoom enableAutoFocusOnZoom}.
41745
+ *
41746
+ * This property enables auto focus while zooming in on a selected shape.
41747
+ *
41748
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
41749
+ *
41750
+ * Default value is `false`.
41751
+ *
41752
+ * @since 1.126
41753
+ *
41754
+ * @returns Reference to `this` in order to allow method chaining
41755
+ */
41756
+ setEnableAutoFocusOnZoom(
41757
+ /**
41758
+ * New value for property `enableAutoFocusOnZoom`
41759
+ */
41760
+ bEnableAutoFocusOnZoom?: boolean
41761
+ ): this;
41682
41762
  /**
41683
41763
  * Sets a new value for property {@link #getEnableAutoSelectOnFind enableAutoSelectOnFind}.
41684
41764
  *
@@ -42233,6 +42313,13 @@ declare module "sap/gantt/simple/GanttChartContainer" {
42233
42313
  */
42234
42314
  enableAutoSelectOnFind?: boolean | PropertyBindingInfo | `{${string}}`;
42235
42315
 
42316
+ /**
42317
+ * This property enables auto focus while zooming in on a selected shape.
42318
+ *
42319
+ * @since 1.126
42320
+ */
42321
+ enableAutoFocusOnZoom?: boolean | PropertyBindingInfo | `{${string}}`;
42322
+
42236
42323
  /**
42237
42324
  * Toolbar of the container.
42238
42325
  */
@@ -55141,6 +55228,773 @@ declare module "sap/gantt/simple/UtilizationPeriod" {
55141
55228
  }
55142
55229
  }
55143
55230
 
55231
+ declare module "sap/gantt/skipTime/DayInterval" {
55232
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
55233
+
55234
+ import SkipInterval from "sap/gantt/skipTime/SkipInterval";
55235
+
55236
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
55237
+
55238
+ import {
55239
+ PropertyBindingInfo,
55240
+ AggregationBindingInfo,
55241
+ } from "sap/ui/base/ManagedObject";
55242
+
55243
+ /**
55244
+ * Enables the user to define skip time pattern within a day.
55245
+ *
55246
+ * @since 1.126
55247
+ */
55248
+ export default class DayInterval extends UI5Element {
55249
+ /**
55250
+ * Creates and initializes a new class for day interval.
55251
+ *
55252
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
55253
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
55254
+ * of the syntax of the settings object.
55255
+ */
55256
+ constructor(
55257
+ /**
55258
+ * ID of the new control. The ID is generated automatically if it is not provided.
55259
+ */
55260
+ sId?: string,
55261
+ /**
55262
+ * Initial settings for the new control
55263
+ */
55264
+ mSetting?: object
55265
+ );
55266
+
55267
+ /**
55268
+ * Creates a new subclass of class sap.gantt.skipTime.DayInterval with name `sClassName` and enriches it
55269
+ * with the information contained in `oClassInfo`.
55270
+ *
55271
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
55272
+ *
55273
+ *
55274
+ * @returns Created class / constructor function
55275
+ */
55276
+ static extend<T extends Record<string, unknown>>(
55277
+ /**
55278
+ * Name of the class being created
55279
+ */
55280
+ sClassName: string,
55281
+ /**
55282
+ * Object literal with information about the class
55283
+ */
55284
+ oClassInfo?: sap.ClassInfo<T, DayInterval>,
55285
+ /**
55286
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
55287
+ * used by this class
55288
+ */
55289
+ FNMetaImpl?: Function
55290
+ ): Function;
55291
+ /**
55292
+ * Returns a metadata object for class sap.gantt.skipTime.DayInterval.
55293
+ *
55294
+ *
55295
+ * @returns Metadata object describing this class
55296
+ */
55297
+ static getMetadata(): ElementMetadata;
55298
+ /**
55299
+ * Adds some skipInterval to the aggregation {@link #getSkipIntervals skipIntervals}.
55300
+ *
55301
+ * @since 1.126
55302
+ *
55303
+ * @returns Reference to `this` in order to allow method chaining
55304
+ */
55305
+ addSkipInterval(
55306
+ /**
55307
+ * The skipInterval to add; if empty, nothing is inserted
55308
+ */
55309
+ oSkipInterval: SkipInterval
55310
+ ): this;
55311
+ /**
55312
+ * Destroys all the skipIntervals in the aggregation {@link #getSkipIntervals skipIntervals}.
55313
+ *
55314
+ * @since 1.126
55315
+ *
55316
+ * @returns Reference to `this` in order to allow method chaining
55317
+ */
55318
+ destroySkipIntervals(): this;
55319
+ /**
55320
+ * Gets current value of property {@link #getDay day}.
55321
+ *
55322
+ * Non-working day, supported values: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday",
55323
+ * "Sunday"
55324
+ *
55325
+ * @since 1.126
55326
+ *
55327
+ * @returns Value of property `day`
55328
+ */
55329
+ getDay(): string;
55330
+ /**
55331
+ * Gets content of aggregation {@link #getSkipIntervals skipIntervals}.
55332
+ *
55333
+ * Time intervals to be skipped for the day.
55334
+ *
55335
+ * @since 1.126
55336
+ */
55337
+ getSkipIntervals(): SkipInterval[];
55338
+ /**
55339
+ * Checks for the provided `sap.gantt.skipTime.SkipInterval` in the aggregation {@link #getSkipIntervals skipIntervals}.
55340
+ * and returns its index if found or -1 otherwise.
55341
+ *
55342
+ * @since 1.126
55343
+ *
55344
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
55345
+ */
55346
+ indexOfSkipInterval(
55347
+ /**
55348
+ * The skipInterval whose index is looked for
55349
+ */
55350
+ oSkipInterval: SkipInterval
55351
+ ): int;
55352
+ /**
55353
+ * Inserts a skipInterval into the aggregation {@link #getSkipIntervals skipIntervals}.
55354
+ *
55355
+ * @since 1.126
55356
+ *
55357
+ * @returns Reference to `this` in order to allow method chaining
55358
+ */
55359
+ insertSkipInterval(
55360
+ /**
55361
+ * The skipInterval to insert; if empty, nothing is inserted
55362
+ */
55363
+ oSkipInterval: SkipInterval,
55364
+ /**
55365
+ * The `0`-based index the skipInterval should be inserted at; for a negative value of `iIndex`, the skipInterval
55366
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the skipInterval
55367
+ * is inserted at the last position
55368
+ */
55369
+ iIndex: int
55370
+ ): this;
55371
+ /**
55372
+ * Removes all the controls from the aggregation {@link #getSkipIntervals skipIntervals}.
55373
+ *
55374
+ * Additionally, it unregisters them from the hosting UIArea.
55375
+ *
55376
+ * @since 1.126
55377
+ *
55378
+ * @returns An array of the removed elements (might be empty)
55379
+ */
55380
+ removeAllSkipIntervals(): SkipInterval[];
55381
+ /**
55382
+ * Removes a skipInterval from the aggregation {@link #getSkipIntervals skipIntervals}.
55383
+ *
55384
+ * @since 1.126
55385
+ *
55386
+ * @returns The removed skipInterval or `null`
55387
+ */
55388
+ removeSkipInterval(
55389
+ /**
55390
+ * The skipInterval to remove or its index or id
55391
+ */
55392
+ vSkipInterval: int | string | SkipInterval
55393
+ ): SkipInterval | null;
55394
+ /**
55395
+ * Sets a new value for property {@link #getDay day}.
55396
+ *
55397
+ * Non-working day, supported values: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday",
55398
+ * "Sunday"
55399
+ *
55400
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
55401
+ *
55402
+ * @since 1.126
55403
+ *
55404
+ * @returns Reference to `this` in order to allow method chaining
55405
+ */
55406
+ setDay(
55407
+ /**
55408
+ * New value for property `day`
55409
+ */
55410
+ sDay: string
55411
+ ): this;
55412
+ }
55413
+ /**
55414
+ * Describes the settings that can be provided to the DayInterval constructor.
55415
+ */
55416
+ export interface $DayIntervalSettings extends $ElementSettings {
55417
+ /**
55418
+ * Non-working day, supported values: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday",
55419
+ * "Sunday"
55420
+ *
55421
+ * @since 1.126
55422
+ */
55423
+ day?: string | PropertyBindingInfo;
55424
+
55425
+ /**
55426
+ * Time intervals to be skipped for the day.
55427
+ *
55428
+ * @since 1.126
55429
+ */
55430
+ skipIntervals?:
55431
+ | SkipInterval[]
55432
+ | SkipInterval
55433
+ | AggregationBindingInfo
55434
+ | `{${string}}`;
55435
+ }
55436
+ }
55437
+
55438
+ declare module "sap/gantt/skipTime/DiscontinuousProvider" {
55439
+ /**
55440
+ * @since 1.126
55441
+ */
55442
+ export default class DiscontinuousProvider {
55443
+ /**
55444
+ * Creates and initializes a new class for DiscontinuousProvider. Enables the user to define custom discontinuous
55445
+ * provider.
55446
+ */
55447
+ constructor();
55448
+ }
55449
+ }
55450
+
55451
+ declare module "sap/gantt/skipTime/SkipInterval" {
55452
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
55453
+
55454
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
55455
+
55456
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
55457
+
55458
+ /**
55459
+ * Enables the user to define skip time interval.
55460
+ *
55461
+ * @since 1.126
55462
+ */
55463
+ export default class SkipInterval extends UI5Element {
55464
+ /**
55465
+ * Creates and initializes a new class for skip interval.
55466
+ *
55467
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
55468
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
55469
+ * of the syntax of the settings object.
55470
+ */
55471
+ constructor(
55472
+ /**
55473
+ * ID of the new control. The ID is generated automatically if it is not provided.
55474
+ */
55475
+ sId?: string,
55476
+ /**
55477
+ * Initial settings for the new control
55478
+ */
55479
+ mSetting?: object
55480
+ );
55481
+
55482
+ /**
55483
+ * Creates a new subclass of class sap.gantt.skipTime.SkipInterval with name `sClassName` and enriches it
55484
+ * with the information contained in `oClassInfo`.
55485
+ *
55486
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
55487
+ *
55488
+ *
55489
+ * @returns Created class / constructor function
55490
+ */
55491
+ static extend<T extends Record<string, unknown>>(
55492
+ /**
55493
+ * Name of the class being created
55494
+ */
55495
+ sClassName: string,
55496
+ /**
55497
+ * Object literal with information about the class
55498
+ */
55499
+ oClassInfo?: sap.ClassInfo<T, SkipInterval>,
55500
+ /**
55501
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
55502
+ * used by this class
55503
+ */
55504
+ FNMetaImpl?: Function
55505
+ ): Function;
55506
+ /**
55507
+ * Returns a metadata object for class sap.gantt.skipTime.SkipInterval.
55508
+ *
55509
+ *
55510
+ * @returns Metadata object describing this class
55511
+ */
55512
+ static getMetadata(): ElementMetadata;
55513
+ /**
55514
+ * Gets current value of property {@link #getEndTime endTime}.
55515
+ *
55516
+ * End time with in a day till which time is to be skipped. Format: HHMMSS.
55517
+ *
55518
+ * Default value is `"235959"`.
55519
+ *
55520
+ * @since 1.126
55521
+ *
55522
+ * @returns Value of property `endTime`
55523
+ */
55524
+ getEndTime(): string;
55525
+ /**
55526
+ * Gets current value of property {@link #getStartTime startTime}.
55527
+ *
55528
+ * Start time with in a day from which time is to be skipped. Format: HHMMSS.
55529
+ *
55530
+ * Default value is `"000000"`.
55531
+ *
55532
+ * @since 1.126
55533
+ *
55534
+ * @returns Value of property `startTime`
55535
+ */
55536
+ getStartTime(): string;
55537
+ /**
55538
+ * Sets a new value for property {@link #getEndTime endTime}.
55539
+ *
55540
+ * End time with in a day till which time is to be skipped. Format: HHMMSS.
55541
+ *
55542
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
55543
+ *
55544
+ * Default value is `"235959"`.
55545
+ *
55546
+ * @since 1.126
55547
+ *
55548
+ * @returns Reference to `this` in order to allow method chaining
55549
+ */
55550
+ setEndTime(
55551
+ /**
55552
+ * New value for property `endTime`
55553
+ */
55554
+ sEndTime?: string
55555
+ ): this;
55556
+ /**
55557
+ * Sets a new value for property {@link #getStartTime startTime}.
55558
+ *
55559
+ * Start time with in a day from which time is to be skipped. Format: HHMMSS.
55560
+ *
55561
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
55562
+ *
55563
+ * Default value is `"000000"`.
55564
+ *
55565
+ * @since 1.126
55566
+ *
55567
+ * @returns Reference to `this` in order to allow method chaining
55568
+ */
55569
+ setStartTime(
55570
+ /**
55571
+ * New value for property `startTime`
55572
+ */
55573
+ sStartTime?: string
55574
+ ): this;
55575
+ }
55576
+ /**
55577
+ * Describes the settings that can be provided to the SkipInterval constructor.
55578
+ */
55579
+ export interface $SkipIntervalSettings extends $ElementSettings {
55580
+ /**
55581
+ * Start time with in a day from which time is to be skipped. Format: HHMMSS.
55582
+ *
55583
+ * @since 1.126
55584
+ */
55585
+ startTime?: string | PropertyBindingInfo;
55586
+
55587
+ /**
55588
+ * End time with in a day till which time is to be skipped. Format: HHMMSS.
55589
+ *
55590
+ * @since 1.126
55591
+ */
55592
+ endTime?: string | PropertyBindingInfo;
55593
+ }
55594
+ }
55595
+
55596
+ declare module "sap/gantt/skipTime/SkipPattern" {
55597
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
55598
+
55599
+ import DiscontinuousProvider from "sap/gantt/skipTime/DiscontinuousProvider";
55600
+
55601
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
55602
+
55603
+ /**
55604
+ * Enables the user to define skip time pattern.
55605
+ *
55606
+ * @since 1.126
55607
+ */
55608
+ export default class SkipPattern extends UI5Element {
55609
+ /**
55610
+ * Creates and initializes a new class for skip time pattern.
55611
+ *
55612
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
55613
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
55614
+ * of the syntax of the settings object.
55615
+ *
55616
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Element#constructor sap.ui.core.Element }
55617
+ * can be used.
55618
+ */
55619
+ constructor(
55620
+ /**
55621
+ * ID of the new control. The ID is generated automatically if it is not provided.
55622
+ */
55623
+ sId?: string,
55624
+ /**
55625
+ * Initial settings for the new control
55626
+ */
55627
+ mSetting?: object
55628
+ );
55629
+
55630
+ /**
55631
+ * Creates a new subclass of class sap.gantt.skipTime.SkipPattern with name `sClassName` and enriches it
55632
+ * with the information contained in `oClassInfo`.
55633
+ *
55634
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
55635
+ *
55636
+ *
55637
+ * @returns Created class / constructor function
55638
+ */
55639
+ static extend<T extends Record<string, unknown>>(
55640
+ /**
55641
+ * Name of the class being created
55642
+ */
55643
+ sClassName: string,
55644
+ /**
55645
+ * Object literal with information about the class
55646
+ */
55647
+ oClassInfo?: sap.ClassInfo<T, SkipPattern>,
55648
+ /**
55649
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
55650
+ * used by this class
55651
+ */
55652
+ FNMetaImpl?: Function
55653
+ ): Function;
55654
+ /**
55655
+ * Returns a metadata object for class sap.gantt.skipTime.SkipPattern.
55656
+ *
55657
+ *
55658
+ * @returns Metadata object describing this class
55659
+ */
55660
+ static getMetadata(): ElementMetadata;
55661
+ /**
55662
+ * Returns the discontinuity provider of the skip pattern. Default value is null
55663
+ *
55664
+ *
55665
+ * @returns Discontinuity provider of the skip pattern
55666
+ */
55667
+ getDiscontinuityProvider(): DiscontinuousProvider;
55668
+ /**
55669
+ * Updates the discontinuity provider for the gantt chart timeline.
55670
+ */
55671
+ updateDiscontinuousProvider(
55672
+ /**
55673
+ * Discontinuous provider to be set
55674
+ */
55675
+ oDiscontinuousProvider: DiscontinuousProvider,
55676
+ /**
55677
+ * Flag to suppress re-rendering of the control.
55678
+ */
55679
+ bSuppressInvalidate: Boolean
55680
+ ): void;
55681
+ }
55682
+ /**
55683
+ * Describes the settings that can be provided to the SkipPattern constructor.
55684
+ */
55685
+ export interface $SkipPatternSettings extends $ElementSettings {}
55686
+ }
55687
+
55688
+ declare module "sap/gantt/skipTime/WeekPattern" {
55689
+ import {
55690
+ default as SkipPattern,
55691
+ $SkipPatternSettings,
55692
+ } from "sap/gantt/skipTime/SkipPattern";
55693
+
55694
+ import DayInterval from "sap/gantt/skipTime/DayInterval";
55695
+
55696
+ import SkipInterval from "sap/gantt/skipTime/SkipInterval";
55697
+
55698
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
55699
+
55700
+ import {
55701
+ PropertyBindingInfo,
55702
+ AggregationBindingInfo,
55703
+ } from "sap/ui/base/ManagedObject";
55704
+
55705
+ /**
55706
+ * Enables the user to define weekly skip pattern. Non working hours are to be removed for timeLineOptions
55707
+ * with innerInterval unit as sap.gantt.config.TimeUnit.day, sap.gantt.config.TimeUnit.hour
55708
+ * and sap.gantt.config.TimeUnit.minute
55709
+ *
55710
+ * @since 1.126
55711
+ */
55712
+ export default class WeekPattern extends SkipPattern {
55713
+ /**
55714
+ * Creates and initializes a new class for weekly time pattern.
55715
+ *
55716
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
55717
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
55718
+ * of the syntax of the settings object.
55719
+ */
55720
+ constructor(
55721
+ /**
55722
+ * ID of the new control. The ID is generated automatically if it is not provided.
55723
+ */
55724
+ sId?: string,
55725
+ /**
55726
+ * Initial settings for the new control
55727
+ */
55728
+ mSetting?: object
55729
+ );
55730
+
55731
+ /**
55732
+ * Creates a new subclass of class sap.gantt.skipTime.WeekPattern with name `sClassName` and enriches it
55733
+ * with the information contained in `oClassInfo`.
55734
+ *
55735
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.gantt.skipTime.SkipPattern.extend}.
55736
+ *
55737
+ *
55738
+ * @returns Created class / constructor function
55739
+ */
55740
+ static extend<T extends Record<string, unknown>>(
55741
+ /**
55742
+ * Name of the class being created
55743
+ */
55744
+ sClassName: string,
55745
+ /**
55746
+ * Object literal with information about the class
55747
+ */
55748
+ oClassInfo?: sap.ClassInfo<T, WeekPattern>,
55749
+ /**
55750
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
55751
+ * used by this class
55752
+ */
55753
+ FNMetaImpl?: Function
55754
+ ): Function;
55755
+ /**
55756
+ * Returns a metadata object for class sap.gantt.skipTime.WeekPattern.
55757
+ *
55758
+ *
55759
+ * @returns Metadata object describing this class
55760
+ */
55761
+ static getMetadata(): ElementMetadata;
55762
+ /**
55763
+ * Adds some dailyInterval to the aggregation {@link #getDailyIntervals dailyIntervals}.
55764
+ *
55765
+ * @since 1.126
55766
+ *
55767
+ * @returns Reference to `this` in order to allow method chaining
55768
+ */
55769
+ addDailyInterval(
55770
+ /**
55771
+ * The dailyInterval to add; if empty, nothing is inserted
55772
+ */
55773
+ oDailyInterval: DayInterval
55774
+ ): this;
55775
+ /**
55776
+ * Adds some weeklyInterval to the aggregation {@link #getWeeklyIntervals weeklyIntervals}.
55777
+ *
55778
+ * @since 1.126
55779
+ *
55780
+ * @returns Reference to `this` in order to allow method chaining
55781
+ */
55782
+ addWeeklyInterval(
55783
+ /**
55784
+ * The weeklyInterval to add; if empty, nothing is inserted
55785
+ */
55786
+ oWeeklyInterval: SkipInterval
55787
+ ): this;
55788
+ /**
55789
+ * Destroys all the dailyIntervals in the aggregation {@link #getDailyIntervals dailyIntervals}.
55790
+ *
55791
+ * @since 1.126
55792
+ *
55793
+ * @returns Reference to `this` in order to allow method chaining
55794
+ */
55795
+ destroyDailyIntervals(): this;
55796
+ /**
55797
+ * Destroys all the weeklyIntervals in the aggregation {@link #getWeeklyIntervals weeklyIntervals}.
55798
+ *
55799
+ * @since 1.126
55800
+ *
55801
+ * @returns Reference to `this` in order to allow method chaining
55802
+ */
55803
+ destroyWeeklyIntervals(): this;
55804
+ /**
55805
+ * Gets content of aggregation {@link #getDailyIntervals dailyIntervals}.
55806
+ *
55807
+ * Day-wise non working time. These intervals are going to be skipped for the specified day.
55808
+ *
55809
+ * @since 1.126
55810
+ */
55811
+ getDailyIntervals(): DayInterval[];
55812
+ /**
55813
+ * Utility method to calculate the discontinuity provider for the week pattern
55814
+ *
55815
+ *
55816
+ * @returns returns the discontinuity provider of the week pattern
55817
+ */
55818
+ getDiscontinuityProvider(): object;
55819
+ /**
55820
+ * Gets current value of property {@link #getEnabled enabled}.
55821
+ *
55822
+ * If this property is set to true, week pattern is applied to the gantt chart.
55823
+ *
55824
+ * Default value is `true`.
55825
+ *
55826
+ * @since 1.126
55827
+ *
55828
+ * @returns Value of property `enabled`
55829
+ */
55830
+ getEnabled(): boolean;
55831
+ /**
55832
+ * Gets content of aggregation {@link #getWeeklyIntervals weeklyIntervals}.
55833
+ *
55834
+ * Weekly non working time. This time is going to be skipped for all the days unless dailyIntervals are
55835
+ * defined for that day.
55836
+ *
55837
+ * @since 1.126
55838
+ */
55839
+ getWeeklyIntervals(): SkipInterval[];
55840
+ /**
55841
+ * Checks for the provided `sap.gantt.skipTime.DayInterval` in the aggregation {@link #getDailyIntervals dailyIntervals}.
55842
+ * and returns its index if found or -1 otherwise.
55843
+ *
55844
+ * @since 1.126
55845
+ *
55846
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
55847
+ */
55848
+ indexOfDailyInterval(
55849
+ /**
55850
+ * The dailyInterval whose index is looked for
55851
+ */
55852
+ oDailyInterval: DayInterval
55853
+ ): int;
55854
+ /**
55855
+ * Checks for the provided `sap.gantt.skipTime.SkipInterval` in the aggregation {@link #getWeeklyIntervals weeklyIntervals}.
55856
+ * and returns its index if found or -1 otherwise.
55857
+ *
55858
+ * @since 1.126
55859
+ *
55860
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
55861
+ */
55862
+ indexOfWeeklyInterval(
55863
+ /**
55864
+ * The weeklyInterval whose index is looked for
55865
+ */
55866
+ oWeeklyInterval: SkipInterval
55867
+ ): int;
55868
+ /**
55869
+ * Inserts a dailyInterval into the aggregation {@link #getDailyIntervals dailyIntervals}.
55870
+ *
55871
+ * @since 1.126
55872
+ *
55873
+ * @returns Reference to `this` in order to allow method chaining
55874
+ */
55875
+ insertDailyInterval(
55876
+ /**
55877
+ * The dailyInterval to insert; if empty, nothing is inserted
55878
+ */
55879
+ oDailyInterval: DayInterval,
55880
+ /**
55881
+ * The `0`-based index the dailyInterval should be inserted at; for a negative value of `iIndex`, the dailyInterval
55882
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the dailyInterval
55883
+ * is inserted at the last position
55884
+ */
55885
+ iIndex: int
55886
+ ): this;
55887
+ /**
55888
+ * Inserts a weeklyInterval into the aggregation {@link #getWeeklyIntervals weeklyIntervals}.
55889
+ *
55890
+ * @since 1.126
55891
+ *
55892
+ * @returns Reference to `this` in order to allow method chaining
55893
+ */
55894
+ insertWeeklyInterval(
55895
+ /**
55896
+ * The weeklyInterval to insert; if empty, nothing is inserted
55897
+ */
55898
+ oWeeklyInterval: SkipInterval,
55899
+ /**
55900
+ * The `0`-based index the weeklyInterval should be inserted at; for a negative value of `iIndex`, the weeklyInterval
55901
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the weeklyInterval
55902
+ * is inserted at the last position
55903
+ */
55904
+ iIndex: int
55905
+ ): this;
55906
+ /**
55907
+ * Removes all the controls from the aggregation {@link #getDailyIntervals dailyIntervals}.
55908
+ *
55909
+ * Additionally, it unregisters them from the hosting UIArea.
55910
+ *
55911
+ * @since 1.126
55912
+ *
55913
+ * @returns An array of the removed elements (might be empty)
55914
+ */
55915
+ removeAllDailyIntervals(): DayInterval[];
55916
+ /**
55917
+ * Removes all the controls from the aggregation {@link #getWeeklyIntervals weeklyIntervals}.
55918
+ *
55919
+ * Additionally, it unregisters them from the hosting UIArea.
55920
+ *
55921
+ * @since 1.126
55922
+ *
55923
+ * @returns An array of the removed elements (might be empty)
55924
+ */
55925
+ removeAllWeeklyIntervals(): SkipInterval[];
55926
+ /**
55927
+ * Removes a dailyInterval from the aggregation {@link #getDailyIntervals dailyIntervals}.
55928
+ *
55929
+ * @since 1.126
55930
+ *
55931
+ * @returns The removed dailyInterval or `null`
55932
+ */
55933
+ removeDailyInterval(
55934
+ /**
55935
+ * The dailyInterval to remove or its index or id
55936
+ */
55937
+ vDailyInterval: int | string | DayInterval
55938
+ ): DayInterval | null;
55939
+ /**
55940
+ * Removes a weeklyInterval from the aggregation {@link #getWeeklyIntervals weeklyIntervals}.
55941
+ *
55942
+ * @since 1.126
55943
+ *
55944
+ * @returns The removed weeklyInterval or `null`
55945
+ */
55946
+ removeWeeklyInterval(
55947
+ /**
55948
+ * The weeklyInterval to remove or its index or id
55949
+ */
55950
+ vWeeklyInterval: int | string | SkipInterval
55951
+ ): SkipInterval | null;
55952
+ /**
55953
+ * Method to enable or disable the week pattern
55954
+ */
55955
+ setEnabled(
55956
+ /**
55957
+ * flag to enable or disable the week pattern
55958
+ */
55959
+ bEnable: boolean
55960
+ ): void;
55961
+ }
55962
+ /**
55963
+ * Describes the settings that can be provided to the WeekPattern constructor.
55964
+ */
55965
+ export interface $WeekPatternSettings extends $SkipPatternSettings {
55966
+ /**
55967
+ * If this property is set to true, week pattern is applied to the gantt chart.
55968
+ *
55969
+ * @since 1.126
55970
+ */
55971
+ enabled?: boolean | PropertyBindingInfo | `{${string}}`;
55972
+
55973
+ /**
55974
+ * Day-wise non working time. These intervals are going to be skipped for the specified day.
55975
+ *
55976
+ * @since 1.126
55977
+ */
55978
+ dailyIntervals?:
55979
+ | DayInterval[]
55980
+ | DayInterval
55981
+ | AggregationBindingInfo
55982
+ | `{${string}}`;
55983
+
55984
+ /**
55985
+ * Weekly non working time. This time is going to be skipped for all the days unless dailyIntervals are
55986
+ * defined for that day.
55987
+ *
55988
+ * @since 1.126
55989
+ */
55990
+ weeklyIntervals?:
55991
+ | SkipInterval[]
55992
+ | SkipInterval
55993
+ | AggregationBindingInfo
55994
+ | `{${string}}`;
55995
+ }
55996
+ }
55997
+
55144
55998
  declare namespace sap {
55145
55999
  /**
55146
56000
  * UI5 library: sap.gantt.
@@ -55461,5 +56315,15 @@ declare namespace sap {
55461
56315
  "sap/gantt/simple/UtilizationLineChart": undefined;
55462
56316
 
55463
56317
  "sap/gantt/simple/UtilizationPeriod": undefined;
56318
+
56319
+ "sap/gantt/skipTime/DayInterval": undefined;
56320
+
56321
+ "sap/gantt/skipTime/DiscontinuousProvider": undefined;
56322
+
56323
+ "sap/gantt/skipTime/SkipInterval": undefined;
56324
+
56325
+ "sap/gantt/skipTime/SkipPattern": undefined;
56326
+
56327
+ "sap/gantt/skipTime/WeekPattern": undefined;
55464
56328
  }
55465
56329
  }