@sapui5/types 1.125.0 → 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/makit/library" {
4
4
  /**
package/types/sap.me.d.ts CHANGED
@@ -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/me/library" {
4
4
  /**
@@ -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/ndc/library" {}
4
4
 
@@ -1,16 +1,31 @@
1
- // For Library Version: 1.125.0
1
+ // For Library Version: 1.126.0
2
2
 
3
3
  declare module "sap/ovp/library" {}
4
4
 
5
5
  declare module "sap/ovp/app/Component" {
6
- import AppComponent from "sap/fe/core/AppComponent";
6
+ import {
7
+ default as AppComponent,
8
+ $AppComponentSettings,
9
+ } from "sap/fe/core/AppComponent";
7
10
 
8
11
  import ComponentMetadata from "sap/ui/core/ComponentMetadata";
9
12
 
10
13
  /**
11
14
  * Overview Page Application Component
12
15
  */
13
- interface Component extends AppComponent {
16
+ export default class Component extends AppComponent {
17
+ /**
18
+ * Main class used for Overview Page Application Component
19
+ *
20
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
21
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
22
+ * of the syntax of the settings object.
23
+ *
24
+ * This class does not have its own settings, but all settings applicable to the base type {@link sap.fe.core.AppComponent#constructor sap.fe.core.AppComponent }
25
+ * can be used.@ui5-updated-doclet
26
+ */
27
+ constructor();
28
+
14
29
  /**
15
30
  * Creates a new subclass of class sap.ovp.app.Component with name `sClassName` and enriches it with the
16
31
  * information contained in `oClassInfo`.
@@ -20,7 +35,7 @@ declare module "sap/ovp/app/Component" {
20
35
  *
21
36
  * @returns Created class / constructor function
22
37
  */
23
- extend(
38
+ static extend<T extends Record<string, unknown>>(
24
39
  /**
25
40
  * Name of the class being created
26
41
  */
@@ -28,7 +43,7 @@ declare module "sap/ovp/app/Component" {
28
43
  /**
29
44
  * Object literal with information about the class
30
45
  */
31
- oClassInfo?: object,
46
+ oClassInfo?: sap.ClassInfo<T, Component>,
32
47
  /**
33
48
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
34
49
  * used by this class
@@ -41,10 +56,12 @@ declare module "sap/ovp/app/Component" {
41
56
  *
42
57
  * @returns Metadata object describing this class
43
58
  */
44
- getMetadata(): ComponentMetadata;
59
+ static getMetadata(): ComponentMetadata;
45
60
  }
46
- const Component: Component;
47
- export default Component;
61
+ /**
62
+ * Describes the settings that can be provided to the Component constructor.
63
+ */
64
+ export interface $ComponentSettings extends $AppComponentSettings {}
48
65
  }
49
66
 
50
67
  declare module "sap/ovp/app/TemplateBaseExtension" {
@@ -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/rules/ui/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.125.1
1
+ // For Library Version: 1.126.0
2
2
 
3
3
  declare module "sap/sac/df/library" {}
4
4
 
@@ -1801,6 +1801,8 @@ declare module "sap/sac/df/model/DataProvider" {
1801
1801
 
1802
1802
  import Variable from "sap/sac/df/model/Variable";
1803
1803
 
1804
+ import Visualization from "sap/sac/df/model/Visualization";
1805
+
1804
1806
  import Metadata from "sap/ui/base/Metadata";
1805
1807
 
1806
1808
  import Event from "sap/ui/base/Event";
@@ -1871,6 +1873,11 @@ declare module "sap/sac/df/model/DataProvider" {
1871
1873
  */
1872
1874
  Variables: Record<string, Variable>;
1873
1875
 
1876
+ /**
1877
+ * Visualizations
1878
+ */
1879
+ Visualizations: Record<string, Visualization>;
1880
+
1874
1881
  /**
1875
1882
  * Creates a new subclass of class sap.sac.df.model.DataProvider with name `sClassName` and enriches it
1876
1883
  * with the information contained in `oClassInfo`.
@@ -1902,253 +1909,6 @@ declare module "sap/sac/df/model/DataProvider" {
1902
1909
  * @returns Metadata object describing this class
1903
1910
  */
1904
1911
  static getMetadata(): Metadata;
1905
- /**
1906
- * Updates the multidimensional model from the given the state of a data provider
1907
- *
1908
- *
1909
- * @returns Promise with reference to this in order to allow method chaining
1910
- */
1911
- deserialize(
1912
- /**
1913
- * the JSON object containing the persisted state of a data provider to be applied.
1914
- */
1915
- oModelState: object,
1916
- /**
1917
- * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY).
1918
- */
1919
- sFormat?: string,
1920
- /**
1921
- * Indicator if the data provider updated should be suppressed after deserialization
1922
- */
1923
- bSuppressUpdate?: boolean
1924
- ): Promise<this>;
1925
- /**
1926
- * Export Data
1927
- */
1928
- exportData(
1929
- /**
1930
- * Data export configuration
1931
- */
1932
- oDataExportConfig: object
1933
- ): void;
1934
- /**
1935
- * Fires event {@link #event:dataUpdated dataUpdated} to attached listeners.
1936
- *
1937
- *
1938
- * @returns Reference to this in order to allow method chaining
1939
- */
1940
- fireDataUpdated(
1941
- /**
1942
- * Parameters to pass along with the event
1943
- */
1944
- oParameters?: object
1945
- ): this;
1946
- /**
1947
- * Get the property AutoFetchEnabled
1948
- */
1949
- getAutoFetchEnabled(): boolean;
1950
- /**
1951
- * Get axis Layout
1952
- *
1953
- *
1954
- * @returns Axis layout object
1955
- */
1956
- getAxesLayout(): AxesLayout;
1957
- /**
1958
- * Get data source information
1959
- *
1960
- *
1961
- * @returns data source information object
1962
- */
1963
- getDataSourceInfo(): DataSourceInfo;
1964
- /**
1965
- * Get the scaling factor of a measure or cell
1966
- *
1967
- *
1968
- * @returns Number of decimal places
1969
- */
1970
- getDecimalPlaces(
1971
- /**
1972
- * Measure structure member
1973
- */
1974
- sMeasureStructureMember: string,
1975
- /**
1976
- * Structure (non-measure) member
1977
- */
1978
- sStructureMember: string
1979
- ): int;
1980
- /**
1981
- * Get Dimension
1982
- *
1983
- *
1984
- * @returns Dimension object
1985
- */
1986
- getDimension(
1987
- /**
1988
- * Dimension name
1989
- */
1990
- sDimensionName: string
1991
- ): Dimension;
1992
- /**
1993
- * Get all dimensions
1994
- *
1995
- *
1996
- * @returns Object of all dimensions
1997
- */
1998
- getDimensions(): Record<string, Dimension>;
1999
- /**
2000
- * Get Grid
2001
- *
2002
- *
2003
- * @returns Grid object
2004
- */
2005
- getGrid(): Grid;
2006
- /**
2007
- * Get measure
2008
- *
2009
- *
2010
- * @returns Measure object
2011
- */
2012
- getMeasure(
2013
- /**
2014
- * Measure name
2015
- */
2016
- sMeasureName: string
2017
- ): /* was: sap.sac.df.model.Measure */ any;
2018
- /**
2019
- * Get all measures
2020
- *
2021
- *
2022
- * @returns Object of all measures
2023
- */
2024
- getMeasures(): /* was: sap.sac.df.model.Measure */ any;
2025
- /**
2026
- * Get Measure Structure Dimension
2027
- *
2028
- *
2029
- * @returns Measure structure dimension
2030
- */
2031
- getMeasureStructureDimension(): Dimension;
2032
- /**
2033
- * Trigger data update
2034
- *
2035
- * @deprecated (since 1.124) - Replaced by {@link sap.sac.df.model.DataProvider#setAutoFetchEnabled setAutoFetchEnabled }
2036
- * API to refresh the data.
2037
- *
2038
- * @returns Promise with reference to this in order to allow method chaining
2039
- */
2040
- getResultSet(): Promise<this>;
2041
- /**
2042
- * Get the scaling factor of a measure or cell
2043
- *
2044
- *
2045
- * @returns Scaling factor
2046
- */
2047
- getScalingFactor(
2048
- /**
2049
- * Measure structure member
2050
- */
2051
- sMeasureStructureMember: string,
2052
- /**
2053
- * Structure (non-measure) member
2054
- */
2055
- sStructureMember: string
2056
- ): int;
2057
- /**
2058
- * Get structure (non-measure) dimension
2059
- *
2060
- *
2061
- * @returns Structure dimension object
2062
- */
2063
- getStructureDimension(): Dimension;
2064
- /**
2065
- * Get Variable
2066
- *
2067
- *
2068
- * @returns Variable object
2069
- */
2070
- getVariable(
2071
- /**
2072
- * Variable Name
2073
- */
2074
- sVariableName: string
2075
- ): Variable;
2076
- /**
2077
- * Get all variables
2078
- *
2079
- *
2080
- * @returns Object of all variables
2081
- */
2082
- getVariables(): Record<string, Variable>;
2083
- /**
2084
- * Serialize the data provider state to a JSON representation
2085
- *
2086
- *
2087
- * @returns A JSON object which represents the data provider
2088
- */
2089
- serialize(
2090
- /**
2091
- * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY)
2092
- */
2093
- sFormat?: string
2094
- ): object;
2095
- /**
2096
- * Set the property `AutoFetchEnabled`, if the data should be automatically be refreshed on invalid.
2097
- */
2098
- setAutoFetchEnabled(bAutoFetchEnabled: boolean): void;
2099
- /**
2100
- * Set the number of decimal places of a measure or cell
2101
- *
2102
- *
2103
- * @returns Reference to this in order to allow method chaining
2104
- */
2105
- setDecimalPlaces(
2106
- /**
2107
- * Number of the decimal places
2108
- */
2109
- nNumberOfDecimalPlaces: int,
2110
- /**
2111
- * Measure structure member
2112
- */
2113
- sMeasureStructureMember: string,
2114
- /**
2115
- * Structure (non-measure) member
2116
- */
2117
- sStructureMember: string
2118
- ): this;
2119
- /**
2120
- * Set the scaling factor of a measure or cell
2121
- *
2122
- *
2123
- * @returns Reference to this in order to allow method chaining
2124
- */
2125
- setScalingFactor(
2126
- /**
2127
- * Scaling factor
2128
- */
2129
- nFactor: int,
2130
- /**
2131
- * Measure structure member
2132
- */
2133
- sMeasureStructureMember: string,
2134
- /**
2135
- * Structure (non-measure) member
2136
- */
2137
- sStructureMember: string
2138
- ): this;
2139
- /**
2140
- * Checks whether an InA capability is supported by the server. Throws an error for unhandled capabilities.
2141
- * List of handled capabilities can be seen in type {@link sap.sac.df.model.Capability}
2142
- *
2143
- *
2144
- * @returns Returns true, if the capability is supported, else false
2145
- */
2146
- supportsCapability(
2147
- /**
2148
- * Capability name
2149
- */
2150
- sCapability: undefined
2151
- ): boolean;
2152
1912
  }
2153
1913
  /**
2154
1914
  * Parameters of the DataProvider#dataUpdated event.
@@ -2162,6 +1922,32 @@ declare module "sap/sac/df/model/DataProvider" {
2162
1922
  DataProvider$DataUpdatedEventParameters,
2163
1923
  DataProvider
2164
1924
  >;
1925
+
1926
+ /**
1927
+ * Parameters of the DataProvider#visualizationAdded event.
1928
+ */
1929
+ export interface DataProvider$VisualizationAddedEventParameters {}
1930
+
1931
+ /**
1932
+ * Event object of the DataProvider#visualizationAdded event.
1933
+ */
1934
+ export type DataProvider$VisualizationAddedEvent = Event<
1935
+ DataProvider$VisualizationAddedEventParameters,
1936
+ DataProvider
1937
+ >;
1938
+
1939
+ /**
1940
+ * Parameters of the DataProvider#visualizationRemoved event.
1941
+ */
1942
+ export interface DataProvider$VisualizationRemovedEventParameters {}
1943
+
1944
+ /**
1945
+ * Event object of the DataProvider#visualizationRemoved event.
1946
+ */
1947
+ export type DataProvider$VisualizationRemovedEvent = Event<
1948
+ DataProvider$VisualizationRemovedEventParameters,
1949
+ DataProvider
1950
+ >;
2165
1951
  }
2166
1952
 
2167
1953
  declare module "sap/sac/df/model/DataSourceInfo" {
@@ -2362,7 +2148,7 @@ declare module "sap/sac/df/model/Dimension" {
2362
2148
  */
2363
2149
  getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
2364
2150
  /**
2365
- * Move dimension one position down on it's axis
2151
+ * Move dimension one position down on its axis
2366
2152
  *
2367
2153
  *
2368
2154
  * @returns Reference to this in order to allow method chaining
@@ -3076,7 +2862,7 @@ declare module "sap/sac/df/model/MultiDimModel" {
3076
2862
  * Get a data provider
3077
2863
  *
3078
2864
  *
3079
- * @returns Data provider instance if found
2865
+ * @returns Data provider object if found
3080
2866
  */
3081
2867
  getDataProvider(
3082
2868
  /**
@@ -3603,6 +3389,57 @@ declare module "sap/sac/df/model/VariableGroup" {
3603
3389
  }
3604
3390
  }
3605
3391
 
3392
+ declare module "sap/sac/df/model/Visualization" {
3393
+ import BaseObject from "sap/ui/base/Object";
3394
+
3395
+ import Metadata from "sap/ui/base/Metadata";
3396
+
3397
+ /**
3398
+ * Visualization Object
3399
+ *
3400
+ * @since 1.125
3401
+ * @experimental (since 1.125)
3402
+ */
3403
+ export default class Visualization extends BaseObject {
3404
+ /**
3405
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3406
+ */
3407
+ protected constructor();
3408
+
3409
+ /**
3410
+ * Creates a new subclass of class sap.sac.df.model.Visualization with name `sClassName` and enriches it
3411
+ * with the information contained in `oClassInfo`.
3412
+ *
3413
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3414
+ *
3415
+ *
3416
+ * @returns Created class / constructor function
3417
+ */
3418
+ static extend<T extends Record<string, unknown>>(
3419
+ /**
3420
+ * Name of the class being created
3421
+ */
3422
+ sClassName: string,
3423
+ /**
3424
+ * Object literal with information about the class
3425
+ */
3426
+ oClassInfo?: sap.ClassInfo<T, Visualization>,
3427
+ /**
3428
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3429
+ * used by this class
3430
+ */
3431
+ FNMetaImpl?: Function
3432
+ ): Function;
3433
+ /**
3434
+ * Returns a metadata object for class sap.sac.df.model.Visualization.
3435
+ *
3436
+ *
3437
+ * @returns Metadata object describing this class
3438
+ */
3439
+ static getMetadata(): Metadata;
3440
+ }
3441
+ }
3442
+
3606
3443
  declare module "sap/sac/df/types/DataSourceType" {
3607
3444
  /**
3608
3445
  * Type of a data source
@@ -3714,6 +3551,8 @@ declare namespace sap {
3714
3551
 
3715
3552
  "sap/sac/df/model/VariableGroup": undefined;
3716
3553
 
3554
+ "sap/sac/df/model/Visualization": undefined;
3555
+
3717
3556
  "sap/sac/df/types/DataSourceType": undefined;
3718
3557
 
3719
3558
  "sap/sac/df/types/DocumentsSupportType": undefined;
@@ -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/suite/ui/commons/collaboration/BaseHelperService" {
4
4
  /**
@@ -12,7 +12,8 @@ declare module "sap/suite/ui/commons/collaboration/BaseHelperService" {
12
12
  * to start a message, audio call or video call
13
13
  *
14
14
  *
15
- * @returns Instance of the contact quick view providing the data for the collaboration functionality
15
+ * @returns Returns promise resolving to an instance of the contact quick view providing the data for the
16
+ * collaboration functionality
16
17
  */
17
18
  enableContactsCollaboration(
18
19
  /**
@@ -23,7 +24,7 @@ declare module "sap/suite/ui/commons/collaboration/BaseHelperService" {
23
24
  * Parameter object which contains the information to be shared
24
25
  */
25
26
  oParams: string
26
- ): object;
27
+ ): Promise<any>;
27
28
  /**
28
29
  * Provides a list of all collaboration options
29
30
  *
@@ -53,9 +54,9 @@ declare module "sap/suite/ui/commons/collaboration/BaseHelperService" {
53
54
  * Provides the Microsoft Teams collaboration options for the contact quick view
54
55
  *
55
56
  *
56
- * @returns The Microsoft Teams collaboration options
57
+ * @returns Returns promise which has the options for teams collaboration
57
58
  */
58
- getTeamsContactCollabOptions(): object;
59
+ getTeamsContactCollabOptions(): Promise<any>;
59
60
  /**
60
61
  * Checks if collaboration with contacts is supported in Microsoft Teams
61
62
  *
@@ -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/suite/ui/generic/template/library" {
4
4
  /**
@@ -498,6 +498,9 @@ declare module "sap/suite/ui/generic/template/AnalyticalListPage/extensionAPI/Ex
498
498
  */
499
499
  getNavigationController(): NavigationController;
500
500
  /**
501
+ * Generally, this method returns the currently selected contexts in the given ui element (table, chart,
502
+ * or list). In case the context menu is opened, it returns the contexts applicable to the context menu.
503
+ *
501
504
  * Get the list entries currently selected
502
505
  *
503
506
  *
@@ -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/suite/ui/microchart/library" {
4
4
  /**
@@ -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/tnt/library" {
4
4
  /**
@@ -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/ui/codeeditor/library" {}
4
4
 
@@ -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/ui/commons/library" {
4
4
  import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";