@sapui5/ts-types-esm 1.129.2 → 1.130.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.
- package/package.json +1 -1
- package/types/index.d.ts +1 -0
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.cux.home.d.ts +41 -40
- package/types/sap.esh.search.ui.d.ts +1 -1
- package/types/sap.f.d.ts +87 -1
- package/types/sap.fe.base.d.ts +1 -1
- package/types/sap.fe.controls.d.ts +3 -0
- package/types/sap.fe.core.d.ts +42 -6
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +462 -200
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +5 -2
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +724 -204
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +1002 -3360
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +108 -16
- package/types/sap.suite.ui.commons.d.ts +264 -125
- package/types/sap.suite.ui.generic.template.d.ts +1 -1
- package/types/sap.suite.ui.microchart.d.ts +309 -79
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +1 -25
- package/types/sap.ui.core.d.ts +119 -110
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +5 -2
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +22 -5
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +273 -234
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +6 -11
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +1 -1
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.fe.macros.d.ts
CHANGED
|
@@ -1,4 +1,323 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.130.0
|
|
2
|
+
|
|
3
|
+
declare module "sap/fe/macros/Chart" {
|
|
4
|
+
import {
|
|
5
|
+
default as MacroAPI,
|
|
6
|
+
$MacroAPISettings,
|
|
7
|
+
} from "sap/fe/macros/MacroAPI";
|
|
8
|
+
|
|
9
|
+
import PresentationVariant from "sap/fe/navigation/PresentationVariant";
|
|
10
|
+
|
|
11
|
+
import Context from "sap/ui/model/odata/v4/Context";
|
|
12
|
+
|
|
13
|
+
import SelectionVariant from "sap/fe/navigation/SelectionVariant";
|
|
14
|
+
|
|
15
|
+
import {
|
|
16
|
+
PropertyBindingInfo,
|
|
17
|
+
AggregationBindingInfo,
|
|
18
|
+
} from "sap/ui/base/ManagedObject";
|
|
19
|
+
|
|
20
|
+
import ActionGroup from "sap/fe/macros/chart/ActionGroup";
|
|
21
|
+
|
|
22
|
+
import Action from "sap/fe/macros/chart/Action";
|
|
23
|
+
|
|
24
|
+
import Event from "sap/ui/base/Event";
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Building block used to create a chart based on the metadata provided by OData V4.
|
|
28
|
+
*
|
|
29
|
+
*
|
|
30
|
+
* Usually, a contextPath and metaPath is expected.
|
|
31
|
+
*
|
|
32
|
+
* Usage example:
|
|
33
|
+
*
|
|
34
|
+
* ```javascript
|
|
35
|
+
*
|
|
36
|
+
* <macros:Chart id="MyChart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
export default class Chart
|
|
40
|
+
extends MacroAPI
|
|
41
|
+
implements
|
|
42
|
+
/* was: sap.fe.core.controllerextensions.viewState.IViewStateContributor */ Object
|
|
43
|
+
{
|
|
44
|
+
__implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Gets current value of property contextPath.
|
|
48
|
+
*
|
|
49
|
+
*
|
|
50
|
+
* @returns Value of property `contextPath`
|
|
51
|
+
*/
|
|
52
|
+
getContextPath(): string;
|
|
53
|
+
/**
|
|
54
|
+
* Gets the key of the current variant in the associated variant management.
|
|
55
|
+
*
|
|
56
|
+
*
|
|
57
|
+
* @returns Variant key of {@link sap.ui.fl.variants.VariantManagement } applied to the chart
|
|
58
|
+
*/
|
|
59
|
+
getCurrentVariantKey(): null | string;
|
|
60
|
+
/**
|
|
61
|
+
* Gets current value of property filterBar.
|
|
62
|
+
*
|
|
63
|
+
*
|
|
64
|
+
* @returns Value of property `filterBar`
|
|
65
|
+
*/
|
|
66
|
+
getFilterBar(): string;
|
|
67
|
+
/**
|
|
68
|
+
* Gets current value of property header.
|
|
69
|
+
*
|
|
70
|
+
*
|
|
71
|
+
* @returns Value of property `header`
|
|
72
|
+
*/
|
|
73
|
+
getHeader(): string;
|
|
74
|
+
/**
|
|
75
|
+
* Gets current value of property headerVisible.
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @returns Value of property `headerVisible`
|
|
79
|
+
*/
|
|
80
|
+
getHeaderVisible(): boolean;
|
|
81
|
+
/**
|
|
82
|
+
* Gets current value of property metaPath.
|
|
83
|
+
*
|
|
84
|
+
*
|
|
85
|
+
* @returns Value of property `metaPath`
|
|
86
|
+
*/
|
|
87
|
+
getMetaPath(): string;
|
|
88
|
+
/**
|
|
89
|
+
* Gets current value of property personalization.
|
|
90
|
+
*
|
|
91
|
+
*
|
|
92
|
+
* @returns Value of property `personalization`
|
|
93
|
+
*/
|
|
94
|
+
getPersonalization(): string;
|
|
95
|
+
/**
|
|
96
|
+
* Get the presentation variant that is currently applied on the chart.
|
|
97
|
+
*
|
|
98
|
+
*
|
|
99
|
+
* @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
|
|
100
|
+
*/
|
|
101
|
+
getPresentationVariant(): Promise<PresentationVariant>;
|
|
102
|
+
/**
|
|
103
|
+
* Gets contexts from the chart that have been selected by the user.
|
|
104
|
+
*
|
|
105
|
+
*
|
|
106
|
+
* @returns Contexts of the rows selected by the user
|
|
107
|
+
*/
|
|
108
|
+
getSelectedContexts(): Context[];
|
|
109
|
+
/**
|
|
110
|
+
* Gets current value of property selectionMode.
|
|
111
|
+
*
|
|
112
|
+
*
|
|
113
|
+
* @returns Value of property `selectionMode`
|
|
114
|
+
*/
|
|
115
|
+
getSelectionMode(): string;
|
|
116
|
+
/**
|
|
117
|
+
* Get the selection variant from the chart.
|
|
118
|
+
*
|
|
119
|
+
*
|
|
120
|
+
* @returns A promise that resolves with a {@link sap.fe.navigation.SelectionVariant }
|
|
121
|
+
*/
|
|
122
|
+
getSelectionVariant(): Promise<SelectionVariant>;
|
|
123
|
+
/**
|
|
124
|
+
* Gets current value of property variantManagement.
|
|
125
|
+
*
|
|
126
|
+
*
|
|
127
|
+
* @returns Value of property `variantManagement`
|
|
128
|
+
*/
|
|
129
|
+
getVariantManagement(): string;
|
|
130
|
+
/**
|
|
131
|
+
* Gets current value of property contextPath.
|
|
132
|
+
*
|
|
133
|
+
*
|
|
134
|
+
* @returns Value of property `contextPath`
|
|
135
|
+
*/
|
|
136
|
+
setContextPath(): string;
|
|
137
|
+
/**
|
|
138
|
+
* Sets the variant of the provided key in the associated variant management.
|
|
139
|
+
*/
|
|
140
|
+
setCurrentVariantKey(
|
|
141
|
+
/**
|
|
142
|
+
* The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
|
|
143
|
+
*/
|
|
144
|
+
key: string
|
|
145
|
+
): void;
|
|
146
|
+
/**
|
|
147
|
+
* Gets current value of property filterBar.
|
|
148
|
+
*
|
|
149
|
+
*
|
|
150
|
+
* @returns Value of property `filterBar`
|
|
151
|
+
*/
|
|
152
|
+
setFilterBar(): string;
|
|
153
|
+
/**
|
|
154
|
+
* Gets current value of property header.
|
|
155
|
+
*
|
|
156
|
+
*
|
|
157
|
+
* @returns Value of property `header`
|
|
158
|
+
*/
|
|
159
|
+
setHeader(): string;
|
|
160
|
+
/**
|
|
161
|
+
* Gets current value of property headerVisible.
|
|
162
|
+
*
|
|
163
|
+
*
|
|
164
|
+
* @returns Value of property `headerVisible`
|
|
165
|
+
*/
|
|
166
|
+
setHeaderVisible(): boolean;
|
|
167
|
+
/**
|
|
168
|
+
* Gets current value of property metaPath.
|
|
169
|
+
*
|
|
170
|
+
*
|
|
171
|
+
* @returns Value of property `metaPath`
|
|
172
|
+
*/
|
|
173
|
+
setMetaPath(): string;
|
|
174
|
+
/**
|
|
175
|
+
* Gets current value of property personalization.
|
|
176
|
+
*
|
|
177
|
+
*
|
|
178
|
+
* @returns Value of property `personalization`
|
|
179
|
+
*/
|
|
180
|
+
setPersonalization(): string;
|
|
181
|
+
/**
|
|
182
|
+
* Set the presentation variant for the mdc chart.
|
|
183
|
+
* The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
|
|
184
|
+
* be followed while trying to set the PresentationVariant as needed.
|
|
185
|
+
* The values dimensions, measures and other properties should also be given in the valid format and null
|
|
186
|
+
* or empty values should be avoided.
|
|
187
|
+
* One dimension attribute should have only one role associated with it on a given chart.
|
|
188
|
+
*/
|
|
189
|
+
setPresentationVariant(
|
|
190
|
+
/**
|
|
191
|
+
* the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
|
|
192
|
+
*/
|
|
193
|
+
presentationVariant: PresentationVariant
|
|
194
|
+
): Promise<void>;
|
|
195
|
+
/**
|
|
196
|
+
* Gets current value of property selectionMode.
|
|
197
|
+
*
|
|
198
|
+
*
|
|
199
|
+
* @returns Value of property `selectionMode`
|
|
200
|
+
*/
|
|
201
|
+
setSelectionMode(): string;
|
|
202
|
+
/**
|
|
203
|
+
* Sets {@link sap.fe.navigation.SelectionVariant } to the chart. Note: setSelectionVariant will clear existing
|
|
204
|
+
* filters and then apply the SelectionVariant values.
|
|
205
|
+
*
|
|
206
|
+
*
|
|
207
|
+
* @returns A promise for asynchronous handling
|
|
208
|
+
*/
|
|
209
|
+
setSelectionVariant(
|
|
210
|
+
/**
|
|
211
|
+
* The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
|
|
212
|
+
*/
|
|
213
|
+
selectionVariant: SelectionVariant,
|
|
214
|
+
/**
|
|
215
|
+
* Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
|
|
216
|
+
* to display the filter value descriptions, instead of loading them from the backend
|
|
217
|
+
*/
|
|
218
|
+
prefillDescriptions?: boolean
|
|
219
|
+
): Promise<any>;
|
|
220
|
+
/**
|
|
221
|
+
* Gets current value of property variantManagement.
|
|
222
|
+
*
|
|
223
|
+
*
|
|
224
|
+
* @returns Value of property `variantManagement`
|
|
225
|
+
*/
|
|
226
|
+
setVariantManagement(): string;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Describes the settings that can be provided to the Chart constructor.
|
|
230
|
+
*/
|
|
231
|
+
export interface $ChartSettings extends $MacroAPISettings {
|
|
232
|
+
/**
|
|
233
|
+
* Metadata path to the entitySet or navigationProperty
|
|
234
|
+
*/
|
|
235
|
+
contextPath?: string | PropertyBindingInfo;
|
|
236
|
+
|
|
237
|
+
/**
|
|
238
|
+
* Id of the FilterBar building block associated with the chart.
|
|
239
|
+
*/
|
|
240
|
+
filterBar?: string | PropertyBindingInfo;
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* Specifies the header text that is shown in the chart
|
|
244
|
+
*/
|
|
245
|
+
header?: string | PropertyBindingInfo;
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Controls if the header text should be shown or not
|
|
249
|
+
*/
|
|
250
|
+
headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* Metadata path to the presentation context (UI.Chart with or without a qualifier)
|
|
254
|
+
*/
|
|
255
|
+
metaPath?: string | PropertyBindingInfo;
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* Controls which options should be enabled for the chart personalization dialog.
|
|
259
|
+
* If it is set to `true`, all possible options for this kind of chart are enabled.
|
|
260
|
+
*
|
|
261
|
+
* If it is set to `false`, personalization is disabled.
|
|
262
|
+
*
|
|
263
|
+
*
|
|
264
|
+
*
|
|
265
|
+
* You can also provide a more granular control for the personalization by providing a comma-separated list
|
|
266
|
+
* with the options you want to be available.
|
|
267
|
+
*
|
|
268
|
+
* Available options are:
|
|
269
|
+
*
|
|
270
|
+
* - Sort
|
|
271
|
+
*
|
|
272
|
+
* - Type
|
|
273
|
+
*
|
|
274
|
+
* - Item
|
|
275
|
+
*
|
|
276
|
+
* - Filter
|
|
277
|
+
*/
|
|
278
|
+
personalization?: string | PropertyBindingInfo;
|
|
279
|
+
|
|
280
|
+
/**
|
|
281
|
+
* Defines the selection mode to be used by the chart.
|
|
282
|
+
* Allowed values are `None`, `Single` or `Multiple`
|
|
283
|
+
*/
|
|
284
|
+
selectionMode?: string | PropertyBindingInfo;
|
|
285
|
+
|
|
286
|
+
/**
|
|
287
|
+
* Controls the kind of variant management that should be enabled for the chart.
|
|
288
|
+
* Allowed value is `Control`.
|
|
289
|
+
*
|
|
290
|
+
* If set with value `Control`, a variant management control is seen within the chart and the chart is linked
|
|
291
|
+
* to this.
|
|
292
|
+
*
|
|
293
|
+
* If not set with any value, variant management control is not available for this chart.
|
|
294
|
+
*/
|
|
295
|
+
variantManagement?: string | PropertyBindingInfo;
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Aggregate actions of the chart.
|
|
299
|
+
*/
|
|
300
|
+
actions?:
|
|
301
|
+
| Array<ActionGroup | Action>
|
|
302
|
+
| ActionGroup
|
|
303
|
+
| Action
|
|
304
|
+
| AggregationBindingInfo
|
|
305
|
+
| `{${string}}`;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
/**
|
|
309
|
+
* Parameters of the Chart#selectionChange event.
|
|
310
|
+
*/
|
|
311
|
+
export interface Chart$SelectionChangeEventParameters {}
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Event object of the Chart#selectionChange event.
|
|
315
|
+
*/
|
|
316
|
+
export type Chart$SelectionChangeEvent = Event<
|
|
317
|
+
Chart$SelectionChangeEventParameters,
|
|
318
|
+
Chart
|
|
319
|
+
>;
|
|
320
|
+
}
|
|
2
321
|
|
|
3
322
|
declare module "sap/fe/macros/CollectionBindingInfo" {
|
|
4
323
|
import Filter from "sap/ui/model/Filter";
|
|
@@ -392,10 +711,7 @@ declare module "sap/fe/macros/chart/ActionGroup" {
|
|
|
392
711
|
}
|
|
393
712
|
|
|
394
713
|
declare module "sap/fe/macros/chart/Chart" {
|
|
395
|
-
import {
|
|
396
|
-
default as BuildingBlockWithTemplating,
|
|
397
|
-
$BuildingBlockWithTemplatingSettings,
|
|
398
|
-
} from "sap/fe/macros/controls/BuildingBlockWithTemplating";
|
|
714
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
399
715
|
|
|
400
716
|
import PresentationVariant from "sap/fe/navigation/PresentationVariant";
|
|
401
717
|
|
|
@@ -435,9 +751,17 @@ declare module "sap/fe/macros/chart/Chart" {
|
|
|
435
751
|
* usage.
|
|
436
752
|
*
|
|
437
753
|
*
|
|
754
|
+
* @deprecated (since now) - As of version 1.130, use {@link sap.fe.macros.Chart } instead
|
|
438
755
|
* @experimental
|
|
439
756
|
*/
|
|
440
|
-
export default class Chart extends
|
|
757
|
+
export default class Chart extends Control {
|
|
758
|
+
/**
|
|
759
|
+
* Gets current value of property contextPath.
|
|
760
|
+
*
|
|
761
|
+
*
|
|
762
|
+
* @returns Value of property `contextPath`
|
|
763
|
+
*/
|
|
764
|
+
getContextPath(): string;
|
|
441
765
|
/**
|
|
442
766
|
* Gets the key of the current variant in the associated variant management.
|
|
443
767
|
*
|
|
@@ -446,244 +770,126 @@ declare module "sap/fe/macros/chart/Chart" {
|
|
|
446
770
|
*/
|
|
447
771
|
getCurrentVariantKey(): null | string;
|
|
448
772
|
/**
|
|
449
|
-
*
|
|
773
|
+
* Gets current value of property filterBar.
|
|
450
774
|
*
|
|
451
775
|
*
|
|
452
|
-
* @returns
|
|
776
|
+
* @returns Value of property `filterBar`
|
|
453
777
|
*/
|
|
454
|
-
|
|
778
|
+
getFilterBar(): string;
|
|
455
779
|
/**
|
|
456
|
-
* Gets
|
|
780
|
+
* Gets current value of property header.
|
|
457
781
|
*
|
|
458
782
|
*
|
|
459
|
-
* @returns
|
|
783
|
+
* @returns Value of property `header`
|
|
460
784
|
*/
|
|
461
|
-
|
|
785
|
+
getHeader(): string;
|
|
462
786
|
/**
|
|
463
|
-
*
|
|
787
|
+
* Gets current value of property headerVisible.
|
|
464
788
|
*
|
|
465
789
|
*
|
|
466
|
-
* @returns
|
|
467
|
-
*/
|
|
468
|
-
getSelectionVariant(): Promise<SelectionVariant>;
|
|
469
|
-
/**
|
|
470
|
-
* Sets the variant of the provided key in the associated variant management.
|
|
471
|
-
*/
|
|
472
|
-
setCurrentVariantKey(
|
|
473
|
-
/**
|
|
474
|
-
* The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
|
|
475
|
-
*/
|
|
476
|
-
key: string
|
|
477
|
-
): void;
|
|
478
|
-
/**
|
|
479
|
-
* Set the presentation variant for the mdc chart.
|
|
480
|
-
* The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
|
|
481
|
-
* be followed while trying to set the PresentationVariant as needed.
|
|
482
|
-
* The values dimensions, measures and other properties should also be given in the valid format and null
|
|
483
|
-
* or empty values should be avoided.
|
|
484
|
-
* One dimension attribute should have only one role associated with it on a given chart.
|
|
790
|
+
* @returns Value of property `headerVisible`
|
|
485
791
|
*/
|
|
486
|
-
|
|
487
|
-
/**
|
|
488
|
-
* the presentation variant {@link sap.fe.navigation.PresentationVariant } to be set
|
|
489
|
-
*/
|
|
490
|
-
presentationVariant: PresentationVariant
|
|
491
|
-
): Promise<void>;
|
|
792
|
+
getHeaderVisible(): boolean;
|
|
492
793
|
/**
|
|
493
|
-
*
|
|
494
|
-
* filters and then apply the SelectionVariant values.
|
|
794
|
+
* Gets current value of property metaPath.
|
|
495
795
|
*
|
|
496
796
|
*
|
|
497
|
-
* @returns
|
|
498
|
-
*/
|
|
499
|
-
setSelectionVariant(
|
|
500
|
-
/**
|
|
501
|
-
* The {@link sap.fe.navigation.SelectionVariant } to apply to the chart
|
|
502
|
-
*/
|
|
503
|
-
selectionVariant: SelectionVariant,
|
|
504
|
-
/**
|
|
505
|
-
* Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
|
|
506
|
-
* to display the filter value descriptions, instead of loading them from the backend
|
|
507
|
-
*/
|
|
508
|
-
prefillDescriptions?: boolean
|
|
509
|
-
): Promise<any>;
|
|
510
|
-
}
|
|
511
|
-
/**
|
|
512
|
-
* Describes the settings that can be provided to the Chart constructor.
|
|
513
|
-
*
|
|
514
|
-
* @experimental
|
|
515
|
-
*/
|
|
516
|
-
export interface $ChartSettings extends $BuildingBlockWithTemplatingSettings {
|
|
517
|
-
/**
|
|
518
|
-
* Metadata path to the entitySet or navigationProperty
|
|
519
|
-
*/
|
|
520
|
-
contextPath?: string | PropertyBindingInfo;
|
|
521
|
-
|
|
522
|
-
/**
|
|
523
|
-
* Id of the FilterBar building block associated with the chart.
|
|
524
|
-
*/
|
|
525
|
-
filterBar?: string | PropertyBindingInfo;
|
|
526
|
-
|
|
527
|
-
/**
|
|
528
|
-
* Specifies the header text that is shown in the chart
|
|
529
|
-
*/
|
|
530
|
-
header?: string | PropertyBindingInfo;
|
|
531
|
-
|
|
532
|
-
/**
|
|
533
|
-
* Controls if the header text should be shown or not
|
|
797
|
+
* @returns Value of property `metaPath`
|
|
534
798
|
*/
|
|
535
|
-
|
|
536
|
-
|
|
799
|
+
getMetaPath(): string;
|
|
537
800
|
/**
|
|
538
|
-
*
|
|
801
|
+
* Gets current value of property personalization.
|
|
802
|
+
*
|
|
803
|
+
*
|
|
804
|
+
* @returns Value of property `personalization`
|
|
539
805
|
*/
|
|
540
|
-
|
|
541
|
-
|
|
806
|
+
getPersonalization(): string;
|
|
542
807
|
/**
|
|
543
|
-
*
|
|
544
|
-
* If it is set to `true`, all possible options for this kind of chart are enabled.
|
|
545
|
-
*
|
|
546
|
-
* If it is set to `false`, personalization is disabled.
|
|
808
|
+
* Get the presentation variant that is currently applied on the chart.
|
|
547
809
|
*
|
|
548
810
|
*
|
|
811
|
+
* @returns The presentation variant {@link sap.fe.navigation.PresentationVariant } applied to the chart
|
|
812
|
+
*/
|
|
813
|
+
getPresentationVariant(): Promise<PresentationVariant>;
|
|
814
|
+
/**
|
|
815
|
+
* Gets contexts from the chart that have been selected by the user.
|
|
549
816
|
*
|
|
550
|
-
* You can also provide a more granular control for the personalization by providing a comma-separated list
|
|
551
|
-
* with the options you want to be available.
|
|
552
817
|
*
|
|
553
|
-
*
|
|
818
|
+
* @returns Contexts of the rows selected by the user
|
|
819
|
+
*/
|
|
820
|
+
getSelectedContexts(): Context[];
|
|
821
|
+
/**
|
|
822
|
+
* Gets current value of property selectionMode.
|
|
554
823
|
*
|
|
555
|
-
* - Sort
|
|
556
824
|
*
|
|
557
|
-
*
|
|
825
|
+
* @returns Value of property `selectionMode`
|
|
826
|
+
*/
|
|
827
|
+
getSelectionMode(): string;
|
|
828
|
+
/**
|
|
829
|
+
* Get the selection variant from the chart.
|
|
558
830
|
*
|
|
559
|
-
* - Item
|
|
560
831
|
*
|
|
561
|
-
*
|
|
832
|
+
* @returns A promise that resolves with a {@link sap.fe.navigation.SelectionVariant }
|
|
562
833
|
*/
|
|
563
|
-
|
|
564
|
-
|
|
834
|
+
getSelectionVariant(): Promise<SelectionVariant>;
|
|
565
835
|
/**
|
|
566
|
-
*
|
|
567
|
-
*
|
|
836
|
+
* Gets current value of property variantManagement.
|
|
837
|
+
*
|
|
838
|
+
*
|
|
839
|
+
* @returns Value of property `variantManagement`
|
|
568
840
|
*/
|
|
569
|
-
|
|
570
|
-
|
|
841
|
+
getVariantManagement(): string;
|
|
571
842
|
/**
|
|
572
|
-
*
|
|
573
|
-
* Allowed value is `Control`.
|
|
843
|
+
* Gets current value of property contextPath.
|
|
574
844
|
*
|
|
575
|
-
* If set with value `Control`, a variant management control is seen within the chart and the chart is linked
|
|
576
|
-
* to this.
|
|
577
845
|
*
|
|
578
|
-
*
|
|
846
|
+
* @returns Value of property `contextPath`
|
|
579
847
|
*/
|
|
580
|
-
|
|
581
|
-
|
|
848
|
+
setContextPath(): string;
|
|
582
849
|
/**
|
|
583
|
-
*
|
|
850
|
+
* Sets the variant of the provided key in the associated variant management.
|
|
584
851
|
*/
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
}
|
|
592
|
-
|
|
593
|
-
/**
|
|
594
|
-
* Parameters of the Chart#selectionChange event.
|
|
595
|
-
*/
|
|
596
|
-
export interface Chart$SelectionChangeEventParameters {}
|
|
597
|
-
|
|
598
|
-
/**
|
|
599
|
-
* Event object of the Chart#selectionChange event.
|
|
600
|
-
*/
|
|
601
|
-
export type Chart$SelectionChangeEvent = Event<
|
|
602
|
-
Chart$SelectionChangeEventParameters,
|
|
603
|
-
Chart
|
|
604
|
-
>;
|
|
605
|
-
}
|
|
606
|
-
|
|
607
|
-
declare module "sap/fe/macros/chart/ChartAPI" {
|
|
608
|
-
import {
|
|
609
|
-
default as MacroAPI,
|
|
610
|
-
$MacroAPISettings,
|
|
611
|
-
} from "sap/fe/macros/MacroAPI";
|
|
612
|
-
|
|
613
|
-
import PresentationVariant from "sap/fe/navigation/PresentationVariant";
|
|
614
|
-
|
|
615
|
-
import Context from "sap/ui/model/odata/v4/Context";
|
|
616
|
-
|
|
617
|
-
import SelectionVariant from "sap/fe/navigation/SelectionVariant";
|
|
618
|
-
|
|
619
|
-
import {
|
|
620
|
-
PropertyBindingInfo,
|
|
621
|
-
AggregationBindingInfo,
|
|
622
|
-
} from "sap/ui/base/ManagedObject";
|
|
623
|
-
|
|
624
|
-
import ActionGroup from "sap/fe/macros/chart/ActionGroup";
|
|
625
|
-
|
|
626
|
-
import Action from "sap/fe/macros/chart/Action";
|
|
627
|
-
|
|
628
|
-
import Event from "sap/ui/base/Event";
|
|
629
|
-
|
|
630
|
-
/**
|
|
631
|
-
* Building block used to create a chart based on the metadata provided by OData V4.
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
* Usually, a contextPath and metaPath is expected.
|
|
635
|
-
*
|
|
636
|
-
* Usage example:
|
|
637
|
-
*
|
|
638
|
-
* ```javascript
|
|
639
|
-
*
|
|
640
|
-
* <macros:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
|
|
641
|
-
* ```
|
|
642
|
-
*/
|
|
643
|
-
export default class Chart
|
|
644
|
-
extends MacroAPI
|
|
645
|
-
implements
|
|
646
|
-
/* was: sap.fe.core.controllerextensions.viewState.IViewStateContributor */ Object
|
|
647
|
-
{
|
|
648
|
-
__implements__sap_fe_core_controllerextensions_viewState_IViewStateContributor: boolean;
|
|
649
|
-
|
|
852
|
+
setCurrentVariantKey(
|
|
853
|
+
/**
|
|
854
|
+
* The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
|
|
855
|
+
*/
|
|
856
|
+
key: string
|
|
857
|
+
): void;
|
|
650
858
|
/**
|
|
651
|
-
* Gets
|
|
859
|
+
* Gets current value of property filterBar.
|
|
652
860
|
*
|
|
653
861
|
*
|
|
654
|
-
* @returns
|
|
862
|
+
* @returns Value of property `filterBar`
|
|
655
863
|
*/
|
|
656
|
-
|
|
864
|
+
setFilterBar(): string;
|
|
657
865
|
/**
|
|
658
|
-
*
|
|
866
|
+
* Gets current value of property header.
|
|
659
867
|
*
|
|
660
868
|
*
|
|
661
|
-
* @returns
|
|
869
|
+
* @returns Value of property `header`
|
|
662
870
|
*/
|
|
663
|
-
|
|
871
|
+
setHeader(): string;
|
|
664
872
|
/**
|
|
665
|
-
* Gets
|
|
873
|
+
* Gets current value of property headerVisible.
|
|
666
874
|
*
|
|
667
875
|
*
|
|
668
|
-
* @returns
|
|
876
|
+
* @returns Value of property `headerVisible`
|
|
669
877
|
*/
|
|
670
|
-
|
|
878
|
+
setHeaderVisible(): boolean;
|
|
671
879
|
/**
|
|
672
|
-
*
|
|
880
|
+
* Gets current value of property metaPath.
|
|
673
881
|
*
|
|
674
882
|
*
|
|
675
|
-
* @returns
|
|
883
|
+
* @returns Value of property `metaPath`
|
|
676
884
|
*/
|
|
677
|
-
|
|
885
|
+
setMetaPath(): string;
|
|
678
886
|
/**
|
|
679
|
-
*
|
|
887
|
+
* Gets current value of property personalization.
|
|
888
|
+
*
|
|
889
|
+
*
|
|
890
|
+
* @returns Value of property `personalization`
|
|
680
891
|
*/
|
|
681
|
-
|
|
682
|
-
/**
|
|
683
|
-
* The variant key of {@link sap.ui.fl.variants.VariantManagement } to be set
|
|
684
|
-
*/
|
|
685
|
-
key: string
|
|
686
|
-
): void;
|
|
892
|
+
setPersonalization(): string;
|
|
687
893
|
/**
|
|
688
894
|
* Set the presentation variant for the mdc chart.
|
|
689
895
|
* The json format retrieved by using the get PresentationVariant button in the linked FPM sample should
|
|
@@ -698,6 +904,13 @@ declare module "sap/fe/macros/chart/ChartAPI" {
|
|
|
698
904
|
*/
|
|
699
905
|
presentationVariant: PresentationVariant
|
|
700
906
|
): Promise<void>;
|
|
907
|
+
/**
|
|
908
|
+
* Gets current value of property selectionMode.
|
|
909
|
+
*
|
|
910
|
+
*
|
|
911
|
+
* @returns Value of property `selectionMode`
|
|
912
|
+
*/
|
|
913
|
+
setSelectionMode(): string;
|
|
701
914
|
/**
|
|
702
915
|
* Sets {@link sap.fe.navigation.SelectionVariant } to the chart. Note: setSelectionVariant will clear existing
|
|
703
916
|
* filters and then apply the SelectionVariant values.
|
|
@@ -716,11 +929,21 @@ declare module "sap/fe/macros/chart/ChartAPI" {
|
|
|
716
929
|
*/
|
|
717
930
|
prefillDescriptions?: boolean
|
|
718
931
|
): Promise<any>;
|
|
932
|
+
/**
|
|
933
|
+
* Gets current value of property variantManagement.
|
|
934
|
+
*
|
|
935
|
+
*
|
|
936
|
+
* @returns Value of property `variantManagement`
|
|
937
|
+
*/
|
|
938
|
+
setVariantManagement(): string;
|
|
719
939
|
}
|
|
720
940
|
/**
|
|
721
941
|
* Describes the settings that can be provided to the Chart constructor.
|
|
942
|
+
*
|
|
943
|
+
* @deprecated (since now) - As of version 1.130, use {@link sap.fe.macros.Chart } instead
|
|
944
|
+
* @experimental
|
|
722
945
|
*/
|
|
723
|
-
export interface $ChartSettings extends $
|
|
946
|
+
export interface $ChartSettings extends $ControlSettings {
|
|
724
947
|
/**
|
|
725
948
|
* Metadata path to the entitySet or navigationProperty
|
|
726
949
|
*/
|
|
@@ -1164,6 +1387,18 @@ declare module "sap/fe/macros/field/FieldAPI" {
|
|
|
1164
1387
|
* Additional format options for the field.
|
|
1165
1388
|
*/
|
|
1166
1389
|
export type FieldFormatOptions = {
|
|
1390
|
+
/**
|
|
1391
|
+
* Property for defining a custom pattern for the date, time, or dateTime format.
|
|
1392
|
+
*
|
|
1393
|
+
* If there is a dateTimePattern defined dateTimeStyle is ignored.
|
|
1394
|
+
*/
|
|
1395
|
+
dateTimePattern: string;
|
|
1396
|
+
/**
|
|
1397
|
+
* Property for defining the display style for the date, time, or dateTime format.
|
|
1398
|
+
*
|
|
1399
|
+
* If there is a dateTimePattern defined dateTimeStyle is ignored.
|
|
1400
|
+
*/
|
|
1401
|
+
dateTimeStyle: /* was: sap.fe.core.templating.UIFormatters.DateTimeStyle */ any;
|
|
1167
1402
|
/**
|
|
1168
1403
|
* Defines how the field value and associated text will be displayed together.
|
|
1169
1404
|
*
|
|
@@ -2139,7 +2374,7 @@ declare module "sap/fe/macros/richtexteditor/ButtonGroup" {
|
|
|
2139
2374
|
/**
|
|
2140
2375
|
* The priority of the group in the custom toolbar.
|
|
2141
2376
|
*/
|
|
2142
|
-
customToolbarPriority?:
|
|
2377
|
+
customToolbarPriority?: int | PropertyBindingInfo | `{${string}}`;
|
|
2143
2378
|
|
|
2144
2379
|
/**
|
|
2145
2380
|
* The name of the group.
|
|
@@ -2149,7 +2384,12 @@ declare module "sap/fe/macros/richtexteditor/ButtonGroup" {
|
|
|
2149
2384
|
/**
|
|
2150
2385
|
* The priority of the group.
|
|
2151
2386
|
*/
|
|
2152
|
-
priority?:
|
|
2387
|
+
priority?: int | PropertyBindingInfo | `{${string}}`;
|
|
2388
|
+
|
|
2389
|
+
/**
|
|
2390
|
+
* Row number in which the button should be
|
|
2391
|
+
*/
|
|
2392
|
+
row?: int | PropertyBindingInfo | `{${string}}`;
|
|
2153
2393
|
|
|
2154
2394
|
/**
|
|
2155
2395
|
* Whether the group is visible.
|
|
@@ -3478,6 +3718,14 @@ declare module "sap/fe/macros/table/TableCreationOptions" {
|
|
|
3478
3718
|
*/
|
|
3479
3719
|
createAtEnd?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
3480
3720
|
|
|
3721
|
+
/**
|
|
3722
|
+
* Defines the list of properties that will be displayed in the creation dialog, when the creation mode
|
|
3723
|
+
* is set to 'CreationDialog'.
|
|
3724
|
+
*
|
|
3725
|
+
* The value is a comma-separated list of property names.
|
|
3726
|
+
*/
|
|
3727
|
+
creationFields?: string | PropertyBindingInfo;
|
|
3728
|
+
|
|
3481
3729
|
/**
|
|
3482
3730
|
* Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
|
|
3483
3731
|
* to responsive tables.
|
|
@@ -3491,7 +3739,7 @@ declare module "sap/fe/macros/table/TableCreationOptions" {
|
|
|
3491
3739
|
|
|
3492
3740
|
/**
|
|
3493
3741
|
* Defines the creation mode to be used by the table.
|
|
3494
|
-
* Allowed values are `NewPage`, `Inline`, `InlineCreationsRows` or `
|
|
3742
|
+
* Allowed values are `NewPage`, `Inline`, `InlineCreationsRows`, `External` or `CreationDialog`.
|
|
3495
3743
|
*
|
|
3496
3744
|
*
|
|
3497
3745
|
*
|
|
@@ -3503,6 +3751,9 @@ declare module "sap/fe/macros/table/TableCreationOptions" {
|
|
|
3503
3751
|
* InlineCreationsRows - The creation is done inline with an empty row
|
|
3504
3752
|
*
|
|
3505
3753
|
* External - The creation is done in a different application specified via the parameter 'outbound'
|
|
3754
|
+
* CreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property
|
|
3755
|
+
* values (the properties are listed in `creationFields`).
|
|
3756
|
+
*
|
|
3506
3757
|
* If not set with any value:
|
|
3507
3758
|
*
|
|
3508
3759
|
* if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
|
|
@@ -4556,6 +4807,14 @@ declare module "sap/fe/macros/table/TreeTableCreationOptions" {
|
|
|
4556
4807
|
*/
|
|
4557
4808
|
createInPlace?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4558
4809
|
|
|
4810
|
+
/**
|
|
4811
|
+
* Defines the list of properties that will be displayed in the creation dialog, when the creation mode
|
|
4812
|
+
* is set to 'CreationDialog'.
|
|
4813
|
+
*
|
|
4814
|
+
* The value is a comma-separated list of property names.
|
|
4815
|
+
*/
|
|
4816
|
+
creationFields?: string | PropertyBindingInfo;
|
|
4817
|
+
|
|
4559
4818
|
/**
|
|
4560
4819
|
* Defines the extension point to control the enablement of the Create button or Create Menu buttons.
|
|
4561
4820
|
*/
|
|
@@ -4563,7 +4822,7 @@ declare module "sap/fe/macros/table/TreeTableCreationOptions" {
|
|
|
4563
4822
|
|
|
4564
4823
|
/**
|
|
4565
4824
|
* Defines the creation mode to be used by the tree table.
|
|
4566
|
-
* Allowed values are `NewPage` or `
|
|
4825
|
+
* Allowed values are `NewPage`, `Inline` or `CreationDialog`.
|
|
4567
4826
|
*
|
|
4568
4827
|
*
|
|
4569
4828
|
*
|
|
@@ -4572,6 +4831,9 @@ declare module "sap/fe/macros/table/TreeTableCreationOptions" {
|
|
|
4572
4831
|
*
|
|
4573
4832
|
* Inline - the creation is done inline.
|
|
4574
4833
|
*
|
|
4834
|
+
* CreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property
|
|
4835
|
+
* values (the properties are listed in `creationFields`).
|
|
4836
|
+
*
|
|
4575
4837
|
* If not set with any value:
|
|
4576
4838
|
*
|
|
4577
4839
|
* if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
|
|
@@ -4584,8 +4846,8 @@ declare module "sap/fe/macros/table/TreeTableCreationOptions" {
|
|
|
4584
4846
|
* propertyName: the name of the property on the page entity set used to categorize the node type to be
|
|
4585
4847
|
* created within the hierarchy
|
|
4586
4848
|
*
|
|
4587
|
-
* values: an array of key and
|
|
4588
|
-
*
|
|
4849
|
+
* values: an array of key, label and an optional creationFields that define a value of the property defined
|
|
4850
|
+
* by the propertyName key, its label, and the specific fields to be shown in the creation dialog.
|
|
4589
4851
|
*/
|
|
4590
4852
|
nodeType?: object | PropertyBindingInfo | `{${string}}`;
|
|
4591
4853
|
}
|
|
@@ -4694,14 +4956,14 @@ declare module "sap/fe/macros/controls/section/ISingleSectionContributor" {
|
|
|
4694
4956
|
|
|
4695
4957
|
declare namespace sap {
|
|
4696
4958
|
interface IUI5DefineDependencyNames {
|
|
4959
|
+
"sap/fe/macros/Chart": undefined;
|
|
4960
|
+
|
|
4697
4961
|
"sap/fe/macros/chart/Action": undefined;
|
|
4698
4962
|
|
|
4699
4963
|
"sap/fe/macros/chart/ActionGroup": undefined;
|
|
4700
4964
|
|
|
4701
4965
|
"sap/fe/macros/chart/Chart": undefined;
|
|
4702
4966
|
|
|
4703
|
-
"sap/fe/macros/chart/ChartAPI": undefined;
|
|
4704
|
-
|
|
4705
4967
|
"sap/fe/macros/CollectionBindingInfo": undefined;
|
|
4706
4968
|
|
|
4707
4969
|
"sap/fe/macros/controls/BuildingBlockObjectProperty": undefined;
|